command_mapper 0.1.0 → 0.2.0

data/lib/command_mapper/option.rb

@@ -7,12 +7,18 @@ module CommandMapper
   #
   class Option
 
+    # The option's flag (ex: `-o` or `--output`).
+    #
     # @return [String]
     attr_reader :flag
 
+    # The option's name.
+    #
     # @return [Symbol]
     attr_reader :name
 
+    # Describes the option's value.
+    #
     # @return [OptionValue, nil]
     attr_reader :value
 
@@ -25,10 +31,6 @@ module CommandMapper
     # @param [Symbol, nil] name
     #   The option's name.
     #
-    # @param [Boolean] equals
-    #   Specifies whether the option's flag and value should be separated with a
-    #   `=` character.
-    #
     # @param [Hash, nil] value
     #   The option's value.
     #
@@ -41,15 +43,29 @@ module CommandMapper
     # @param [Boolean] repeats
     #   Specifies whether the option can be given multiple times.
     #
-    def initialize(flag, name: nil, equals: nil, value: nil, repeats: false)
+    # @param [Boolean] equals
+    #   Specifies whether the option's flag and value should be separated with a
+    #   `=` character.
+    #
+    # @param [Boolean] value_in_flag
+    #   Specifies that the value should be appended to the option's flag
+    #   (ex: `-Fvalue`).
+    #
+    def initialize(flag, name: nil, value: nil, repeats: false,
+                         # formatting options
+                         equals:        nil,
+                         value_in_flag: nil)
       @flag    = flag
       @name    = name || self.class.infer_name_from_flag(flag)
-      @equals  = equals
       @value   = case value
                  when Hash then OptionValue.new(**value)
                  when true then OptionValue.new
                  end
       @repeats = repeats
+
+      # formatting options
+      @equals        = equals
+      @value_in_flag = value_in_flag
     end
 
     #
@@ -90,6 +106,15 @@ module CommandMapper
       !@value.nil?
     end
 
+    #
+    # Determines whether the option can be given multiple times.
+    #
+    # @return [Boolean]
+    #
+    def repeats?
+      @repeats
+    end
+
     #
     # Indicates whether the option flag and value should be separated with a
     # `=` character.
@@ -101,18 +126,21 @@ module CommandMapper
     end
 
     #
-    # Determines whether the option can be given multiple times.
+    # Indicates whether the value will be appended to the option's flag.
     #
     # @return [Boolean]
     #
-    def repeats?
-      @repeats
+    # @since 0.2.0
+    #
+    def value_in_flag?
+      @value_in_flag
     end
 
     #
     # 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 +203,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 +237,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
@@ -266,13 +296,15 @@ module CommandMapper
       else
         string = @value.format(value)
 
-        if string.start_with?('-')
-          raise(ValidationError,"option #{@name} formatted value (#{string.inspect}) cannot start with a '-'")
-        end
-
         if equals?
           argv << "#{@flag}=#{string}"
+        elsif value_in_flag?
+          argv << "#{@flag}#{string}"
         else
+          if string.start_with?('-')
+            raise(ValidationError,"option #{@name} formatted value (#{string.inspect}) cannot start with a '-'")
+          end
+
           argv << @flag << string
         end
       end

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

@@ -14,9 +14,11 @@ module CommandMapper
       #   Specifies whether the hex value will start with `0x` or not.
       #
       # @param [Hash{Symbol => Object}] kwargs
-      #   Additional keyword arguments for {Type#initialize}.
+      #   Additional keyword arguments for {Num#initialize}.
       #
-      def initialize(leading_zero: false)
+      def initialize(leading_zero: false, **kwargs)
+        super(**kwargs)
+
         @leading_zero = leading_zero
       end
 
@@ -33,8 +35,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
@@ -43,6 +48,12 @@ module CommandMapper
             return [false, "not in hex format (#{value.inspect})"]
           end
 
+          if @range
+            unless @range.include?(value.to_i(16))
+              return [false, "unacceptable value (#{value.inspect})"]
+            end
+          end
+
           return true
         else
           super(value)
@@ -53,8 +64,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

@@ -4,6 +4,8 @@ module CommandMapper
   module Types
     class Map < Type
 
+      # The map of values to Strings.
+      #
       # @return [Hash{Object => String}]
       attr_reader :map
 
@@ -39,24 +41,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

@@ -7,17 +7,35 @@ module CommandMapper
     #
     class Num < Type
 
+      # The optional range of acceptable numbers.
+      #
+      # @return [Range, nil]
+      attr_reader :range
+
+      #
+      # Initializes the numeric value.
+      #
+      # @param [Range] range
+      #   Specifies the range of acceptable numbers.
+      #
+      def initialize(range: nil)
+        @range = range
+      end
+
       #
       # 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
         when Integer
-          return true
+          # no-op
         when String
           unless value =~ /\A\d+\z/
             return [false, "contains non-numeric characters (#{value.inspect})"]
@@ -28,6 +46,12 @@ module CommandMapper
           end
         end
 
+        if @range
+          unless @range.include?(value.to_i)
+            return [false, "unacceptable value (#{value.inspect})"]
+          end
+        end
+
         return true
       end
 
@@ -35,8 +59,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.2.0'
 end