attributor 5.2.0 → 5.6

data/lib/attributor/attribute.rb

@@ -93,12 +93,12 @@ module Attributor
 
     TOP_LEVEL_OPTIONS = [:description, :values, :default, :example, :required, :required_if, :custom_data].freeze
     INTERNAL_OPTIONS = [:dsl_compiler, :dsl_compiler_options].freeze # Options we don't want to expose when describing attributes
-
-    def describe(shallow = true, example: nil)
-      description = {}
+    JSON_SCHEMA_UNSUPPORTED_OPTIONS = [ :required, :required_if ].freeze
+    def describe(shallow=true, example: nil)
+      description = { }
       # Clone the common options
       TOP_LEVEL_OPTIONS.each do |option_name|
-        description[option_name] = options[option_name] if options.key? option_name
+        description[option_name] = self.describe_option(option_name) if self.options.has_key? option_name
       end
 
       # Make sure this option definition is not mistaken for the real generated example
@@ -109,7 +109,7 @@ module Attributor
       special_options = options.keys - TOP_LEVEL_OPTIONS - INTERNAL_OPTIONS
       description[:options] = {} unless special_options.empty?
       special_options.each do |opt_name|
-        description[:options][opt_name] = options[opt_name]
+        description[:options][opt_name] = self.describe_option(opt_name)
       end
       # Change the reference option to the actual class name.
       if (reference = options[:reference])
@@ -146,8 +146,40 @@ module Attributor
       load(generated, context)
     end
 
-    def example(context = nil, parent: nil, values: {})
-      raise ArgumentError, 'attribute example cannot take a context of type String' if context.is_a? ::String
+    def describe_option( option_name )
+      self.type.describe_option( option_name, self.options[option_name] )
+    end
+
+    # FiXME: pass and utilize the "shallow" parameter
+    #required
+    #options
+    #type
+    #example
+    # UTILIZE THIS SITE! http://jsonschema.net/#/
+    def as_json_schema(shallow: true, example: nil)
+      description = self.type.as_json_schema(shallow: shallow, example: example, attribute_options: self.options )
+
+      description[:description] = self.options[:description] if self.options[:description]
+      description[:enum] = self.options[:values] if self.options[:values]
+      if the_default = self.options[:default]
+        the_object = the_default.is_a?(Proc) ? the_default.call : the_default
+        description[:default] = the_object.is_a?(Attributor::Dumpable) ? the_object.dump : the_object
+      end
+      #TODO      description[:title] = "TODO: do we want to use a title??..."
+
+      # Change the reference option to the actual class name.
+      if ( reference = self.options[:reference] )
+        description[:'x-reference'] = reference.name
+      end
+
+      # TODO: not sure if that's correct (we used to get it from the described hash...
+      description[:example] = self.dump(example) if example
+
+      description
+    end
+
+    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)
         seed, = Digest::SHA1.digest(ctx).unpack('QQ')
@@ -158,7 +190,8 @@ module Attributor
 
       if options.key? :example
         loaded = example_from_options(parent, context)
-        errors = validate(loaded, context)
+        # Only validate the type, if the proc-generated example is "complex" (has attributes)
+        errors = loaded.class.respond_to?(:attributes) ? validate_type(loaded, context) : validate(loaded, context)
         raise AttributorException, "Error generating example for #{Attributor.humanize_context(context)}. Errors: #{errors.inspect}" if errors.any?
         return loaded
       end
@@ -166,7 +199,7 @@ module Attributor
       return options[:values].pick if options.key? :values
 
       if type.respond_to?(:attributes)
-        type.example(context, values)
+        type.example(context, **values)
       else
         type.example(context, options: options)
       end

data/lib/attributor/extras/field_selector.rb

@@ -12,6 +12,10 @@ module Attributor
 
     include Attributor::Type
 
+    def self.json_schema_type
+      :string
+    end
+
     def self.native_type
       ::Hash
     end

data/lib/attributor/families/numeric.rb

@@ -1,15 +1,28 @@
 # Abstract type for the 'numeric' family
 
 module Attributor
-  class Numeric
+  module Numeric
+    extend ActiveSupport::Concern
     include Type
 
-    def self.native_type
-      raise NotImplementedError
-    end
+    module ClassMethods
+      
+      def native_type
+        raise NotImplementedError
+      end
+
+      def family
+        'numeric'
+      end
 
