attributor 2.2.1 → 2.3.0

data/lib/attributor/types/model.rb

@@ -142,8 +142,15 @@ module Attributor
 
 
     # Model-specific decoding and coercion of the attribute.
-    def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
-      return value if value.nil?
+    def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, recurse: false, **options)
+      if value.nil?
+        if recurse
+          value = {}
+        else
+          return value
+        end
+      end
+
       return value if value.kind_of?(self.native_type)
 
       context = Array(context)
@@ -162,18 +169,19 @@ module Attributor
         raise IncompatibleTypeError,  context: context, value_type: value.class, type: self
       end
 
-      self.from_hash(hash,context)
+      self.from_hash(hash,context, recurse: recurse)
     end
 
 
-    def self.from_hash(hash,context)
+    def self.from_hash(hash,context, recurse: false)
       model = self.new
 
       self.attributes.each do |attribute_name, attribute|
+        # p [attribute_name, attribute]
         # OPTIMIZE: deleting the keys as we go is mucho faster, but also very risky
         # Note: use "load" vs. attribute assignment so we can propagate the right context down.
         sub_context = self.generate_subcontext(context,attribute_name)
-        model.attributes[attribute_name] = attribute.load(hash[attribute_name] || hash[attribute_name.to_s], sub_context)
+        model.attributes[attribute_name] = attribute.load(hash[attribute_name] || hash[attribute_name.to_s], sub_context, recurse: recurse)
       end
 
       unknown_keys = hash.keys.collect {|k| k.to_sym} - self.attributes.keys
@@ -237,7 +245,7 @@ module Attributor
       @validating = false
       @dumping = false
       if data
-        loaded = self.class.load( data )
+        loaded = self.class.load(data)
         @attributes = loaded.attributes
       else
         @attributes = ::Hash.new

data/lib/attributor/types/string.rb

@@ -8,7 +8,7 @@ module Attributor
 
 
     def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
-      String(value)
+      value && String(value)
     rescue
       super
     end

data/lib/attributor/types/time.rb

@@ -0,0 +1,39 @@
+require 'date'
+
+module Attributor
+
+  class Time
+    include Type
+
+    def self.native_type
+      return ::Time
+    end
+
+    def self.example(context=nil, options: {})
+      return self.load(/[:time:]/.gen, context)
+    end
+
+    def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+      return value if value.is_a?(self.native_type)
+      return nil if value.nil?
+
+      return value.to_time if value.respond_to?(:to_time)
+
+      case value
+      when ::Integer
+        return ::Time.at(value)
+      when ::String
+        begin
+          return ::Time.parse(value)
+        rescue ArgumentError => e
+          raise Attributor::DeserializationError, context: context, from: value.class, encoding: "Time" , value: value
+        end
+      else
+        raise CoercionError, context: context, from: value.class, to: self, value: value
+      end
+    end
+
+  end
+
+end
+

data/lib/attributor/version.rb

@@ -1,3 +1,3 @@
 module Attributor
-  VERSION = "2.2.1"
+  VERSION = "2.3.0"
 end

data/spec/attribute_spec.rb

@@ -226,11 +226,6 @@ describe Attributor::Attribute do
     let(:context){ ['context'] }
     let(:value) { '1' }
 
-    it 'does not call type.load for nil values' do
-      type.should_not_receive(:load)
-      attribute.load(nil)
-    end
-
     it 'delegates to type.load' do
       type.should_receive(:load).with(value,context, {})
       attribute.load(value,context)
@@ -252,15 +247,13 @@ describe Attributor::Attribute do
         it { should == default_value}
       end
 
-
-      context 'for a value that the type loads as nil' do
-        let(:value) { "not nil"}
-        before do
-          type.should_receive(:load).and_return(nil)
-        end
+      context 'for false' do
+        let(:type) { Attributor::Boolean }
+        let(:default_value) { false }
+        let(:value) { nil }
         it { should == default_value}
-      end
 
+      end
     end
 
     context 'validating a value' do

data/spec/support/hashes.rb

@@ -0,0 +1,7 @@
+class HashWithModel < Attributor::Hash
+  keys do
+    key :name, String, :default => "Turkey McDucken", :description => "Turducken name", :example => /[:name:]/
+    key :chicken, Chicken
+  end
+end
+

data/spec/support/models.rb

@@ -33,7 +33,7 @@ end
 
 class Turducken < Attributor::Model
   attributes do
-    attribute :name, String, :description => "Turducken name", :example => /[:name:]/
+    attribute :name, String, :default => "Turkey McDucken", :description => "Turducken name", :example => /[:name:]/
     attribute :chicken, Chicken
     attribute :duck, Duck
     attribute :turkey, Turkey, :description => "The turkey"
