attributor 5.1.0 → 5.5

data/lib/attributor/types/bigdecimal.rb

@@ -1,13 +1,14 @@
 require 'bigdecimal'
 
 module Attributor
-  class BigDecimal < Numeric
+  class BigDecimal 
+    include Numeric
     def self.native_type
       ::BigDecimal
     end
 
     def self.example(_context = nil, options: {})
-      ::BigDecimal.new("#{/\d{3}/.gen}.#{/\d{3}/.gen}")
+      BigDecimal("#{/\d{3}/.gen}.#{/\d{3}/.gen}")
     end
 
     def self.load(value, _context = Attributor::DEFAULT_ROOT_CONTEXT, **_options)
@@ -16,5 +17,9 @@ module Attributor
       return BigDecimal(value, 10) if value.is_a?(::Float)
       BigDecimal(value)
     end
+
+    def self.json_schema_type
+      :number
+    end
   end
 end

data/lib/attributor/types/boolean.rb

@@ -17,14 +17,19 @@ module Attributor
     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)
+      raise CoercionError.new(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)
-      raise CoercionError, context: context, from: value.class, to: self
+      raise CoercionError.new(context: context, from: value.class, to: self)
     end
 
     def self.family
       'boolean'
     end
+
+    def self.json_schema_type
+      :boolean
+    end
+
   end
 end

data/lib/attributor/types/class.rb

@@ -1,4 +1,4 @@
-require 'active_support'
+require 'active_support/core_ext/string/inflections'
 
 require_relative '../exceptions'
 
@@ -16,7 +16,7 @@ module Attributor
 
       # Must be given a String object or nil
       unless value.is_a?(::String) || value.nil?
-        raise IncompatibleTypeError,  context: context, value_type: value.class, type: self
+        raise IncompatibleTypeError.new(context: context, value_type: value.class, type: self)
       end
 
       value = '::' + value if value[0..1] != '::'

data/lib/attributor/types/collection.rb

@@ -51,7 +51,7 @@ module Attributor
 
     def self.member_attribute
       @member_attribute ||= begin
-        construct(nil, {})
+        construct(nil)
 
         @member_attribute
       end
@@ -59,6 +59,7 @@ module Attributor
 
     # generates an example Collection
     # @return An Array of native type objects conforming to the specified member_type
+    # TODO:  ALLOW to pass  "values" for the members?...as values: {id: 1, ...}
     def self.example(context = nil, options: {})
       result = []
       size = options[:size] || (rand(3) + 1)
@@ -90,7 +91,7 @@ module Attributor
       elsif value.respond_to?(:to_a)
         loaded_value = value.to_a
       else
-        raise Attributor::IncompatibleTypeError, context: context, value_type: value.class, type: self
+        raise Attributor::IncompatibleTypeError.new(context: context, value_type: value.class, type: self)
       end
 
       new(loaded_value.collect { |member| member_attribute.load(member, context) })
@@ -102,7 +103,7 @@ module Attributor
 
     def self.dump(values, **opts)
       return nil if values.nil?
-      values.collect { |value| member_attribute.dump(value, opts) }
+      values.collect { |value| member_attribute.dump(value, **opts) }
     end
 
     def self.describe(shallow = false, example: nil)
@@ -116,11 +117,27 @@ module Attributor
       hash
     end
 
+    def self.json_schema_type
+      :array
+    end
+
+    def self.as_json_schema( shallow: false, example: nil, attribute_options: {} )
+      hash = super
+      opts = self.options.merge( attribute_options )
+      hash[:description] = opts[:description] if opts[:description]
+      hash[:default] = opts[:default] if opts[:default]
+
+      #hash[:examples] = [ example.dump ] if example
+      member_example = example && example.first
+      hash[:items] = member_attribute.as_json_schema(example: member_example)
+      hash
+    end
+
     def self.constructable?
       true
     end
 
-    def self.construct(constructor_block, options)
+    def self.construct(constructor_block, **options)
       member_options = (options[:member_options] || {}).clone
       if options.key?(:reference) && !member_options.key?(:reference)
         member_options[:reference] = options[:reference]
@@ -172,7 +189,7 @@ module Attributor
     end
 
     def dump(**opts)
