command_kit-completion 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d38eb48761e8c78265e4fe3de35b056a4b20a1c709ae92d1748b55bdaf26d78
-  data.tar.gz: 632bd4541f75fadeff3ecb7f754c865e387a2282c4329719e47fa628b049ebab
+  metadata.gz: 5f85e448a2df37a8bc6231b839b8e56992432498384e6ea4c2e1060a9485c874
+  data.tar.gz: 898168ab4ed70e3e595de27c933432a085976ea81980c7bcc3572e6e2cc4c38c
 SHA512:
-  metadata.gz: 671fd188f0ba01c1a32bf02d3d06ed5e9fd2e9e78f7e055d0cde9f687bb732a1913bef999f9e15e2d8d29837db8e996ea40dd7e65891bad03e92440999ba2839
-  data.tar.gz: a4dd29acbf852ad3a746bb8ea47595a6b613ac8e12f407a1966165d3a3f86aadb7893295c743448574f12c9e417a7fef084845ceacac8f3782484fe33d7c1da6
+  metadata.gz: 45ceb26079e0d5caf31e94ea0851fc30e5175661491bed0d6da4f57feb3bc37352ef48e9f7d817f5dced1825db2aa94e0500387a8175dde6b805921c62453ab6
+  data.tar.gz: 8858593122d06c2e4fff8d5f78fae75cd8f23665732131d36eb2fd9c52a51e94a8aa5fe3920b5b622a4f03a16360f442b79e6fd5a9b1c96cf78389c1871a6872

data/ChangeLog.md

@@ -1,3 +1,17 @@
+### 0.2.0 / 2024-04-26
+
+* Also generate completion rules for option's short flags.
+* Also generate `<file>`, `<directory>`, `<hostname>`, and `<user>` completion 
+  rules for options who's value is named `FILE`, `DIR`, `HOST`, `USER`
+  (or ends in `_FILE`, `_DIR`, `_HOST`, `_USER`), respectively.
+* Also generate `<file>`, `<directory>`, `<hostname>`, and `<user>` completion 
+  rules for the command's first argument if it's named `FILE`, `DIR`, `HOST`,
+  `USER` (or ends in `_FILE`, `_DIR`, `_HOST`, `_USER`), respectively.
+
+### 0.1.2 / 2023-12-18
+
+* Fix namespace conflict between `FileUtils` and `CommandKit::FileUtils`.
+
 ### 0.1.1 / 2023-12-18
 
 * Ensure that the parent directory of the output file exists before writing to

data/lib/command_kit/completion/task.rb

@@ -90,7 +90,7 @@ module CommandKit
                            completions.script
                          end
 
-          FileUtils.mkdir_p(File.dirname(@output_file))
+          ::FileUtils.mkdir_p(File.dirname(@output_file))
           File.write(@output_file,shell_script)
         end
 
@@ -110,13 +110,25 @@ module CommandKit
         Object.const_get(@class_name)
       end
 
-      # Mapping of command usage strings to completely `<keyword>`s.
-      USAGE_COMPLETIONS = {
-        'FILE' => '<file>',
-        'DIR'  => '<directory>',
-        'HOST' => '<hostname>',
-        'USER' => '<user>'
-      }
+      #
+      # Maps the argument name strings to completely suggestion `<keyword>`s.
+      #
+      # @param [String] arg
+      #   The argument name.
+      #
+      # @return [String, nil]
+      #   The suggestion keyword for the argument name.
+      #
+      # @since 0.2.0
+      #
+      def suggestion_for_argument(arg)
+        case arg
+        when /\AFILE\z|_FILE\z/ then '<file>'
+        when /\ADIR\z|_DIR\z/   then '<directory>'
+        when /\AHOST\z|_HOST\z/ then '<hostname>'
+        when /\AUSER\z|_USER\z/ then '<user>'
+        end
+      end
 
       #
       # Generates the completion rules for the given [command_kit] command
@@ -139,20 +151,26 @@ module CommandKit
           # add all long option flags
           command_class.options.each_value do |option|
             completions[command_name] << option.long
+            completions[command_name] << option.short if option.short
 
             if option.value
-              if (option_value_completion = USAGE_COMPLETIONS[option.value.usage])
+              if (suggestion = suggestion_for_argument(option.value.usage))
+                command_pattern = "#{command_name}*#{option.long}"
+
                 # add a special rule if the option's value USAGE maps to a
                 # 'completely' completion keyword (ex: `FILE` -> `<file>`).
-                completions["#{command_name}*#{option.long}"] = [
-                  option_value_completion
-                ]
+                completions[command_pattern] = [suggestion]
+
+                if option.short
+                  # also add another rule with the option's short flag
+                  completions["#{command_name}*#{option.short}"] = [suggestion]
+                end
               end
             end
           end
         end
 
