command_mapper 0.2.0 → 0.3.0

data/lib/command_mapper/types/key_value.rb

@@ -11,16 +11,22 @@ module CommandMapper
       # The separator String between the key and value.
       #
       # @return [String]
+      #
+      # @api semipublic
       attr_reader :separator
 
       # The key's type.
       #
       # @return [Type]
+      #
+      # @api semipublic
       attr_reader :key
 
       # The value's type.
       #
       # @return [Type]
+      #
+      # @api semipublic
       attr_reader :value
 
       #
@@ -63,6 +69,8 @@ module CommandMapper
       #   Returns true if the value is valid, or `false` and a validation error
       #   message if the value is not compatible.
       #
+      # @api semipublic
+      #
       def validate(value)
         case value
         when Hash
@@ -113,6 +121,8 @@ module CommandMapper
       # @return [String]
       #   The formatted key-value pair.
       #
+      # @api semipublic
+      #
       def format(value)
         case value
         when Hash, Array

data/lib/command_mapper/types/key_value_list.rb

@@ -36,6 +36,8 @@ module CommandMapper
       # @return [String]
       #   The formatted key-value list.
       #
+      # @api semipublic
+      #
       def format(value)
         super(Array(value).map(&@type.method(:format)))
       end

data/lib/command_mapper/types/list.rb

@@ -11,11 +11,15 @@ module CommandMapper
       # The seperator character.
       #
       # @return [String]
+      #
+      # @api semipublic
       attr_reader :separator
 
       # The list element type.
       #
       # @return [Type]
+      #
+      # @api semipublic
       attr_reader :type
 
       #
@@ -43,6 +47,8 @@ module CommandMapper
       #
       # @return [Boolean]
       #
+      # @api semipublic
+      #
       def allow_empty?
         @allow_empty
       end
@@ -57,6 +63,8 @@ module CommandMapper
       #   Returns true if the value is valid, or `false` and a validation error
       #   message if the value is not compatible.
       #
+      # @api semipublic
+      #
       def validate(value)
         values = Array(value)
 
@@ -86,6 +94,8 @@ module CommandMapper
       # @return [String]
       #   The formatted list.
       #
+      # @api semipublic
+      #
       def format(value)
         Array(value).map(&@type.method(:format)).join(@separator)
       end

data/lib/command_mapper/types/map.rb

@@ -2,11 +2,16 @@ require 'command_mapper/types/type'
 
 module CommandMapper
   module Types
+    #
+    # Represents a mapping of Ruby values to other String values.
+    #
     class Map < Type
 
       # The map of values to Strings.
       #
       # @return [Hash{Object => String}]
+      #
+      # @api semipublic
       attr_reader :map
 
       #
@@ -47,9 +52,11 @@ module CommandMapper
       #   Returns true if the value is valid, or `false` and a validation error
       #   message if the value is not compatible.
       #
+      # @api semipublic
+      #
       def validate(value)
         unless (@map.has_key?(value) || @map.has_value?(value))
-          return [false, "unknown value (#{value.inspect})"]
+          return [false, "unknown value (#{value.inspect}) must be #{@map.keys.map(&:inspect).join(', ')}, or #{@map.values.map(&:inspect).join(', ')}"]
         end
 
         return true
@@ -67,6 +74,8 @@ module CommandMapper
       # @raise [KeyError]
       #   The given value is not a key or value in the map.
       #
+      # @api semipublic
+      #
       def format(value)
         if @map.has_key?(value)
           super(@map[value])

data/lib/command_mapper/types/num.rb

@@ -10,6 +10,8 @@ module CommandMapper
       # The optional range of acceptable numbers.
       #
       # @return [Range, nil]
+      #
+      # @api semipublic
       attr_reader :range
 
       #
@@ -32,6 +34,8 @@ module CommandMapper
       #   Returns true if the value is valid, or `false` and a validation error
       #   message if the value is not compatible.
       #
+      # @api semipublic
+      #
       def validate(value)
         case value
         when Integer
@@ -48,7 +52,7 @@ module CommandMapper
 
         if @range
           unless @range.include?(value.to_i)
