completely 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 133a4cb7fec5b868e4c98e594bc6ffc228c25eee4b85a58801f03fc78d9b1cbf
-  data.tar.gz: 5073efb37aba0c9601875d05a9b9acce469d71d182f91c8729f18052bdcfc915
+  metadata.gz: a935ee0ae2ceb0c9c7b1f579c876a97068c45f133cfeaebcc2e6a6578216af22
+  data.tar.gz: 624cc5668dd558f54aa8d66e6b6af765131c2f0a2442fe3c024247a52687a2fa
 SHA512:
-  metadata.gz: 63029b5f2cfd9362a7daa0e0d940e5f296d42962c2d0e9b2bda2297fe0c95b5abd3e6c9029f6c3781932b7fa2d2e122b0672ca6708774c375bcb277db48e5cf3
-  data.tar.gz: 9ec01adf53afe6d2aaa14ca6a369754adb76ef0043a51663183807eee3d0266c74c18bfd2518ff2d5bf1a5ba04216e0ac9fe0af3a3435b3ee2816115570cc568
+  metadata.gz: 0a08c66582789427539a284b8b7e037643178cdfc602ea2621366fcd0de37bba34a6bd05a712ac5243e5538ddf19cc042549a9c6ecce1694cf8dabf5189f6e75
+  data.tar.gz: e654bff7e530d8cb5414a1bcefe52081542041c57387c2b71cf61d8d49f26b2b8b5df96c648b51fa83594c828f597f8f0f814e7f6760fac3cc8f5c8fb5b76aa0

data/bin/completely

@@ -10,6 +10,6 @@ begin
   exit runner.run ARGV
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
-  say! "!undred!#{e.class}!txtrst!\n#{e.message}"
+  say! "rib` #{e.class} `\n#{e.message}"
   exit 1
 end

data/lib/completely/cli.rb

@@ -10,7 +10,7 @@ module Completely
     def self.runner
       runner = MisterBin::Runner.new version: Completely::VERSION,
         header: 'Completely - Bash Completions Generator',
-        footer: 'Run !txtpur!completely COMMAND --help!txtrst! for more information'
+        footer: 'Run m`completely COMMAND --help` for more information'
 
       runner.route 'init',      to: Commands::Init
       runner.route 'preview',   to: Commands::Preview

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
 
@@ -44,8 +51,8 @@ module Completely
       end
 
       def syntax_warning
-        say! "\n!txtred!WARNING:\nYour configuration is invalid."
-        say! '!txtred!All patterns must start with the same word.'
+        say! "\nr`WARNING:`\nr`Your configuration is invalid.`"
+        say! 'r`All patterns must start with the same word.`'
       end
     end
   end

data/lib/completely/commands/generate.rb

@@ -9,20 +9,25 @@ 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
         wrap = args['--wrap']
         output = wrap ? wrapper_function(wrap) : script
         File.write output_path, output
-        say "Saved !txtpur!#{output_path}"
+        say "Saved m`#{output_path}`"
         syntax_warning unless completions.valid?
       end
 

data/lib/completely/commands/init.rb

@@ -15,7 +15,7 @@ module Completely
         raise "File already exists: #{config_path}" if File.exist? config_path
 
         File.write config_path, sample
-        say "Saved !txtpur!#{config_path}"
+        say "Saved m`#{config_path}`"
       end
 
     private

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 "b`$` g`#{compline}`<tab>"
+        puts tester.test(compline).join "\n"
+        puts
+
+        return unless keep
+
+        File.write filename, tester_script(compline)
+        say "Saved m`#{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.3'
 end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-28 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.7'
 description: Generate bash completion scripts using simple YAML configuration
 email: db@dannyben.com
 executables:
@@ -81,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
 summary: Bash Completions Generator