attributor 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b7e1ce2db7e093c7a3073db2cea1d45b861f015
-  data.tar.gz: f3623a6d5e3b313b9493cba77a6e7a7b250d1de5
+  metadata.gz: b366557c378f786a7a4620793c05bdb06504ef3e
+  data.tar.gz: 728171cc3c89f03c7f998fb24db74fada6c845a8
 SHA512:
-  metadata.gz: 625ac84d1636b6d21044c69d8be170bae210b28f302c2ed78de5b3130e1d82e760ee65c68a6b9f0c614e06b8a2a4770ab26da92a6b5917d847a1a02a73bdb522
-  data.tar.gz: f7c4324913a80c92191c9bc6f46ced3d5f7e9f01758faea751c79254b24e547f68b88ce836c446523cd759e2c35d4ca04778b7c033787878b5f75e88b77d7046
+  metadata.gz: facbc89fd9ac8b18cd60611b3699bf3308854890becc782522959497d81c6c89abf59dbc29219c5c9e378a8ff317bfb67b511696c377bd6c024ad234ba3f5866
+  data.tar.gz: 0abb9af1bde8c73bf374686aeb441ef6aba3426f9767970a072d2730d6e71b3e164c9458d1bcb42a48851f424bfdff302096a78300bf8758c0b5461743a13e8f

data/.travis.yml

@@ -1,4 +1,8 @@
+sudo: false
 language: ruby
 rvm:
-  - "2.1.2"
+  - "2.1.5"
 script: bundle exec rspec spec
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -1,8 +1,18 @@
 Attributor Changelog
 ============================
 
-next
-----
+2.6.0
+-----
+
+* Fixed bug in `example_mixin` where lazy_attributes were not evaluated.
+* Fixed bug in `Hash` where the class would refuse to load from another `Attributor::Hash` when there were no keys defined and they were seemingly compatible.
+* Fixed a `Hash.dump` bug where nil attribute values would transitively be `dumpe`d therefore causing a nil dereference.
+* Hardened the `dump`ing of types to support nil values.
+* Fix `attribute.example` to actually accept native types (that are not only Strings)
+* Fixed bug where `Hash#get` would insert a nil value if asked for a key that was not present in the hash.
+* Fixed bug in `Hash.from_hash` where it would add nil values for keys that are defined on the type but not present in the input.
+* Added `Hash#merge` that works with two identically-typed hashes
+* Added `Hash#each_pair` for better duck-type compatibility with ::Hash.
 
 2.5.0
 ----

data/README.md

@@ -22,23 +22,23 @@ With Attributor you can:
 
 ### Running specs:
 
-    `bundle exec rake spec`
+    bundle exec rake spec
 
 Note: This should also compute code coverage. See below for details on viewing code coverage.
 
 ### Generating documentation:
 
-    `bundle exec yard`
+    bundle exec yard
 
 ### Computing documentation coverage:
 
-    `bundle exec yardstick 'lib/**/*.rb'`
+    bundle exec yardstick 'lib/**/*.rb'
 
 ### Computing code coverage:
 
-    `bundle exec rake spec`
+    bundle exec rake spec
 
-    `open coverage/index.html`
+    open coverage/index.html
 
 
 ## Contributing to attributor

data/lib/attributor/attribute.rb

@@ -135,9 +135,6 @@ module Attributor
       if self.options.has_key? :example
         val = self.options[:example]
         case val
-        when ::String
-          # FIXME: spec this properly to use self.type.native_type
-          val
         when ::Regexp
           self.load(val.gen,context)
         when ::Array
@@ -154,7 +151,7 @@ module Attributor
         when nil
           nil
         else
-          raise AttributorException, "unknown example attribute type, got: #{val}"
+          self.load(val)
         end
       else
         if (option_values = self.options[:values])

data/lib/attributor/attribute_resolver.rb

@@ -5,6 +5,7 @@ module Attributor
 
   class AttributeResolver
     ROOT_PREFIX = '$'.freeze
+    COLLECTION_INDEX_KEY = /^at\((\d+)\)$/.freeze
 
     class Data < ::Hash
       include Hashie::Extensions::MethodReader
