hashmake 0.2.0 → 0.2.1

data/ChangeLog.rdoc

@@ -48,4 +48,9 @@ A bit of a major release. mostly to cut back features and modify interfaces a bi
   -removed allow_nil from arg_spec
   -add separate classes for container arg specs (array and hash)
   -remove make_hash
-  -switch order of arguments for hash_make. Hashed args come first now, and arg spec Hash comes next.
+  -switch order of arguments for hash_make. Hashed args come first now, and arg spec Hash comes next.
+
+=== 0.2.1 / 2013-08-07
+
+Arg specs can support single or multiple types.
+Removed unused hash_make_if_needed and make_hash_if_possible.

data/README.rdoc

@@ -11,7 +11,7 @@ Make hash-based object initialization easy!
 The hash_make method checks hashed arguments against a set of specifications, then values are assigned to instance variables matching the arg keys.
 
 == Features
-Type checking via Object#is_a?. The default type is Object, allowing anything.
+Type checking via Object#is_a?. The default type is Object, allowing anything. Can allow multiple types.
 Mark as required/not. Set to true, by default.
 Default value, for non-required args that aren't given. For default values that are mutable, make the default value a Proc that can be called to generate the mutable value.
 Validation of values via a Proc.
@@ -44,6 +44,18 @@ Validation of values via a Proc.
   a = MyClass.new :x => 0.5, :z => ["abc", "efg"] # OK
   a = MyClass.new :x => 0.5, :z => ["abc", ""] # raise ArgumentError, because validator requires str.size > 0
   
+  class MultitypeDemo
+    include Hashmake::HashMakeable
+
+    ARG_SPECS = {
+      :str_or_class => arg_spec(:reqd => true, :type => [String, Class])
+    }
+  end
+
+  MultitypeDemo.new(:str_or_class => "")  # OK
+  MultitypeDemo.new(:str_or_class => String)  # OK
+  MultitypeDemo.new(:str_or_class => 1)  # raise ArgumentError
+
 == Requirements
 
 == Install

data/lib/hashmake/arg_spec.rb

@@ -42,7 +42,13 @@ class ArgSpec
     new_args = DEFAULT_ARGS.merge(hashed_args)
     
     @type = new_args[:type]
-    raise ArgumentError, "#{@type} is not a Class" unless @type.is_a?(Class)
+    if @type.is_a?(Enumerable)
+      @type.each do |type|
+        raise ArgumentError, "#{type} is not a Class" unless type.is_a?(Class)
+      end
+    else
+      raise ArgumentError, "#{@type} is not a Class" unless @type.is_a?(Class)
+    end
     
     @validator = new_args[:validator]
     @reqd = new_args[:reqd]
@@ -53,27 +59,24 @@ class ArgSpec
       @default = new_args[:default]
     end
   end
-    
-  # If the val is not of the right type, but is a Hash, attempt to
-  # make an object of the right type if it is hash-makeable
-  def hash_make_if_needed val
-    if Hashmake.hash_makeable?(@type) and val.is_a?(Hash)
-      val = @type.new val
-    end
-    return val
-  end
   
   # Check the given value, and raise ArgumentError it is not valid.
   def validate_value val
-    raise ArgumentError, "val #{val} is not a #{@type}" unless val.is_a?(@type)
-    raise ArgumentError, "val #{val} is not valid" unless @validator.call(val)
-  end
-  
-  def make_hash_if_possible val
-    if Hashmake::hash_makeable?(val.class) and val.class.is_a?(@type)
-      val = val.make_hash
+    if @type.is_a?(Array)
+      type_matched = false
+      @type.each do |type|
+        if val.is_a? type
+          type_matched = true
+        end
+      end
+      unless type_matched
+        raise ArgumentError, "val #{val} is not one of #{@type}"
+      end
+    else
+      raise ArgumentError, "val #{val} is not a #{@type}" unless val.is_a?(@type)
     end
-    return val
-  end
+
+    raise ArgumentError, "val #{val} is not valid" unless @validator.call(val)
+  end  
 end
 end

data/lib/hashmake/array_arg_spec.rb

@@ -26,24 +26,11 @@ class ArrayArgSpec
     @arg_spec.default
   end
   
