completely 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 133a4cb7fec5b868e4c98e594bc6ffc228c25eee4b85a58801f03fc78d9b1cbf
-  data.tar.gz: 5073efb37aba0c9601875d05a9b9acce469d71d182f91c8729f18052bdcfc915
+  metadata.gz: 7928212af575e203b41b2b6a1c94a0f6f564c28ae44795ade142b41ed83cbfe7
+  data.tar.gz: 541bd497455eedd5b0114edb7913ed1ccb1d2cfc90d78ca6d45298864f210583
 SHA512:
-  metadata.gz: 63029b5f2cfd9362a7daa0e0d940e5f296d42962c2d0e9b2bda2297fe0c95b5abd3e6c9029f6c3781932b7fa2d2e122b0672ca6708774c375bcb277db48e5cf3
-  data.tar.gz: 9ec01adf53afe6d2aaa14ca6a369754adb76ef0043a51663183807eee3d0266c74c18bfd2518ff2d5bf1a5ba04216e0ac9fe0af3a3435b3ee2816115570cc568
+  metadata.gz: cccadd0753d2ba83700f9bdebbd8e29eb3519206bb99992636fdde98cc313107b6475b8c12291dac3be8cbfc9ee235fa59c512dd55b62c2d8027ab871d8d424c
+  data.tar.gz: 36997d82e3438909788eb70484aabcaebe7a37534039ce748c1f3257aef05a674a8a9110280b3b324622eea1ff749263ea2a9968e31708be050676549536efcb

data/lib/completely/commands/base.rb

@@ -5,19 +5,26 @@ module Completely
     class Base < MisterBin::Command
       class << self
         def param_config_path
-          param 'CONFIG_PATH', "Path to the YAML configuration file [default: completely.yaml]\nCan also be set by an environment variable"
+          param 'CONFIG_PATH', <<~USAGE
+            Path to the YAML configuration file [default: completely.yaml].
+            Can also be set by an environment variable.
+          USAGE
         end
 
         def option_function
-          option '-f --function NAME', 'Modify the name of the function in the generated script'
+          option '-f --function NAME',
+            'Modify the name of the function in the generated script.'
         end
 
         def environment_config_path
-          environment 'COMPLETELY_CONFIG_PATH', 'Path to a completely configuration file [default: completely.yaml]'
+          environment 'COMPLETELY_CONFIG_PATH',
+            'Path to a completely configuration file [default: completely.yaml].'
         end
 
         def environment_debug
-          environment 'COMPLETELY_DEBUG', 'It not empty, the generated script will include an additional debugging snippet that outputs the compline and current word to a text file when a completion is requested'
+          environment 'COMPLETELY_DEBUG', 'If not empty, the generated script will include ' \
+            'an additional debugging snippet that outputs the compline and current word to ' \
+            'a text file when a completion is requested.'
         end
       end
 

data/lib/completely/commands/generate.rb

@@ -9,13 +9,18 @@ module Completely
       usage 'completely generate (-h|--help)'
 
       option_function
-      option '-w --wrap NAME', 'Wrap the completion script inside a function that echos the script. This is useful if you wish to embed it directly in your script'
+      option '-w --wrap NAME', 'Wrap the completion script inside a function that echos the ' \
+        'script. This is useful if you wish to embed it directly in your script.'
 
       param_config_path
-      param 'OUTPUT_PATH', "Path to the output bash script. When not provided, the name of the input file will be used with a .bash extension\nCan also be set by an environment variable"
+      param 'OUTPUT_PATH', <<~USAGE
+        Path to the output bash script.
+        When not provided, the name of the input file will be used with a .bash extension.
+        Can also be set by an environment variable.
+      USAGE
 
       environment_config_path
-      environment 'COMPLETELY_OUTPUT_PATH', 'Path to the output bash script'
+      environment 'COMPLETELY_OUTPUT_PATH', 'Path to the output bash script.'
       environment_debug
 
       def run

data/lib/completely/commands/test.rb

@@ -5,27 +5,30 @@ module Completely
     class Test < Base
       summary 'Test completions'
 
-      help 'This command can be used to test that your completions script responds with the right completions. It works by reading your completely.yaml file, generating a completions script, and generating a temporary testing script.'
+      help 'This command can be used to test that your completions script responds with ' \
+        'the right completions. It works by reading your completely.yaml file, generating ' \
+        'a completions script, and generating a temporary testing script.'
 
-      usage 'completely test [--keep] COMPLINE'
+      usage 'completely test [--keep] COMPLINE...'
       usage 'completely test (-h|--help)'
 
-      option '-k --keep', 'Keep the temporary testing script in the current directory'
+      option '-k --keep', 'Keep the temporary testing script in the current directory.'
 
-      param 'COMPLINE', 'The command to test completions for. This will be handled as if a TAB was pressed immediately at the end of it, so the last word is considered the active cursor. If you wish to complete for the next word instead, end your command with a space.'
+      param 'COMPLINE', 'One or more commands to test completions for. ' \
+        'This will be handled as if a TAB was pressed immediately at the end of it, ' \
+        'so the last word is considered the active cursor. ' \
+        'If you wish to complete for the next word instead, end your command with a space.'
 
       environment_config_path
       environment_debug
 
-      example 'completely test "mygit pu"'
-      example 'completely test "mygit pull "'
+      example 'completely test "mygit "'
+      example 'completely test --keep "mygit status "'
+      example 'completely test "mygit status --" "mygit init "'
 
       def run
-        puts tester.test(compline).join "\n"
-
-        if args['--keep']
-          File.write 'completely-tester.sh', tester_script
-          puts 'saved completely-tester.sh'
+        complines.each_with_index do |compline, i|
+          show_compline compline, filename: "completely-tester-#{i + 1}.sh"
         end
 
         syntax_warning unless completions.valid?
@@ -33,8 +36,24 @@ module Completely
 
     private
 
-      def compline
-        args['COMPLINE']
+      def show_compline(compline, filename: nil)
+        filename ||= 'completely-tester.sh'
+        say "!txtblu!$ !txtgrn!#{compline}!txtrst!<tab>"
+        puts tester.test(compline).join "\n"
+        puts
+
+        return unless keep
+
+        File.write filename, tester_script(compline)
+        say "Saved !txtpur!#{filename}"
+      end
+
+      def complines
+        @complines ||= args['COMPLINE']
+      end
+
+      def keep
+        @keep ||= args['--keep']
       end
 
       def completions
@@ -45,8 +64,8 @@ module Completely
         @tester ||= completions.tester
       end
 
-      def tester_script
-        @tester_script ||= tester.tester_script compline
+      def tester_script(compline)
+        tester.tester_script compline
       end
     end
   end

data/lib/completely/version.rb

@@ -1,3 +1,3 @@
 module Completely
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-28 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole