command_mapper 0.1.1 → 0.2.1

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
 
@@ -25,6 +27,8 @@ module CommandMapper
       #
       # @return [Boolean]
       #
+      # @api semipublic
+      #
       def leading_zero?
         @leading_zero
       end
@@ -39,6 +43,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 String
@@ -46,6 +52,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)
@@ -61,6 +73,8 @@ module CommandMapper
       # @return [String]
       #   The formatted numeric value.
       #
+      # @api semipublic
+      #
       def format(value)
         case value
         when String

data/lib/command_mapper/types/input_dir.rb

@@ -17,6 +17,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)
         valid, message = super(value)
 

data/lib/command_mapper/types/input_file.rb

@@ -17,6 +17,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)
         valid, message = super(value)
 

data/lib/command_mapper/types/input_path.rb

@@ -17,6 +17,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)
         unless value.empty?
           unless File.exists?(value)

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,9 +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
 
       #
@@ -45,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
@@ -65,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

@@ -7,6 +7,23 @@ module CommandMapper
     #
     class Num < Type
 
+      # The optional range of acceptable numbers.
+      #
+      # @return [Range, nil]
+      #
+      # @api semipublic
+      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.
       #
@@ -17,10 +34,12 @@ 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
-          return true
+          # no-op
         when String
           unless value =~ /\A\d+\z/
             return [false, "contains non-numeric characters (#{value.inspect})"]
@@ -31,6 +50,12 @@ module CommandMapper
           end
         end
 
+        if @range
+          unless @range.include?(value.to_i)
+            return [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
+          end
+        end
+
         return true
       end
 
@@ -43,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,6 +50,8 @@ module CommandMapper
     #
     #     argument :ports, required: true, type: PortRange.new
     #
+    # @api semipublic
+    #
     class Type
 
       #
@@ -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/version.rb

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