jsonapionify 0.9.0 → 0.9.1

data/lib/jsonapionify/api/sort_field.rb

@@ -38,6 +38,15 @@ module JSONAPIonify::Api
       end
     end
 
+    def contains_arel
+      case @order
+      when :asc
+        :gteq
+      when :desc
+        :lteq
+      end
+    end
+
     def outside_operator
       case @order
       when :asc
@@ -47,6 +56,15 @@ module JSONAPIonify::Api
       end
     end
 
+    def outside_arel
+      case @order
+      when :asc
+        :gt
+      when :desc
+        :lt
+      end
+    end
+
     def to_s
       @str
     end

data/lib/jsonapionify/api/sort_field_set.rb

@@ -12,7 +12,7 @@ module JSONAPIonify::Api
       map(&:to_hash).reduce(:merge)
     end
 
-    def reverse
+    def invert
       self.class.new.tap do |set|
         each do |field|
           name =

data/lib/jsonapionify/api/test_helper.rb

@@ -6,6 +6,23 @@ module JSONAPIonify
     extend ActiveSupport::Concern
     include Rack::Test::Methods
 
+    included do
+      around(:each) do |example|
+        begin
+          if example.run && last_response && last_response_json
+            aggregate_failures do
+              "response failures"
+              last_response_error_messages&.each do |message|
+                expect(message).to be_empty, message
+              end
+            end
+          end
+        rescue Oj::ParseError
+          expect(last_response.body).to be_empty, last_response.body
+        end
+      end
+    end
+
     module ClassMethods
       def set_api(api)
         define_method(:app) do
@@ -14,6 +31,35 @@ module JSONAPIonify
       end
     end
 
+    def last_response_error_messages
+      last_response_errors&.map do |error|
+        {
+          id:        error['id'],
+          code:      error['code'],
+          status:    error['status'],
+          title:     error['title'],
+          detail:    error['detail'],
+          links:     error['links'],
+          source:    error['source']&.each_with_object([]) { |(k, v), a|
+            a << "\n  #{k}: #{v}" if v
+          }&.join,
+          meta:      error['meta']&.except('backtrace')&.each_with_object([]) { |(k, v), a|
+            a << "\n  #{k}: #{v}" if v
+          }&.join,
+          ': ':      ':',
+          backtrace: ["\n", *(error.dig('meta', 'backtrace') || [])].join("\n")
+        }.each_with_object([]) { |(k, v), a|
+          a << "#{k}: #{v}" if v&.strip
+        }.join("\n")
+      end
+    end
+
+    def last_response_errors
+      last_response_json['errors']
+    rescue
+      []
+    end
+
     def set_headers
       @set_headers ||= Rack::Utils::HeaderHash.new
     end

data/lib/jsonapionify/documentation/template.erb

@@ -390,8 +390,8 @@
                             <div class="col-xs-4 attribute-name">
                               <strong><%= attribute.name %></strong>
                               <i class="attribute-type"><%= attribute.type %></i>
-                              <% if attribute.required %>
-                                  <p class="optional">required</p>
+                              <% if attribute.required.present? %>
+                                  <p class="optional">required: <%= attribute.required? %></p>
                               <% else %>
                                   <p class="optional">optional</p>
                               <% end %>

data/lib/jsonapionify/documentation.rb

@@ -2,10 +2,12 @@ require 'erb'
 require 'redcarpet'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/array'
+require 'redcarpet/render_strip'
 
 module JSONAPIonify
   class Documentation
     using JSONAPIonify::IndentedString
