attributor 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76667cd055dc19dfec12646bbdbf1514c90f71d9
-  data.tar.gz: 828783ff925e1a52b46fba2b2bd63c658f0cb6b6
+  metadata.gz: eaf11f67f19da1559c3abdbcebed02193ac9e5e3
+  data.tar.gz: 6ba6a1dbf45d4e2d43450036651f0d4c0fde9829
 SHA512:
-  metadata.gz: 8aa70abf93838a54751afb73020cd949ce7aa829fd6d9c679e84d8326d5b93fb2a06275b121b59a7495159b9ae40d5fdfce3d5c81d7b17c0a170eba42d9b3b66
-  data.tar.gz: 862d52a9800f01e7dd853b2b331a1e9edda95f26634ac50907e658b4cca510888f034fc8e0c69d8bca60c4b857ae3be8ac73976476a6c3e09e2c8ad6dfaa4571
+  metadata.gz: 410e51a836135f981bee0cc40aabb254c526ade79aafa224a96881dac78b8c1986ff088b33f89e80da8a0899ebc086a9ff589768130adf78ca3cb84ae7a8b350
+  data.tar.gz: 22d78b19144db5a3c19b778a6c9c32e66ce819f86d3a71dc443462ab0f4a8911345cefe193995b43897c8fd30224de0a67a7e000fa79a5b18a66586e70adbb67

data/.gitignore

@@ -15,3 +15,4 @@ doc
 .DS_Store
 
 Gemfile.lock
+pkg

data/CHANGELOG.md

@@ -1,9 +1,17 @@
 Attributor Changelog
 ============================
 
-next
+2.3.0
 ------
 
+* Added `recurse` option to `Type.load` that is used by `Model` and `Hash` to force the loading of values (specifically, so that default values are assigned) even if the loaded value is `nil`.
+* Fix `Attributor::CSV` to dump `String` values and generate `String` examples.
+* Default values of `false` now work correctly.
+* Added `BigDecimal`, `Date` and `Time` types
+* `DateTime.load` now raises `CoercionError` (instead of returning `nil`) if given values that can not coerced properly.
+* `Hash.dump` now first calls `Hash.load`, and correctly uses defined value types for dumping.
+* Added `Hash#get`, for retrieving keys using the same logic the `case_insensitive_load` and `allow_extra` with defined `extra` key.
+
 
 2.2.1
 ------
@@ -22,7 +30,7 @@ next
     * `:case_insensitive_load` for string-keyed hashes. This allows loading hashes with keys that do not exactly match the case defined in the hash.
     * Added `:allow_extras` option to allow handling of undefined keys when loading.
   * Added `Hash#set` to encapsulate the above options and attribute loading.
-  * Added `extra` command in the `keys` DSL, which lets you define a key (whose value should be a Hash), to group any unspecified keys during load. 
+  * Added `extra` command in the `keys` DSL, which lets you define a key (whose value should be a Hash), to group any unspecified keys during load.
 
 2.1.0
 ------
@@ -31,7 +39,7 @@ next
 * Add Collection subclasses for CSVs and Ids
   * CSV type for Collection of values serialized as comma-separated strings.
   * Ids type. A helper for creating CSVs with members matching a given a type's :identity option.
-* Allow instances of Models to be initialized with initial data. 
+* Allow instances of Models to be initialized with initial data.
   * Supported formats for the data are equivalent to the loading formats (i.e. ruby Hash, a JSON string or another instance of the same model type).
 * Improved context reporting in errors
   * Added contextual information while loading and dumping attributes.
@@ -39,7 +47,7 @@ next
     * `validate` takes a `context` argument that (instead of a string) is now an array of parent segments.
     * `dump` takes a `context:` option parameter of the same type
   * Enhanced error messages to report the correct context scope.
-  * Make Attribute assignments in models to report a special context (not the attributor root) 
+  * Make Attribute assignments in models to report a special context (not the attributor root)
     * Instead of reporting "$." as the context , when doing model.field_name=value, they'll now report "assignment.of(field_name)" instead
   * Truncate the length of values when reporting loading errors when they're long (i.e. >500 chars)
 * `Model.attributes` may now be called more than once to set add or replace attributes. The exact behavior depends upon the types of the attributes being added or replaced. See [model_spec.rb](spec/types/model_spec.rb) for examples.

data/lib/attributor.rb

@@ -67,16 +67,19 @@ module Attributor
 
   require_relative 'attributor/types/container'
   require_relative 'attributor/types/object'
+  require_relative 'attributor/types/bigdecimal'
   require_relative 'attributor/types/integer'
   require_relative 'attributor/types/string'
   require_relative 'attributor/types/model'
   require_relative 'attributor/types/struct'
   require_relative 'attributor/types/boolean'