-        # sub-commands
+        # sub-commands / first argument
         if command_class.include?(CommandKit::Commands)
           command_class.commands.each do |subcommand_name,subcommand|
             # add all sub-command names
@@ -165,6 +183,13 @@ module CommandKit
           end
 
           completions[command_name].concat(command_class.command_aliases.keys)
+        elsif command_class.include?(CommandKit::Arguments)
+          if (argument = command_class.arguments.values.first)
+            if (suggestion = suggestion_for_argument(argument.usage))
+              # add a suggestion for the first argument
+              completions[command_name] << suggestion
+            end
+          end
         end
 
         # filter out any command's that have no options/sub-commands

data/lib/command_kit/completion/version.rb

@@ -3,6 +3,6 @@
 module CommandKit
   module Completion
     # command_kit-completion version
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/spec/task_spec.rb

@@ -219,6 +219,140 @@ describe CommandKit::Completion::Task do
       end
     end
 
+    context "when the command class includes CommandKit::Arguments" do
+      context "and has at least one argument" do
+        context "and it's named FILE" do
+          class TestCommandWithFILEArgument < CommandKit::Command
+
+            command_name 'test'
+
+            option :foo, desc: 'Foo option'
+
+            argument :bar, usage: 'FILE', desc: 'Bar option'
+
+          end
+
+          let(:command_class) { TestCommandWithFILEArgument }
+
+          it "must add '<file>' to the command's completion rule" do
+            expect(subject.completion_rules_for(command_class)).to eq(
+              {
+                "test" => %w[--foo <file>]
+              }
+            )
+          end
+        end
+
+        context "and it's named DIR" do
+          class TestCommandWithDIRArgument < CommandKit::Command
+
+            command_name 'test'
+
+            option :foo, desc: 'Foo option'
+
+            argument :bar, usage: 'DIR', desc: 'Bar option'
+
+          end
+
+          let(:command_class) { TestCommandWithDIRArgument }
+
+          it "must add '<directory>' to the command's completion rule" do
+            expect(subject.completion_rules_for(command_class)).to eq(
+              {
+                "test" => %w[--foo <directory>]
+              }
+            )
+          end
+        end
+
+        context "and it's named HOST" do
+          class TestCommandWithHOSTArgument < CommandKit::Command
+
+            command_name 'test'
+
+            option :foo, desc: 'Foo option'
+
+            argument :bar, usage: 'HOST', desc: 'Bar option'
+
+          end
+
+          let(:command_class) { TestCommandWithHOSTArgument }
+
+          it "must add '<hostname>' to the command's completion rule" do
+            expect(subject.completion_rules_for(command_class)).to eq(
+              {
+                "test" => %w[--foo <hostname>]
+              }
+            )
+          end
+        end
+
+        context "and it's named USER" do
+          class TestCommandWithUSERArgument < CommandKit::Command
+
+            command_name 'test'
+
+            option :foo, desc: 'Foo option'
+
+            argument :bar, usage: 'USER', desc: 'Bar option'
+
+          end
+
+          let(:command_class) { TestCommandWithUSERArgument }
+
+          it "must add '<user>' to the command's completion rule" do
+            expect(subject.completion_rules_for(command_class)).to eq(
+              {
+                "test" => %w[--foo <user>]
+              }
+            )
+          end
+        end
+
+        context "but it's named something else" do
+          class TestCommandWithArgument < CommandKit::Command
+
+            command_name 'test'
+
+            option :foo, desc: 'Foo option'
+
+            argument :bar, usage: 'BAR', desc: 'Bar option'
+
+          end
+
+          let(:command_class) { TestCommandWithArgument }
+
+          it "must not add additional suggestions to the command's completion rule" do
+            expect(subject.completion_rules_for(command_class)).to eq(
+              {
+                "test" => %w[--foo]
+              }
+            )
+          end
+        end
+      end
+
+      context "but has no arguments" do
+        class TestCommandWithoutArguments < CommandKit::Command
+
+          command_name 'test'
+
+          option :foo, desc: 'Foo option'
+
+        end
+
+        let(:command_class) { TestCommandWithoutArguments }
+
+        it "must not add additional suggestions" do
+          expect(subject.completion_rules_for(command_class)).to eq(
+            {
+              "test" => %w[--foo]
+            }
+          )
+        end
+      end
+    end
+
     context "when the command class includes CommandKit::Commands" do
       class TestCommandWithSubCommands < CommandKit::Command
         include CommandKit::Commands