-      collect { |value| self.class.member_attribute.dump(value, opts) }
+      collect { |value| self.class.member_attribute.dump(value, **opts) }
     end
   end
 end

data/lib/attributor/types/container.rb

@@ -19,17 +19,17 @@ module Attributor
       # @return [Array] a normal Ruby Array
       #
       def decode_json(value, context = Attributor::DEFAULT_ROOT_CONTEXT)
-        raise Attributor::DeserializationError, context: context, from: value.class, encoding: 'JSON', value: value unless value.is_a? ::String
+        raise Attributor::DeserializationError.new(context: context, from: value.class, encoding: 'JSON', value: value) unless value.is_a? ::String
 
         # attempt to parse as JSON
         parsed_value = JSON.parse(value)
         unless valid_type?(parsed_value)
-          raise Attributor::CoercionError, context: context, from: parsed_value.class, to: name, value: parsed_value
+          raise Attributor::CoercionError.new(context: context, from: parsed_value.class, to: name, value: parsed_value)
         end
 
         parsed_value
       rescue JSON::JSONError
-        raise Attributor::DeserializationError, context: context, from: value.class, encoding: 'JSON', value: value
+        raise Attributor::DeserializationError.new(context: context, from: value.class, encoding: 'JSON', value: value)
       end
     end
   end

data/lib/attributor/types/csv.rb

@@ -9,7 +9,7 @@ module Attributor
       when ::String
         values
       when ::Array
-        values.collect { |value| member_attribute.dump(value, opts).to_s }.join(',')
+        values.collect { |value| member_attribute.dump(value, **opts).to_s }.join(',')
       when nil
         nil
       else
@@ -37,5 +37,9 @@ module Attributor
     def self.family
       Collection.family
     end
+
+    def self.json_schema_type
+      :string
+    end
   end
 end

data/lib/attributor/types/date.rb

@@ -1,7 +1,9 @@
 require 'date'
 
 module Attributor
-  class Date < Temporal
+  class Date
+    include Temporal
+
     def self.native_type
       ::Date
     end
@@ -21,11 +23,15 @@ module Attributor
         begin
           return ::Date.parse(value)
         rescue ArgumentError
-          raise Attributor::DeserializationError, context: context, from: value.class, encoding: 'Date', value: value
+          raise Attributor::DeserializationError.new(context: context, from: value.class, encoding: 'Date', value: value)
         end
       else
-        raise CoercionError, context: context, from: value.class, to: self, value: value
+        raise CoercionError.new(context: context, from: value.class, to: self, value: value)
       end
     end
+
+    def self.json_schema_string_format
+      :date
+    end
   end
 end

data/lib/attributor/types/date_time.rb

@@ -5,7 +5,9 @@ require_relative '../exceptions'
 require 'date'
 
 module Attributor
-  class DateTime < Temporal
+  class DateTime
+    include Temporal
+
     def self.native_type
       ::DateTime
     end
@@ -24,8 +26,12 @@ module Attributor
       begin
         return ::DateTime.parse(value)
       rescue ArgumentError
-        raise Attributor::DeserializationError, context: context, from: value.class, encoding: 'DateTime', value: value
+        raise Attributor::DeserializationError.new(context: context, from: value.class, encoding: 'DateTime', value: value)
       end
     end
+
+    def self.json_schema_string_format
+      :'date-time'
+    end
   end
 end

data/lib/attributor/types/float.rb

@@ -2,8 +2,9 @@
 # See: http://ruby-doc.org/core-2.1.0/Float.html
 
 module Attributor
+
   class Float
-    include Type
+    include Numeric
 
     def self.native_type
       ::Float
@@ -22,8 +23,8 @@ module Attributor
       super
     end
 
-    def self.family
-      'numeric'
+    def self.json_schema_type
+      :number
     end
   end
 end

data/lib/attributor/types/hash.rb

@@ -16,7 +16,7 @@ module Attributor
   end
 
   class Hash
-    MAX_EXAMPLE_DEPTH = 5
+    MAX_EXAMPLE_DEPTH = 10
     CIRCULAR_REFERENCE_MARKER = '...'.freeze
 
     include Container
@@ -82,7 +82,7 @@ module Attributor
     def self.attributes(**options, &key_spec)
       raise @error if @error
 