-    def self.family
-      'numeric'
+      def as_json_schema( shallow: false, example: nil, attribute_options: {} )
+        h = super
+        opts = ( self.respond_to?(:options) ) ? self.options.merge( attribute_options ) : attribute_options
+        h[:minimum] = opts[:min] if opts[:min]
+        h[:maximum] = opts[:max] if opts[:max]
+        # We're not explicitly setting false to exclusiveMinimum and exclusiveMaximum (as that's the default)
+        h
+      end
     end
   end
 end

data/lib/attributor/families/temporal.rb

@@ -1,19 +1,26 @@
 # Abstract type for the 'temporal' family
 
 module Attributor
-  class Temporal
+  module Temporal
+    extend ActiveSupport::Concern
     include Type
 
-    def self.native_type
-      raise NotImplementedError
-    end
+    module ClassMethods
+      def native_type
+        raise NotImplementedError
+      end
 
-    def self.family
-      'temporal'
-    end
+      def family
+        'temporal'
+      end
+
+      def dump(value, **_opts)
+        value && value.iso8601
+      end
 
-    def self.dump(value, **_opts)
-      value && value.iso8601
+      def json_schema_type
+        :string
+      end
     end
   end
 end

data/lib/attributor/hash_dsl_compiler.rb

@@ -89,31 +89,31 @@ module Attributor
       end
 
       def all(*attr_names, **opts)
-        req = Requirement.new(options.merge(opts).merge(all: attr_names))
+        req = Requirement.new(**options.merge(opts).merge(all: attr_names))
         target.add_requirement req
         req
       end
 
       def at_most(number)
-        req = Requirement.new(options.merge(at_most: number))
+        req = Requirement.new(**options.merge(at_most: number))
         target.add_requirement req
         req
       end
 
       def at_least(number)
-        req = Requirement.new(options.merge(at_least: number))
+        req = Requirement.new(**options.merge(at_least: number))
         target.add_requirement req
         req
       end
 
       def exactly(number)
-        req = Requirement.new(options.merge(exactly: number))
+        req = Requirement.new(**options.merge(exactly: number))
         target.add_requirement req
         req
       end
 
       def exclusive(*attr_names, **opts)
-        req = Requirement.new(options.merge(opts).merge(exclusive: attr_names))
+        req = Requirement.new(**options.merge(opts).merge(exclusive: attr_names))
         target.add_requirement req
         req
       end
@@ -132,7 +132,7 @@ module Attributor
           _requirements_dsl
         end
       else
-        _requirements_dsl.all(*spec, opts)
+        _requirements_dsl.all(*spec, **opts)
       end
     end
   end

data/lib/attributor/type.rb

@@ -2,9 +2,7 @@ module Attributor
   # 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?
   module Type
-    def self.included(klass)
-      klass.extend(ClassMethods)
-    end
+    extend ActiveSupport::Concern
 
     module ClassMethods
       # Does this type support the generation of subtypes?
@@ -29,7 +27,7 @@ module Attributor
       def load(value, context = Attributor::DEFAULT_ROOT_CONTEXT, **_options)
         return nil if value.nil?
         unless value.is_a?(native_type)
-          raise Attributor::IncompatibleTypeError, context: context, value_type: value.class, type: self
+          raise Attributor::IncompatibleTypeError.new(context: context, value_type: value.class, type: self)
         end
 
         value
@@ -124,6 +122,31 @@ module Attributor
       def family
         'any'
       end
+
+      # Default no format in case it's a string type
+      def json_schema_string_format
+        nil
+      end
+  
+      def as_json_schema( shallow: false, example: nil, attribute_options: {} )
+        type_name = self.ancestors.find { |k| k.name && !k.name.empty? }.name
+        hash = { type: json_schema_type, 'x-type_name': type_name.gsub( Attributor::MODULE_PREFIX_REGEX, '' )}
+        # Add a format, if the type has defined
+        if hash[:type] == :string && the_format = json_schema_string_format
+          hash[:format] = the_format
+        end
+        hash
+      end
+
+      def describe_option( option_name, option_value )
+        return case option_name
+        when :description
+          option_value
+        else
+          option_value  # By default, describing an option returns the hash with the specification
+        end
+      end
+
     end
   end
 end

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
@@ -91,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) })
@@ -103,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)
@@ -117,11 +117,30 @@ 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]
+      if the_default = opts[:default]
+        the_object = the_default.is_a?(Proc) ? the_default.call : the_default
+        hash[:description] = the_object.is_a?(Attributor::Dumpable) ? the_object.dump : the_object
+      end
+
+      #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]
@@ -173,7 +192,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