@@ -17,7 +18,6 @@ module Attributor
     end
 
 
-    # TODO: support collection queries
     def query!(key_path, path_prefix=ROOT_PREFIX)
       # If the incoming key_path is not an absolute path, append the given prefix
       # NOTE: Need to index key_path by range here because Ruby 1.8 returns a
@@ -30,12 +30,21 @@ module Attributor
       # Discard the initial element, which should always be ROOT_PREFIX at this point
       _root, *path = key_path.split(SEPARATOR)
 
-      # Follow the hierarchy path to the requested node and return it
+      # Follow the hierarchy path to the requested node and return it:
       # Example path => ["instance", "ssh_key", "name"]
       # Example @data => {"instance" => { "ssh_key" => { "name" => "foobar" } }}
+      #
+      # at(n) is a collection index:
+      # Example path => ["filters", "at(0)", "type"]
+      # Example data => {"filters" => [{ "type" => "instance:tag" }]}
+      #
       result = path.inject(@data) do |hash, key|
         return nil if hash.nil?
-        hash.send key
+        if (match = key.match(COLLECTION_INDEX_KEY))
+          hash[match[1].to_i]
+        else
+          hash.send key
+        end
       end
       result
     end

data/lib/attributor/example_mixin.rb

@@ -51,7 +51,7 @@ module Attributor
     end
 
     def contents
-      lazy_attributes.keys do |key|
+      lazy_attributes.keys.each do |key|
         proc = lazy_attributes.delete(key)
         @contents[key] = proc.call(self)
       end

data/lib/attributor/types/csv.rb

@@ -12,9 +12,11 @@ module Attributor
         values
       when ::Array
         values.collect { |value| member_attribute.dump(value,opts).to_s }.join(',')
+      when nil
+        nil
       else
-        context = opts[:context]
-        name =  opts[:context].last.to_s
+        context = opts[:context] || DEFAULT_ROOT_CONTEXT
+        name =  context.last.to_s
         type = values.class.name
         reason = "Attributor::CSV only supports dumping values of type " +
                  "Array or String, not #{values.class.name}."

data/lib/attributor/types/date.rb

@@ -32,7 +32,7 @@ module Attributor
       end
 
       def self.dump(value,**opts)
-        value.iso8601
+        value && value.iso8601
       end
 
     end

data/lib/attributor/types/date_time.rb

@@ -31,7 +31,7 @@ module Attributor
     end
 
     def self.dump(value,**opts)
-      value.iso8601
+      value && value.iso8601
     end
 
 

data/lib/attributor/types/hash.rb

@@ -1,6 +1,5 @@
 module Attributor
   class Hash
-    extend Forwardable
 
     MAX_EXAMPLE_DEPTH = 5
     CIRCULAR_REFERENCE_MARKER = '...'.freeze
@@ -157,7 +156,7 @@ module Attributor
 
     def self.example(context=nil, **values)
       if (key_type == Object && value_type == Object && self.keys.empty?)
-        return self.new 
+        return self.new
       end
 
       context ||= ["#{Hash}-#{rand(10000000)}"]
@@ -185,8 +184,11 @@ module Attributor
 
 
     def self.dump(value, **opts)
-      self.load(value).
-        dump(**opts)
+      if loaded = self.load(value)
+        loaded.dump(**opts)
+      else
+        nil
+      end
     end
 
 
@@ -221,10 +223,6 @@ module Attributor
       elsif value.is_a?(self)
         return value
       elsif value.kind_of?(Attributor::Hash)
-        if (value.keys - self.attributes.keys).any?
-          raise Attributor::IncompatibleTypeError, context: context, value_type: value.class, type: self
-        end
-
         loaded_value = value.contents
       elsif value.is_a?(::Hash)
         loaded_value = value
@@ -255,11 +253,17 @@ module Attributor
 
     def get(key, context: self.generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT,key))
       key = self.class.key_attribute.load(key, context)
-      
+
       value = @contents[key]
 
+      # FIXME: getting an unset value here should not force it in the hash
       if (attribute = self.class.keys[key])
