Fix #15 pane ordering

Author: tony

CHANGES

@@ -11,6 +11,12 @@ Here you can find the recent changes to tmuxp.
 
 - [internal] :meth:`Window.show_window_options`,
   :meth:`Window.show_window_option` now accept ``g`` to pass in ``-g``.
+- [internal] Behavioral changes in the WorkspaceBuilder to fix pane
+  ordering `Issue #15`_.
+- [tests] WorkspaceBuilder tests have been improved to use async better.
+
+.. _Issue #15: https://github.com/tony/tmuxp/issues/15
+
 
 2013-11-17
 ''''''''''

TODO

@@ -38,6 +38,16 @@ Done
 Milestone 0.2
 -------------
 
+Major
+"""""
+
+- Fix inconsistencies / syncing with ``.get`` on Windows and panes. Always
+  get freshest data.
+- Validate the data types passed back and forth between options and pane,
+  window, session proprties. (Create a util method that maps key values to
+  a type).
+- Unit test the above.
+
 - ``tmuxp freeze`` add autogenerated command to yaml configs (won't work w/ json)
 - `pep8`_, `pep257`_ for tests. (ongoing)
 - if no ``window_name`` in config, option ``automatic_rename: on`` by 

tmuxp/testsuite/test_workspacebuilder.py

@@ -2,10 +2,11 @@
 from __future__ import absolute_import, division, print_function, with_statement
 
 import os
+import sys
 import logging
 import time
 import kaptan
-from .. import Window, config, exc
+from .. import Window, config, exc, util
 from ..workspacebuilder import WorkspaceBuilder
 from .helpers import TmuxTestCase
 
@@ -132,7 +133,6 @@ def test_split_windows(self):
         s = self.session
         sconfig = kaptan.Kaptan(handler='yaml')
         sconfig = sconfig.import_config(self.yaml_config).get()
-        import sys
 
         builder = WorkspaceBuilder(sconf=sconfig)
 
@@ -247,24 +247,34 @@ def test_automatic_rename_option(self):
             window_count += 1
             w.select_layout(wconf['layout'])
 
-        w = s.attached_window()
+        self.assertNotEqual(s.get('session_name'), 'tmuxp')
+        w = s.windows[0]
 
         for i in range(30):
-            w = s.attached_window()
-            if w['window_name'] == 'man':
+            if w.get('window_name') != 'man':
                 break
             time.sleep(.2)
 
-        self.assertEqual(w.get('window_name'), 'man')
+        self.assertNotEqual(w.get('window_name'), 'man')
+
+        pane_base_index = w.show_window_option('pane-base-index', g=True)
+        w.select_pane(pane_base_index)
+
+        for i in range(30):
+            self.session.server._update_windows()
+            if w.get('window_name') == 'man':
+                break
+            time.sleep(.2)
+
+        self.assertEqual(w.get('window_name'), unicode('man'))
 
         w.select_pane('-D')
         for i in range(30):
-            w = s.attached_window()
             if w['window_name'] != 'man':
                 break
             time.sleep(.2)
 
-        self.assertNotEqual(w.get('window_name'), 'man')
+        self.assertEqual(w.get('window_name'), unicode('man'))
 
 
 class BlankPaneTest(TmuxTestCase):
@@ -342,8 +352,6 @@ 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)
 
@@ -376,6 +384,14 @@ class PaneOrderingTest(TmuxTestCase):
     """
 
     def test_pane_order(self):
+
+        # test order of `panes` (and pane_index) above aganist pane_dirs
+        pane_paths = [
+            '/var/log',
+            '/sys',
+            '/sbin',
+            '/tmp'
+        ]
         s = self.session
         sconfig = kaptan.Kaptan(handler='yaml')
         sconfig = sconfig.import_config(self.yaml_config).get()
@@ -399,11 +415,19 @@ def test_pane_order(self):
 
         for w in self.session.windows:
             import time
-            time.sleep(.5)
-            for p_index, p in enumerate(w.list_panes(), start=w.show_window_option('pane-base-index', g=True)):
-            #for p in w.list_panes():
-                logger.error(p.get('pane_current_path'))
+            time.sleep(1)
+            pane_base_index = w.show_window_option('pane-base-index', g=True)
+            for p_index, p in enumerate(w.list_panes(), start=pane_base_index):
                 self.assertEqual(int(p_index), int(p.get('pane_index')))
-                logger.error('pane-base-index: %s, p_index: %s, pane_index: %s' % (
-                    w.show_window_option('pane-base-index', g=True), p_index, p.get('pane_index')
-                ))
+
+                # pane-base-index start at base-index, pane_paths always start
+                # at 0 since python list.
+                pane_path = pane_paths[p_index - pane_base_index]
+
+                for i in range(30):
+                    p.server._update_panes()
+                    if p.get('pane_current_path') == pane_path:
+                        break
+                    time.sleep(.2)
+
+                self.assertEqual(p.get('pane_current_path'), pane_path)

tmuxp/window.py

@@ -287,6 +287,18 @@ def move_window(self, destination):
 
         self.server._update_windows()
 
+    def select_window(self):
+        """Select window. Return ``self``.
+
+        To select a window object asynchrously. If a ``window`` object exists
+        and is no longer longer the current window, ``w.select_window()``
+        will make ``w`` the current window.
+
+        :rtype: :class:`Window`
+
+        """
+        return self.session.select_window(self.get('window_id'))
+
     def select_pane(self, target_pane):
         """Return selected :class:`Pane` through ``$ tmux select-pane``.
 
@@ -307,6 +319,10 @@ def select_pane(self, target_pane):
 
         return self.attached_pane()
 
+    def last_pane(self):
+        """Return last pane."""
+        return self.select_pane('-l')
+
     def split_window(self, target=None, attach=True):
         """Split window and return the created :class:`Pane`.
 

tmuxp/workspacebuilder.py

@@ -132,6 +132,7 @@ def build(self, session=None):
 
         assert(isinstance(session, Session))
 
+        focus = None
         for w, wconf in self.iter_create_windows(session):
             assert(isinstance(w, Window))
             for p in self.iter_create_panes(w, wconf):
@@ -141,6 +142,12 @@ def build(self, session=None):
                 if 'layout' in wconf:
                     w.select_layout(wconf['layout'])
 
+            if 'focus' in wconf and wconf['focus']:
+                focus = w
+
+        if focus:
+            focus.select_window()
+
     def iter_create_windows(self, s):
         """Return :class:`Window` iterating through session config dict.
 
@@ -200,13 +207,20 @@ def iter_create_panes(self, w, wconf):
         """
         assert(isinstance(w, Window))
 
-        for pindex, pconf in enumerate(wconf['panes'], start=1):
-            if pindex != int(1):
-                p = w.split_window(attach=False)
+        pane_base_index = int(w.show_window_option('pane-base-index', g=True))
+
+        for pindex, pconf in enumerate(wconf['panes'], start=pane_base_index):
+            if pindex != int(pane_base_index):
+                p = w.split_window(
+                    attach=True,
+                    #target=w.list_panes()[-1].get('pane_index')
+                )
                 assert(isinstance(p, Pane))
+                assert(p.get('pane_index'), pane_base_index)
             else:
                 p = w.attached_pane()
                 assert(isinstance(p, Pane))
+                assert(p.get('pane_index'), pindex)
 
             if 'layout' in wconf:
                 w.select_layout(wconf['layout'])