doc update for about page

Author: tony

doc/about.rst

@@ -54,25 +54,28 @@ Differences
 
 **Programming Language** python. teamocil and tmuxinator uses ruby.
 
-**Internals** teamocil and tmuxinator pipe configurations into
+**Internals** teamocil and tmuxinator process configurations into shell
 commands. tmuxp turns configuration into a live :class:`Session` object
 with access to all window and pane data. See :ref:`internals`.
 
-**CLI** tmuxp's CLI can attach and kill sessions with tab-completion
-support.
-
 Additional Features
 -------------------
 
-**Unit tests** Tests against live tmux version to test statefulness of
-tmux sessions, windows and panes. See :ref:`travis`.
+**CLI** tmuxp's CLI can attach and kill sessions with tab-completion
+support. See :ref:`commands`.
 
-**Import config** import configs from Teamocil / Tmuxinator [1]_.
+**Import config** import configs from Teamocil / Tmuxinator [1]_. See
+:ref:`cli_import`.
 
 **Session freezing** Supports session freezing into YAML and JSON
-format [1]_.
+format [1]_. See :ref:`cli_freeze`.
+
+**JSON config** JSON config support. See :ref:`Examples`.
 
-**JSON config** JSON config support
+**ORM-based API** - Utilitizes tmux >= 1.8's unique ID's for panes,
+windows and sessions to create an object relational view of the tmux
+:class:`Server` and its entities; :class:`Session`, :class:`Window`,
+:class:`Pane`. See :ref:`Internals`.
 
 **Conversion** ``$ tmuxp convert <filename>`` can convert files to and
 from JSON and YAML.
@@ -84,6 +87,8 @@ from JSON and YAML.
 Minor tweaks
 ------------
 
+- Unit tests against live tmux version to test statefulness of tmux
+  sessions, windows and panes. See :ref:`travis`.
 - Load + switch to new session from inside tmux.
 - Resume session if config loaded.
 - Pre-commands virtualenv / rvm / any other commands.

doc/cli.rst

@@ -36,6 +36,8 @@ directory may be loaded with:
 
     $ tmuxp load .
 
+.. _cli_import:
+
 Import
 """"""
 

tmuxp/cli.py

@@ -369,6 +369,8 @@ def command_load(args):
         startup(config_dir)
         configs_in_user = config.in_dir(config_dir)
         configs_in_cwd = config.in_cwd()
+        print(configs_in_cwd)
+        sys.exit()
 
         output = ''
 
@@ -390,13 +392,18 @@ def command_load(args):
         if '.' == args.config:
             if config.in_cwd():
                 configfile = config.in_cwd()[0]
+                print(configfile)
             else:
                 sys.exit('No tmuxp configs found in current directory.')
         else:
             configfile = args.config
         file_user = os.path.join(config_dir, configfile)
         file_cwd = os.path.join(cwd_dir, configfile)
+        print(file_user)
+        print(file_cwd)
+        print(cwd_dir)
         if os.path.exists(file_cwd) and os.path.isfile(file_cwd):
+            print('load %s' % file_cwd)
             load_workspace(file_cwd, args)
         elif os.path.exists(file_user) and os.path.isfile(file_user):
             load_workspace(file_user, args)

tmuxp/config.py

@@ -206,7 +206,9 @@ def trickle(sconf):
             if not 'start_directory' in windowconfig:
                 windowconfig['start_directory'] = session_start_directory
             else:
-                if not any(windowconfig['start_directory'].startswith(a) for a in ['~', '/']):
+                if any(windowconfig['start_directory'] == a for a in ['.', './']):
+                    windowconfig['start_directory'] = os.getcwd()
+                elif not any(windowconfig['start_directory'].startswith(a) for a in ['~', '/']):
                     windowconfig['start_directory'] = os.path.join(
                         session_start_directory, windowconfig['start_directory'])
 

tmuxp/testsuite/test_config.py

@@ -132,9 +132,7 @@ def tearDownClass(cls):
 
 class ExpandTest(unittest.TestCase):
 
