hashmake 0.1.2 → 0.1.3

data/ChangeLog.rdoc

@@ -11,4 +11,9 @@ Changed HashedArg to ArgSpec. Added documentation.
 === 0.1.2 / 2013-02-04
 
 Added documentation comment for Hashmake::HashMakeable module.
-Removed README.md so YARD could run without the redcarpet gem.
+Removed README.md so YARD could run without the redcarpet gem.
+
+=== 0.1.3 / 2013-02-06
+
+For the ArgSpec class, change :array key to :container, which can be set to any value included in ArgSpec::CONTAINERS.
+In hash_make, add support for Hash containers which contain objects of type :type. Suppor for Array container is still in place.

data/lib/hashmake/arg_spec.rb

@@ -6,21 +6,37 @@ module Hashmake
 # @author James Tunnell
 # 
 class ArgSpec
-  
+
+  # Used to specify that an arg key is mapped to to a regular value of type
+  # :type (rather than a container which contains values of type :type).
+  CONTAINER_NONE = :containerNone
+  # Used to specify that an arg key is mapped to an Array that contains values
+  # of type :type.
+  CONTAINER_ARRAY = :containerArray
+  # Used to specify that an arg key is mapped to a Hash that contains values
+  # of type :type.
+  CONTAINER_HASH = :containerHash
+  # The valid container types. CONTAINER_NONE indicates no container is expected,
+  # just a plain object of type given by :type.
+  CONTAINERS = [ CONTAINER_NONE, CONTAINER_ARRAY, CONTAINER_HASH ]
+    
   # Defines default key/value pairs to use in initializing an instance.
+  # The :reqd key is set to true by default.
+  # The :validator key is set to a Proc that always returns true.
+  # The :container key is set to CONTAINER_NONE.
   DEFAULT_ARGS = {
     :reqd => true,
     :validator => ->(a){true},
-    :array => false,
+    :container => CONTAINER_NONE,
   }
   
-  attr_reader :key, :type, :validator, :reqd, :default, :array
+  attr_reader :key, :type, :validator, :reqd, :default, :container
   
   # A new instance of ArgSpec. 
   # 
   # @param [Hash] hashed_args Hash to use in initializing an instance. Required
   #                           keys are :key and :type. Optional keys are :reqd,
-  #                           :validator, :array, and :default.
+  #                           :validator, :container, and :default.
   #                           :key => the key used to identify a hashed arg.
   #                           :type => the type of object expected to be paired
   #                                    with the key.
@@ -34,9 +50,10 @@ class ArgSpec
   #                                       expecting it to produce the default.
   #                           :validator => a Proc used to check the validity of
   #                                         whatever value is paired with an arg key.
-  #                           :array => indicates the arg key will be paired with
-  #                                     an array containing objects of the type
-  #                                     specified by :type.
+  #                           :container => indicates whether the arg key will be paired
+  #                                     with a container (array or hash) which contains
+  #                                     objects of the type specified by :type. Valid values
+  #                                     for this are given by ArgSpec::CONTAINERS.
   def initialize hashed_args
     new_args = DEFAULT_ARGS.merge(hashed_args)
     
@@ -46,7 +63,9 @@ class ArgSpec
     
     @validator = new_args[:validator]
     @reqd = new_args[:reqd]
-    @array = new_args[:array]
+    
+    @container = new_args[:container]
+    raise ArgumentError, "CONTAINERS does not include container #{@container}" unless CONTAINERS.include?(@container)
     
     unless @reqd
       msg = "if hashed arg is not required, a default value or value generator (proc) must be defined via :default key"

data/lib/hashmake/hash_makeable.rb

@@ -45,13 +45,21 @@ module HashMakeable
         end
       end
       
-      if arg_spec.array
+      case arg_spec.container
+      when ArgSpec::CONTAINER_ARRAY
         raise ArgumentError, "val #{val} is not an array" unless val.is_a?(Array)
         val.each do |item|
           raise ArgumentError, "array item #{item} is not a #{arg_spec.type}" unless item.is_a?(arg_spec.type)
         end
-      else
+      when ArgSpec::CONTAINER_HASH
+        raise ArgumentError, "val #{val} is not a hash" unless val.is_a?(Hash)
+        val.values.each do |item|
+          raise ArgumentError, "hash item #{item} is not a #{arg_spec.type}" unless item.is_a?(arg_spec.type)
+        end
+      when ArgSpec::CONTAINER_NONE
         raise ArgumentError, "val #{val} is not a #{arg_spec.type}" unless val.is_a?(arg_spec.type)
+      else
+        raise ArgumentError, "arg_spec.container #{arg_spec.container} is not valid"
       end
       
       if assign_args

data/lib/hashmake/version.rb

@@ -4,5 +4,5 @@
 #
 module Hashmake
   # hashmake version
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/arg_spec_spec.rb

@@ -16,4 +16,22 @@ describe Hashmake::ArgSpec do
     
     lambda { Hashmake::ArgSpec.new hash }.should_not raise_error(ArgumentError)
   end
+
+  it 'should raise ArgumentError if valid container is given' do
+    Hashmake::ArgSpec::CONTAINERS.each do |container|
+      hash = {
+        :reqd => true, :key => :stuff, :type => String, :container => container
+      }
+      
+      lambda { Hashmake::ArgSpec.new hash }.should_not raise_error(ArgumentError)      
+    end
+  end
+  
+  it 'should raise ArgumentError if invalid container is given' do
+    hash = {
+      :reqd => true, :key => :stuff, :type => String, :container => :myOwnContainer
+    }
+    
+    lambda { Hashmake::ArgSpec.new hash }.should raise_error(ArgumentError)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashmake
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -678443747
+      hash: -683104209
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -678443747
+      hash: -683104209
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23