attributor 5.0.1 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e92945289cab58f688cbad5df9d032fa684537b3
-  data.tar.gz: 53c15208c223f49ae8c05fdeebb962e31cc9c63e
+  metadata.gz: 1b19e77ce8b1772454840886e1a1bda5bc248c63
+  data.tar.gz: 32f9bca389ef6c112a7d8edf81cf8adc001ca2fd
 SHA512:
-  metadata.gz: 957400d332d6091f4f288c338ca9564004a9ca07b7d50355a8870c004f4419c3879e35c997aa4cdcdd4e92fd1301935c860de9c92318ae94d1d7af9f7208cf72
-  data.tar.gz: 7a189aa4fac7c5c7263e130a25b52515fb3de6717e652cbc7f5fd00d1c95acf48caaad70771b151b96365e616a9c6e384b873de2abfe68604a2b4b804cc4c0b0
+  metadata.gz: dc0fadeddc769124b2b60e717c48d435d88caf15cb6779b0784840c0bdcbbb4efce092fe4648dc8fd14a7b18958c0142dc8e6b52318b44f0b80b0c6f516e4a92
+  data.tar.gz: 6bfe838ad696d85db73ee1893a1d4f7739958180cb4f0f1a35ca5e8ff5ebb1a11bdde7bd10c23645623390cde56a6b95e72321ec819579068bac7b56037281c6

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## next
 
+## 5.0.2
+
+* Introduce the `Dumpable` (empty) module as an interface to indicate that instances of types that include it
+will respond to the `.dump` method, as a way to convert their internal substructure to primitive Ruby objects.    * Currently the only two directly dumpable types are Collection and Hash (with the caveat that there are several others that derive from them..i.e., CSV, Model, etc...)
+  * The rest of types have `native_types` that are already Ruby primitive Objects.
+* Fixed Hash and Model requirements to treat nil values as missing keys (to be compatible with the `required: true` option on an attribute).
+
 ## 5.0.1
 
 * Fix bug that made Struct/Models skip validation of requirements using the `requires` DSL

data/lib/attributor.rb

@@ -7,6 +7,8 @@ require 'digest/sha1'
 
 module Attributor
 
+  require_relative 'attributor/dumpable'
+
   require_relative 'attributor/exceptions'
   require_relative 'attributor/attribute'
   require_relative 'attributor/type'

data/lib/attributor/dumpable.rb

@@ -0,0 +1,11 @@
+module Attributor
+  module Dumpable
+    # Interface denoting that instances of such type respond to .dump as a way to properly
+    # serialize its contents into primitive ruby objects.
+    # This typically corresponds to non-trivial types that have some sort of substructure
+    def dump
+      raise NotImplementedError, 'Dumpable requires the implementation of #dump'
+    end
+
+  end
+end

data/lib/attributor/hash_dsl_compiler.rb

@@ -25,40 +25,41 @@ module Attributor
           @number = spec[type]
         end
       end
-      def of( *args)
+
+      def of(*args)
         @attr_names = args
         self
       end
 
-      def validate( object,context=Attributor::DEFAULT_ROOT_CONTEXT,_attribute=nil)
+      def validate(keys,context=Attributor::DEFAULT_ROOT_CONTEXT,_attribute=nil)
         result = []
         case type
         when :all
-          rest = attr_names - object.keys
+          rest = attr_names - keys
           unless rest.empty?
             rest.each do |attr|
               result.push "Key #{attr} is required for #{Attributor.humanize_context(context)}."
             end
           end
         when :exactly
-          included = attr_names & object.keys
+          included = attr_names & keys
           unless included.size ==  number
             result.push "Exactly #{number} of the following keys #{attr_names} are required for #{Attributor.humanize_context(context)}. Found #{included.size} instead: #{included.inspect}"
           end
         when :at_most
-          rest = attr_names & object.keys
+          rest = attr_names & keys
           if rest.size > number
             found = rest.empty? ? "none" : rest.inspect
             result.push "At most #{number} keys out of #{attr_names} can be passed in for #{Attributor.humanize_context(context)}. Found #{found}"
           end
         when :at_least
-          rest = attr_names & object.keys
+          rest = attr_names & keys
           if rest.size < number
             found = rest.empty? ? "none" : rest.inspect
             result.push "At least #{number} keys out of #{attr_names} are required to be passed in for #{Attributor.humanize_context(context)}. Found #{found}"
           end
         when :exclusive
-          intersection = attr_names & object.keys
+          intersection = attr_names & keys
           if intersection.size > 1
             result.push "keys #{intersection.inspect} are mutually exclusive for #{Attributor.humanize_context(context)}."
           end
@@ -138,4 +139,4 @@ module Attributor
 
 
   end
-end
+end

