attributor 5.2.0 → 5.6

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

@@ -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)
@@ -111,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
@@ -171,7 +171,7 @@ 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
 
@@ -221,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
 
@@ -262,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?
@@ -282,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
 
@@ -301,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
@@ -431,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
@@ -443,14 +449,14 @@ 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
@@ -461,6 +467,61 @@ module Attributor
       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
 
@@ -548,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?
@@ -555,6 +617,8 @@ module Attributor
       else
         self.validate_generic(context)
       end
+    ensure
+      @validating = false      
     end
 
     def validate_keys(context)
@@ -607,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

data/lib/attributor/types/integer.rb

@@ -1,7 +1,9 @@
 
 
 module Attributor
-  class Integer < Numeric
+  class Integer
+    include Attributor::Numeric
+
     EXAMPLE_RANGE = 1000
 
     def self.native_type
@@ -53,5 +55,9 @@ module Attributor
       end
       true
     end
+
+    def self.json_schema_type
+      :integer
+    end
   end
 end

data/lib/attributor/types/model.rb

@@ -105,7 +105,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
         result = new
       end
@@ -192,7 +192,7 @@ module Attributor
           next
         end
 
-        hash[name.to_sym] = attribute.dump(value, context: context + [name])
+        hash[name.to_sym] = attribute.dump(value, context: context + [name], **_opts)
       end
     ensure
       @dumping = false

data/lib/attributor/types/object.rb

@@ -13,5 +13,10 @@ module Attributor
     def self.example(_context = nil, options: {})
       'An Object'
     end
+        
+    def self.json_schema_type
+      :object #FIXME: not sure this is the most appropriate, since an Attributor::Object can be anything
+    end
+
   end
 end

data/lib/attributor/types/polymorphic.rb

@@ -1,4 +1,3 @@
-require 'active_support'
 
 require_relative '../exceptions'
 
@@ -95,7 +94,9 @@ 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

data/lib/attributor/types/string.rb

@@ -8,7 +8,7 @@ module Attributor
 
     def self.load(value, context = Attributor::DEFAULT_ROOT_CONTEXT, **options)
       if value.is_a?(Enumerable)
-        raise IncompatibleTypeError, context: context, value_type: value.class, type: self
+        raise IncompatibleTypeError.new(context: context, value_type: value.class, type: self)
       end
 
       value && String(value)
@@ -32,5 +32,24 @@ module Attributor
     def self.family
       'string'
     end
+
+    def self.json_schema_type
+      :string
+    end
+    
+    # TODO: we're passing the attribute options for now...might need to rethink ...although these are type-specific...
+    # TODO: multipleOf, minimum, maximum, exclusiveMinimum and exclusiveMaximum
+    def self.as_json_schema( shallow: false, example: nil, attribute_options: {} )
+      h = super
+      opts = ( self.respond_to?(:options) ) ? self.options.merge( attribute_options ) : attribute_options
+      h[:pattern] = self.human_readable_regexp(opts[:regexp]) if opts[:regexp]
+      # TODO: minLength, maxLength
+      h
+    end
+
+    def self.human_readable_regexp( reg )
+      return $1 if reg.to_s =~ /\(\?[^:]+:(.+)\)/
+      reg
+    end
   end
 end

data/lib/attributor/types/struct.rb

@@ -26,7 +26,7 @@ module Attributor
       end
 
       ::Class.new(self) do
-        attributes options, &attribute_definition
+        attributes **options, &attribute_definition
       end
     end
 

data/lib/attributor/types/symbol.rb

@@ -19,5 +19,10 @@ module Attributor
     def self.family
       String.family
     end
+
+    def self.json_schema_type
+      :string
+    end
+
   end
 end

data/lib/attributor/types/tempfile.rb

@@ -38,5 +38,9 @@ module Attributor
     def self.family
       String.family
     end
+
+    def self.json_schema_type
+      :string
+    end
   end
 end

data/lib/attributor/types/time.rb

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

data/lib/attributor/types/uri.rb

@@ -22,6 +22,14 @@ module Attributor
       ::URI::Generic
     end
 
+    def self.json_schema_type
+      :string
+    end
+
+    def self.json_schema_string_format
+      :uri
+    end
+
     def self.example(_context = nil, options: {})
       URI(Randgen.uri)
     end
@@ -34,7 +42,7 @@ module Attributor
       when ::String
         URI(value)
       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
 

data/lib/attributor/version.rb

@@ -1,3 +1,3 @@
 module Attributor
-  VERSION = '5.2.0'.freeze
+  VERSION = '5.6'.freeze
 end

data/spec/attribute_spec.rb

@@ -36,17 +36,48 @@ describe Attributor::Attribute do
     it { should eq other_attribute }
   end
 
+  context 'describe_json_schema' do
+    let(:type) { PositiveIntegerType }
+
+    let(:attribute_options) do
+      {
+        values: [1,20],
+        description: "something",
+        example: 20,
+        max: 1000,
+        default: 1
+      }
+    end
+
+    context 'reports all of the possible attributes' do
+      let(:js){ subject.as_json_schema(example: 20) }
+
+      it 'including the attribute-specific ones' do
+        expect(js[:enum]).to eq( [1,20])
+        expect(js[:description]).to eq( "something")
+        expect(js[:default]).to eq(1)
+        expect(js[:example]).to eq(20)
+      end
+
+      it 'as well as the type-specific ones' do
+        expect(js[:type]).to eq(:integer)
+      end
+    end
+
+  end
+
   context 'describe' do
-    let(:attribute_options) { { required: true, values: ['one'], description: 'something', min: 0 } }
+    let(:attribute_options) { {required: true, values: ['one'], description: "something", min: 0} }
     let(:expected) do
-      h = { type: { name: 'String', id: type.id, family: type.family } }
-      common = attribute_options.select { |k, _v| Attributor::Attribute::TOP_LEVEL_OPTIONS.include? k }
-      h.merge!(common)
-      h[:options] = { min: 0 }
+      h = {type: {name: 'String', id: type.id, family: type.family}}
+      common = attribute_options.select{|k,v| Attributor::Attribute::TOP_LEVEL_OPTIONS.include? k }
+      h.merge!( common )
+      h[:options] = {:min => 0 }
       h
     end
 
-    its(:describe) { should eq expected }
+    # It has both the type-included options (min) as well as the attribute options (max)
+    its(:describe) { should == expected }
 
     context 'with example options' do
       let(:attribute_options) { { description: 'something', example: 'ex_def' } }
@@ -313,7 +344,11 @@ describe Attributor::Attribute do
     let(:value) { '1' }
 
     it 'delegates to type.load' do
-      expect(type).to receive(:load).with(value, context, {})
+      # Need to add the "anything" of the 3rd element, as in ruby < 2.7 it comes as an empty hash
+      expect(type).to receive(:load) do |v, c, _other|
+        expect(v).to eq(value)
+        expect(c).to eq(context)
+      end   
       attribute.load(value, context)
     end