@@ -259,7 +393,7 @@ describe CommandKit::Completion::Task do
       it "must add completion rules for the other commands" do
         expect(subject.completion_rules_for(command_class)).to eq(
           {
-            "test"     => %w[--global-option help foo bar],
+            "test"     => %w[--global-option -g help foo bar],
             "test foo" => %w[--foo-opt1 --foo-opt2],
             "test bar" => %w[--bar-opt1 --bar-opt2]
           }
@@ -309,7 +443,7 @@ describe CommandKit::Completion::Task do
         it "must include the command aliases in the completion rules" do
           expect(subject.completion_rules_for(command_class)).to eq(
             {
-              "test"     => %w[--global-option help foo bar foo2 bar2],
+              "test"     => %w[--global-option -g help foo bar foo2 bar2],
               "test foo" => %w[--foo-opt1 --foo-opt2],
               "test bar" => %w[--bar-opt1 --bar-opt2]
             }
@@ -349,7 +483,7 @@ describe CommandKit::Completion::Task do
         it "must omit the command from the completion rules" do
           expect(subject.completion_rules_for(command_class)).to eq(
             {
-              "test"     => %w[--global-option help foo bar],
+              "test"     => %w[--global-option -g help foo bar],
               "test foo" => %w[--foo-opt1 --foo-opt2]
             }
           )
@@ -423,7 +557,7 @@ describe CommandKit::Completion::Task do
         it "must recursively include completion rules for the sub-sub-commands" do
           expect(subject.completion_rules_for(command_class)).to eq(
             {
-              "test"     => %w[--global-option help foo bar],
+              "test"     => %w[--global-option -g help foo bar],
               "test foo" => %w[--foo-opt1 --foo-opt2],
               "test bar" => %w[--bar-opt1 --bar-opt2 help baz qux],
               "test bar baz" => %w[--baz-opt1 --baz-opt2],
@@ -435,14 +569,65 @@ describe CommandKit::Completion::Task do
     end
   end
 
+  describe "#suggestion_for_argument" do
+    context "when given 'FILE'" do
+      it "must return '<file>'" do
+        expect(subject.suggestion_for_argument('FILE')).to eq('<file>')
+      end
+    end
+
+    context "when the string ends with '_FILE'" do
+      it "must return '<file>'" do
+        expect(subject.suggestion_for_argument('FOO_FILE')).to eq('<file>')
+      end
+    end
+
+    context "when given 'DIR'" do
+      it "must return '<directory>'" do
+        expect(subject.suggestion_for_argument('DIR')).to eq('<directory>')
+      end
+    end
+
+    context "when the string ends with '_DIR'" do
+      it "must return '<directory>'" do
+        expect(subject.suggestion_for_argument('FOO_DIR')).to eq('<directory>')
+      end
+    end
+
+    context "when given 'HOST'" do
+      it "must return '<hostname>'" do
+        expect(subject.suggestion_for_argument('HOST')).to eq('<hostname>')
+      end
+    end
+
+    context "when the string ends with '_HOST'" do
+      it "must return '<hostname>'" do
+        expect(subject.suggestion_for_argument('FOO_HOST')).to eq('<hostname>')
+      end
+    end
+
+    context "when given 'USER'" do
+      it "must return '<user>'" do
+        expect(subject.suggestion_for_argument('USER')).to eq('<user>')
+      end
+    end
+
+    context "when the string ends with '_USER'" do
+      it "must return '<user>'" do
+        expect(subject.suggestion_for_argument('FOO_USER')).to eq('<user>')
+      end
+    end
+  end
+
   describe "#completion_rules" do
     it "must load the class from #class_file and return the generated completion rules for it" do
       expect(subject.completion_rules).to eq(
         {
-          "foo" => %w[--config-file help config list update ls up],
+          "foo" => %w[--config-file -C help config list update ls up],
           "foo config" => %w[help get set],
-          "foo update" => %w[--quiet],
-          "foo*--config-file" => %w[<file>]
+          "foo update" => %w[--quiet -q],
+          "foo*--config-file" => %w[<file>],
+          "foo*-C" => %w[<file>]
         }
       )
     end
@@ -462,10 +647,11 @@ describe CommandKit::Completion::Task do
       it "must merge the additional completion rules with the generated ones" do
         expect(subject.completion_rules).to eq(
           {
-            "foo" => %w[--config-file help config list update ls up],
+            "foo" => %w[--config-file -C help config list update ls up],
             "foo config" => %w[help get set],
-            "foo update" => ['--quiet', '$(foo list)'],
-            "foo*--config-file" => %w[<file>]
+            "foo update" => ['--quiet', '-q', '$(foo list)'],
+            "foo*--config-file" => %w[<file>],
+            "foo*-C" => %w[<file>]
           }
         )
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_kit-completion
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-18 00:00:00.000000000 Z
+date: 2024-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: command_kit
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Generate shell completions for command_kit commands