-            return [false, "unacceptable value (#{value.inspect})"]
+            return [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
           end
         end
 
@@ -64,6 +68,8 @@ module CommandMapper
       # @return [String]
       #   The formatted numeric value.
       #
+      # @api semipublic
+      #
       def format(value)
         case value
         when Integer, String then value.to_s

data/lib/command_mapper/types/str.rb

@@ -2,6 +2,9 @@ require 'command_mapper/types/type'
 
 module CommandMapper
   module Types
+    #
+    # Represents an arbitrary string value.
+    #
     class Str < Type
       #
       # Initializes the value.
@@ -22,6 +25,8 @@ module CommandMapper
       #
       # @return [Boolean]
       #
+      # @api semipublic
+      #
       def allow_empty?
         @allow_empty
       end
@@ -31,6 +36,8 @@ module CommandMapper
       #
       # @return [Boolean]
       #
+      # @api semipublic
+      #
       def allow_blank?
         @allow_blank
       end
@@ -42,7 +49,7 @@ module CommandMapper
       #   The given value to validate.
       #
       # @return [true, (false, String)]
-      #   Returns true if the valid is considered valid, or false and a
+      #   Returns true if the value is considered valid, or false and a
       #   validation message if the value is not valid.
       #   * If `nil` is given and a value is required, then `false` will be
       #     returned.
@@ -51,6 +58,8 @@ module CommandMapper
       #   * If an empty value is given and blank values are not allowed, then
       #     `false` will be returned.
       #
+      # @api semipublic
+      #
       def validate(value)
         case value
         when nil

data/lib/command_mapper/types/type.rb

@@ -50,13 +50,15 @@ module CommandMapper
     #
     #     argument :ports, required: true, type: PortRange.new
     #
+    # @api semipublic
+    #
     class Type
 
       #
       # The default `validate` method for all types.
       #
       # @param [Object]
-      #   The given value to format.
+      #   The given value to validate.
       #
       # @return [true, (false, String)]
       #   Returns true if the value is valid, or `false` and a validation error
@@ -96,6 +98,8 @@ module CommandMapper
     # @raise [ArgumentError]
     #   The given type value was not a {Type}, `Hash`, or `nil`,
     #
+    # @api semipublic
+    #
     def self.Type(value)
       case value
       when Type      then value

data/lib/command_mapper/types.rb

@@ -1,6 +1,7 @@
 require 'command_mapper/types/type'
 require 'command_mapper/types/str'
 require 'command_mapper/types/num'
+require 'command_mapper/types/dec'
 require 'command_mapper/types/hex'
 require 'command_mapper/types/map'
 require 'command_mapper/types/enum'

data/lib/command_mapper/version.rb

@@ -1,4 +1,4 @@
 module CommandMapper
   # Version of command_mapper
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/commnad_spec.rb

@@ -808,7 +808,7 @@ describe CommandMapper::Command do
       end
 
       it "must initialize a new command with the Hash of params and call #run_command" do
-        if RUBY_VERSION < '3.' || RUBY_ENGINE == 'truffleruby'
+        if RUBY_VERSION < '3.'
           expect(subject).to receive(:new).with({},params).and_return(command_instance)
         else
           expect(subject).to receive(:new).with(params).and_return(command_instance)
@@ -846,7 +846,7 @@ describe CommandMapper::Command do
       end
 
       it "must initialize a new command with the Hash of params and call #spawn_command" do
-        if RUBY_VERSION < '3.' || RUBY_ENGINE == 'truffleruby'
+        if RUBY_VERSION < '3.'
           expect(subject).to receive(:new).with({},params).and_return(command_instance)
         else
           expect(subject).to receive(:new).with(params).and_return(command_instance)
@@ -884,7 +884,7 @@ describe CommandMapper::Command do
       end
 
       it "must initialize a new command with the Hash of params and call #capture_command" do
-        if RUBY_VERSION < '3.' || RUBY_ENGINE == 'truffleruby'
+        if RUBY_VERSION < '3.'
           expect(subject).to receive(:new).with({},params).and_return(command_instance)
         else
           expect(subject).to receive(:new).with(params).and_return(command_instance)
@@ -922,7 +922,7 @@ describe CommandMapper::Command do
       end
 
       it "must initialize a new command with the Hash of params and call #popen_command" do
-        if RUBY_VERSION < '3.' || RUBY_ENGINE == 'truffleruby'
+        if RUBY_VERSION < '3.'
           expect(subject).to receive(:new).with({},params).and_return(command_instance)
         else
           expect(subject).to receive(:new).with(params).and_return(command_instance)
@@ -960,7 +960,7 @@ describe CommandMapper::Command do
       end
 
       it "must initialize a new command with the Hash of params and call #sudo_command" do
-        if RUBY_VERSION < '3.' || RUBY_ENGINE == 'truffleruby'
+        if RUBY_VERSION < '3.'
           expect(subject).to receive(:new).with({},params).and_return(command_instance)
         else
           expect(subject).to receive(:new).with(params).and_return(command_instance)
@@ -1163,6 +1163,26 @@ describe CommandMapper::Command do
           }.to raise_error(ArgumentRequired,"argument arg2 is required")
         end
       end