-        return self[key] = attribute.load(value, context)
+        loaded_value = attribute.load(value, context)
+        if loaded_value.nil?
+          return nil
+        else
+          return self[key] = loaded_value
+        end
       end
 
       if self.class.options[:case_insensitive_load]
@@ -338,7 +342,8 @@ module Attributor
       self.keys.each do |key_name, attribute|
         next if hash.key?(key_name)
         sub_context = self.generate_subcontext(context,key_name)
-        hash[key_name] = attribute.load(nil, sub_context, recurse: recurse)
+        default = attribute.load(nil, sub_context, recurse: recurse)
+        hash[key_name] = default unless default.nil?
       end
 
       hash
@@ -379,17 +384,54 @@ module Attributor
 
     # TODO: Think about the format of the subcontexts to use: let's use .at(key.to_s)
     attr_reader :contents
-    
-    def_delegators :@contents, 
-      :[], 
-      :[]=, 
-      :each, 
-      :size, 
-      :keys, 
-      :key?, 
-      :values, 
-      :empty?, 
-      :has_key?
+
+    def [](k)
+      @contents[k]
+    end
+
+    def []=(k,v)
+      @contents[k] = v
+    end
+
+    def each(&block)
+      @contents.each(&block)
+    end
+
+    def each_pair(&block)
+      @contents.each_pair(&block)
+    end
+
+    def size
+      @contents.size
+    end
+
+    def keys
+      @contents.keys
+    end
+
+    def values
+      @contents.values
+    end
+
+    def empty?
+      @contents.empty?
+    end
+
+    def key?(k)
+      @contents.key?(k)
+    end
+    alias_method :has_key?, :key?
+
+    def merge(h)
+      case h
+      when self.class
+        self.class.new(@contents.merge(h.contents))
+      when Attributor::Hash
+        raise ArgumentError, "cannot merge Attributor::Hash instances of different types" unless h.is_a?(self.class)
+      else
+        raise TypeError, "no implicit conversion of #{h.class} into Attributor::Hash"
+      end
+    end
 
     attr_reader :validating, :dumping
 

data/lib/attributor/types/tempfile.rb

@@ -13,7 +13,7 @@ module Attributor
     end
 
     def self.dump(value, **opts)
-      value.path
+      value && value.path
     end
 
     def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)

data/lib/attributor/types/time.rb

@@ -34,7 +34,7 @@ module Attributor
     end
 
     def self.dump(value,**opts)
-      value.iso8601
+      value && value.iso8601
     end
 
 

data/lib/attributor/version.rb

@@ -1,3 +1,3 @@
 module Attributor
-  VERSION = "2.5.0"
+  VERSION = "2.6.0"
 end

data/spec/attribute_resolver_spec.rb

@@ -66,6 +66,37 @@ describe Attributor::AttributeResolver do
     end
   end
 
+  context 'querying collection indices from models' do
+    let(:instances) { [instance1, instance2] }
+    let(:instance1) { double('instance1', :ssh_key => ssh_key1) }
+    let(:instance2) { double('instance2', :ssh_key => ssh_key2) }
+    let(:ssh_key1) { double('ssh_key', :name => value) }
+    let(:ssh_key2) { double('ssh_key', :name => 'second') }
+    let(:args) { [path, prefix].compact }
+
+    before { subject.register('instances', instances) }
+
+    it 'resolves the index to the correct member of the collection' do
+      subject.query('instances').should be instances
+      subject.query('instances.at(1).ssh_key').should be ssh_key2
+      subject.query('instances.at(0).ssh_key.name').should be value
+    end
+
+    it 'returns nil for index out of range' do
+      subject.query('instances.at(2)').should be(nil)
+      subject.query('instances.at(-1)').should be(nil)
+    end
+
+    context 'with a prefix' do
+      let(:key) { 'name' }
+      let(:prefix) { '$.instances.at(0).ssh_key'}
+      let(:value) { 'some_name' }
+
+      it 'resolves the index to the correct member of the collection' do
+        subject.query(key, prefix).should be(value)
+      end
+    end
+  end
 
   context 'checking attribute conditions' do
     let(:key) { "instance.ssh_key.name" }
