hashmake 0.1.8 → 0.1.9

data/ChangeLog.rdoc

@@ -35,4 +35,8 @@ Add #find_arg_specs and #make_hash methods to HashMakeable.
 
 === 0.1.7 / 2013-06-21
 
-In HashMakeable.make_hash, only make objects into hashes if the object class matches the arg spec type (and, still, if it is hash makeable).
+In HashMakeable.make_hash, only make objects into hashes if the object class matches the arg spec type (and, still, if it is hash makeable).
+
+=== 0.1.7 / 2013-06-21
+
+Add :allow_nil option to ArgSpec.new. If an arg spec allows nil, it mean that if a hashed arg is nil, no ArgumentError will be raised and the validator won't be called.

data/lib/hashmake/arg_spec.rb

@@ -20,9 +20,10 @@ class ArgSpec
     :validator => ->(a){true},
     :container => nil,
     :type => Object,
+    :allow_nil => false
   }
   
-  attr_reader :type, :validator, :reqd, :default, :container
+  attr_reader :type, :validator, :reqd, :default, :container, :allow_nil
   
   # A new instance of ArgSpec. 
   # 
@@ -56,6 +57,8 @@ class ArgSpec
     @container = new_args[:container]
     raise ArgumentError, "CONTAINERS does not include container #{@container}" unless CONTAINERS.include?(@container)
     
+    @allow_nil = new_args[:allow_nil]
+    
     unless @reqd
       msg = "if hashed arg is not required, a default value or value generator (proc) must be defined via :default key"
       raise ArgumentError, msg unless new_args.has_key?(:default)

data/lib/hashmake/hash_makeable.rb

@@ -86,18 +86,30 @@ module HashMakeable
     if arg_spec.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)
-        raise ArgumentError, "array item #{item} is not valid" unless arg_spec.validator.call(item)      
+        if item.nil?
+          raise ArgumentError, "nil was given" unless arg_spec.allow_nil
+        else
+          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
       end
     elsif arg_spec.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)      
+        if item.nil?
+          raise ArgumentError, "nil was given" unless arg_spec.allow_nil
+        else
+          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
       end
     elsif arg_spec.container.nil?
-      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)      
+      if val.nil?
+        raise ArgumentError, "nil was given" unless arg_spec.allow_nil
+      else
+        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)      
+      end
     else
       raise ArgumentError, "arg_spec.container #{arg_spec.container} is not valid"
     end

data/lib/hashmake/version.rb

@@ -4,5 +4,5 @@
 #
 module Hashmake
   # hashmake version
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/spec/hash_makeable_spec.rb

@@ -43,6 +43,20 @@ describe Hashmake::HashMakeable do
     end
   end
   
+  class TestAllowNil
+    include HashMakeable
+  
+    ARG_SPECS = {
+      :allows_nil => arg_spec(:reqd => false, :default => ->(){ "123" }, :type => String, :allow_nil => true),
+      :disallows_nil => arg_spec(:reqd => false, :default => ->(){ "123" }, :type => String, :allow_nil => false)
+    }
+    
+    attr_reader :allows_nil, :disallows_nil
+    def initialize args
+      hash_make ARG_SPECS, args
+    end
+  end
+  
   describe '#hash_make' do
     context 'for a reqd arg' do
       it 'should raise an ArgumentError if not given in the hash' do
@@ -136,6 +150,14 @@ describe Hashmake::HashMakeable do
         a.also_hash_makeable.a_number.should eq(a_number)
       end
     end
+    
+    it 'should not raise ArgumentError if nil is given when nil is allowed' do
+      lambda { TestAllowNil.new(:allows_nil => nil) }.should_not raise_error
+    end
+  
+    it 'should raise ArgumentError if nil is given when nil is not allowed' do
+      lambda { TestAllowNil.new(:disallows_nil => nil) }.should raise_error(ArgumentError)
+    end      
   end
   
   describe '#make_hash' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashmake
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-06-23 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: -1512058762089527342
+      hash: -1181723344412730535
 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: -1512058762089527342
+      hash: -1181723344412730535
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23