+
+      context "but the command has un-required arguments that repeat" do
+        module TestCommand
+          class CommandWithUnRequiredRepeatingArguments < CommandMapper::Command
+            command "test" do
+              argument :arg1, required: false
+              argument :arg2, required: false, repeats: true
+              argument :arg3, required: false
+            end
+          end
+        end
+
+        let(:command_class) { TestCommand::CommandWithUnRequiredRepeatingArguments }
+
+        subject { command_class.new(arg1: nil, arg2: nil, arg3: nil) }
+
+        it "must omit the un-required repeating arguments that are not set" do
+          expect(subject.command_argv).to eq([subject.class.command_name])
+        end
+      end
     end
 
     context "when the command is initialized with the command_path: keyword" do

data/spec/option_value_spec.rb

@@ -1,8 +1,36 @@
 require 'spec_helper'
 require 'command_mapper/option_value'
+require 'command_mapper/types/num'
 require 'command_mapper/types/list'
 
 describe CommandMapper::OptionValue do
+  describe "#validate" do
+    let(:type) { Types::Num.new }
+
+    subject { described_class.new(type: type) }
+
+    context "when the option value is not required" do
+      subject do
+        described_class.new(type: type, required: false)
+      end
+
+      context "and given a value of true" do
+        it "must return true" do
+          expect(subject.validate(true)).to be(true)
+        end
+      end
+    end
+
+    context "otherwise" do
+      it "must validate the value using #type.validate" do
+        expect(subject.validate('1234')).to be(true)
+        expect(subject.validate('foo')).to eq(
+          [false, "contains non-numeric characters (\"foo\")"]
+        )
+      end
+    end
+  end
+
   describe "#format" do
     let(:type) { Types::List.new }
 

data/spec/types/dec_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+require 'command_mapper/types/dec'
+
+describe CommandMapper::Types::Dec do
+  describe "#initialize" do
+    context "when initialized with no keyword arguments" do
+      it "must set #range to nil" do
+        expect(subject.range).to be(nil)
+      end
+    end
+
+    context "when initialized with range: ..." do
+      let(:range) { 1.0..1.5 }
+
+      subject { described_class.new(range: range) }
+
+      it "must set #range" do
+        expect(subject.range).to eq(range)
+      end
+    end
+  end
+
+  describe "#validate" do
+    context "when given an Integer" do
+      let(:value) { 1 }
+
+      it "must return true" do
+        expect(subject.validate(value)).to be(true)
+      end
+
+      context "when initialized with range: ..." do
+        let(:range) { 2.0..10.0 }
+
+        subject { described_class.new(range: range) }
+
+        context "and the value is within the range of values" do
+          let(:value) { 4.0 }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+
+        context "but the value is not within the range of values" do
+          let(:value) { 0.0 }
+
+          it "must return [false, \"(...) not within the range of acceptable values (...)\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
+            )
+          end
+        end
+      end
+    end
+
+    context "when given a String" do
+      context "and it contains only digits" do
+        let(:value) { "0123456789" }
+
+        it "must return true" do
+          expect(subject.validate(value)).to be(true)
+        end
+
+        context "when initialized with range: ..." do
+          let(:range) { 2.0..10.0 }
+
+          subject { described_class.new(range: range) }
+
+          context "and the value is within the range of values" do
+            let(:value) { '4.0' }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but the value is not within the range of values" do
+            let(:value) { '0.0' }
+
+            it "must return [false, \"(...) not within the range of acceptable values (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
+              )
+            end
+          end
+        end
+
+        context "but the String contains a newline" do
+          let(:value) { "01234.\n56789" }
+
+          it "must return [false, \"contains non-decimal characters (...)\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "contains non-decimal characters (#{value.inspect})"]
+            )
+          end
+        end
+      end
+
+      context "but it contains non-digits" do
+        let(:value) { "12.abc34" }
+
+        it "must return [false, \"contains non-decimal characters (...)\"]" do
+          expect(subject.validate(value)).to eq(
+            [false, "contains non-decimal characters (#{value.inspect})"]
+          )
+        end
+      end
+    end
+
+    context "when given another type of Object" do
+      context "and it defines a #to_f method" do
+        let(:value) { 1 }
+
+        it "must return true" do
+          expect(subject.validate(value)).to be(true)
+        end
+      end
+
+      context "when initialized with range: ..." do
+        let(:range) { 2.0..10.0 }
+
+        subject { described_class.new(range: range) }
+
+        context "and the value is within the range of values" do
+          let(:value) { 4 }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+
+        context "but the value is not within the range of values" do
+          let(:value) { 0 }
+
+          it "must return [false, \"(...) not within the range of acceptable values (...)\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
+            )
+          end
+        end
+      end
+
+      context "but it does not define a #to_f method" do
+        let(:value) { Object.new }
+
+        it "must return [false, \"value cannot be converted into a Float\"]" do
+          expect(subject.validate(value)).to eq(
+            [false, "cannot be converted into a Float (#{value.inspect})"]
+          )
+        end
+      end
+    end
+  end
+
+  describe "#format" do
+    context "when given a String" do
+      let(:value) { "12345.67890" }
+
+      it "must return the same String" do
+        expect(subject.format(value)).to eq(value)
+      end
+    end
+
+    context "when given an Intger" do
+      let(:value) { 12345.67890 }
+
+      it "must convert the Integer into a String" do
+        expect(subject.format(value)).to eq(value.to_s)
+      end
+    end
+
+    context "when given another type of Object" do
+      let(:value) { 1 }
+
+      it "must call #to_i then #to_s" do
+        expect(subject.format(value)).to eq(value.to_f.to_s)
+      end
+    end
+  end
+end