+    STRIPPER = Redcarpet::Markdown.new(Redcarpet::Render::StripDown)
     RENDERER = Redcarpet::Markdown.new(
       Redcarpet::Render::HTML,
       autolink:                     true,
@@ -24,6 +26,14 @@ module JSONAPIonify
       RENDERER.render(string.deindent)
     end
 
+    def self.onelinify_markdown(string)
+      strip_markdown(string).gsub(/[\r\n\t]/, ' ').strip
+    end
+
+    def self.strip_markdown(string)
+      STRIPPER.render(string.deindent)
+    end
+
     attr_reader :api
 
     def initialize(api, template: nil)

data/lib/jsonapionify/structure/collections/base.rb

@@ -1,9 +1,10 @@
 require 'enumerable_observer'
 require 'active_support/core_ext/module/delegation'
+require 'concurrent'
 
 module JSONAPIonify::Structure
   module Collections
-    class Base < Array
+    class Base < Concurrent::Array
       include EnumerableObserver
       include Helpers::InheritsOrigin
       attr_reader :parent
@@ -72,8 +73,14 @@ module JSONAPIonify::Structure
           when type_class
             instance
           else
-            raise ValidationError,
-                  " Can 't initialize collection `#{self.class.name}` with a type of `#{instance.class.name}`"
+            if type_class < instance.class
+              type_class.from_hash instance.to_hash
+            else
+              raise(
+                ValidationError,
+                "Can't initialize collection `#{self.class.name}` with a type of `#{instance.class.name}`"
+              )
+            end
           end
         super new_instance
       end

data/lib/jsonapionify/structure/helpers/object_defaults.rb

@@ -59,7 +59,11 @@ module JSONAPIonify::Structure
         inherited_hash_attribute :implementations, :collections
 
         before_initialize do
-          @unset = {}
+          @unset    = {}
+          newly_set = unset.select { |_, v| v.present? }
+          newly_set.each do |k, v|
+            self[k] = v
+          end
         end
       end
 
@@ -80,15 +84,6 @@ module JSONAPIonify::Structure
         super k, coerce_value(k, v)
       end
 
-      def object
-        super.tap do
-          newly_set = unset.select { |_, v| v.present? }
-          newly_set.each do |k, v|
-            self[k] = v
-          end
-        end
-      end
-
       private
 
       def coerce_value(k, v)

data/lib/jsonapionify/structure/maps/relationships.rb

@@ -18,6 +18,10 @@ module JSONAPIonify::Structure
 
       value_is Objects::Relationship, strict: true
 
+      def to_hash
+        super.sort.to_h
+      end
+
     end
   end
 end

data/lib/jsonapionify/structure/objects/attributes.rb

@@ -24,6 +24,10 @@ module JSONAPIonify::Structure
       # **SHOULD NOT** appear as attributes.
       should_not_contain! { |key| key.to_s.end_with? '_id' }
 
+      def to_hash
+        super.sort.to_h
+      end
+
     end
   end
 end

data/lib/jsonapionify/structure/objects/base.rb

@@ -5,6 +5,7 @@ require 'active_support/core_ext/hash'
 require 'active_support/core_ext/array/conversions'
 require 'active_support/core_ext/hash/keys'
 require 'enumerable_observer'
+require 'concurrent'
 
 module JSONAPIonify::Structure
   module Objects
@@ -24,12 +25,11 @@ module JSONAPIonify::Structure
       # Attributes
       attr_reader :object, :parent
 
-      delegate :fetch, :select, :has_key?, :keys, :values, :each, :present?, :blank?, :empty?, to: :object
       delegate :cache_store, to: JSONAPIonify
+      delegate *(Hash.instance_methods - instance_methods), to: :object
 
       before_initialize do
-        @object = {}
-        observe(@object).added do |items|
+        observe(self.object).added do |items|
           items.each do |_, value|
             value.instance_variable_set(:@parent, self) unless value.frozen?
           end
@@ -40,12 +40,21 @@ module JSONAPIonify::Structure
         new hash.deep_symbolize_keys
       end
 
+      def self.define_order(*keys)
+        define_singleton_method :ordered_keys do
+          keys
+        end
+      end
+
+      define_order
+
       def self.from_json(json)
         from_hash Oj.load json
       end
 
       # Initialize the object
       def initialize(**attributes)
+        @object = Concurrent::Hash.new
         run_callbacks :initialize do
           attributes.each do |k, v|
             self[k] = v
@@ -72,16 +81,16 @@ module JSONAPIonify::Structure
       attr_reader :errors, :warnings
 
       def compile(validate: true)
-        self.validate if validate
+        self.validate if validate && !JSONAPIonify.validation_disabled?
         to_hash
       end
 
-      def as_json
-        compile.deep_stringify_keys
+      def as_json(**opts)
+        compile(**opts).deep_stringify_keys
       end
 
-      def to_json
-        Oj.dump(as_json)
+      def to_json(**opts)
+        Oj.dump(as_json **opts)
       end
 
       def signature
@@ -89,7 +98,11 @@ module JSONAPIonify::Structure
       end
 
       def to_hash
-        object.reduce({}) do |hash, (k, v)|
+        ordered_object = [
+          *object.slice(*self.class.ordered_keys),
+          *object.except(*self.class.ordered_keys)
+        ]
+        ordered_object.reduce({}) do |hash, (k, v)|
           hash[k] =
             case v
             when Objects::Base

data/lib/jsonapionify/structure/objects/error.rb

@@ -1,6 +1,8 @@
 module JSONAPIonify::Structure
   module Objects
     class Error < Base
+      define_order *%i{id code status source title detail meta links}
+
       may_contain! :id, :links, :status, :code, :title, :detail, :source, :meta
 
       implements :links, as: Maps::ErrorLinks

data/lib/jsonapionify/structure/objects/jsonapi.rb

@@ -1,6 +1,7 @@
 module JSONAPIonify::Structure
   module Objects
     class Jsonapi < Base
+      define_order *%i{version meta}
       may_contain! :version, :meta
     end
   end

data/lib/jsonapionify/structure/objects/link.rb

@@ -1,6 +1,7 @@
 module JSONAPIonify::Structure
   module Objects
     class Link < Base
+      define_order *%i{href meta}
 
       may_contain! :href, :meta
 

data/lib/jsonapionify/structure/objects/relationship.rb

@@ -1,6 +1,8 @@
 module JSONAPIonify::Structure
   module Objects
     class Relationship < Base
+      define_order *%i{data meta links}
+
       # A "relationship object" MUST contain at least one of the following:
       must_contain_one_of! :links, # A links object.
                            :data, # Resource linkage.

data/lib/jsonapionify/structure/objects/resource.rb

@@ -2,6 +2,8 @@ module JSONAPIonify::Structure
   module Objects
     # ResourceObjects appear in a JSON API document to represent resources.
     class Resource < ResourceIdentifier
+      define_order *%i{type id attributes relationships meta links}
+
       # The `id` member is not required when the resource object originates at the
       # client and represents a new resource to be created on the server.
       must_contain! :id, if: ->(obj) { obj.server? } # an id representing the resource

data/lib/jsonapionify/structure/objects/resource_identifier.rb

@@ -1,6 +1,8 @@
 module JSONAPIonify::Structure
   module Objects
     class ResourceIdentifier < Base
+      define_order *%i{type id}
+
       # A resource object **MUST** contain at least the following top-level members:
       must_contain! :id, :type # Describes ResourceObjects that share common attributes and relationships.
 
@@ -21,7 +23,11 @@ module JSONAPIonify::Structure
       def duplicate_exists?
         return false unless parent.is_a?(Array)
         peers = parent - [self]
-        peers.any? { |peer| same_as? peer }
+        !!peers.index(self)
+      end
+
+      def ==(other)
+        same_as? other
       end
 
       def duplicate_does_not_exist?
@@ -30,9 +36,11 @@ module JSONAPIonify::Structure
 
       def same_as?(other)
         return false unless other.is_a? ResourceIdentifier
-        matches_id   = other.has_key?(:id) && has_key?(:id) && other[:id] == self[:id]
-        matches_type = other[:type] == self[:type]
-        matches_type && matches_id
+        other_type, other_id = other.values_at :type, :id
+        local_type, local_id = values_at :type, :id
+        other_type == local_type &&
+          !(other_id || local_id).nil? &&
+          other_id == local_id
       end
 
     end

data/lib/jsonapionify/structure/objects/top_level.rb

@@ -8,6 +8,8 @@ module JSONAPIonify::Structure
     class TopLevel < Base
       attr_reader :origin
 
+      define_order *%i{jsonapi data included errors meta links}
+
       default(:jsonapi) { Jsonapi.new version: '1.0' }
 
       # A document **MUST** contain at least one of:
@@ -75,8 +77,8 @@ module JSONAPIonify::Structure
                                  Collections::ResourceIdentifiers
                                ]
 
