Enhancement: Configurable tab cycle through dashboard.

Relates to timbrel#261.

Author: divmain

Default.sublime-keymap

@@ -309,8 +309,8 @@
     },
     {
         "keys": ["tab"],
-        "command": "gs_show_branch",
-        "args": { "commandeer_active_view": true },
+        "command": "gs_tab_cycle",
+        "args": { "source": "status" },
         "context": [
             { "key": "setting.git_savvy.status_view", "operator": "equal", "operand": true }
         ]
@@ -450,8 +450,8 @@
     },
     {
         "keys": ["tab"],
-        "command": "gs_show_status",
-        "args": { "commandeer_active_view": true },
+        "command": "gs_tab_cycle",
+        "args": { "source": "tags" },
         "context": [
             { "key": "setting.git_savvy.tags_view", "operator": "equal", "operand": true }
         ]
@@ -576,8 +576,8 @@
     },
     {
         "keys": ["tab"],
-        "command": "gs_show_rebase",
-        "args": { "commandeer_active_view": true },
+        "command": "gs_tab_cycle",
+        "args": { "source": "branch" },
         "context": [
             { "key": "setting.git_savvy.branch_view", "operator": "equal", "operand": true }
         ]
@@ -625,6 +625,14 @@
             { "key": "setting.git_savvy.log_graph_view", "operator": "equal", "operand": true }
         ]
     },
+    {
+        "keys": ["tab"],
+        "command": "gs_tab_cycle",
+        "args": { "source": "graph" },
+        "context": [
+            { "key": "setting.git_savvy.log_graph_view", "operator": "equal", "operand": true }
+        ]
+    },
 
     //////////////////////
     // REBASE DASHBOARD //
@@ -761,8 +769,8 @@
     },
     {
         "keys": ["tab"],
-        "command": "gs_show_tags",
-        "args": { "commandeer_active_view": true },
+        "command": "gs_tab_cycle",
+        "args": { "source": "rebase" },
         "context": [
             { "key": "setting.git_savvy.rebase_view", "operator": "equal", "operand": true }
         ]

GitSavvy.sublime-settings

@@ -213,5 +213,25 @@
         Set this value to true if you'd like GitSavvy to automatically attempt
         to decode using the `fallback_encoding` value, without prompting.
      */
-    "silent_fallback": false
+    "silent_fallback": false,
+
+    /*
+        GitSavvy allows you to press `Tab` to cycle from one dashboard interface
+        to the next.  This setting defines the order of that cycle.  The following
+        are valid entries, and can be included in your preferred order:
+
+            status
+            branch
+            rebase
+            tags
+            graph
+
+     */
+    "tab_order": [
+        "status",
+        "branch",
+        "rebase",
+        "tags",
+        "graph"
+    ]
 }

common/ui.py

@@ -76,7 +76,6 @@ def create_view(self, repo_path):
         self.view.settings().set("git_savvy.repo_path", repo_path)
         self.view.set_name(self.title())
         self.view.settings().set("git_savvy.{}_view".format(self.interface_type), True)
-        self.view.settings().set("git_savvy.is_interface", True)
         self.view.settings().set("git_savvy.interface", self.interface_type)
         self.view.settings().set("word_wrap", self.word_wrap)
         self.view.set_syntax_file(self.syntax_file)

core/interfaces/__init__.py

@@ -1,4 +1,44 @@
+import sublime
+from sublime_plugin import TextCommand
+
 from .status import *
 from .branch import *
 from .rebase import *
 from .tags import *
+
+
+class GsTabCycleCommand(TextCommand, GitCommand):
+    commands = {
+        "status": "gs_show_status",
+        "branch": "gs_show_branch",
+        "rebase": "gs_show_rebase",
+        "tags": "gs_show_tags",
+        "graph": "gs_log_graph"
+    }
+
+    view_signatures = {
+        "status": "git_savvy.status_view",
+        "branch": "git_savvy.branch_view",
+        "rebase": "git_savvy.rebase_view",
+        "tags": "git_savvy.tags_view",
+        "graph": "git_savvy.log_graph_view"
+    }
+
+    def run(self, edit, source=None, target=None):
+        to_load = target or self.get_next(source)
+        view_signature = self.view_signatures[to_load]
+
+        self.view.window().run_command("hide_panel", {"cancel": True})
+
+        self.view.window().run_command(self.commands[to_load])
+        if not self.view.settings().get(view_signature):
+            self.view.close()
+
+    def get_next(self, source):
+        savvy_settings = sublime.load_settings("GitSavvy.sublime-settings")
+        tab_order = savvy_settings.get("tab_order")
+
+        source_idx = tab_order.index(source)
+        next_idx = 0 if source_idx == len(tab_order) - 1 else source_idx + 1
+
+        return tab_order[next_idx]

