attributor 3.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9b60ce0b5ac69797dca8bc43ce9164e8a666eeb
-  data.tar.gz: d87a417b41105b3ed4ae10098bd14542d88d7f96
+  metadata.gz: bff0810c57451a4f93b1f23d7bbdc947757ee3ab
+  data.tar.gz: 4017dd9949a54d8d6e14aa5c11aff80aac0f0358
 SHA512:
-  metadata.gz: 660346014295ff874c70f0cc79931b98c109c0034e1b235f516108aa5857fa71688a2a2fcd7aab8c9636c91b87a64d1b82d09ae1a7d247b0bf7a23cf232a80d2
-  data.tar.gz: 174c4d2859d2ad0611c55b3c16c70eaa80440fcdee5308fe84a917192d624383e65bfae19c5bd593732ac59ba0d13d908e4c018406f0256fe0f1c30864911fc1
+  metadata.gz: a8f0a4e9ac2a34d486c5ccd83da33cc8ba073e91ae82c747d01de08652e3b4f7705fc5efad274edafa2f55599b3b7f479a63552ae596854d4e8ba295513dd596
+  data.tar.gz: 2eb0699f1d50de06159e9cd65a8e824804c1be0175384f597cf31c18dc7b438beca565fbe33d2b80a23ffff655d2fb7255d3d5ff28d2d415db12ee5a64fe5cc0

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Attributor Changelog
 
+## next
+
+
+## 3.0.1
+
+* Fixed bug with example Hashes where `[]` with a key not in the hash would throw a `NoMethodError`.
+* Fixed bug in `Hash#get` for Hashes without predefined keys. It would throw an error if given a key not present in the hash's contents.
+
+
 ## 3.0.0
 
 * Small enhancements on `describe` for types

data/lib/attributor.rb

@@ -44,6 +44,12 @@ module Attributor
     klass
   end
 
+  def self.type_name(type)
+    return self.type_name(type.class) unless type.kind_of?(Class)
+
+    type.ancestors.find { |k| k.name && !k.name.empty? }.name
+  end
+
   def self.humanize_context( context )
     return "" unless context
 

data/lib/attributor/attribute.rb

@@ -42,15 +42,15 @@ module Attributor
     end
 
 
-    def parse(value, context=Attributor::DEFAULT_ROOT_CONTEXT)
-      object = self.load(value,context)
+   def parse(value, context=Attributor::DEFAULT_ROOT_CONTEXT)
+     object = self.load(value,context)
 
