hashmake 0.1.3 → 0.1.4

data/ChangeLog.rdoc

@@ -16,4 +16,8 @@ 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.
+In hash_make, add support for Hash containers which contain objects of type :type. Suppor for Array container is still in place.
+
+=== 0.1.4 / 2013-02-06
+
+Add tests to verify array and hash container support.

data/README.rdoc

@@ -8,15 +8,33 @@
 
 Make hash-based object initialization easy!
 
-Provides hash_make method that can consider parameter name, type, default value, validation, and requiredd/not, according to the specification provided.
-
-Also, by default assigns to instance variable of same name as parameter.
+Provides hash_make method that can consider parameter name, type, default value, validation, requiredd/not, and container type (none/array/hash) according to the specification provided. By default it the value given with the arg key to to an instance variable of same name as parameter.
 
 == Features
 
 == Examples
 
   require 'hashmake'
+  
+  class MyClass
+    include Hashmake::HashMakeable
+    
+    ARG_SPECS = [
+      ArgSpec.new(:key => :x, :reqd => true, :type => Float, :validator => ->(a){ a.between?(0.0,1.0) }),
+      ArgSpec.new(:key => :y, :reqd => false, :type => Float, :validator => ->(a){ a.between?(0.0,1.0) }, :default => 0.0),
+    ]
+    
+    attr_reader :x, :y
+    
+    def initialize hashed_args
+      hash_make(ARG_SPECS, hashed_args)
+    end
+  end
+  
+  a = MyClass.new :x => 0.5 # a.x => 0.5, a.y => 0.0
+  a = MyClass.new :x => 0.5, :y => 0.2 # a.x => 0.5, a.y => 0.2
+  a = MyClass.new # raise ArgumentError because :x is reqd and not given
+  a = MyClass.new :y => 0.5 # raise ArgumentError because :x is reqd and not given
 
 == Requirements
 

data/lib/hashmake/hash_makeable.rb

@@ -50,20 +50,22 @@ module HashMakeable
         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)
+          raise ArgumentError, "array item #{item} is not valid" unless arg_spec.validator.call(item)      
         end
       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)
+          raise ArgumentError, "hash item #{item} is not valid" unless arg_spec.validator.call(item)      
         end
       when ArgSpec::CONTAINER_NONE
         raise ArgumentError, "val #{val} is not a #{arg_spec.type}" unless val.is_a?(arg_spec.type)
+        raise ArgumentError, "val #{val} is not valid" unless arg_spec.validator.call(val)      
       else
         raise ArgumentError, "arg_spec.container #{arg_spec.container} is not valid"
       end
       
       if assign_args
-        raise ArgumentError, "value #{val} is not valid" unless arg_spec.validator.call(val)
         self.instance_variable_set("@#{key.to_s}".to_sym, val)
       end
     end

data/lib/hashmake/version.rb

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

data/spec/hash_makeable_spec.rb

@@ -7,9 +7,11 @@ describe Hashmake::HashMakeable do
     HASHED_ARG_SPECS = [
       ArgSpec.new(:reqd => true, :key => :reqd_string, :type => String, :validator => ->(a){ a.length < 10 }),
       ArgSpec.new(:reqd => false, :key => :not_reqd_float, :type => Float, :default => 0.0, :validator => ->(a){ a.between?(0.0,1.0) }),
+      ArgSpec.new(:reqd => false, :key => :not_reqd_array_of_float, :type => Float, :container => ArgSpec::CONTAINER_ARRAY, :default => ->(){Array.new}, :validator => ->(a){ a.between?(0.0,1.0) }),
+      ArgSpec.new(:reqd => false, :key => :not_reqd_hash_of_float, :type => Float, :container => ArgSpec::CONTAINER_HASH, :default => ->(){Hash.new}, :validator => ->(a){ a.between?(0.0,1.0) }),
     ]
     
-    attr_reader :reqd_string, :not_reqd_float
+    attr_reader :reqd_string, :not_reqd_float, :not_reqd_array_of_float, :not_reqd_hash_of_float
     
     def initialize hashed_args = {}
       hash_make MyTestClass::HASHED_ARG_SPECS, hashed_args
@@ -53,5 +55,54 @@ describe Hashmake::HashMakeable do
         a.not_reqd_float.should eq(0.321)
       end
     end
+    
+    context 'array container arg' do
+      it 'should be empty by default' do
+        a = MyTestClass.new :reqd_string => ""
+        a.not_reqd_array_of_float.should be_empty
+      end
+
+      it 'should assign array if it contains valid values of correct type' do
+        a = MyTestClass.new :reqd_string => "", :not_reqd_array_of_float => [ 0.5, 0.75 ]
+        a.not_reqd_array_of_float.should eq([ 0.5, 0.75 ])
+      end
+
+      it 'should raise ArgumentError if it contains invalid values of correct type' do
+        lambda do
+          a = MyTestClass.new :reqd_string => "", :not_reqd_array_of_float => [ -0.5, 2.5 ]
+        end.should raise_error(ArgumentError)
+      end
+
+      it 'should raise ArgumentError if it contains valid values of incorrect type' do
+        lambda do
+          a = MyTestClass.new :reqd_string => "", :not_reqd_array_of_float => [ "", 2.5 ]
+        end.should raise_error(ArgumentError)
+      end
+    end
+
+    context 'hash container arg' do
+      it 'should be empty by default' do
+        a = MyTestClass.new :reqd_string => ""
+        a.not_reqd_hash_of_float.should be_empty
+      end
+
+      it 'should assign array if it contains valid values of correct type' do
+        a = MyTestClass.new :reqd_string => "", :not_reqd_hash_of_float => { :a => 0.5, :b => 0.75 }
+        a.not_reqd_hash_of_float.should eq({ :a => 0.5, :b => 0.75 })
+      end
+
+      it 'should raise ArgumentError if it contains invalid values of correct type' do
+        lambda do
+          a = MyTestClass.new :reqd_string => "", :not_reqd_hash_of_float => { :a => -0.5, :b => 1.75 }
+        end.should raise_error(ArgumentError)
+      end
+
+      it 'should raise ArgumentError if it contains valid values of incorrect type' do
+        lambda do
+          a = MyTestClass.new :reqd_string => "", :not_reqd_hash_of_float => { :a => "", :b => 0.75 }
+        end.should raise_error(ArgumentError)
+      end
+    end
+
   end  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashmake
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -133,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -683104209
+      hash: 581566081
 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: -683104209
+      hash: 581566081
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23