data/lib/attributor/types/collection.rb

@@ -5,6 +5,7 @@ module Attributor
 
   class Collection < Array
     include Container
+    include Dumpable
 
     # @param type [Attributor::Type] optional, defines the type of all collection members
     # @return anonymous class with specified type of collection members

data/lib/attributor/types/hash.rb

@@ -22,6 +22,7 @@ module Attributor
 
     include Container
     include Enumerable
+    include Dumpable
 
     class << self
       attr_reader :key_type, :value_type, :options
@@ -556,6 +557,7 @@ module Attributor
 
     def validate(context=Attributor::DEFAULT_ROOT_CONTEXT)
       context = [context] if context.is_a? ::String
+      errors = []
 
       if self.class.keys.any?
         extra_keys = @contents.keys - self.class.keys.keys
@@ -565,36 +567,41 @@ module Attributor
           end
         end
 
-        ret = self.class.keys.each_with_object(Array.new) do |(key, attribute), errors|
+        keys_with_values = Array.new
+
+        self.class.keys.each do |key, attribute|
           sub_context = self.class.generate_subcontext(context,key)
 
           value = @contents[key]
+          unless value.nil?
+            keys_with_values << key
+          end
 
           if value.respond_to?(:validating) # really, it's a thing with sub-attributes
             next if value.validating
           end
 
-          errors.push *attribute.validate(value, sub_context)
+          errors.push(*attribute.validate(value, sub_context))
+        end
+        self.class.requirements.each do |req|
+          validation_errors = req.validate(keys_with_values, context)
+          errors.push(*validation_errors) unless validation_errors.empty?
         end
       else
-        ret = @contents.each_with_object(Array.new) do |(key, value), errors|
+        @contents.each do |key, value|
           # FIXME: the sub contexts and error messages don't really make sense here
           unless key_type == Attributor::Object
             sub_context = context + ["key(#{key.inspect})"]
-            errors.push *key_attribute.validate(key, sub_context)
+            errors.push(*key_attribute.validate(key, sub_context))
           end
 
           unless value_type == Attributor::Object
             sub_context = context + ["value(#{value.inspect})"]
-            errors.push *value_attribute.validate(value, sub_context)
+            errors.push(*value_attribute.validate(value, sub_context))
           end
         end
       end
-      self.class.requirements.each_with_object(ret) do |req, errors|
-        validation_errors = req.validate( @contents , context)
-        errors.push *validation_errors unless validation_errors.empty?
-      end
-      ret
+      errors
     end
 
 

data/lib/attributor/types/model.rb

@@ -130,22 +130,29 @@ module Attributor
       @validating = true
 
       context = [context] if context.is_a? ::String
+      keys_with_values = []
+      errors = []
 
-      ret = self.class.attributes.each_with_object(Array.new) do |(sub_attribute_name, sub_attribute), errors|
+      self.class.attributes.each do |sub_attribute_name, sub_attribute|
         sub_context = self.class.generate_subcontext(context,sub_attribute_name)
 
         value = self.__send__(sub_attribute_name)
+        unless value.nil?
+          keys_with_values << sub_attribute_name
+        end
+
         if value.respond_to?(:validating) # really, it's a thing with sub-attributes
           next if value.validating
         end
 
-        errors.push *sub_attribute.validate(value, sub_context)
+        errors.push(*sub_attribute.validate(value, sub_context))
       end
-      self.class.requirements.each_with_object(ret) do |req, errors|
-        validation_errors = req.validate( @contents , context)
-        errors.push *validation_errors unless validation_errors.empty?
+      self.class.requirements.each do |req|
+        validation_errors = req.validate(keys_with_values, context)
+        errors.push(*validation_errors) unless validation_errors.empty?
       end
-      ret
+
+      errors
     ensure
       @validating = false
     end

data/lib/attributor/version.rb

@@ -1,3 +1,3 @@
 module Attributor
-  VERSION = '5.0.1'
+  VERSION = '5.0.2'
 end

data/spec/dumpable_spec.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+describe 'Dumpable' do
+
+  context 'for classes forgetting to implement #dump' do
+    let(:type) {
+      Class.new do
+        include Attributor::Dumpable
+      end
+     }
+
+    it 'gets an exception' do
+      expect{ type.new.dump }.to raise_exception(NotImplementedError)
+    end
+  end
+
+  context 'for classes properly implementing #dump' do
+    let(:type) {
+      Class.new do
+        include Attributor::Dumpable
+        def dump
+        end
+      end
+     }
+
+    it 'do not get the base exception' do
+      expect{ type.new.dump }.to_not raise_exception
+    end
+  end
+end

data/spec/hash_dsl_compiler_spec.rb

@@ -116,31 +116,31 @@ describe Attributor::HashDSLCompiler do
 
       context 'for :all' do
         let(:arguments){ { all: [:one, :two, :three] } }
-        let(:value){ {one: 1}}
+        let(:value){ [:one] }
         let(:validation_error){ ["Key two is required for $.", "Key three is required for $."] }
         it { subject.should include(*validation_error) }
       end
       context 'for :exactly' do
         let(:requirement) { req_class.new(exactly: 1).of(:one,:two) }
-        let(:value){ {one: 1, two: 2}}
+        let(:value){ [:one, :two] }
         let(:validation_error){ "Exactly 1 of the following keys [:one, :two] are required for $. Found 2 instead: [:one, :two]" }
         it { subject.should include(validation_error) }
       end
       context 'for :at_least' do
         let(:requirement) { req_class.new(at_least: 2).of(:one,:two,:three) }
-        let(:value){ {one: 1}}
+        let(:value){ [:one] }
         let(:validation_error){ "At least 2 keys out of [:one, :two, :three] are required to be passed in for $. Found [:one]" }
         it { subject.should include(validation_error) }
       end
       context 'for :at_most' do
         let(:requirement) { req_class.new(at_most: 1).of(:one,:two,:three) }
-        let(:value){ {one: 1, two: 2}}
+        let(:value){ [:one, :two] }
         let(:validation_error){ "At most 1 keys out of [:one, :two, :three] can be passed in for $. Found [:one, :two]" }
         it { subject.should include(validation_error) }
       end
       context 'for :exclusive' do
         let(:arguments){ { exclusive: [:one, :two] } }
-        let(:value){ {one: 1, two: 2}}
+        let(:value){ [:one, :two] }
         let(:validation_error){ "keys [:one, :two] are mutually exclusive for $." }
         it { subject.should include(validation_error) }
       end
@@ -174,4 +174,4 @@ describe Attributor::HashDSLCompiler do
       end
     end
   end
-end
+end

data/spec/types/bigdecimal_spec.rb

@@ -3,13 +3,17 @@ require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
 describe Attributor::BigDecimal do
   subject(:type) { Attributor::BigDecimal }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   context '.native_type' do
     its(:native_type) { should be(::BigDecimal) }
   end
 
   context '.example' do
     its(:example) { should be_a(::BigDecimal) }
-    it do 
+    it do
       ex = type.example
     end
   end
@@ -19,7 +23,7 @@ describe Attributor::BigDecimal do
     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|
@@ -36,7 +40,7 @@ describe Attributor::BigDecimal do
       end
     end
 
-    context 'for incoming String values' do 
+    context 'for incoming String values' do
       it 'should equal the value' do
         type.load('0').should eq(0)
         type.load('100').should eq(100)

data/spec/types/boolean_spec.rb

@@ -4,6 +4,10 @@ describe Attributor::Boolean do
 
   subject(:type) { Attributor::Boolean }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   context '.valid_type?' do
 
     context 'for incoming Boolean values' do

data/spec/types/class_spec.rb

@@ -5,6 +5,10 @@ describe Attributor::Class do
 
   subject(:type) { Attributor::Class }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   its(:native_type) { should be(::Class) }
   its(:family) { should == 'string' }
 

data/spec/types/collection_spec.rb

@@ -341,6 +341,10 @@ describe Attributor::Collection do
   context 'dumping' do
     let(:type) { Attributor::Collection.of(Cormorant) }
 
+    it 'it is Dumpable' do
+      type.new.is_a?(Attributor::Dumpable).should be(true)
+    end
+
     subject(:example) { type.example }
     it 'dumps' do
       expect {

data/spec/types/date_spec.rb

@@ -4,6 +4,10 @@ describe Attributor::Date do
 
   subject(:type) { Attributor::Date }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   context '.native_type' do
     its(:native_type) { should be(::Date) }
   end
@@ -20,7 +24,7 @@ describe Attributor::Date do
     end
     context 'nil values' do
       it 'should be nil' do
-        type.dump(nil).should be_nil 
+        type.dump(nil).should be_nil
       end
     end
   end
@@ -33,14 +37,14 @@ describe Attributor::Date do
     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)
@@ -48,8 +52,8 @@ describe Attributor::Date do
         loaded.should be(object)
       end
 