@@ -79,3 +79,5 @@ class Address < Attributor::Model
     attribute :person, Person, example: proc { |address, context| Person.example(context, address: address) }
   end
 end
+
+

data/spec/types/bigdecimal_spec.rb

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+describe Attributor::BigDecimal do
+  subject(:type) { Attributor::BigDecimal }
+
+  context '.native_type' do
+    its(:native_type) { should be(::BigDecimal) }
+  end
+
+  context '.example' do
+    its(:example) { should be_a(::BigDecimal) }
+    it do 
+      ex = type.example
+    end
+  end
+
+  context '.load' do
+    let(:value) { nil }
+    it 'returns nil for nil' do
+      type.load(nil).should be(nil)
+    end
+    
+    context 'for incoming Float values' do
+     it 'returns the incoming value' do
+       [0.0, -1.0, 1.0, 1e-10, 0.25135].each do |value|
+         type.load(value).should eq(value)
+       end
+     end
+    end
+
+    context 'for incoming Integer values' do
+      it 'should equal the incoming value' do
+        [0, -1, 1].each do |value|
+          type.load(value).should eq(value)
+        end
+      end
+    end
+
+    context 'for incoming String values' do 
+      it 'should equal the value' do
+        type.load('0').should eq(0)
+        type.load('100').should eq(100)
+        type.load('0.1').should eq(0.1)
+      end
+    end
+
+  end
+end

data/spec/types/boolean_spec.rb

@@ -64,6 +64,10 @@ describe Attributor::Boolean do
 
     end
 
+    it 'returns nil for nil' do
+      type.load(nil).should be(nil)
+    end
+
     context 'that are not valid Booleans' do
       let(:context){ ['root','subattr'] }
       ['string', 2, 1.0, Class, Object.new].each do |value|

data/spec/types/collection_spec.rb

@@ -282,6 +282,17 @@ describe Attributor::Collection do
         value.all? { |element| member_type.valid_type?(element) }.should be_true
       end
     end
+
+    it "returns an Array with size specified" do
+      type.example(options: {size: 5}).size.should eq(5)
+    end
+
+    it "returns an Array with size within a range" do
+      5.times do
+        type.example(options: {size: (2..4)}).size.should be_within(1).of(3)
+      end
+    end
+
     context "passing a non array context" do
       it 'still is handled correctly ' do
         expect{
@@ -289,6 +300,6 @@ describe Attributor::Collection do
         }.to_not raise_error
       end
     end
-    
+
   end
 end

data/spec/types/csv_spec.rb

@@ -11,7 +11,38 @@ describe Attributor::CSV do
     it 'parses the value and returns an array with the right types' do
       csv.load(value).should eq(array)
     end
+  end
+
+  context '.example' do
+    let!(:example) { csv.example }
+    let!(:loaded_example) { csv.load(example) }
+
+    it 'generates a String example' do
+      example.should be_a(String)
+    end
+
+    it 'generates a comma-separated list of Integer values' do
+      loaded_example.should be_a(Array)
+      loaded_example.size.should be > 1
+      loaded_example.each { |e| e.should be_a(Integer) }
+    end
+  end
 
+  context '.dump' do
+    let!(:int_vals) { [1, 2, 3] }
+    let!(:str_vals)  { (0..2).collect { /\w+/.gen} }
+
+    it 'dumps a String value' do
+      csv.dump(int_vals).should be_a(String)
+    end
+
+    it 'dumps a comma-separated list of Integers' do
+      csv.dump(int_vals).should eq(int_vals.join(','))
+    end
+
+    it 'dumps non-Integer values also' do
+      csv.dump(str_vals).should eq(str_vals.join(','))
+    end
   end
 
 end

data/spec/types/date_spec.rb