-    '''
-    assumes the configuration has been imported into a python dict correctly.
-    '''
+    """Assume configuration has been imported into a python dict correctly."""
 
     before_config = {
         'session_name': 'sampleconfig',
@@ -154,23 +152,27 @@ class ExpandTest(unittest.TestCase):
             {
                 'window_name': 'logging',
                 'panes': [
-                    {'shell_command': ['tail -F /var/log/syslog'],
-                     }
+                    {
+                        'shell_command': ['tail -F /var/log/syslog'],
+                    }
                 ]
             },
             {
                 'start_directory': '/var/log',
                 'options': {'automatic_rename': True, },
                 'panes': [
-                    {'shell_command': 'htop'},
+                    {
+                        'shell_command': 'htop'
+                    },
                     'vim',
                 ]
             },
             {
                 'panes': [
                     'top'
                 ]
-            }]
+            }
+        ]
     }
 
     after_config = {
@@ -267,8 +269,10 @@ class InlineTest(unittest.TestCase):
                 'window_name': 'editor',
                 'panes': [
                     {
-                        'start_directory': '~', 'shell_command': 'vim',
-                    },  {
+                        'start_directory': '~',
+                        'shell_command': 'vim',
+                    },
+                    {
                         'shell_command': 'cowsay "hey"'
                     },
                 ],
@@ -277,14 +281,20 @@ class InlineTest(unittest.TestCase):
             {
                 'window_name': 'logging',
                 'panes': [
-                    {'shell_command': 'tail -F /var/log/syslog',
-                     'start_directory': '/var/log'}
+                    {
+                        'shell_command': 'tail -F /var/log/syslog',
+                        'start_directory': '/var/log'
+                    }
                 ]
             },
             {
-                'options': {'automatic_rename': True, },
+                'options': {
+                    'automatic_rename': True,
+                },
                 'panes': [
-                    {'shell_command': 'htop'}
+                    {
+                        'shell_command': 'htop'
+                    }
                 ]
             }
         ]
@@ -316,8 +326,10 @@ class InheritanceTest(unittest.TestCase):
                 'start_directory': '~',
                 'panes': [
                     {
-                        'start_directory': '~', 'shell_command': ['vim'],
-                    },  {
+                        'start_directory': '~',
+                        'shell_command': ['vim'],
+                    },
+                    {
                         'shell_command': ['cowsay "hey"']
                     },
                 ],
@@ -364,8 +376,10 @@ class InheritanceTest(unittest.TestCase):
             {
                 'window_name': 'logging',
                 'panes': [
-                    {'shell_command': ['tail -F /var/log/syslog'],
-                        'start_directory':'/var/log'}
+                    {
+                        'shell_command': ['tail -F /var/log/syslog'],
+                        'start_directory':'/var/log'
+                    }
                 ]
             },
             {

tmuxp/testsuite/test_workspacebuilder.py

@@ -273,7 +273,7 @@ class StartDirectoryTest(TmuxTestCase):
     session_name: sampleconfig
     start_directory: '/var'
     windows:
-    - window_name: test
+    - window_name: supposed to be /var/log
       start_directory: '/var/log'
       layout: main-horizontal
       options:
@@ -283,7 +283,7 @@ class StartDirectoryTest(TmuxTestCase):
         - echo "hey"
       - shell_command:
         - echo "moo"
-    - window_name: testsa
+    - window_name: support to be /dev
       start_directory: '/dev'
       layout: main-horizontal
       panes:
@@ -302,6 +302,17 @@ class StartDirectoryTest(TmuxTestCase):
         - echo "hey"
       - shell_command:
         - echo "moo3"
+    - window_name: cwd relative to config file
+      layout: main-horizontal
+      start_directory: ./
+      panes:
+      - shell_command:
+        - pwd
+      - shell_command:
+        - echo "hey"
+      - shell_command:
+        - echo "moo3"
+
     '''
 
     def test_start_directory(self):
@@ -311,13 +322,16 @@ def test_start_directory(self):
         sconfig = config.expand(sconfig)
         sconfig = config.trickle(sconfig)
 
+        logger.error(sconfig)
+
         builder = WorkspaceBuilder(sconf=sconfig)
         builder.build(session=self.session)
 
         assert(self.session == builder.session)
-        for window in self.session.windows:
-            for p in window.panes:
-                self.assertTrue(any(p.get('pane_start_path', ['/var/log', '/dev/', '/var/'])))
+        for path in ['/var/log', '/dev/', '/var/', os.getcwd()]:
+            for window in self.session.windows:
+                for p in window.panes:
+                    self.assertTrue(p.get('pane_start_path', path))
 
 if __name__ == '__main__':
     unittest.main()