Add command to generate specification

Author: guille

Default.sublime-commands

@@ -15,5 +15,9 @@
 	{
 		"caption": "RSpec: Create new module",
 		"command": "rspec_create_module"
+	},
+	{
+		"caption": "RSpec: Generate specification",
+		"command": "rspec_generate_specification",
 	}
 ]

README.md

@@ -29,3 +29,4 @@ RSpec does not define default key bindings to avoid conflicts with other package
 * Command to go to the corresponding spec / source file (available in the Command Palette, can be configured to a keyboard shortcut)
 * Large amount of *RSpec* snippets
 * Symbol support: use Goto Symbol... inside an RSpec file and you will get a menu with the specification as you've defined it
+   * You can also generate a structured document of a spec file with the "RSpec: Generate specification" command

generate_specification_command.py

@@ -0,0 +1,30 @@
+import sublime
+import sublime_plugin
+
+
+class RspecGenerateSpecificationCommand(sublime_plugin.WindowCommand):
+    def run(self):
+        view = self.window.active_view()
+        if view is None:
+            return
+
+        symbols = view.symbol_regions()
+        result = []
+        for symbol in symbols:
+            # Sublime automatically assigns NAMESPACE for "RSpec.describe" format
+            # https://github.com/sublimehq/sublime_text/issues/3315
+            if symbol.kind[0] in (sublime.KindId.KEYWORD, sublime.KindId.NAMESPACE):
+                result.append(symbol.name)
+
+        doc_file = self.window.new_file()
+        doc_file.set_name("RSpec specification")
+        doc_file.set_scratch(True)
+        doc_file.run_command("rspec_insert_content", {"text": "\n".join(result)})
+
+    def is_enabled(self):
+        view = self.window.active_view()
+        if view is None:
+            return False
+
+        syntax = view.syntax()
+        return syntax and syntax.scope == "source.ruby.rspec"

messages/3.0.0.txt

@@ -19,8 +19,10 @@ Report bugs or request features in the Github repo: https://github.com/SublimeTe
 
 
 
-# Other improvements
+# Other improvements and new features
 
 - Added improved syntax, courtesy of @themilkman
+	- Extended to include all RSpec matchers available in the latest version (3.13)
 - Scope commands so they don't appear when they are not relevant.
 - Fixed support for symbol lists. Now doing "Goto Symbol" inside an RSpec file will basically show the specification.
+- Added a command, "RSpec: Generate specification" that generates the specification in a new tab.

shared.py

@@ -1,7 +1,17 @@
+import sublime
+import sublime_plugin
+
+
 def other_group_in_pair(window):
     """Returns the neighbour focus group for the current window."""
     if window.active_group() % 2 == 0:
         target_group = window.active_group() + 1
     else:
         target_group = window.active_group() - 1
     return min(target_group, window.num_groups() - 1)
+
+
+# TODO: Call from RspecNewModuleCommand and RspecNewSpecCommand
+class RspecInsertContentCommand(sublime_plugin.TextCommand):
+    def run(self, edit: sublime.Edit, text: str = ""):
+        self.view.insert(edit, 0, text)