command_mapper 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d3986821a50009055f2fe58c4f69e7eb530b5463114f73f838997743c8227fe
-  data.tar.gz: dc0ca8143917f12ef8cb72601f5a2ff44cccd6c76c0fdbc23fc75bafff571ff5
+  metadata.gz: 4db5d03aecac93251d259d3b776a33706bc328208a9fb58c4a96966d87128ed8
+  data.tar.gz: bc67f06449dc8b0b7c5061c55a315112dcf3fab2bf548314e4f20a6b2dbdd67f
 SHA512:
-  metadata.gz: dfaccdfb0892218f9e3b8661d2c80227d492c292407989d3bb2b2ffabe45806898549d463a9bb0aa54fe05092753b0751e797460a94c19849552675b75309ec2
-  data.tar.gz: 4bc76e0cd50aaaf790331ce2aab5acac98562c7ed63cd3979a90429cad836ee4e095ab765aa22b57c17eff9bc89fb92f9ed1b09f97d98fe4ab47cfa38dbcc99a
+  metadata.gz: 9e99f9216620e3847fc8e250d0c05d549f547396eef01a519d332cd3927cd86c71ed26e862fda84f26f28570e180f76eb1fb9117729a737bcf718de33f2d0886
+  data.tar.gz: a3766529ada1866b7736e905d3ba65511eea1b2e9679b9edad99e57089285159a307beb726ee7b1f2f2c02e6eb6d34d569d86babb3f79dc3be54527e834fbacd

data/ChangeLog.md

@@ -1,3 +1,12 @@
+### 0.1.1 / 2021-11-29
+
+* Fixed a bug where {CommandMapper::Types::Num}, {CommandMapper::Types::Hex},
+  {CommandMapper::Types::Enum}, {CommandMapper::Types::InputPath},
+  {CommandMapper::Types::InputFile}, and {CommandMapper::Types::InputDir} were
+  not being required by default.
+* Allow {CommandMapper::Types::Map} to accept values that have already been
+  mapped to a String.
+
 ### 0.1.0 / 2021-11-25
 
 * Initial release:

data/README.md

@@ -18,21 +18,26 @@ allow safely and securely executing commands.
 * Supports defining commands as Ruby classes.
 * Supports mapping in options and additional arguments.
   * Supports common option types:
-    * `Str`: string values
-    * `Num`: numeric values
-    * `Hex`: hexadecimal values
-    * `Map`: maps `true`/`false` to `yes`/`no`, or `enabled`/`disabled`
-      (aka `--opt=yes|no` or `--opt=enabled|disabled` values).
-    * `Enum`: maps a finite set of Symbols to a finite set of Strings
-      (aka `--opt={foo|bar|baz}` values).
-    * `List`: comma-separated list (aka `--opt VALUE,...`).
-    * `KeyValue`: maps a Hash or Array to key:value Strings
-      (aka `--opt KEY:VALUE` or `--opt KEY=VALUE` values).
-    * `KeyValueList`: a key-value list
+    * [Str][CommandMapper::Types::Str]: string values
+    * [Num][CommandMapper::Types::Num]: numeric values
+    * [Hex][CommandMapper::Types::Hex]: hexadecimal values
+    * [Map][CommandMapper::Types::Map]: maps `true`/`false` to `yes`/`no`, or
+      `enabled`/`disabled` (aka `--opt=yes|no` or
+      `--opt=enabled|disabled` values).
+    * [Enum][CommandMapper::Types::Enum]: maps a finite set of Symbols to a
+      finite set of Strings (aka `--opt={foo|bar|baz}` values).
+    * [List][CommandMapper::Types::List]: comma-separated list
+      (aka `--opt VALUE,...`).
+    * [KeyValue][CommandMapper::Types::KeyValue]: maps a Hash or Array to
+      key:value Strings (aka `--opt KEY:VALUE` or `--opt KEY=VALUE` values).
+    * [KeyValueList][CommandMapper::Types::KeyValueList]: a key-value list
       (aka `--opt KEY:VALUE,...` or  `--opt KEY=VALUE;...` values).