+  require_relative 'attributor/types/date'
   require_relative 'attributor/types/date_time'
+  require_relative 'attributor/types/time'
   require_relative 'attributor/types/float'
   require_relative 'attributor/types/collection'
   require_relative 'attributor/types/hash'
-
+  
 
   require_relative 'attributor/types/csv'
   require_relative 'attributor/types/ids'
@@ -85,5 +88,4 @@ module Attributor
   require_relative 'attributor/types/tempfile'
   require_relative 'attributor/types/file_upload'
 
-
 end

data/lib/attributor/attribute.rb

@@ -38,11 +38,10 @@ module Attributor
 
 
     def load(value, context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
-      value = type.load(value,context,**options) unless value.nil?
+      value = type.load(value,context,**options)
 
-      # just in case type.load(value) returned nil, even though value is not nil.
       if value.nil?
-        value = self.options[:default] if self.options[:default]
+        value = self.options[:default] if self.options.key?(:default)
       end
 
       value
@@ -72,7 +71,7 @@ module Attributor
     TOP_LEVEL_OPTIONS = [ :description, :values, :default, :example, :required, :required_if ]
     INTERNAL_OPTIONS = [:dsl_compiler,:dsl_compiler_options] # Options we don't want to expose when describing attributes
     def describe(shallow=true)
-      description = { } 
+      description = { }
       # Clone the common options
       TOP_LEVEL_OPTIONS.each do |option_name|
         description[option_name] = self.options[option_name] if self.options.has_key? option_name
@@ -100,13 +99,13 @@ module Attributor
     def example(context=nil, parent: nil, values:{})
       raise ArgumentError, "attribute example cannot take a context of type String" if (context.is_a? ::String )
       if context
-        ctx = Attributor.humanize_context(context)            
+        ctx = Attributor.humanize_context(context)
         seed, _ = Digest::SHA1.digest(ctx).unpack("QQ")
         Random.srand(seed)
       end
 
       if self.options.has_key? :example
-        val = self.options[:example] 
+        val = self.options[:example]
         case val
         when ::String
           # FIXME: spec this properly to use self.type.native_type
@@ -180,7 +179,7 @@ module Attributor
 
     def validate_missing_value(context)
       raise "INVALID CONTEXT!!! (got: #{context.inspect})" unless context.is_a? Enumerable
-      
+
       # Missing attribute was required if :required option was set
       return ["Attribute #{Attributor.humanize_context(context)} is required"] if self.options[:required]
 
@@ -201,7 +200,7 @@ module Attributor
         # should never get here if the option validation worked...
         raise AttributorException.new("unknown type of dependency: #{requirement.inspect} for #{Attributor.humanize_context(context)}")
       end
-      
+
       # chop off the last part
       requirement_context = context[0..-2]
       requirement_context_string = requirement_context.join(Attributor::SEPARATOR)
@@ -257,7 +256,7 @@ module Attributor
         raise AttributorException.new("Required_if must be a String, a Hash definition or a Proc") unless definition.is_a?(::String) || definition.is_a?(::Hash) || definition.is_a?(::Proc)
         raise AttributorException.new("Required_if cannot be specified together with :required") if self.options[:required]
       when :example
-        unless definition.is_a?(::Regexp) || definition.is_a?(::String) || definition.is_a?(::Array) || definition.is_a?(::Proc) || definition.nil? || self.type.valid_type?(definition) 
+        unless definition.is_a?(::Regexp) || definition.is_a?(::String) || definition.is_a?(::Array) || definition.is_a?(::Proc) || definition.nil? || self.type.valid_type?(definition)
           raise AttributorException.new("Invalid example type (got: #{definition.class.name}). It must always match the type of the attribute (except if passing Regex that is allowed for some types)")
         end
       else

data/lib/attributor/exceptions.rb

@@ -4,9 +4,9 @@ module Attributor
 
   class LoadError < AttributorException
   end
-  
+
   class IncompatibleTypeError < LoadError
-    
+
     def initialize(type:, value_type: , context: )
       super "Type #{type} cannot load values of type #{value_type} while loading #{Attributor.humanize_context(context)}."
     end
@@ -19,18 +19,18 @@ module Attributor
       super msg
     end
   end
-  
+
   class DeserializationError < LoadError
     def initialize( context: , from:, encoding: , value: nil)
       msg = "Error deserializing a #{from} using #{encoding} while loading #{Attributor.humanize_context(context)}."
       msg += " Received value #{Attributor.errorize_value(value)}" if value
       super msg
-    end  
+    end
   end
-  
+
   class DumpError < AttributorException
     def initialize( context: , name: , type: , original_exception: )
-      msg = "Error while dumping attribute #{name} of type #{type} for context #{Attributor.humanize_context(context)} ."
+      msg = "Error while dumping attribute #{name} of type #{type} for context #{Attributor.humanize_context(context)}."
       msg << " Reason: #{original_exception}"
       super msg
     end

data/lib/attributor/extensions/randexp.rb

@@ -7,4 +7,9 @@ class Randgen
   def self.date
     return DATE_TIME_EPOCH - rand(800)
   end
+
+  def self.time
+    return date.to_time
+  end
+
 end

data/lib/attributor/types/bigdecimal.rb

@@ -0,0 +1,28 @@
+require 'bigdecimal'
+
+module Attributor
+
+  class BigDecimal
+    include Type
+
+    def self.native_type
+      return ::BigDecimal
+    end
+
+    def self.example(context=nil, **options)
+      return ::BigDecimal.new("#{/\d{3}/.gen}.#{/\d{3}/.gen}")
+    end
+
+    def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+      return nil if value.nil?
+      return value if value.is_a?(self.native_type)
+      if value.kind_of?(::Float)
+        return BigDecimal(value, 10)
+      end
+      return BigDecimal(value)
+    end
+
+  end
+
+end
+

data/lib/attributor/types/boolean.rb

@@ -16,6 +16,8 @@ module Attributor
     end
 
     def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+      return nil if value.nil?
+
       raise CoercionError, context: context, from: value.class, to: self, value: value  if value.is_a?(::Float)
       return false if [ false, 'false', 'FALSE', '0', 0, 'f', 'F' ].include?(value)
       return true if [ true, 'true', 'TRUE', '1', 1, 't', 'T' ].include?(value)

data/lib/attributor/types/collection.rb

@@ -41,10 +41,12 @@ module Attributor
     # @return An Array of native type objects conforming to the specified member_type
     def self.example(context=nil, options: {})
       result = []
-      size = rand(3) + 1
+      size = options[:size] || (rand(3) + 1)
+      size = [*size].sample if size.is_a?(Range)
+
       context ||= ["Collection-#{result.object_id}"]
       context = Array(context)
-      
+
       size.times do |i|
         subcontext = context + ["at(#{i})"]
         result << self.member_attribute.example(subcontext)
@@ -64,7 +66,7 @@ module Attributor
       elsif value.is_a?(::String)
         loaded_value = decode_string(value,context)
       else
-        raise Attributor::IncompatibleTypeError, context: context, value_type: value.class, type: self 
+        raise Attributor::IncompatibleTypeError, context: context, value_type: value.class, type: self
       end
 
       return loaded_value.collect { |member| self.member_attribute.load(member,context) }
@@ -82,7 +84,6 @@ module Attributor
     end
 
     def self.describe(shallow=false)
-      #puts "Collection: #{self.type}"      
       hash = super(shallow)
       hash[:options] = {} unless hash[:options]
       hash[:member_attribute] = self.member_attribute.describe
@@ -95,7 +96,7 @@ module Attributor
       if options.has_key?(:reference) && !member_options.has_key?(:reference)
         member_options[:reference] = options[:reference]
       end
-      
+
       # create the member_attribute, passing in our member_type and whatever constructor_block is.
       # that in turn will call construct on the type if applicable.
       @member_attribute = Attributor::Attribute.new self.member_type, member_options, &constructor_block

data/lib/attributor/types/csv.rb

@@ -6,5 +6,26 @@ module Attributor
       value.split(',')
     end
 
+    def self.dump(values, **opts)
+      case values
+      when ::String
+        values
+      when ::Array
+        values.collect { |value| member_attribute.dump(value,opts).to_s }.join(',')
+      else
+        context = opts[:context]
+        name =  opts[:context].last.to_s
+        type = values.class.name
+        reason = "Attributor::CSV only supports dumping values of type " +
+                 "Array or String, not #{values.class.name}."
+        raise DumpError.new(context: context, name: name, type: type, original_exception: reason)
+      end
+    end
+
+    def self.example(context=nil, options: {})
+      collection = super(context, options: options.merge(size: (2..4)))
+      return collection.join(',')
+    end
+
   end
 end

data/lib/attributor/types/date.rb

@@ -0,0 +1,37 @@
+require 'date'
+
+module Attributor
+
+    class Date
+      include Type
+
+      def self.native_type
+        return ::Date
+      end
+
+      def self.example(context=nil, options: {})
+        return self.load(/[:date:]/.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_date if value.respond_to?(:to_date)
+
+        case value
+        when ::String
+          begin
+            return ::Date.parse(value)
+          rescue ArgumentError => e
+            raise Attributor::DeserializationError, context: context, from: value.class, encoding: "Date" , value: value            
+          end
+        else
+          raise CoercionError, context: context, from: value.class, to: self, value: value
+        end
+      end
+
+    end
+
+  end
+

data/lib/attributor/types/date_time.rb

@@ -19,7 +19,7 @@ module Attributor
       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.is_a?(::Time)
+        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.

data/lib/attributor/types/hash.rb

@@ -119,7 +119,7 @@ module Attributor
 
       unless @concrete
         return self.of(key:self.key_type, value: self.value_type)
-          .construct(constructor_block,**options)
+        .construct(constructor_block,**options)
       end
 
       if options[:case_insensitive_load] && !(self.key_type <= String)
@@ -158,15 +158,10 @@ module Attributor
 
 
     def self.dump(value, **opts)
-      return nil if value.nil?
-
-      value.each_with_object({}) do |(k,v),hash|
-        k = key_type.dump(k,opts) if @key_type
-        v = value_type.dump(v,opts) if @value_type
-        hash[k] = v
-      end
+      self.load(value).dump(**opts)
     end
 
+
     def self.check_option!(name, definition)
       case name
       when :reference
@@ -186,9 +181,13 @@ module Attributor
     end
 
 
-    def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+    def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, recurse: false, **options)
       if value.nil?
-        return nil
+        if recurse
+          loaded_value = {}
+        else
+          return nil
+        end
       elsif value.is_a?(self)
         return value
       elsif value.kind_of?(Attributor::Hash)
@@ -201,7 +200,7 @@ module Attributor
         raise Attributor::IncompatibleTypeError, context: context, value_type: value.class, type: self
       end
 
-      return self.from_hash(loaded_value,context) if self.keys.any?
+      return self.from_hash(loaded_value,context, recurse: recurse) if self.keys.any?
       return self.new(loaded_value) if (key_type == Object && value_type == Object)
 
       loaded_value.each_with_object(self.new) do| (k, v), obj |
@@ -215,9 +214,41 @@ module Attributor
     end
 
     def generate_subcontext(context, key_name)
-      self.class.generate_sub_context(context,key_name)
+      self.class.generate_subcontext(context,key_name)
+    end
+
+    def get(key, context: self.generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT,key))
+      key = self.class.key_attribute.load(key, context)
+      value = @contents[key]
+      
+      if (attribute = self.class.keys[key])
+        return self[key] = attribute.load(value, context)
+      end
+
+      if self.class.options[:case_insensitive_load]
+        key = self.class.insensitive_map[key.downcase]
+        return self.get(key, context: context)
+      end
+
+      if self.class.options[:allow_extra]
+        if self.class.extra_keys.nil?
+          return @contents[key] = self.class.value_attribute.load(value, context)
+        else
+          extra_keys_key = self.class.extra_keys
+
+          unless @contents.key? extra_keys_key
+            extra_keys_value = self.class.keys[extra_keys_key].load({})
+            @contents[extra_keys_key] = extra_keys_value
+          end
+
+          return @contents[extra_keys_key].get(key, context: context)
+        end
+      end
+
+      raise AttributorException, "Unknown key received: #{key.inspect} for #{Attributor.humanize_context(context)}"
     end
 