data/spec/types/input_dir_spec.rb

@@ -3,19 +3,21 @@ require 'command_mapper/types/input_dir'
 
 describe CommandMapper::Types::InputDir do
   describe "#validate" do
-    context "when given a valid file path" do
-      let(:value) { __FILE__ }
+    context "when given a valid directory path" do
+      let(:value) { __dir__ }
 
-      it "must return [false, 'directory does not exist (...)']" do
-        expect(subject.validate(value)).to eq([false, "directory does not exist (#{value.inspect})"])
+      it "must return true" do
+        expect(subject.validate(value)).to be(true)
       end
     end
 
-    context "when given a valid directory path" do
-      let(:value) { __dir__ }
+    context "when given a valid file path" do
+      let(:value) { __FILE__ }
 
-      it "must return true" do
-        expect(subject.validate(value)).to eq(true)
+      it "must return [false, 'directory does not exist (...)']" do
+        expect(subject.validate(value)).to eq(
+          [false, "directory does not exist (#{value.inspect})"]
+        )
       end
     end
 
@@ -23,7 +25,9 @@ describe CommandMapper::Types::InputDir do
       let(:value) { "/path/does/not/exist" }
 
       it "must return [false, 'path does not exist (...)']" do
-        expect(subject.validate(value)).to eq([false, "path does not exist (#{value.inspect})"])
+        expect(subject.validate(value)).to eq(
+          [false, "path does not exist (#{value.inspect})"]
+        )
       end
     end
   end

data/spec/types/map_spec.rb

@@ -41,9 +41,9 @@ describe CommandMapper::Types::Map do
     context "when given a value that is not in the map" do
       let(:value) { 42 }
 
-      it "must return [false, \"unknown value (...)\"]" do
+      it "must return [false, \"unknown value (...) must be ..., or ...\"]" do
         expect(subject.validate(value)).to eq(
-          [false, "unknown value (#{value.inspect})"]
+          [false, "unknown value (#{value.inspect}) must be #{subject.map.keys.map(&:inspect).join(', ')}, or #{subject.map.values.map(&:inspect).join(', ')}"]
         )
       end
     end

data/spec/types/num_spec.rb

@@ -44,9 +44,9 @@ describe CommandMapper::Types::Num do
         context "but the value is not within the range of values" do
           let(:value) { 0 }
 
-          it "must return [false, \"unacceptable value (...)\"]" do
+          it "must return [false, \"(...) not within the range of acceptable values (...)\"]" do
             expect(subject.validate(value)).to eq(
-              [false, "unacceptable value (#{value.inspect})"]
+              [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
             )
           end
         end
@@ -77,9 +77,9 @@ describe CommandMapper::Types::Num do
           context "but the value is not within the range of values" do
             let(:value) { '0' }
 
-            it "must return [false, \"unacceptable value (...)\"]" do
+            it "must return [false, \"(...) not within the range of acceptable values (...)\"]" do
               expect(subject.validate(value)).to eq(
-                [false, "unacceptable value (#{value.inspect})"]
+                [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
               )
             end
           end
@@ -132,9 +132,9 @@ describe CommandMapper::Types::Num do
         context "but the value is not within the range of values" do
           let(:value) { 0.0 }
 
-          it "must return [false, \"unacceptable value (...)\"]" do
+          it "must return [false, \"(...) not within the range of acceptable values (...)\"]" do
             expect(subject.validate(value)).to eq(
-              [false, "unacceptable value (#{value.inspect})"]
+              [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
             )
           end
         end