@@ -0,0 +1,94 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+describe Attributor::Date do
+
+  subject(:type) { Attributor::Date }
+
+  context '.native_type' do
+    its(:native_type) { should be(::Date) }
+  end
+
+  context '.example' do
+    its(:example) { should be_a(::Date) }
+  end
+
+  context '.load' do
+
+    it 'returns nil for nil' do
+      type.load(nil).should be(nil)
+    end
+
+    context 'for incoming objects' do
+      
+      it "returns correct Date for Time objects" do
+        object = Time.now
+        loaded = type.load(object)
+        loaded.should be_a(::Date)
+        loaded.to_date.should == object.to_date
+      end
+     
+      it "returns correct Date for DateTime objects" do
+        object = DateTime.now
+        loaded = type.load(object)
+        loaded.should be_a(::Date)
+        loaded.should be(object)
+      end
+
+    end    
+    
+    context 'for incoming strings' do
+
+      [
+        '2001-02-03T04:05:06+07:00',
+        'Sat, 03 Feb 2001 04:05:06 GMT',
+        '20010203T040506+0700',
+        '2001-W05-6T04:05:06+07:00',
+        'H13.02.03T04:05:06+07:00',
+        'Sat, 3 Feb 2001 04:05:06 +0700',
+        '2013/08/23 00:39:55 +0000',
+        '2007-10-19T04:11:33Z',
+        '2001-02-03T04:05:06+07:00.123456', # custom format with microseconds
+      ].each do |value|
+
+        it "returns correct Date for #{value.inspect}" do
+          type.load(value).should == Date.parse(value)
+        end
+
+      end
+
+      [
+        'Sat, 30 Feb 2001 04:05:06 GMT', # No such date exists
+        '2013/08/33 00:39:55 +0000',
+        '2007-10-33T04:11:33Z',
+        '2001-02-33T04:05:06+07:00.123456', # custom format with microseconds
+      ].each do |value|
+
+        it "raises Attributor::AttributorException for #{value.inspect}" do
+          expect {
+            type.load(value)
+          }.to raise_error(Attributor::DeserializationError, /Error deserializing a String using Date/)
+        end
+
+      end
+
+      [
+        '',
+        'foobar',
+        'Sat, 30 Feb 2001 04:05:06 FOOBAR', # No such date format exists
+      ].each do |value|
+
+        it "raises Attributor::AttributorException for #{value.inspect}" do
+          expect {
+            type.load(value)
+          }.to raise_error(Attributor::DeserializationError, /Error deserializing a String using Date/)
+        end
+
+      end
+
+    end
+
+  end
+
+end
+
+

data/spec/types/date_time_spec.rb

@@ -14,8 +14,12 @@ describe Attributor::DateTime do
 
   context '.load' do
 
+    it 'returns nil for nil' do
+      type.load(nil).should be(nil)
+    end
+
     context 'for incoming objects' do
-     
+      
       it "returns correct DateTime for Time objects" do
         object = Time.now
         loaded = type.load(object)
@@ -35,15 +39,15 @@ describe Attributor::DateTime do
     context 'for incoming strings' do
 
       [
-          '2001-02-03T04:05:06+07:00',
-          'Sat, 03 Feb 2001 04:05:06 GMT',
-          '20010203T040506+0700',
-          '2001-W05-6T04:05:06+07:00',
-          'H13.02.03T04:05:06+07:00',
-          'Sat, 3 Feb 2001 04:05:06 +0700',
-          '2013/08/23 00:39:55 +0000', # Right API 1.5
-          '2007-10-19T04:11:33Z', # Right API 1.0
-          '2001-02-03T04:05:06+07:00.123456', # custom format with microseconds
+        '2001-02-03T04:05:06+07:00',
+        'Sat, 03 Feb 2001 04:05:06 GMT',
+        '20010203T040506+0700',
+        '2001-W05-6T04:05:06+07:00',
+        'H13.02.03T04:05:06+07:00',
+        'Sat, 3 Feb 2001 04:05:06 +0700',
+        '2013/08/23 00:39:55 +0000',
+        '2007-10-19T04:11:33Z',
+        '2001-02-03T04:05:06+07:00.123456', # custom format with microseconds
       ].each do |value|
 
         it "returns correct DateTime for #{value.inspect}" do
@@ -53,10 +57,10 @@ describe Attributor::DateTime do
       end
 
       [
-          'Sat, 30 Feb 2001 04:05:06 GMT', # No such date exists
-          '2013/08/33 00:39:55 +0000', # Right API 1.5
-          '2007-10-33T04:11:33Z', # Right API 1.0
-          '2001-02-33T04:05:06+07:00.123456', # custom format with microseconds
+        'Sat, 30 Feb 2001 04:05:06 GMT', # No such date exists
+        '2013/08/33 00:39:55 +0000',
+        '2007-10-33T04:11:33Z',
+        '2001-02-33T04:05:06+07:00.123456', # custom format with microseconds
       ].each do |value|
 
         it "raises Attributor::AttributorException for #{value.inspect}" do
@@ -68,9 +72,9 @@ describe Attributor::DateTime do
       end
 
       [
-          '',
-          'foobar',
-          'Sat, 30 Feb 2001 04:05:06 FOOBAR', # No such date format exists
+        '',
+        'foobar',
+        'Sat, 30 Feb 2001 04:05:06 FOOBAR', # No such date format exists
       ].each do |value|
 
         it "raises Attributor::AttributorException for #{value.inspect}" do