core/interfaces/branch.py

@@ -15,11 +15,8 @@ class GsShowBranchCommand(WindowCommand, GitCommand):
     Open a branch dashboard for the active Git repository.
     """
 
-    def run(self, commandeer_active_view=False):
-        active_view = sublime.active_window().active_view()
-        interface = BranchInterface(repo_path=self.repo_path)
-        if commandeer_active_view and active_view != interface.view:
-            active_view.close()
+    def run(self):
+        BranchInterface(repo_path=self.repo_path)
 
 
 class BranchInterface(ui.Interface, GitCommand):
@@ -58,7 +55,7 @@ class BranchInterface(ui.Interface, GitCommand):
       [H] diff history against active
       [e] toggle display of remote branches
 
-      [tab] transition to rebase dashboard
+      [tab] transition to next dashboard
       [r]   refresh
 
     -

core/interfaces/rebase.py

@@ -14,11 +14,8 @@ class GsShowRebaseCommand(WindowCommand, GitCommand):
     Open a status view for the active git repository.
     """
 
-    def run(self, commandeer_active_view=False):
-        active_view = sublime.active_window().active_view()
-        interface = RebaseInterface(repo_path=self.repo_path)
-        if commandeer_active_view and active_view != interface.view:
-            active_view.close()
+    def run(self):
+        RebaseInterface(repo_path=self.repo_path)
 
 
 class RebaseInterface(ui.Interface, GitCommand):
@@ -61,7 +58,7 @@ class RebaseInterface(ui.Interface, GitCommand):
       [u] move commit up (before previous)      [A] abort rebase
       [w] show commit
 
-      [tab] transition to tags dashboard
+      [tab] transition to next dashboard
 
       [{super_key}-Z] undo previous action
       [{super_key}-Y] redo action

core/interfaces/status.py

@@ -15,11 +15,8 @@ class GsShowStatusCommand(WindowCommand, GitCommand):
     Open a status view for the active git repository.
     """
 
-    def run(self, commandeer_active_view=False):
-        active_view = sublime.active_window().active_view()
-        interface = StatusInterface(repo_path=self.repo_path)
-        if commandeer_active_view and active_view != interface.view:
-            active_view.close()
+    def run(self):
+        StatusInterface(repo_path=self.repo_path)
 
 
 class StatusInterface(ui.Interface, GitCommand):
@@ -76,7 +73,7 @@ class StatusInterface(ui.Interface, GitCommand):
       ###########
 
       [r]   refresh status
-      [tab] transition to branch dashboard
+      [tab] transition to next dashboard
       [.]   move cursor to next file
       [,]   move cursor to previous file
 

core/interfaces/tags.py

@@ -29,11 +29,8 @@ class GsShowTagsCommand(WindowCommand, GitCommand):
     Open a branch dashboard for the active Git repository.
     """
 
-    def run(self, commandeer_active_view=False):
-        active_view = sublime.active_window().active_view()
-        interface = TagsInterface(repo_path=self.repo_path)
-        if commandeer_active_view and active_view != interface.view:
-            active_view.close()
+    def run(self):
+        TagsInterface(repo_path=self.repo_path)
 
 
 class TagsInterface(ui.Interface, GitCommand):
@@ -63,7 +60,7 @@ class TagsInterface(ui.Interface, GitCommand):
 
       [c] create                      [r]   refresh dashboard
       [d] delete                      [e]   toggle display of remote branches
-      [p] push to remote              [tab] transition to status dashboard
+      [p] push to remote              [tab] transition to next dashboard
       [P] push all tags to remote
       [l] view commit