-  def hash_make_if_needed val
-    val.each_index do |i|
-      item = val[i]
-      val[i] = @arg_spec.hash_make_if_needed item
-    end
-  end
-  
   def validate_value val
     val.each do |item|
       @arg_spec.validate_value item
     end
-  end
-  
-  def make_hash_if_possible ary
-    ary.each_index do |i|
-      ary[i] = @arg_spec.make_hash_if_possible ary[i]
-    end
-  end
+  end  
 end
 
 end

data/lib/hashmake/hash_arg_spec.rb

@@ -26,24 +26,11 @@ class HashArgSpec
     @arg_spec.default
   end
   
-  def hash_make_if_needed val
-    val.each_key do |item_key|
-      item = val[item_key]
-      val[item_key] = @arg_spec.hash_make_if_needed item
-    end
-  end
-  
   def validate_value val
     val.each do |key, item|
       @arg_spec.validate_value item
     end
-  end
-  
-  def make_hash_if_possible hash
-    hash.each_key do |key|
-      hash[key] = @arg_spec.make_hash_if_possible hash[key]
-    end
-  end
+  end  
 end
 
 end

data/lib/hashmake/version.rb

@@ -4,5 +4,5 @@
 #
 module Hashmake
   # hashmake version
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/arg_spec_spec.rb

@@ -1,51 +1,74 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Hashmake::ArgSpec do
-  it 'should raise ArgumentError if :reqd is false and no :default value is given' do
-    hash = {
-      :reqd => false, :key => :some_variable, :type => String
-    }
-    
-    lambda { Hashmake::ArgSpec.new hash }.should raise_error(ArgumentError)
-  end
-  
-  it 'should not raise ArgumentError if :reqd is false and a :default value is given' do
-    hash = {
-      :reqd => false, :key => :some_variable, :type => String, :default => ""
-    }
-    
-    lambda { Hashmake::ArgSpec.new hash }.should_not raise_error(ArgumentError)
+  context ':reqd is false' do
+    context 'no default value is given' do
+      it 'should raise error' do
+        hash = { :reqd => false, :key => :some_variable, :type => String }
+        expect { Hashmake::ArgSpec.new hash }.to raise_error
+      end
+    end
+
+    context 'default value is given' do
+      it 'should not raise error' do
+        hash = { :reqd => false, :key => :some_variable, :type => String, :default => "" }
+        expect { Hashmake::ArgSpec.new hash }.not_to raise_error
+      end
+    end
+
   end
-  
+
   context '#validate_value' do
-    before :each do
-      @arg_spec = ArgSpec.new(:reqd => true, :type => Fixnum, :validator => ->(a){ a > 0})
-    end
-    
-    context 'value given is correct type' do
-      context 'value given is valid' do
-        it 'should not raise ArgumentError' do
-          lambda { @arg_spec.validate_value 1 }.should_not raise_error
+    context 'single type given' do
+      before :all do
+        @arg_spec = ArgSpec.new(:reqd => true, :type => Fixnum, :validator => ->(a){ a > 0})
+      end
+      
+      context 'value given is correct type' do
+        context 'value given is valid' do
+          it 'should not raise ArgumentError' do
+            lambda { @arg_spec.validate_value 1 }.should_not raise_error
+          end
+        end
+        
+        context 'value given is not valid' do
+          it 'should raise ArgumentError' do
+            lambda { @arg_spec.validate_value 0 }.should raise_error(ArgumentError)
+          end
         end
       end
       
-      context 'value given is not valid' do
-        it 'should raise ArgumentError' do
-          lambda { @arg_spec.validate_value 0 }.should raise_error(ArgumentError)
+      context 'value given is not correct type' do
+        context 'value given is valid' do
+          it 'should raise ArgumentError' do
+            lambda { @arg_spec.validate_value 1.0 }.should raise_error(ArgumentError)
+          end
+        end
+        
+        context 'value given is not valid' do
+          it 'should raise ArgumentError' do
+            lambda { @arg_spec.validate_value 0.0 }.should raise_error(ArgumentError)
+          end
         end
       end
     end
-    
-    context 'value given is not correct type' do
-      context 'value given is valid' do
-        it 'should raise ArgumentError' do
-          lambda { @arg_spec.validate_value 1.0 }.should raise_error(ArgumentError)
+
+    context 'multiple types given' do
+      before :all do
+        @arg_spec = ArgSpec.new(:reqd => true, :type => [FalseClass, TrueClass])
+      end
+      
+      context 'value given is one of the correct types' do
+        it 'should not raise ArgumentError' do
+          expect { @arg_spec.validate_value false }.not_to raise_error
+          expect { @arg_spec.validate_value true }.not_to raise_error
         end
       end
       