-      errors = self.validate(object,context)
-      [ object, errors ]
-    end
+     errors = self.validate(object,context)
+     [ object, errors ]
+   end
 
 
-    def load(value, context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+    def load(value, context=Attributor::DEFAULT_ROOT_CONTEXT,  **options)
       value = type.load(value,context,**options)
 
       if value.nil? && self.options.has_key?(:default)
@@ -98,7 +98,8 @@ module Attributor
 
     TOP_LEVEL_OPTIONS = [ :description, :values, :default, :example, :required, :required_if, :custom_data ]
     INTERNAL_OPTIONS = [:dsl_compiler,:dsl_compiler_options] # Options we don't want to expose when describing attributes
-    def describe(shallow=true, example: nil )
+
+    def describe(shallow=true, example: nil)
       description = { }
       # Clone the common options
       TOP_LEVEL_OPTIONS.each do |option_name|

data/lib/attributor/example_mixin.rb

@@ -25,8 +25,9 @@ module Attributor
 
     def [](k)
       unless @contents.key?(k)
-        proc = lazy_attributes.delete k
-        @contents[k] = proc.call
+        if (proc = lazy_attributes.delete k)
+          @contents[k] = proc.call
+        end
       end
       @contents[k]
     end

data/lib/attributor/type.rb

@@ -106,7 +106,7 @@ module Attributor
 
       # Default describe for simple types...only their name (stripping the base attributor module)
       def describe(root=false, example: nil)
-        type_name = self.ancestors.find { |k| k.name && !k.name.empty? }.name
+        type_name = Attributor.type_name(self)
         hash = {
           name: type_name.gsub(Attributor::MODULE_PREFIX_REGEX, ''),
           family: self.family,

data/lib/attributor/types/collection.rb

@@ -53,6 +53,7 @@ module Attributor
     def self.member_attribute
       @member_attribute ||= begin
         self.construct(nil,{})
+        
         @member_attribute
       end
     end
@@ -153,22 +154,15 @@ module Attributor
       :ok
     end
 
-    # @param values [Array] Array of values to validate
-    def self.validate(values, context=Attributor::DEFAULT_ROOT_CONTEXT, attribute=nil)
+    # @param object [Collection] Collection instance to validate.
+    def self.validate(object, context=Attributor::DEFAULT_ROOT_CONTEXT, attribute=nil)
+      context = [context] if context.is_a? ::String
 
-      unless self.valid_type?(values)
-        descriptive_type =if self.member_type != Object
-          "Collection.of(#{self.member_type})"
-        else
-          self
-        end
-        raise Attributor::IncompatibleTypeError, context: context, value_type: values.class, type: descriptive_type
+      unless object.kind_of?(self)
+        raise ArgumentError, "#{self.name} can not validate object of type #{object.class.name} for #{Attributor.humanize_context(context)}."
       end
 
-      values.each_with_index.collect do |value, i|
-        subcontext = context + ["at(#{i})"]
-        self.member_attribute.validate(value, subcontext)
-      end.flatten.compact
+      object.validate(context)
     end
 
     def self.validate_options( value, context, attribute )
@@ -177,6 +171,14 @@ module Attributor
     end
 
 
+    def validate(context=Attributor::DEFAULT_ROOT_CONTEXT)
+      self.each_with_index.collect do |value, i|
+        subcontext = context + ["at(#{i})"]
+        self.class.member_attribute.validate(value, subcontext)
+      end.flatten.compact
+    end
+
+
     def dump(**opts)
       self.collect { |value| self.class.member_attribute.dump(value,opts) }
     end

data/lib/attributor/types/hash.rb

@@ -245,7 +245,7 @@ module Attributor
     end
 
 
-    def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, recurse: false, **options)
+    def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, recurse: false,  **options)
       context = Array(context)
 
       if value.nil?
@@ -288,6 +288,24 @@ module Attributor
     def get(key, context: self.generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT,key))
       key = self.class.key_attribute.load(key, context)
 
+      if self.class.keys.empty?
+        if @contents.key? key
+          value = @contents[key]
+          loaded_value = value_attribute.load(value, context)
+          return self[key] = loaded_value
+        else
+          if self.class.options[:case_insensitive_load]
+            key = key.downcase
+            @contents.each do |k,v|
+              if key == k.downcase
+                return self.get(key, context: context)
+              end
+            end
+          end
+        end
+        return nil
+      end
+
       value = @contents[key]
 
       # FIXME: getting an unset value here should not force it in the hash
@@ -318,6 +336,7 @@ module Attributor
         end
       end
 
+
       raise AttributorException, "Unknown key received: #{key.inspect} for #{Attributor.humanize_context(context)}"
     end
 
@@ -325,6 +344,10 @@ module Attributor
     def set(key, value, context: self.generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT,key), recurse: false)
       key = self.class.key_attribute.load(key, context)
 
+      if self.class.keys.empty?
+        return self[key] = self.class.value_attribute.load(value, context)
+      end
+
       if (attribute = self.class.keys[key])
         return self[key] = attribute.load(value, context, recurse: recurse)
       end
@@ -541,10 +564,9 @@ module Attributor
 
     def dump(**opts)
       return CIRCULAR_REFERENCE_MARKER if @dumping
-
       @dumping = true
 