-      keys(options, &key_spec)
+      keys(**options, &key_spec)
     end
 
     def self.keys(**options, &key_spec)
@@ -97,6 +97,13 @@ module Attributor
       @keys
     end
 
+    def self.requirements
+      if @saved_blocks.any?
+        definition
+      end
+      @requirements
+    end
+
     def self.definition
       opts = {
         key_type: @key_type,
@@ -104,7 +111,7 @@ module Attributor
       }.merge(@options)
 
       blocks = @saved_blocks.shift(@saved_blocks.size)
-      compiler = dsl_class.new(self, opts)
+      compiler = dsl_class.new(self, **opts)
       compiler.parse(*blocks)
 
       if opts[:case_insensitive_load] == true
@@ -164,15 +171,27 @@ module Attributor
         raise Attributor::AttributorException, ":case_insensitive_load may not be used with keys of type #{key_type.name}"
       end
 
-      keys(options, &constructor_block)
+      keys(**options, &constructor_block)
       self
     end
 
+
+
     def self.example_contents(context, parent, **values)
       hash = ::Hash.new
       example_depth = context.size
-
-      keys.each do |sub_attribute_name, sub_attribute|
+      # Be smart about what attributes to use for the example: i.e. have into account complex requirements
+      # that might have been defined in the hash like at_most(1).of ..., exactly(2).of ...etc.
+      # But play it safe and default to the previous behavior in case there is any error processing them
+      # ( that is until the SmartAttributeSelector class isn't fully tested and ready for prime time)
+      begin
+        stack = SmartAttributeSelector.new( requirements.map(&:describe), keys.keys , values)
+        selected = stack.process
+      rescue => e
+        selected = keys.keys
+      end
+
+      keys.select{|n,attr| selected.include? n}.each do |sub_attribute_name, sub_attribute|
         if sub_attribute.attributes
           # TODO: add option to raise an exception in this case?
           next if example_depth > MAX_EXAMPLE_DEPTH
@@ -202,7 +221,7 @@ module Attributor
         result = new
         result.extend(ExampleMixin)
 
-        result.lazy_attributes = example_contents(context, result, values)
+        result.lazy_attributes = example_contents(context, result, **values)
       else
         hash = ::Hash.new
 
@@ -243,11 +262,11 @@ module Attributor
     end
 
     def self.load(value, context = Attributor::DEFAULT_ROOT_CONTEXT, recurse: false, **_options)
-      context = Array(context)
 
       return value if value.is_a?(self)
       return nil if value.nil? && !recurse
 
+      context = Array(context)
       loaded_value = self.parse(value, context)
 
       return from_hash(loaded_value, context, recurse: recurse) if keys.any?
@@ -263,10 +282,12 @@ module Attributor
         value
       elsif value.is_a?(::String)
         decode_json(value, context)
-      elsif value.respond_to?(:to_hash)
+      elsif value.respond_to?(:to_h)
+        value.to_h
+      elsif value.respond_to?(:to_hash) # Deprecate this in lieu of to_h only?
         value.to_hash
       else
-        raise Attributor::IncompatibleTypeError, context: context, value_type: value.class, type: self
+        raise Attributor::IncompatibleTypeError.new(context: context, value_type: value.class, type: self)
       end
     end
 
@@ -282,6 +303,10 @@ module Attributor
       context + ["key(#{key_name.inspect})"]
     end
 
+    def to_h
+      Attributor.recursive_to_h(@contents)
+    end
+
     def generate_subcontext(context, key_name)
       self.class.generate_subcontext(context, key_name)
     end
@@ -412,11 +437,11 @@ module Attributor
 
       if keys.any?
         # Spit keys if it's the root or if it's an anonymous structures
-        if !shallow || name.nil?
-          required_names = []
+        if ( !shallow || self.name == nil)
+          required_names_from_attr = []
           # FIXME: change to :keys when the praxis doc browser supports displaying those
