command_kit-completion 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f85e448a2df37a8bc6231b839b8e56992432498384e6ea4c2e1060a9485c874
-  data.tar.gz: 898168ab4ed70e3e595de27c933432a085976ea81980c7bcc3572e6e2cc4c38c
+  metadata.gz: 0c0c0378bac84ce2d4471fa0f3765f67b0c5fbf2324e4014fbbc6dc7b2d65eba
+  data.tar.gz: 5bc39444369f6b447b8a7ac7e184180de85867be5c11a69d9a0d5fcbb11124f8
 SHA512:
-  metadata.gz: 45ceb26079e0d5caf31e94ea0851fc30e5175661491bed0d6da4f57feb3bc37352ef48e9f7d817f5dced1825db2aa94e0500387a8175dde6b805921c62453ab6
-  data.tar.gz: 8858593122d06c2e4fff8d5f78fae75cd8f23665732131d36eb2fd9c52a51e94a8aa5fe3920b5b622a4f03a16360f442b79e6fd5a9b1c96cf78389c1871a6872
+  metadata.gz: cb50d3dfa8d1ea82cbc4e81587e2d96f197417d0e05c1e553ea246dba428387c93baf78c4ec8985a92d6c38177eddc3468e2285460680578e703941c2c8dc007
+  data.tar.gz: 0ed3ebd76e5463e2d05b74b424a3e83c87c69ca99babd98486d47ca0c813546a737ff258fa17c5badc744d21c9ec55b916b3bdf86f0f30c3d2f2aef232b6de81

data/ChangeLog.md

@@ -1,3 +1,7 @@
+### 0.2.1 / 2024-04-29
+
+* Support loading YAML input files that contain YAML aliases.
+
 ### 0.2.0 / 2024-04-26
 
 * Also generate completion rules for option's short flags.

data/lib/command_kit/completion/task.rb

@@ -110,6 +110,16 @@ module CommandKit
         Object.const_get(@class_name)
       end
 
+      #
+      # Loads the completion rules from the {#input_file}.
+      #
+      # @return [Hash]
+      #   The completion rules from the {#input_file}.
+      #
+      def load_input_file
+        YAML.load_file(@input_file, aliases: true)
+      end
+
       #
       # Maps the argument name strings to completely suggestion `<keyword>`s.
       #
@@ -211,7 +221,7 @@ module CommandKit
 
         if @input_file
           # load the additional rules from the input file
-          additional_completion_rules = YAML.load_file(@input_file)
+          additional_completion_rules = load_input_file
 
           # merge the additional completion rules
           additional_completion_rules.each do |command_string,completions|

data/lib/command_kit/completion/version.rb

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

data/spec/fixtures/additional_rules_with_aliases.yml

@@ -0,0 +1,4 @@
+---
+foo update: &update
+  - $(foo list)
+foo up: *update

data/spec/task_spec.rb

@@ -69,6 +69,42 @@ describe CommandKit::Completion::Task do
     end
   end
 
+  describe "#load_input_file" do
+    let(:input_file) { File.join(fixtures_dir,'additional_rules.yml') }
+
+    subject do
+      described_class.new(
+        class_file:  class_file,
+        class_name:  class_name,
+        input_file:  input_file,
+        output_file: output_file
+      )
+    end
+
+    it "must load the YAML from the input file" do
+      expect(subject.load_input_file).to eq(
+        {
+          'foo update' => ['$(foo list)']
+        }
+      )
+    end
+
+    context "when the input file contains YAML aliases" do
+      let(:input_file) do
+        File.join(fixtures_dir,'additional_rules_with_aliases.yml')
+      end
+
+      it "must support parsing YAML aliases" do
+        expect(subject.load_input_file).to eq(
+          {
+            'foo update' => ['$(foo list)'],
+            'foo up'=> ['$(foo list)']
+          }
+        )
+      end
+    end
+  end
+
   describe "#completion_rules_for" do
     context "when given a simple CommandKit::Command class" do
       class TestBasicCommand < CommandKit::Command

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_kit-completion
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-27 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: command_kit
@@ -84,6 +84,7 @@ files:
 - lib/command_kit/completion/task.rb
 - lib/command_kit/completion/version.rb
 - spec/fixtures/additional_rules.yml
+- spec/fixtures/additional_rules_with_aliases.yml
 - spec/spec_helper.rb
 - spec/task_spec.rb
 homepage: https://github.com/postmodern/command_kit-completion#readme