@@ -123,7 +154,7 @@ describe Attributor::AttributeResolver do
       end
     end
     
-    context 'with a hash condition' do
+    pending 'with a hash condition' do
     end
 
     context 'with a proc condition' do

data/spec/attribute_spec.rb

@@ -146,12 +146,21 @@ describe Attributor::Attribute do
 
       context 'for a type with a non-String native_type' do
         let(:type) { IntegerAttributeType}
-        let(:example) { /\d{5}/ }
-        it 'coerces the example value properly' do
-          example.should_receive(:gen).and_call_original
-          type.should_receive(:load).and_call_original
-
-          subject.example.should be_kind_of(type.native_type)
+        context 'using a regexp' do
+          let(:example) { /\d{5}/ }
+          it 'coerces the example value properly' do
+            example.should_receive(:gen).and_call_original
+            type.should_receive(:load).and_call_original
+  
+            subject.example.should be_kind_of(type.native_type)
+          end
+        end
+        context 'usign a native Integer type' do
+          let(:example) { 5 }
+          it 'coerces the example value properly' do
+            type.should_receive(:load).and_call_original
+            subject.example.should be_kind_of(type.native_type)
+          end          
         end
       end
     end

data/spec/types/collection_spec.rb

@@ -152,7 +152,7 @@ describe Attributor::Collection do
         it "raises error when incoming value is not of member_type" do
           expect {
             val = type.of(member_type).load(value)
-          }.to raise_error(Attributor::AttributorException)
+          }.to raise_error(Attributor::AttributorException,/Unknown key received/)
         end
 
       end

data/spec/types/csv_spec.rb

@@ -43,6 +43,10 @@ describe Attributor::CSV do
     it 'dumps non-Integer values also' do
       csv.dump(str_vals).should eq(str_vals.join(','))
     end
+    
+    it 'dumps nil values as nil' do
+      csv.dump(nil).should eq(nil)
+    end
   end
 
 end

data/spec/types/date_spec.rb

@@ -18,6 +18,11 @@ describe Attributor::Date do
     it 'is formatted correctly' do
       value.should match(/\d{4}-\d{2}-\d{2}T00:00:00\+00:00/)
     end
+    context 'nil values' do
+      it 'should be nil' do
+        type.dump(nil).should be_nil 
+      end
+    end
   end
 
 

data/spec/types/date_time_spec.rb

@@ -18,6 +18,11 @@ describe Attributor::DateTime do
     it 'is formatted correctly' do
       value.should match(/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[\+-]\d{2}:\d{2}/)
     end
+    context 'nil values' do
+      it 'should be nil' do
+        type.dump(nil).should be_nil 
+      end
+    end
   end
 
 

data/spec/types/hash_spec.rb

@@ -110,6 +110,82 @@ describe Attributor::Hash do
         end
       end
     end
+
+    context 'for another Attributor Hash with a compatible type definition' do
+      let(:other_hash) do
+        Attributor::Hash.of(key: Integer, value: Integer)
+      end
+      let(:value) { other_hash.example }
+      it 'succeeds' do
+        type.load(value)
+      end
+    end
+
+    context 'for Hash with defined keys' do
+      let(:type) do
+        Class.new(Attributor::Hash) do
+          keys do
+            key 'id', Integer
+            key 'name', String, default: "unnamed"
+            key 'chicken', Chicken
+          end
+        end
+      end
+
+      let(:value) { {'chicken' => Chicken.example} }
+
+      subject(:hash) { type.load(value) }
+
+      it { should_not have_key('id') }
+      it 'has the defaulted key' do
+        hash.should have_key('name')
+        hash['name'].should eq('unnamed')
+      end
+    end
+
+    context 'for a different Attributor Hash' do
+      let(:loader_hash) do
+        Class.new(Attributor::Hash) do
+          keys do
+            key :id, String
+            key :name, String
+          end
+        end
+      end
+      let(:value) { value_hash.example }
+      context 'with compatible key definitions' do
+        let(:value_hash) do
+          Class.new(Attributor::Hash) do
+            keys do
+              key :id, String
+            end
+          end
+        end
+
+        it 'succeeds' do
+          loader_hash.load(value)
+        end
+
+        context 'with a not compatible key definition' do
+          let(:value_hash) do
+            Class.new(Attributor::Hash) do
+              keys do
+                key :id, String
+                key :weird_key, String
+              end
+            end
+          end
+
+          it 'complains about an unknown key' do
+            expect {
+              loader_hash.load(value)
+            }.to raise_error(Attributor::AttributorException,/Unknown key received: :weird_key/)
+          end
+        end
+      end
+    end
+
+
   end
 
 