-    end    
-    
+    end
+
     context 'for incoming strings' do
 
       [

data/spec/types/date_time_spec.rb

@@ -4,6 +4,10 @@ describe Attributor::DateTime do
 
   subject(:type) { Attributor::DateTime }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   context '.native_type' do
     its(:native_type) { should be(::DateTime) }
   end
@@ -20,7 +24,7 @@ describe Attributor::DateTime do
     end
     context 'nil values' do
       it 'should be nil' do
-        type.dump(nil).should be_nil 
+        type.dump(nil).should be_nil
       end
     end
   end
@@ -33,14 +37,14 @@ describe Attributor::DateTime do
     end
 
     context 'for incoming objects' do
-      
+
       it "returns correct DateTime for Time objects" do
         object = Time.now
         loaded = type.load(object)
         loaded.should be_a(::DateTime)
         loaded.to_time.should == object
       end
-     
+
       it "returns correct DateTime for DateTime objects" do
         object = DateTime.now
         loaded = type.load(object)
@@ -48,8 +52,8 @@ describe Attributor::DateTime do
         loaded.should be( object )
       end
 
-    end    
-    
+    end
+
     context 'for incoming strings' do
 
       [

data/spec/types/float_spec.rb

@@ -4,6 +4,10 @@ describe Attributor::Float do
 
   subject(:type) { Attributor::Float }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   context '.native_type' do
     its(:native_type) { should be(::Float) }
   end

data/spec/types/hash_spec.rb

@@ -439,6 +439,10 @@ describe Attributor::Hash do
     let(:value) { {one: 1, two: 2} }
     let(:opts) { {} }
 
+    it 'it is Dumpable' do
+      type.new.is_a?(Attributor::Dumpable).should be(true)
+    end
+
     context 'for a simple (untyped) hash' do
       it 'returns the untouched hash value' do
         type.dump(value, opts).should eq(value)

data/spec/types/integer_spec.rb

@@ -4,6 +4,10 @@ describe Attributor::Integer do
 
   subject(:type) { Attributor::Integer }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   context '.example' do
 
     context 'when :min and :max are unspecified' do

data/spec/types/regexp_spec.rb

@@ -4,6 +4,10 @@ describe Attributor::Regexp do
 
   subject(:type) { Attributor::Regexp }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   its(:native_type) { should be(::Regexp) }
   its(:example) { should be_a(::String) }
   its(:family) { should == 'string' }

data/spec/types/string_spec.rb

@@ -4,6 +4,10 @@ describe Attributor::String do
 
   subject(:type) { Attributor::String }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   context '.native_type' do
     it "returns String" do
       type.native_type.should be(::String)

data/spec/types/time_spec.rb

@@ -4,6 +4,10 @@ describe Attributor::Time do
 
   subject(:type) { Attributor::Time }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   context '.native_type' do
     its(:native_type) { should be(::Time) }
   end
@@ -20,7 +24,7 @@ describe Attributor::Time do
     end
     context 'nil values' do
       it 'should be nil' do
-        type.dump(nil).should be_nil 
+        type.dump(nil).should be_nil
       end
     end
   end
@@ -33,14 +37,14 @@ describe Attributor::Time do
     end
 
     context 'for incoming objects' do
-      
+
       it "returns correct Time for DateTime objects" do
         object = Time.now
         loaded = type.load(object)
         loaded.should be_a(::Time)
         loaded.to_time.should == object
       end
-     
+
       it "returns correct Time for DateTime objects" do
         object = DateTime.now
         loaded = type.load(object)
@@ -48,8 +52,8 @@ describe Attributor::Time do
         loaded.should eq(object.to_time)
       end
 
-    end    
-    
+    end
+
     context 'for incoming strings' do
 
       [

data/spec/types/uri_spec.rb

@@ -4,6 +4,10 @@ describe Attributor::URI do
 
   subject(:type) { Attributor::URI }
 
+  it 'it is not Dumpable' do
+    type.new.is_a?(Attributor::Dumpable).should_not be(true)
+  end
+
   its(:native_type) { should be ::URI::Generic }
 
   context '.example' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attributor
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.0.2
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-21 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -285,6 +285,7 @@ files:
 - lib/attributor/attribute.rb
 - lib/attributor/attribute_resolver.rb
 - lib/attributor/dsl_compiler.rb
+- lib/attributor/dumpable.rb
 - lib/attributor/example_mixin.rb
 - lib/attributor/exceptions.rb
 - lib/attributor/extensions/randexp.rb
@@ -322,6 +323,7 @@ files:
 - spec/attribute_spec.rb
 - spec/attributor_spec.rb
 - spec/dsl_compiler_spec.rb
+- spec/dumpable_spec.rb
 - spec/extras/field_selector/field_selector_spec.rb
 - spec/families_spec.rb
 - spec/hash_dsl_compiler_spec.rb
@@ -369,7 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A powerful attribute and type management library for Ruby
@@ -378,6 +380,7 @@ test_files:
 - spec/attribute_spec.rb
 - spec/attributor_spec.rb
 - spec/dsl_compiler_spec.rb
+- spec/dumpable_spec.rb
 - spec/extras/field_selector/field_selector_spec.rb
 - spec/families_spec.rb
 - spec/hash_dsl_compiler_spec.rb