-      def compile(*)
-        compiled        = super(validate: ENV['RACK_ENV'] != 'production')
+      def compile(**opts)
+        compiled        = super(**opts)
         compiled_errors = compiled['errors'] || []
         all_errors      = compiled_errors | errors.as_collection.compile
         if all_errors.present?

data/lib/jsonapionify/types/array_type.rb

@@ -7,24 +7,29 @@ module JSONAPIonify::Types
       end
     end
 
-    def load(value)
-      super unless options[:of]
-      value.map do |item|
-        options[:of].load(item)
+    def sample(field_name)
+      field_name = field_name.to_s.singularize.to_sym
+      3.times.map do
+        (options[:of] || StringType.new).sample(field_name)
       end
     end
 
-    def dump(value)
-      super unless options[:of]
+    loader do |value|
+      raise LoadError, 'invalid type' unless value.is_a?(Array)
+      return super(value) unless options[:of]
       value.map do |item|
-        options[:of].dump(item)
+        options[:of].load(item)
       end
     end
 
-    def sample(field_name)
-      field_name = field_name.to_s.singularize.to_sym
-      3.times.map do
-        (options[:of] || StringType.new).sample(field_name)
+    dumper do |value|
+      raise DumpError, 'cannot convert value to array' unless value.respond_to?(:to_a)
+      value.to_a.tap do |array|
+        raise DumpError, 'output value was not an array' unless array.is_a? Array
+      end
+      return super(value) unless options[:of]
+      value.map do |item|
+        options[:of].dump(item)
       end
     end
 

data/lib/jsonapionify/types/boolean_type.rb

@@ -1,16 +1,21 @@
 module JSONAPIonify::Types
   class BooleanType < BaseType
 