-      context 'value given is not valid' do
+      context 'value given is not one of the correct types' do
         it 'should raise ArgumentError' do
-          lambda { @arg_spec.validate_value 0.0 }.should raise_error(ArgumentError)
+          expect { @arg_spec.validate_value 1 }.to raise_error
+          expect { @arg_spec.validate_value 0 }.to raise_error
         end
       end
     end

data/spec/hash_makeable_spec.rb

@@ -12,6 +12,7 @@ describe Hashmake::HashMakeable do
       :not_reqd_float => arg_spec(:reqd => false, :type => Float, :default => NON_REQD_FLOAT_DEFAULT, :validator => ->(a){ a.between?(0.0,1.0) }),
       :not_reqd_array_of_float => arg_spec_array(:reqd => false, :type => Float,  :validator => ->(a){ a.between?(0.0,1.0) }),
       :not_reqd_hash_of_float => arg_spec_hash(:reqd => false, :type => Float, :validator => ->(a){ a.between?(0.0,1.0) }),
+      :string_or_class => arg_spec(:reqd => false, :type => [String, Class], :default => "")
     }
     
     attr_accessor :not_reqd_float
@@ -106,6 +107,66 @@ describe Hashmake::HashMakeable do
           a = MyTestClass.new :reqd_string => "", :not_reqd_hash_of_float => { :a => "", :b => 0.75 }
         end.should raise_error(ArgumentError)
       end
+
+      it 'should not care (raise error) what the hash keys are' do
+        expect { MyTestClass.new :reqd_string => "", :not_reqd_hash_of_float => { 0 => 0.5, "abc" => 0.75 } }.not_to raise_error
+        expect { MyTestClass.new :reqd_string => "", :not_reqd_hash_of_float => { Class => 0.5, Hashmake => 0.75 } }.not_to raise_error
+      end
+    end
+
+    context 'multi-type arg' do
+      it 'should not raise error if value is one of the allowed types' do
+        expect { MyTestClass.new(:reqd_string => "", :string_or_class => "Hello") }.not_to raise_error
+        expect { MyTestClass.new(:reqd_string => "", :string_or_class => String) }.not_to raise_error
+      end
+
+      it 'should raise error if value is not one of the allowed types' do
+        expect { MyTestClass.new(:reqd_string => "", :string_or_class => 1.2) }.to raise_error
+      end
+    end
+
+    context 'multi-type array container' do
+      it 'should not raise error if all values are one of the allowed types' do
+        [
+          ["String"],
+          ["String", String],
+          [String, Float, "Fixnum"],
+        ].each do |good_values|
+          expect { MyTestClass.new(:reqd_string => "", :strings_or_classes => good_values) }.not_to raise_error
+        end
+      end
+
+      it 'should raise error if any of the values is not one of the allowed types' do
+        [
+          [1.2],
+          ["String", 1.2, String],
+          [String, 1.2, "Fixnum"],
+        ].each do |good_values|
+          expect { MyTestClass.new(:reqd_string => "", :strings_or_classes => good_values) }.not_to raise_error
+        end
+      end
+    end
+
+    context 'multi-type hash container' do
+      it 'should not raise error if all values are one of the allowed types' do
+        [
+          [0 => "String"],
+          [0 => "String", 1 => String],
+          [0 => String, 1 => Float, 2 => "Fixnum"],
+        ].each do |good_values|
+          expect { MyTestClass.new(:reqd_string => "", :strings_or_classes => good_values) }.not_to raise_error
+        end
+      end
+
+      it 'should raise error if any of the values is not one of the allowed types' do
+        [
+          [0 => 1.2],
+          [0 => "String", 1 => 1.2, 2 => String],
+          [0 => String, 1 => 1.2, 2 => "Fixnum"],
+        ].each do |good_values|
+          expect { MyTestClass.new(:reqd_string => "", :strings_or_classes => good_values) }.not_to raise_error
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashmake
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-03 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4514910862506440485
+      hash: -549260074741909705
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4514910862506440485
+      hash: -549260074741909705
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23