+
     def set(key, value, context: self.generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT,key))
       key = self.class.key_attribute.load(key, context)
 
@@ -234,14 +265,21 @@ module Attributor
         if self.class.extra_keys.nil?
           return self[key] = self.class.value_attribute.load(value, context)
         else
-          return self[self.class.extra_keys].set(key, value, context: context)
+          extra_keys_key = self.class.extra_keys
+
+          unless @contents.key? extra_keys_key
+            extra_keys_value = self.class.keys[extra_keys_key].load({})
+            @contents[extra_keys_key] = extra_keys_value
+          end
+
+          return self[extra_keys_key].set(key, value, context: context)
         end
       end
 
       raise AttributorException, "Unknown key received: #{key.inspect} while loading #{Attributor.humanize_context(context)}"
     end
 
-    def self.from_hash(object,context)
+    def self.from_hash(object,context, recurse: false)
       hash = self.new
 
       # if the hash definition includes named extra keys, initialize
@@ -265,7 +303,7 @@ 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)
+        hash[key_name] = attribute.load(nil, sub_context, recurse: recurse)
       end
 
       hash
@@ -374,9 +412,17 @@ module Attributor
       end
     end
 
-    def dump(*args)
-      @contents.each_with_object(::Hash.new) do |(k,v), hash|
-        hash[k] = self.class.value_type.dump(v)
+    def dump(**opts)
+      @contents.each_with_object({}) do |(k,v),hash|
+        k = self.key_attribute.dump(k,opts)
+        
+        if (attribute_for_value = self.class.keys[k])
+          v = attribute_for_value.dump(v,opts)
+        else
+          v = self.value_attribute.dump(v,opts)
+        end
+
+        hash[k] = v
       end
     end