-    def load(value)
-      value
+    loader do |value|
+      case value
+      when true, false
+        value
+      else
+        raise LoadError, "#{value} is not a valid JSON #{name}."
+      end
     end
 
-    def dump(value)
+    dumper do |value|
       case value
       when true, false
         value
       else
-        raise TypeError, "#{value} is not a valid JSON #{name}."
+        raise DumpError, "#{value} is not a valid JSON #{name}."
       end
     end
 

data/lib/jsonapionify/types/date_string_type.rb

@@ -1,18 +1,14 @@
 require 'faker'
 
 module JSONAPIonify::Types
-  class DateStringType < BaseType
-    def load(value)
-      Date.parse value
+  class DateStringType < StringType
+    loader do |value|
+      Date.parse super(value)
     end
 
-    def dump(value)
-      case value
-      when Date
-        JSON.load JSON.dump(value.to_date)
-      else
-        raise TypeError, "#{value} is not a valid JSON #{name}."
-      end
+    dumper do |value|
+      raise DumpError, 'cannot convert value to date' unless value.respond_to?(:to_date)
+      JSON.load JSON.dump(value.to_date)
     end
 
     def sample(field_name)
@@ -26,3 +22,4 @@ module JSONAPIonify::Types
 
   end
 end
+

data/lib/jsonapionify/types/float_type.rb

@@ -4,5 +4,18 @@ module JSONAPIonify::Types
     def sample(*)
       rand(0.0..201.42).round(2)
     end
+
+    loader do |value|
+      raise LoadError, 'input value was not a float' unless value.is_a?(Float)
+      value
+    end
+
+    dumper do |value|
+      raise DumpError, 'cannot convert value to float' unless value.respond_to?(:to_f)
+      value.to_f.tap do |float|
+        raise DumpError, 'output value was not a float' unless float.is_a? Float
+      end
+    end
+
   end
 end

data/lib/jsonapionify/types/integer_type.rb

@@ -5,5 +5,17 @@ module JSONAPIonify::Types
       rand(1..123)
     end
 
+    loader do |value|
+      raise LoadError, 'input value was not an integer' unless value.is_a?(Fixnum)
+      value
+    end
+
+    dumper do |value|
+      raise DumpError, 'cannot convert value to integer' unless value.respond_to?(:to_i)
+      value.to_i.tap do |int|
+        raise DumpError, 'output value was not a integer' unless int.is_a? Fixnum
+      end
+    end
+
   end
 end

data/lib/jsonapionify/types/object_type.rb

@@ -3,11 +3,16 @@ require 'active_support/core_ext/hash/keys'
 module JSONAPIonify::Types
   class ObjectType < BaseType
 
-    def load(value)
+    loader do |value|
+      raise LoadError, 'invalid type' unless value.is_a?(Hash)
       super(value).deep_symbolize_keys
     end
 
-    def dump(value)
+    dumper do |value|
+      raise DumpError, 'cannot convert value to hash' unless value.respond_to?(:to_h)
+      value = value.to_h.tap do |hash|
+        raise DumpError, 'output value was not a hash' unless hash.is_a? Hash
+      end
       super(value.deep_stringify_keys)
     end
 

data/lib/jsonapionify/types/string_type.rb

@@ -59,6 +59,18 @@ module JSONAPIonify::Types
 
     end
 
+    loader do |value|
+      raise LoadError, 'input value was not a string' unless value.is_a?(String)
+      value
+    end
+
+    dumper do |value|
+      raise DumpError, 'cannot convert value to string' unless value.respond_to?(:to_s)
+      value.to_s.tap do |string|
+        raise DumpError, 'output value was not a string' unless string.is_a? String
+      end
+    end
+
     def sample(field_name)
       StringSampler.new(field_name).value
     end

data/lib/jsonapionify/types/time_string_type.rb

@@ -1,18 +1,14 @@
 require 'faker'
 
 module JSONAPIonify::Types
-  class TimeStringType < BaseType
-    def load(value)
-      Time.parse value
+  class TimeStringType < StringType
+    loader do |value|
+      Time.parse super(value)
     end
 
-    def dump(value)
-      case value
-      when Time
-        JSON.load JSON.dump(value.to_time)
-      else
-        raise TypeError, "#{value} is not a valid JSON #{name}."
-      end
+    dumper do |value|
+      raise DumpError, 'cannot convert value to time' unless value.respond_to?(:to_time)
+      JSON.load JSON.dump(value.to_time.utc)
     end
 
     def sample(field_name)
@@ -21,6 +17,8 @@ module JSONAPIonify::Types
         Faker::Time.backward
       elsif field_name.include?('end')
         Faker::Time.forward
+      else
+        Faker::Time.backward
       end
     end