jsonapi-resources 0.10.0.beta1 → 0.10.0.beta2

data/lib/jsonapi/processor.rb

@@ -42,7 +42,7 @@ module JSONAPI
     def find
       filters = params[:filters]
       include_directives = params[:include_directives]
-      sort_criteria = params.fetch(:sort_criteria, [])
+      sort_criteria = params[:sort_criteria]
       paginator = params[:paginator]
       fields = params[:fields]
       serializer = params[:serializer]
@@ -93,7 +93,8 @@ module JSONAPI
       find_options = {
         context: context,
         fields: fields,
-        filters: { resource_klass._primary_key => key }
+        filters: { resource_klass._primary_key => key },
+        include_directives: include_directives
       }
 
       resource_set = find_resource_set(resource_klass,
@@ -109,7 +110,7 @@ module JSONAPI
       parent_key = params[:parent_key]
       relationship_type = params[:relationship_type].to_sym
       paginator = params[:paginator]
-      sort_criteria = params.fetch(:sort_criteria, [])
+      sort_criteria = params[:sort_criteria]
       include_directives = params[:include_directives]
       fields = params[:fields]
 
@@ -119,7 +120,8 @@ module JSONAPI
           context: context,
           sort_criteria: sort_criteria,
           paginator: paginator,
-          fields: fields
+          fields: fields,
+          include_directives: include_directives
       }
 
       resource_id_tree = find_related_resource_id_tree(resource_klass,
@@ -146,7 +148,8 @@ module JSONAPI
       find_options = {
           context: context,
           fields: fields,
-          filters: {}
+          filters: {},
+          include_directives: include_directives
       }
 
       source_resource = source_klass.find_by_key(source_id, context: context, fields: fields)
@@ -166,7 +169,7 @@ module JSONAPI
       source_id = params[:source_id]
       relationship_type = params[:relationship_type]
       filters = params[:filters]
-      sort_criteria = params.fetch(:sort_criteria, resource_klass.default_sort)
+      sort_criteria = params[:sort_criteria]
       paginator = params[:paginator]
       fields = params[:fields]
       include_directives = params[:include_directives]
@@ -179,7 +182,8 @@ module JSONAPI
         sort_criteria: sort_criteria,
         paginator: paginator,
         fields: fields,
-        context: context
+        context: context,
+        include_directives: include_directives
       }
 
       source_resource = source_klass.find_by_key(source_id, context: context, fields: fields)
