Allow to edit the command before running it (#16)

Author: timfjord

Default.sublime-commands

@@ -22,21 +22,41 @@
         "command": "any_test_run",
         "args": { "scope": "line" }
     },
+    {
+        "caption": "AnyTest: Edit nearest",
+        "command": "any_test_run",
+        "args": { "scope": "line", "edit": true }
+    },
     {
         "caption": "AnyTest: Test file",
         "command": "any_test_run",
         "args": { "scope": "file" }
     },
+    {
+        "caption": "AnyTest: Edit file",
+        "command": "any_test_run",
+        "args": { "scope": "file", "edit": true }
+    },
     {
         "caption": "AnyTest: Test suite",
         "command": "any_test_run",
         "args": { "scope": "suite" }
     },
+    {
+        "caption": "AnyTest: Edit suite",
+        "command": "any_test_run",
+        "args": { "scope": "suite", "edit": true }
+    },
     {
         "caption": "AnyTest: Run last",
         "command": "any_test_run",
         "args": { "scope": "last" }
     },
+    {
+        "caption": "AnyTest: Edit last",
+        "command": "any_test_run",
+        "args": { "scope": "last", "edit": true }
+    },
     {
         "caption": "AnyTest: Show last output",
         "command": "any_test_show_last_output",

Default.sublime-keymap

@@ -16,9 +16,13 @@
         ]
     },
     // { "keys": ["primary+j", "primary+n"], "command": "any_test_run", "args": { "scope": "line" } },
+    // { "keys": ["primary+j", "primary+shift+n"], "command": "any_test_run", "args": { "scope": "line", "edit": true } },
     // { "keys": ["primary+j", "primary+f"], "command": "any_test_run", "args": { "scope": "file" } },
+    // { "keys": ["primary+j", "primary+shift+f"], "command": "any_test_run", "args": { "scope": "file", "edit": true } },
     // { "keys": ["primary+j", "primary+s"], "command": "any_test_run", "args": { "scope": "suite" } },
+    // { "keys": ["primary+j", "primary+shift+s"], "command": "any_test_run", "args": { "scope": "suite", "edit": true } },
     // { "keys": ["primary+j", "primary+l"], "command": "any_test_run", "args": { "scope": "last" } },
+    // { "keys": ["primary+j", "primary+shift+l"], "command": "any_test_run", "args": { "scope": "last", "edit": true } },
     // { "keys": ["primary+j", "primary+k"], "command": "any_test_show_last_output", "args": { "focus": true } },
     // { "keys": ["primary+j", "primary+e"], "command": "any_test_edit_last" },
 ]

README.md

@@ -31,6 +31,8 @@ There are 4 main commands that the package exposes:
 - `AnyTest: Test nearest`: runs the test nearest to the current line(cursor)
 - `AnyTest: Run last`: runs the last test
 
+Any of the commands above supports the `edit` flag that allows editing the command before running it.
+
 The package comes with polyfills for test frameworks that don't have  built-in support for running tests for the current line.  
 All the polyfills have been borrowed from the `vim-test` plugin and adapted for Sublime Text.
 
@@ -135,7 +137,6 @@ Using `unittesting` only makes sense with PyUnit test framework, so it is usuall
 - Add more test frameworks (the end goal is to at least support all test frameworks that `vim-test` supports)
 - Allow to explicitly select a test framework for the given file/project
 - Run tests from the Side Bar (including testing folders)
-- Allow to edit a test command before running it
 - Potentially integrate the package with [Sublime Debugger](https://github.com/daveleroy/sublime_debugger)
 
 ## Contribution

main.py

@@ -19,8 +19,8 @@
 
 
 class AnyTestRunCommand(sublime_plugin.TextCommand):
-    def run(self, _, scope='file'):
-        Plugin(self.view).run_test(scope)
+    def run(self, _, scope='file', edit=False):
+        Plugin(self.view).run_test(scope, edit)
 
 
 class AnyTestShowLastOutputCommand(sublime_plugin.ApplicationCommand):

plugin/__init__.py

@@ -4,7 +4,7 @@
 
 from . import runners, settings, test_frameworks
 from .context import Context
-from .errors import handle_errors
+from .errors import Error, handle_errors
 from .history import History
 from .view_callbacks import ViewCallbacks
 
@@ -31,6 +31,7 @@ def edit_last(cls):
 
     def __init__(self, view):
         self.view = view
+        self.runner = None
 
     def build_runner(self, scope):
         if scope == SCOPE_LAST:
@@ -43,13 +44,32 @@ def build_runner(self, scope):
         return runner.build(test_framework(context), scope)
 
     @handle_errors
-    def run_test(self, scope):
+    def run_test(self, scope, edit=False):
         settings.reload_project_settings()
 
-        runner = self.build_runner(scope)
+        self.runner = self.build_runner(scope)
+
+        if edit:
+            self.view.window().show_input_panel(
+                'Command',
+                self.runner.cmd,
+                self.process_runner,
+                lambda _: None,
+                lambda: None,
+            )
+        else:
+            self.process_runner()
+
+    @handle_errors
+    def process_runner(self, command=''):
+        if self.runner is None:
+            raise Error('Runner is not set')
+
+        if bool(command):
+            self.runner = self.runner._replace(cmd=command)
 
         ViewCallbacks(self.view).run()
 
-        logger.debug("Running '%s' from '%s'", runner.cmd, runner.dir)
-        runner.run()
-        history.add(runner)
+        logger.debug("Running '%s' from '%s'", self.runner.cmd, self.runner.dir)
+        self.runner.run()
+        history.add(self.runner)