-    * `InputPath`: a path to a pre-existing file or directory
-    * `InputFile`: a path to a pre-existing file
-    * `InputDir`: a path to a pre-existing directory
+    * [InputPath][CommandMapper::Types::InputPath]: a path to a pre-existing
+      file or directory
+    * [InputFile][CommandMapper::Types::InputFile]: a path to a pre-existing
+      file
+    * [InputDir][CommandMapper::Types::InputDir]: a path to a pre-existing
+      directory
 * Supports mapping in sub-commands.
 * Allows running the command via `IO.popen` to read the command's output.
 * Allows running commands with additional environment variables.
@@ -40,6 +45,18 @@ allow safely and securely executing commands.
 * Allows running commands via `sudo`.
 * Prevents command injection and option injection.
 
+[CommandMapper::Types::Str]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Str
+[CommandMapper::Types::Num]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Num
+[CommandMapper::Types::Hex]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Hex
+[CommandMapper::Types::Map]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Map
+[CommandMapper::Types::Enum]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Enum
+[CommandMapper::Types::List]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/List
+[CommandMapper::Types::KeyValue]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/KeyValue
+[CommandMapper::Types::KeyValueList]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/KeyValueList
+[CommandMapper::Types::InputPath]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/InputPath
+[CommandMapper::Types::InputFile]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/InputFile
+[CommandMapper::Types::InputDir]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/InputDir
+
 ## Examples
 
 ```ruby

data/lib/command_mapper/arg.rb

@@ -18,6 +18,7 @@ module CommandMapper
     #   Specifies whether the argument is required or can be omitted.
     #
     # @param [Types::Type, Hash, nil] type
+    #   The type of the arg's value.
     #
     # @raise [ArgumentError]
     #   The `type` keyword argument was given a `nil` value.
@@ -54,6 +55,7 @@ module CommandMapper
     # Validates whether a given value is compatible with the arg.
     #
     # @param [Object] value
+    #   The given value to validate.
     #
     # @return [true, (false, String)]
     #   Returns true if the value is valid, or `false` and a validation error

data/lib/command_mapper/argument.rb

@@ -50,6 +50,7 @@ module CommandMapper
     # Validates whether a given value is compatible with the arg.
     #
     # @param [Array<Object>, Object] value
+    #   The given value to validate.
     #
     # @return [true, (false, String)]
     #   Returns true if the value is valid, or `false` and a validation error

data/lib/command_mapper/option.rb

@@ -113,6 +113,7 @@ module CommandMapper
     # Validates whether the given value is compatible with the option.
     #
     # @param [Array<Object>, Object] value
+    #   The given value to validate.
     #
     # @return [true, (false, String)]
     #   Returns true if the value is valid, or `false` and a validation error
@@ -175,6 +176,7 @@ module CommandMapper
     # Validates a value when the option can be repeated.
     #
     # @param [Array<Object>, Object] value
+    #   The given value to validate.
     #
     # @return [true, (false, String)]
     #   Returns true if the value is valid, or `false` and a validation error
@@ -208,6 +210,7 @@ module CommandMapper
     # Validates a value when the option does not accept a value.
     #
     # @param [Array<Object>, Object] value
+    #   The given value to validate.
     #
     # @return [true, (false, String)]
     #   Returns true if the value is valid, or `false` and a validation error

data/lib/command_mapper/option_value.rb

@@ -10,8 +10,10 @@ module CommandMapper
     # Formats a value using the options {#type}.
     #
     # @param [Object] value
+    #   The given value to format.
     #
     # @return [String]
+    #   The formatted value.
     #
     def format(value)
       @type.format(value)

data/lib/command_mapper/types/enum.rb

@@ -23,8 +23,10 @@ module CommandMapper
       # Creates a new enum.
       #
       # @param [Array<Object>] values
+      #   List of enum values.
       #
       # @return [Enum]
+      #   The newly created enum object.
       #
       def self.[](*values)
         new(values)

data/lib/command_mapper/types/hex.rb

@@ -33,8 +33,11 @@ module CommandMapper
       # Validates a value.
       #
       # @param [String, Integer, Object] value
+      #   The given value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         case value
@@ -53,8 +56,10 @@ module CommandMapper
       # Formats the value.
       #
       # @param [#to_i] value
+      #   The given numeric value.
       #
       # @return [String]
+      #   The formatted numeric value.
       #
       def format(value)
         case value

data/lib/command_mapper/types/input_dir.rb

@@ -11,8 +11,11 @@ module CommandMapper
       # Validates whether the directory exists.
       #
       # @param [Object] value
+      #   The given value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         valid, message = super(value)

data/lib/command_mapper/types/input_file.rb

@@ -11,8 +11,11 @@ module CommandMapper
       # Validates the file exists.
       #
       # @param [Object] value
+      #   The given value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         valid, message = super(value)

data/lib/command_mapper/types/input_path.rb

@@ -11,8 +11,11 @@ module CommandMapper
       # Validates whether the path exists or not.
       #
       # @param [Object] value
+      #   The given value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         unless value.empty?

data/lib/command_mapper/types/key_value.rb

@@ -57,8 +57,11 @@ module CommandMapper
       # Valides the given value.
       #
       # @param [Object] value
+      #   The given value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         case value
@@ -105,7 +108,7 @@ module CommandMapper
       # Formats a value into a key-value pair.
       #
       # @param [Hash, Array, #to_s] value
-      #   The given value.
+      #   The given value to format.
       #
       # @return [String]
       #   The formatted key-value pair.

data/lib/command_mapper/types/key_value_list.rb

@@ -31,7 +31,7 @@ module CommandMapper
       # Formats the value.
       #
       # @param [Hash, Array((key, value))] value
-      #   The list of key-value pairs.
+      #   The list of key-value pairs to format.
       #
       # @return [String]
       #   The formatted key-value list.

data/lib/command_mapper/types/list.rb

@@ -51,8 +51,11 @@ module CommandMapper
       # Validates the value.
       #
       # @param [Object] value
+      #   The given value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         values = Array(value)
@@ -78,8 +81,10 @@ module CommandMapper
       # Formats the value into a list.
       #
       # @param [Object] value
+      #   The given value to format.
       #
       # @return [String]
+      #   The formatted list.
       #
       def format(value)
         Array(value).map(&@type.method(:format)).join(@separator)

data/lib/command_mapper/types/map.rb

@@ -39,24 +39,40 @@ module CommandMapper
       # Validates a value.
       #
       # @param [Object] value
+      #   The given value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
-        unless @map.has_key?(value)
+        unless (@map.has_key?(value) || @map.has_value?(value))
           return [false, "unknown value (#{value.inspect})"]
         end
 
         return true
       end
 
+      #
+      # Maps a value.
       #
       # @param [Object] value
+      #   The given value.
       #
       # @return [String]
+      #   The mapped value.
+      #
+      # @raise [KeyError]
+      #   The given value is not a key or value in the map.
       #
       def format(value)
-        super(@map.fetch(value))
+        if @map.has_key?(value)
+          super(@map[value])
+        elsif @map.has_value?(value)
+          super(value)
+        else
+          raise(KeyError,"value (#{value.inspect}) is not a key or value in the map: #{@map.inspect}")
+        end
       end
 
     end

data/lib/command_mapper/types/num.rb

@@ -11,8 +11,11 @@ module CommandMapper
       # Validates a value.
       #
       # @param [String, Integer] value
+      #   The given value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         case value
@@ -35,8 +38,10 @@ module CommandMapper
       # Formats a numeric value.
       #
       # @param [String, Integer, #to_i] value
+      #   The given value to format.
       #
       # @return [String]
+      #   The formatted numeric value.
       #
       def format(value)
         case value

data/lib/command_mapper/types/type.rb

@@ -56,8 +56,11 @@ module CommandMapper
       # The default `validate` method for all types.
       #
       # @param [Object]
+      #   The given value to format.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         true
@@ -67,6 +70,7 @@ module CommandMapper
       # The default `format` method for all types.
       #
       # @param [#to_s] value
+      #   The given value to format.
       #
       # @return [String]
       #   The String version of the value.
@@ -83,10 +87,14 @@ module CommandMapper
     # Converts a value into a {Type} object.
     #
     # @param [Type, Hash, nil] value
+    #   The type value or `Hash` of keyword arguments.
     #
-    # @return [Type]
+    # @return [Type, Str]
+    #   The type object or a new {Str} type object if a `Hash` of keyword
+    #   arguments is given.
     #
     # @raise [ArgumentError]
+    #   The given type value was not a {Type}, `Hash`, or `nil`,
     #
     def self.Type(value)
       case value

data/lib/command_mapper/types.rb

@@ -1,6 +1,12 @@
 require 'command_mapper/types/type'
 require 'command_mapper/types/str'
+require 'command_mapper/types/num'
+require 'command_mapper/types/hex'
 require 'command_mapper/types/map'
+require 'command_mapper/types/enum'
 require 'command_mapper/types/list'
 require 'command_mapper/types/key_value'
 require 'command_mapper/types/key_value_list'
+require 'command_mapper/types/input_path'
+require 'command_mapper/types/input_file'
+require 'command_mapper/types/input_dir'

data/lib/command_mapper/version.rb

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

data/spec/commnad_spec.rb

@@ -11,6 +11,10 @@ describe CommandMapper::Command do
     end
   end
 
+  it "must include Types" do
+    expect(command_class).to include(CommandMapper::Types)
+  end
+
   describe ".command_name" do
     subject { command_class }
 

data/spec/types/map_spec.rb

@@ -22,13 +22,22 @@ describe CommandMapper::Types::Map do
   end
 
   describe "#validate" do
-    context "when given a value that's in the map" do
+    context "when given a value that's a key in the map" do
       let(:value) { 2 }
 
       it "must return true" do
         expect(subject.validate(value)).to be(true)
       end
     end
+
+    context "when given a value that's a value in the map" do
+      let(:value) { "two" }
+
+      it "must return true" do
+        expect(subject.validate(value)).to be(true)
+      end
+    end
+
     context "when given a value that is not in the map" do
       let(:value) { 42 }
 
@@ -41,7 +50,7 @@ describe CommandMapper::Types::Map do
   end
 
   describe "#format" do
-    context "when given a value that's in the map" do
+    context "when given a value that's a key in the map" do
       let(:value) { 2 }
 
       it "must return the corresponding mapped value" do
@@ -49,13 +58,21 @@ describe CommandMapper::Types::Map do
       end
     end
 
+    context "when given a value that's a value in the map" do
+      let(:value) { "two" }
+
+      it "must return the value" do
+        expect(subject.format(value)).to eq(value)
+      end
+    end
+
     context "when given a value that is not in the map" do
       let(:value) { 42 }
 
       it "must return the String version of the value" do
         expect {
           subject.format(value)
-        }.to raise_error(KeyError)
+        }.to raise_error(KeyError,"value (#{value.inspect}) is not a key or value in the map: #{map.inspect}")
       end
     end
   end

data/spec/types_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'command_mapper/types'
+
+describe CommandMapper::Types do
+  it "must define a Str type" do
+    expect(subject.const_defined?('Str')).to be(true)
+  end
+
+  it "must define a Num type" do
+    expect(subject.const_defined?('Num')).to be(true)
+  end
+
+  it "must define a Hex type" do
+    expect(subject.const_defined?('Hex')).to be(true)
+  end
+
+  it "must define a Map type" do
+    expect(subject.const_defined?('Map')).to be(true)
+  end
+
+  it "must define a Enum type" do
+    expect(subject.const_defined?('Enum')).to be(true)
+  end
+
+  it "must define a List type" do
+    expect(subject.const_defined?('List')).to be(true)
+  end
+
+  it "must define a KeyValue type" do
+    expect(subject.const_defined?('KeyValue')).to be(true)
+  end
+
+  it "must define a KeyValueList type" do
+    expect(subject.const_defined?('KeyValueList')).to be(true)
+  end
+
+  it "must define a InputPath type" do
+    expect(subject.const_defined?('InputPath')).to be(true)
+  end
+
+  it "must define a InputFile type" do
+    expect(subject.const_defined?('InputFile')).to be(true)
+  end
+
+  it "must define a InputDir type" do
+    expect(subject.const_defined?('InputDir')).to be(true)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-26 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,7 @@ files:
 - spec/types/num_spec.rb
 - spec/types/str_spec.rb
 - spec/types/type_spec.rb
+- spec/types_spec.rb
 homepage: https://github.com/postmodern/command_mapper.rb#readme
 licenses:
 - MIT