@@ -233,7 +237,8 @@ module JSONAPI
       find_options = {
           context: context,
           fields: fields,
-          filters: { resource_klass._primary_key => resource.id }
+          filters: { resource_klass._primary_key => resource.id },
+          include_directives: include_directives
       }
 
       resource_set = find_resource_set(resource_klass,
@@ -269,7 +274,8 @@ module JSONAPI
       find_options = {
           context: context,
           fields: fields,
-          filters: { resource_klass._primary_key => resource.id }
+          filters: { resource_klass._primary_key => resource.id },
+          include_directives: include_directives
       }
 
       resource_set = find_resource_set(resource_klass,

data/lib/jsonapi/relationship.rb

@@ -1,7 +1,7 @@
 module JSONAPI
   class Relationship
     attr_reader :acts_as_set, :foreign_key, :options, :name,
-                :class_name, :polymorphic, :always_include_linkage_data,
+                :class_name, :polymorphic, :always_include_optional_linkage_data,
                 :parent_resource, :eager_load_on_include, :custom_methods,
                 :inverse_relationship, :allow_include
 
@@ -15,8 +15,13 @@ module JSONAPI
       @parent_resource = options[:parent_resource]
       @relation_name = options.fetch(:relation_name, @name)
       @polymorphic = options.fetch(:polymorphic, false) == true
-      @polymorphic_relations = options[:polymorphic_relations]
-      @always_include_linkage_data = options.fetch(:always_include_linkage_data, false) == true
+      @polymorphic_types = options[:polymorphic_types]
+      if options[:polymorphic_relations]
+        ActiveSupport::Deprecation.warn('Use polymorphic_types instead of polymorphic_relations')
+        @polymorphic_types ||= options[:polymorphic_relations]
+      end
+
+      @always_include_optional_linkage_data = options.fetch(:always_include_optional_linkage_data, false) == true
       @eager_load_on_include = options.fetch(:eager_load_on_include, false) == true
       @allow_include = options[:allow_include]
       @class_name = nil
@@ -58,8 +63,12 @@ module JSONAPI
       @poly_hash[name.to_sym]
     end
 
-    def polymorphic_relations
-      @polymorphic_relations ||= self.class.polymorphic_types(@relation_name)
+    def resource_types
+      if polymorphic? && belongs_to?
+        @polymorphic_types ||= self.class.polymorphic_types(@relation_name).collect {|t| t.pluralize}
+      else
+        [resource_klass._type.to_s.pluralize]
+      end
     end
 
     def type
@@ -102,6 +111,12 @@ module JSONAPI
         end
       end
 
+      def to_s
+        # :nocov: useful for debugging
+        "#{parent_resource._type}.#{name} => (#{belongs_to? ? 'ToOne' : 'BelongsToOne'}) #{resource_klass._type}"
+        # :nocov:
+      end
+
       def belongs_to?
         # :nocov:
         foreign_key_on == :self
@@ -112,6 +127,10 @@ module JSONAPI
         "#{name}_type" if polymorphic?
       end
 
+      def include_optional_linkage_data?
+        @always_include_optional_linkage_data || JSONAPI::configuration.always_include_to_one_linkage_data
+      end
+
       def allow_include?(context = nil)
         strategy = if @allow_include.nil?
                      JSONAPI.configuration.default_allow_include_to_one
@@ -142,6 +161,18 @@ module JSONAPI
         end
       end
 
+      def to_s
+        # :nocov: useful for debugging
+        "#{parent_resource._type}.#{name} => (ToMany) #{resource_klass._type}"
+        # :nocov:
+      end
+
+      def include_optional_linkage_data?
+        # :nocov:
+        @always_include_optional_linkage_data || JSONAPI::configuration.always_include_to_many_linkage_data
+        # :nocov:
+      end
+
       def allow_include?(context = nil)
         strategy = if @allow_include.nil?
                      JSONAPI.configuration.default_allow_include_to_many
@@ -156,8 +187,8 @@ module JSONAPI
         else
           strategy.call(context)
         end
-
       end
+
     end
   end
 end

data/lib/jsonapi/request_parser.rb

@@ -345,7 +345,7 @@ module JSONAPI
     end
 
     def parse_include_directives(resource_klass, raw_include)
-      return unless raw_include
+      raw_include ||= ''
 
       included_resources = []
       begin
@@ -354,8 +354,6 @@ module JSONAPI
         fail JSONAPI::Exceptions::InvalidInclude.new(format_key(resource_klass._type), raw_include)
       end
 
-      return if included_resources.nil?
-
       begin
         result = included_resources.compact.map do |included_resource|
           check_include(resource_klass, included_resource.partition('.'))

data/lib/jsonapi/resource.rb

@@ -400,6 +400,7 @@ module JSONAPI
         subclass.caching(_caching)
         subclass.paginator(_paginator)
         subclass._attributes = (_attributes || {}).dup
+        subclass.polymorphic(false)
 
         subclass._model_hints = (_model_hints || {}).dup
 
@@ -439,53 +440,53 @@ module JSONAPI
       # }
       #
       # begin ResourceFinder Abstract methods
-        def find(_filters, _options = {})
-          # :nocov:
-          raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
-          # :nocov:
-        end
+      def find(_filters, _options = {})
+        # :nocov:
+        raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
+        # :nocov:
+      end
 
-        def count(_filters, _options = {})
-          # :nocov:
-          raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
-          # :nocov:
-        end
+      def count(_filters, _options = {})
+        # :nocov:
+        raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
+        # :nocov:
+      end
 
-        def find_by_keys(_keys, _options = {})
-          # :nocov:
-          raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
-          # :nocov:
-        end
+      def find_by_keys(_keys, _options = {})
+        # :nocov:
+        raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
+        # :nocov:
+      end
 
-        def find_by_key(_key, _options = {})
-          # :nocov:
-          raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
-          # :nocov:
-        end
+      def find_by_key(_key, _options = {})
+        # :nocov:
+        raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
+        # :nocov:
+      end
 
-        def find_fragments(_filters, _options = {})
-          # :nocov:
-          raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
-          # :nocov:
-        end
+      def find_fragments(_filters, _options = {})
+        # :nocov:
+        raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
+        # :nocov:
+      end
 
-        def find_included_fragments(_source_rids, _relationship_name, _options = {})
-          # :nocov:
-          raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
-          # :nocov:
-        end
+      def find_included_fragments(_source_rids, _relationship_name, _options = {})
+        # :nocov:
+        raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
+        # :nocov:
+      end
 
-        def find_related_fragments(_source_rids, _relationship_name, _options = {})
-          # :nocov:
-          raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
-          # :nocov:
-        end
+      def find_related_fragments(_source_rids, _relationship_name, _options = {})
+        # :nocov:
+        raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
+        # :nocov:
+      end
 
-        def count_related(_source_rid, _relationship_name, _options = {})
-          # :nocov:
-          raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
-          # :nocov:
-        end
+      def count_related(_source_rid, _relationship_name, _options = {})
+        # :nocov:
+        raise 'Abstract ResourceFinder method called. Ensure that a ResourceFinder has been set.'
+        # :nocov:
+      end
 
       #end ResourceFinder Abstract methods
 
@@ -710,14 +711,6 @@ module JSONAPI
         _relationships.keys | _attributes.keys
       end
 
-      def records(options = {})
-        _model_class.all
-      end
-
-      def retrieve_records(ids, options = {})
-        _model_class.where(_primary_key => ids)
-      end
-
       def resources_for(records, context)
         records.collect do |record|
           resource_for(record, context)
@@ -850,19 +843,28 @@ module JSONAPI
       end
 
       def _relationship(type)
+        return nil unless type
         type = type.to_sym
         @_relationships[type]
       end
 
       def _model_name
         if _abstract
-          return ''
+           ''
         else
           return @_model_name.to_s if defined?(@_model_name)
           class_name = self.name
           return '' if class_name.nil?
           @_model_name = class_name.demodulize.sub(/Resource$/, '')
-          return @_model_name.to_s
+          @_model_name.to_s
+        end
+      end
+
+      def _polymorphic_name
+        if !_polymorphic
+          ''
+        else
+          @_polymorphic_name ||= _model_name.to_s.downcase
         end
       end
 
@@ -902,6 +904,34 @@ module JSONAPI
         @_paginator = paginator
       end
 
+      def _polymorphic
+        @_polymorphic
+      end
+
+      def polymorphic(polymorphic = true)
+        @_polymorphic = polymorphic
+      end
+
+      def _polymorphic_types
+        @poly_hash ||= {}.tap do |hash|
+          ObjectSpace.each_object do |klass|
+            next unless Module === klass
+            if klass < ActiveRecord::Base
+              klass.reflect_on_all_associations(:has_many).select{|r| r.options[:as] }.each do |reflection|
+                (hash[reflection.options[:as]] ||= []) << klass.name.downcase
+              end
+            end
+          end
+        end
+        @poly_hash[_polymorphic_name.to_sym]
+      end
+
+      def _polymorphic_resource_klasses
+        @_polymorphic_resource_klasses ||= _polymorphic_types.collect do |type|
+          resource_klass_for(type)
+        end
+      end
+
       def abstract(val = true)
         @abstract = val
       end

data/lib/jsonapi/resource_set.rb

@@ -48,12 +48,11 @@ module JSONAPI
 
         # fill in any missed resources
         unless missed_ids.empty?
-          filters = {resource_klass._primary_key => missed_ids}
           find_opts = {
               context: context,
               fields: find_options[:fields] }
 
-          found_resources = resource_klass.find(filters, find_opts)
+          found_resources = resource_klass.find_by_keys(missed_ids, find_opts)
 
           found_resources.each do |resource|
             relationship_data = @resource_klasses[resource_klass][resource.id][:relationships]

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = '0.10.0.beta1'
+    VERSION = '0.10.0.beta2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.10.0.beta1
+  version: 0.10.0.beta2
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-03 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,6 +177,7 @@ files:
 - lib/generators/jsonapi/templates/jsonapi_resource.rb
 - lib/jsonapi-resources.rb
 - lib/jsonapi/active_relation_resource_finder.rb
+- lib/jsonapi/active_relation_resource_finder/adapters/join_left_active_record_adapter.rb
 - lib/jsonapi/active_relation_resource_finder/join_tree.rb
 - lib/jsonapi/acts_as_resource_controller.rb
 - lib/jsonapi/cached_response_fragment.rb
@@ -194,6 +195,8 @@ files:
 - lib/jsonapi/operation.rb
 - lib/jsonapi/operation_result.rb
 - lib/jsonapi/paginator.rb
+- lib/jsonapi/path.rb
+- lib/jsonapi/path_segment.rb
 - lib/jsonapi/processor.rb
 - lib/jsonapi/relationship.rb
 - lib/jsonapi/request_parser.rb
@@ -228,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: Easily support JSON API in Rails.