@@ -254,6 +330,9 @@ describe Attributor::Hash do
     end
 
     context 'for a typed hash' do
+      before do
+        subtype.should_receive(:dump).exactly(2).times.and_call_original
+      end
       let(:value1) { {first: "Joe", last: "Moe"} }
       let(:value2) { {first: "Mary", last: "Foe"} }
       let(:value) { { id1: subtype.new(value1), id2: subtype.new(value2) } }
@@ -268,8 +347,6 @@ describe Attributor::Hash do
       let(:type) { Attributor::Hash.of(key: String, value: subtype) }
 
       it 'returns a hash with the dumped values and keys' do
-        subtype.should_receive(:dump).exactly(2).times.and_call_original
-
         dumped_value = type.dump(value, opts)
         dumped_value.should be_kind_of(::Hash)
         dumped_value.keys.should =~ ['id1','id2']
@@ -278,6 +355,17 @@ describe Attributor::Hash do
         dumped_value['id2'].should == value2
       end
 
+      context 'that has nil attribute values' do
+        let(:value) { { id1: nil, id2: subtype.new(value2) } }
+
+        it 'correctly returns nil rather than trying to dump their contents' do
+          dumped_value = type.dump(value, opts)
+          dumped_value.should be_kind_of(::Hash)
+          dumped_value.keys.should =~ ['id1','id2']
+          dumped_value['id1'].should == nil
+          dumped_value['id2'].should == value2
+        end
+      end
     end
 
   end
@@ -593,10 +681,41 @@ describe Attributor::Hash do
 
           hash.get('foo').should be(bar)
         end
+
+        it 'does not set a key that is unset' do
+          hash.should_not have_key('id')
+          hash.get('id').should be(nil)
+          hash.should_not have_key('id')
+        end
+
       end
 
     end
 
   end
 
+  context '#merge' do
+    let(:hash_of_strings) { Attributor::Hash.of(key: String) }
+    let(:hash_of_symbols) { Attributor::Hash.of(key: Symbol) }
+
+    let(:merger) { hash_of_strings.load('a' => 1) }
+    let(:good_mergee) { hash_of_strings.load('b' => 2) }
+    let(:bad_mergee) { hash_of_symbols.load(c: 3) }
+    let(:result) { hash_of_strings.load('a' => 1, 'b' => 2) }
+
+    it 'validates that the mergee is of like type' do
+      expect { merger.merge(bad_mergee) }.to raise_error(ArgumentError)
+      expect { merger.merge({}) }.to raise_error(TypeError)
+      expect { merger.merge(nil) }.to raise_error(TypeError)
+    end
+
+    it 'returns a like-typed result' do
+      expect(merger.merge(good_mergee)).to be_a(hash_of_strings)
+    end
+
+    it 'merges' do
+      expect(merger.merge(good_mergee)).to eq(result)
+    end
+
+  end
 end

data/spec/types/model_spec.rb

@@ -172,7 +172,7 @@ describe Attributor::Model do
           expect {
             turducken = Turducken.example
             chicken = Chicken.load(turducken,context)
-          }.to raise_error(Attributor::IncompatibleTypeError, /Type Chicken cannot load values of type Turducken.*#{context.join('.')}/)
+          }.to raise_error(Attributor::AttributorException, /Unknown key received/)
         end
       end
 

data/spec/types/time_spec.rb

@@ -18,6 +18,11 @@ describe Attributor::Time do
     it 'is formatted correctly' do
       value.should match(/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[\+-]\d{2}:\d{2}/)
     end
+    context 'nil values' do
+      it 'should be nil' do
+        type.dump(nil).should be_nil 
+      end
+    end
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attributor
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie