attributor 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e832c8023013ffad5fa5a40e13200e5dcfeb4c4
-  data.tar.gz: a1d2a7043187872b6cdc424b503b8ce08a5935ab
+  metadata.gz: 6b7e1ce2db7e093c7a3073db2cea1d45b861f015
+  data.tar.gz: f3623a6d5e3b313b9493cba77a6e7a7b250d1de5
 SHA512:
-  metadata.gz: 26f1bd976df8c4ad47ea3e617e2abdcabd7d6d070a82dce44abb2e16ededcae6289ca7e074ba503f9ee7f6f4e79036bb49078509c2812f63ca02d3eab190466e
-  data.tar.gz: ee7b663e6d9095d2909f355cf0f78e76d0cc5e6c8c0a2b0f44338fed5776a9a36360aba0b81f9a2b7ac532b88c2b8e7c8168187503405ed1b8cff1a82fc36cbd
+  metadata.gz: 625ac84d1636b6d21044c69d8be170bae210b28f302c2ed78de5b3130e1d82e760ee65c68a6b9f0c614e06b8a2a4770ab26da92a6b5917d847a1a02a73bdb522
+  data.tar.gz: f7c4324913a80c92191c9bc6f46ced3d5f7e9f01758faea751c79254b24e547f68b88ce836c446523cd759e2c35d4ca04778b7c033787878b5f75e88b77d7046

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 Attributor Changelog
 ============================
 
+next
+----
+
+2.5.0
+----
+
+* Partial support for defining `:default` values through Procs.
+  * Note: this is only "partially" supported the `parent` argument of the Proc will NOT contain the correct attribute parent yet. It will contain a fake class, that will loudly complain about any attempt to use any of its methods.
+* Fixed `Model.example` to properly handle the case when no attributes are defined on the class.
+* `Model#dump` now issues a warning if its contents have keys for attributes not present on the class. The unknown contents are not dumped.
+* `Hash.load` now supports loading any value that responds to `to_hash`.
+* `Time`, `DateTime`, and `Date` now all return ISO 8601 formatted values from `.dump` (via calling `iso8601` on the value).
+* Added `Type.id`, a unique value based on the type's class name.
+
 2.4.0
 ------
 

data/attributor.gemspec

@@ -8,7 +8,6 @@ Gem::Specification.new do |spec|
   spec.name = "attributor"
   spec.version       = Attributor::VERSION
   spec.authors = ["Josep M. Blanquer","Dane Jensen"]
-  spec.date = "2014-08-15"
   spec.summary = "A powerful attribute and type management library for Ruby"
   spec.email = ["blanquer@gmail.com","dane.jensen@gmail.com"]
   

data/lib/attributor/attribute.rb

@@ -2,6 +2,19 @@
 
 module Attributor
 
+  class FakeParent < ::BasicObject
+    
+    def method_missing(name, *args)
+      ::Kernel.warn "Warning, you have tried to access the '#{name}' method of the 'parent' argument of a Proc-defined :default values." +
+                    "Those Procs should completely ignore the 'parent' attribute for the moment as it will be set to an " +
+                    "instance of a useless class (until the framework can provide such functionality)"
+      nil
+    end
+    
+    def class
+      FakeParent
+    end
+  end
   # It is the abstract base class to hold an attribute, both a leaf and a container (hash/Array...)
   # TODO: should this be a mixin since it is an abstract class?
   class Attribute
@@ -40,8 +53,23 @@ module Attributor
     def load(value, context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
       value = type.load(value,context,**options)
 
-      if value.nil?
-        value = self.options[:default] if self.options.key?(:default)
+      if value.nil? && self.options.has_key?(:default)
+        defined_val = self.options[:default]
+        val = case defined_val
+        when ::Proc
+          fake_parent = FakeParent.new
+          # TODO: we can only support "context" as a parameter to the proc for now, since we don't have the parent...
+          if defined_val.arity == 2
+            defined_val.call(fake_parent, context)
+          elsif defined_val.arity == 1
+            defined_val.call(fake_parent)
+          else
+            defined_val.call
+          end
+        else
+            defined_val
+        end
+        value = val #Need to load?
       end
 
       value

data/lib/attributor/type.rb

@@ -107,9 +107,17 @@ module Attributor
       # Default describe for simple types...only their name (stripping the base attributor module)
       def describe(root=false)
         type_name = self.ancestors.find { |k| k.name && !k.name.empty? }.name
-        { :name => type_name.gsub( Attributor::MODULE_PREFIX_REGEX, '' ) }        
+        {
+          name: type_name.gsub(Attributor::MODULE_PREFIX_REGEX, ''),
+          id: self.id
+        }
       end
       
+      def id
+        return nil if self.name.nil?
+        self.name.gsub('::'.freeze,'-'.freeze)
+      end
+
     end
   end
 end

data/lib/attributor/types/date.rb

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

data/lib/attributor/types/date_time.rb

@@ -5,32 +5,36 @@ require 'date'
 
 module Attributor
 
-    class DateTime
-      include Type
+  class DateTime
+    include Type
 
-      def self.native_type
-        return ::DateTime
-      end
+    def self.native_type
+      return ::DateTime
+    end
 
-      def self.example(context=nil, options: {})
-        return self.load(/[:date:]/.gen, context)
-      end
+    def self.example(context=nil, options: {})
+      return self.load(/[:date:]/.gen, context)
+    end
 
-      def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
-        # We assume that if the value is already in the right type, we've decoded it already
-        return value if value.is_a?(self.native_type)
-        return value.to_datetime if value.respond_to?(:to_datetime)
-        return nil unless value.is_a?(::String)
-        # TODO: we should be able to convert not only from String but Time...etc
-        # Else, we'll decode it from String.
-        begin
-          return ::DateTime.parse(value)
-        rescue ArgumentError => e
-          raise Attributor::DeserializationError, context: context, from: value.class, encoding: "DateTime" , value: value            
-        end
+    def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+      # We assume that if the value is already in the right type, we've decoded it already
+      return value if value.is_a?(self.native_type)
+      return value.to_datetime if value.respond_to?(:to_datetime)
+      return nil unless value.is_a?(::String)
+      # TODO: we should be able to convert not only from String but Time...etc
+      # Else, we'll decode it from String.
+      begin
+        return ::DateTime.parse(value)
+      rescue ArgumentError => e
+        raise Attributor::DeserializationError, context: context, from: value.class, encoding: "DateTime" , value: value
       end
+    end
 
+    def self.dump(value,**opts)
+      value.iso8601
     end
 
+
   end
 
+end

data/lib/attributor/types/hash.rb

@@ -230,6 +230,8 @@ module Attributor
         loaded_value = value
       elsif value.is_a?(::String)
         loaded_value = decode_json(value,context)
+      elsif value.respond_to?(:to_hash)
+        loaded_value = value.to_hash
       else
         raise Attributor::IncompatibleTypeError, context: context, value_type: value.class, type: self
       end

data/lib/attributor/types/model.rb

@@ -92,6 +92,21 @@ module Attributor
       context + [subname] 
     end
 
+    def self.example(context=nil, **values)
+      context ||= ["#{self.name || 'Struct'}-#{rand(10000000)}"]
+      context = Array(context)
+
+      if self.keys.any?
+        result = self.new
+        result.extend(ExampleMixin)
+
+        result.lazy_attributes = self.example_contents(context, result, values)
+      else
+        result = self.new
+      end
+      result
+    end
+
     def initialize(data = nil)
       if data
         loaded = self.class.load(data)
@@ -161,6 +176,13 @@ module Attributor
 
       self.attributes.each_with_object({}) do |(name, value), result|
         attribute = self.class.attributes[name]
+        
+        # skip dumping undefined attributes
+        unless attribute
+          warn "WARNING: Trying to dump unknown attribute: #{name.inspect} with context: #{context.inspect}"
+          next
+        end
+
         result[name.to_sym] = attribute.dump(value, context: context + [name] )
       end
     ensure

data/lib/attributor/types/time.rb

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

data/lib/attributor/version.rb

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

data/spec/attribute_spec.rb

@@ -43,7 +43,7 @@ describe Attributor::Attribute do
   context 'describe' do
     let(:attribute_options) { {:required => true, :values => ["one"], :description => "something", :min => 0} }
     let(:expected) do
-      h = {:type => {:name => type.name} }
+      h = {type: {name: type.name, id: type.id}}
       common = attribute_options.select{|k,v| Attributor::Attribute::TOP_LEVEL_OPTIONS.include? k }
       h.merge!( common )
       h[:options] = {:min => 0 }
@@ -237,23 +237,56 @@ describe Attributor::Attribute do
     end
 
     context 'applying default values' do
+      let(:value) { nil }
       let(:default_value) { "default value" }
       let(:attribute_options) { {:default => default_value} }
 
       subject(:result) { attribute.load(value) }
 
       context 'for nil' do
-        let(:value) { nil }
         it { should == default_value}
       end
 
       context 'for false' do
         let(:type) { Attributor::Boolean }
         let(:default_value) { false }
-        let(:value) { nil }
         it { should == default_value}
 
       end
+      
+      context 'for a Proc-based default value' do
+        let(:context){ ["$"] }
+        subject(:result){ attribute.load(value,context) }
+
+
+        context 'with no arguments arguments' do
+          let(:default_value) { proc { "no_params" } }
+          it { should == default_value.call }
+        end
+        
+        context 'with 1 argument (the parent)' do
+          let(:default_value) { proc {|parent| "parent is fake: #{parent.class}" } }
+          it { should == "parent is fake: Attributor::FakeParent" }
+        end
+        
+        context 'with 2 argument (the parent and the contents)' do
+          let(:default_value) { proc {|parent,context| "parent is fake: #{parent.class} and context is: #{context}" } }
+          it { should == "parent is fake: Attributor::FakeParent and context is: [\"$\"]"}
+        end
+        
+        context 'which attempts to use the parent (which is not supported for the moment)' do
+          let(:default_value) { proc {|parent| "any parent method should spit out warning: [#{parent.something}]" } }
+          it "should output a warning" do
+            begin 
+              old_verbose, $VERBOSE = $VERBOSE, nil
+              Kernel.should_receive(:warn).and_call_original
+              attribute.load(value,context).should == "any parent method should spit out warning: []"
+            ensure
+              $VERBOSE = old_verbose
+            end
+          end
+        end
+      end
     end
 
     context 'validating a value' do

data/spec/type_spec.rb

@@ -3,7 +3,6 @@ require File.join(File.dirname(__FILE__), 'spec_helper.rb')
 
 describe Attributor::Type do
 
-
   subject(:test_type) { AttributeType }
 
   let(:attribute_options) { Hash.new }
@@ -17,6 +16,7 @@ describe Attributor::Type do
 
 
   its(:native_type) { should be(::String) }
+  its(:id) { should eq('AttributeType')}
 
 
   context 'load' do
@@ -123,12 +123,25 @@ describe Attributor::Type do
 
   end
 
+  context 'id' do
+    it 'works for built-in types' do
+      Attributor::String.id.should eq('Attributor-String')
+    end
+
+    it 'returns nil for anonymous types' do
+      type = Class.new(Attributor::Model)
+      type.id.should eq(nil)
+    end
+  end
+
   context 'describe' do
     subject(:description) { test_type.describe }
     it 'outputs the type name' do
-      description[:name].should == test_type.name
+      description[:name].should eq(test_type.name)
+    end
+    it 'outputs the type id' do
+      description[:id].should eq(test_type.name)
     end
-
   end
 
 end

data/spec/types/date_spec.rb

@@ -12,6 +12,15 @@ describe Attributor::Date do
     its(:example) { should be_a(::Date) }
   end
 
+  context '.dump' do
+    let(:example) { type.example}
+    subject(:value) { type.dump(example) }
+    it 'is formatted correctly' do
+      value.should match(/\d{4}-\d{2}-\d{2}T00:00:00\+00:00/)
+    end
+  end
+
+
   context '.load' do
 
     it 'returns nil for nil' do

data/spec/types/date_time_spec.rb

@@ -12,6 +12,15 @@ describe Attributor::DateTime do
     its(:example) { should be_a(::DateTime) }
   end
 
+  context '.dump' do
+    let(:example) { type.example}
+    subject(:value) { type.dump(example) }
+    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
+  end
+
+
   context '.load' do
 
     it 'returns nil for nil' do

data/spec/types/hash_spec.rb

@@ -343,8 +343,8 @@ describe Attributor::Hash do
     context 'for hashes with key and value types' do
       it 'describes the type correctly' do
         description[:name].should eq('Hash')
-        description[:key].should eq(type:{name: 'Object'})
-        description[:value].should eq(type:{name: 'Object'})
+        description[:key].should eq(type:{name: 'Object', id: 'Attributor-Object'})
+        description[:value].should eq(type:{name: 'Object', id: 'Attributor-Object'})
       end
     end
 
@@ -362,15 +362,15 @@ describe Attributor::Hash do
 
       it 'describes the type correctly' do
         description[:name].should eq('Hash')
-        description[:key].should eq(type:{name: 'String'})
+        description[:key].should eq(type:{name: 'String', id: 'Attributor-String'})
         description.should_not have_key(:value)
 
         keys = description[:keys]
 
-        keys['a string'].should eq(type: {name: 'String'} )
-        keys['1'].should eq(type: {name: 'Integer'}, options: {min: 1, max: 20}  )
-        keys['some_date'].should eq(type: {name: 'DateTime' }) #
-        keys['defaulted'].should eq(type: {name: 'String'}, default: 'default value')
+        keys['a string'].should eq(type: {name: 'String', id: 'Attributor-String'} )
+        keys['1'].should eq(type: {name: 'Integer', id: 'Attributor-Integer'}, options: {min: 1, max: 20}  )
+        keys['some_date'].should eq(type: {name: 'DateTime', id: 'Attributor-DateTime'})
+        keys['defaulted'].should eq(type: {name: 'String', id: 'Attributor-String'}, default: 'default value')
       end
     end
   end

data/spec/types/model_spec.rb

@@ -416,6 +416,22 @@ describe Attributor::Model do
 
   end
 
+  context 'with no defined attributes' do
+    let(:model_class) do
+      Class.new(Attributor::Model) do
+        attributes do
+        end
+      end
+    end
 
+    subject(:example) { model_class.example }
+
+    its(:attributes) { should be_empty }
+    
+    it 'dumps as an empty hash' do 
+      example.dump.should eq({})
+    end
+
+  end
 
 end

data/spec/types/time_spec.rb

@@ -12,6 +12,15 @@ describe Attributor::Time do
     its(:example) { should be_a(::Time) }
   end
 
+  context '.dump' do
+    let(:example) { type.example}
+    subject(:value) { type.dump(example) }
+    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
+  end
+
+
   context '.load' do
 
     it 'returns nil for nil' do

metadata

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