-          hash[:attributes] = keys.each_with_object({}) do |(sub_name, sub_attribute), sub_attributes|
-            required_names << sub_name if sub_attribute.options[:required] == true
+          hash[:attributes] = self.keys.each_with_object({}) do |(sub_name, sub_attribute), sub_attributes|
+            required_names_from_attr << sub_name if sub_attribute.options[:required] == true
             sub_example = example.get(sub_name) if example
             sub_attributes[sub_name] = sub_attribute.describe(true, example: sub_example)
           end
@@ -424,23 +449,79 @@ module Attributor
             described_req = req.describe(shallow)
             if described_req[:type] == :all
               # Add the names of the attributes that have the required flag too
-              described_req[:attributes] |= required_names
-              required_names = []
+              described_req[:attributes] |= required_names_from_attr
+              required_names_from_attr = []
             end
             list << described_req
           end
           # Make sure we create an :all requirement, if there wasn't one so we can add the required: true attributes
-          unless required_names.empty?
-            hash[:requirements] << { type: :all, attributes: required_names }
+          unless required_names_from_attr.empty?
+            hash[:requirements] << {type: :all, attributes: required_names_from_attr }
           end
         end
       else
         hash[:value] = { type: value_type.describe(true) }
+        hash[:example] = example if example
+      end
+
+      hash
+    end
+
+    def self.as_json_schema( shallow: false, example: nil, attribute_options: {} )
+      hash = super
+      opts = self.options.merge( attribute_options )
+
+      if key_type
+        hash[:'x-key_type'] = key_type.as_json_schema
+      end
+
+      if self.keys.any?
+        # Spit keys if it's the root or if it's an anonymous structures
+        if ( !shallow || self.name == nil)
+          required_names_from_attr = []
+          # FIXME: change to :keys when the praxis doc browser supports displaying those
+          hash[:properties] = self.keys.each_with_object({}) do |(sub_name, sub_attribute), sub_attributes|
+            required_names_from_attr << sub_name if sub_attribute.options[:required] == true
+            sub_example = example.get(sub_name) if example
+            sub_attributes[sub_name] = sub_attribute.as_json_schema(shallow: true, example: sub_example)
+          end
+
+          # Expose the more complex requirements to in the x-tended attribute
+          extended_requirements = self.requirements.each_with_object([]) do |req, list|
+            described_req = req.describe(shallow)
+            if described_req[:type] == :all
+              # Add the names of the attributes that have the required flag too
+              described_req[:attributes] |= required_names_from_attr
+              required_names_from_attr = []
+            end
+            list << described_req
+          end
+          all = extended_requirements.find{|r| r[:type] == :all }
+          if ( all && !all[:attributes].empty? )
+            hash[:required] = all[:attributes]
+          end
+          hash[:'x-requirements'] = extended_requirements unless extended_requirements.empty?
+        end
+      else
+        hash[:'x-value_type'] = value_type.as_json_schema(shallow:true)
       end
 
+      if opts[:allow_extra]
+        hash[:additionalProperties] = if value_type == Attributor::Object
+          true
+        else
+          value_type.as_json_schema(shallow: true)
+        end
+      end
+      # TODO: minProperties and maxProperties and patternProperties
+      # TODO: map our required_if (and possible our above requirements 'at_least...' to json schema dependencies)
       hash
     end
 
+    def self.json_schema_type
+      :object
+    end
+
     # TODO: Think about the format of the subcontexts to use: let's use .at(key.to_s)
     attr_reader :contents
 
@@ -528,6 +609,7 @@ module Attributor
     end
 
     def validate(context = Attributor::DEFAULT_ROOT_CONTEXT)
+      @validating = true
       context = [context] if context.is_a? ::String
 
       if self.class.keys.any?
@@ -535,6 +617,8 @@ module Attributor
       else
         self.validate_generic(context)
       end
+    ensure
+      @validating = false      
     end
 
     def validate_keys(context)
@@ -587,12 +671,12 @@ module Attributor
       @dumping = true
 
       contents.each_with_object({}) do |(k, v), hash|
-        k = key_attribute.dump(k, opts)
+        k = key_attribute.dump(k, **opts)
 
         v = if (attribute_for_value = self.class.keys[k])
-              attribute_for_value.dump(v, opts)
+              attribute_for_value.dump(v, **opts)
             else
-              value_attribute.dump(v, opts)
+              value_attribute.dump(v, **opts)
             end
 
         hash[k] = v