-      @contents.each_with_object({}) do |(k,v),hash|
+      contents.each_with_object({}) do |(k,v),hash|
         k = self.key_attribute.dump(k,opts)
 
         if (attribute_for_value = self.class.keys[k])

data/lib/attributor/types/model.rb

@@ -177,7 +177,7 @@ module Attributor
       return CIRCULAR_REFERENCE_MARKER if @dumping
       @dumping = true
 
-      self.attributes.each_with_object({}) do |(name, value), result|
+      self.attributes.each_with_object({}) do |(name, value), hash|
         attribute = self.class.attributes[name]
 
         # skip dumping undefined attributes
@@ -186,7 +186,7 @@ module Attributor
           next
         end
 
-        result[name.to_sym] = attribute.dump(value, context: context + [name] )
+        hash[name.to_sym] = attribute.dump(value, context: context + [name] )
       end
     ensure
       @dumping = false

data/lib/attributor/types/tempfile.rb

@@ -9,11 +9,15 @@ module Attributor
     end
 
     def self.example(context=Attributor::DEFAULT_ROOT_CONTEXT, options:{})
-      ::Tempfile.new(Attributor.humanize_context(context))
+      file = ::Tempfile.new(Attributor.humanize_context(context))
+      file.write /[:sentence:]/.gen
+      file.write '.'
+      file.rewind
+      file
     end
 
     def self.dump(value, **opts)
-      value && value.path
+      value && value.read
     end
 
     def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)

data/lib/attributor/version.rb

@@ -1,3 +1,3 @@
 module Attributor
-  VERSION = "3.0"
+  VERSION = "3.0.1"
 end

data/spec/attribute_spec.rb

@@ -690,13 +690,12 @@ describe Attributor::Attribute do
         end
 
         it 'validates' do
-          errors = attribute.validate(values)
-          errors.should_not be_empty
-          errors[0].should =~ /of the wrong type/
-          errors[1].should =~ /value \(12\) is larger/
-        end
-
+          object = attribute.load(values)
+          errors = attribute.validate(object)
 
+          errors.should have(1).item
+          errors[0].should =~ /value \(12\) is larger/
+        end
       end
 
 

data/spec/attributor_spec.rb

@@ -39,4 +39,25 @@ describe Attributor do
     end
 
   end
+
+
+  context '.type_name' do
+    it 'accepts arbtirary classes' do
+      Attributor.type_name(File).should eq 'File'
+    end
+
+    it 'accepts instances' do
+      Attributor.type_name('a string').should eq 'String'
+    end
+
+    it 'accepts instances of anonymous types' do
+      type = Class.new(Attributor::Struct) 
+      Attributor.type_name(type).should eq 'Attributor::Struct'
+    end
+
+    it 'accepts Attributor types' do
+      Attributor.type_name(Attributor::String).should eq 'Attributor::String'
+    end
+    
+  end
 end

data/spec/types/collection_spec.rb

@@ -253,6 +253,8 @@ describe Attributor::Collection do
       let(:collection_members) { [1, 2, 'three'] }
       let(:expected_errors) { ["error 1", "error 2", "error 3"]}
 
+      let(:value) { type.load(collection_members) }
+
       before do
         collection_members.zip(expected_errors).each do |member, expected_error|
           type.member_attribute.should_receive(:validate).
@@ -262,7 +264,7 @@ describe Attributor::Collection do
       end
 
       it 'validates members' do
-        type.validate(collection_members).should =~ expected_errors
+        type.validate(value).should =~ expected_errors
       end
     end
     context 'invalid incoming types' do
@@ -270,7 +272,7 @@ describe Attributor::Collection do
       it 'raise an exception' do
         expect {
           type.validate('invalid_value')
-        }.to raise_error(Attributor::IncompatibleTypeError, /cannot load values of type String/)
+        }.to raise_error(ArgumentError, /can not validate object of type String/)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attributor
 version: !ruby/object:Gem::Version
-  version: '3.0'
+  version: 3.0.1
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie