jsonapi-resources 0.10.6 → 0.11.0.beta2

data/lib/jsonapi/processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Processor
     include Callbacks
@@ -49,7 +51,7 @@ module JSONAPI
 
       verified_filters = resource_klass.verify_filters(filters, context)
 
-      find_options = {
+      options = {
         context: context,
         sort_criteria: sort_criteria,
         paginator: paginator,
@@ -58,11 +60,9 @@ module JSONAPI
         include_directives: include_directives
       }
 
-      resource_set = find_resource_set(resource_klass,
-                                       include_directives,
-                                       find_options)
+      resource_set = find_resource_set(include_directives, options)
 
-      resource_set.populate!(serializer, context, find_options)
+      resource_set.populate!(serializer, context, options)
 
       page_options = result_options
       if (JSONAPI.configuration.top_level_meta_include_record_count || (paginator && paginator.class.requires_record_count))
@@ -79,7 +79,7 @@ module JSONAPI
         page_options[:pagination_params] = paginator.links_page_params(page_options.merge(fetched_resources: resource_set))
       end
 
-      return JSONAPI::ResourcesSetOperationResult.new(:ok, resource_set, page_options)
+      JSONAPI::ResourcesSetOperationResult.new(:ok, resource_set, page_options)
     end
 
     def show
@@ -90,26 +90,25 @@ module JSONAPI
 
       key = resource_klass.verify_key(id, context)
 
-      find_options = {
+      options = {
         context: context,
         fields: fields,
         filters: { resource_klass._primary_key => key },
         include_directives: include_directives
       }
 
-      resource_set = find_resource_set(resource_klass,
-                                       include_directives,
-                                       find_options)
+      resource_set = find_resource_set(include_directives, options)
 
       fail JSONAPI::Exceptions::RecordNotFound.new(id) if resource_set.resource_klasses.empty?
-      resource_set.populate!(serializer, context, find_options)
+      resource_set.populate!(serializer, context, options)
 
-      return JSONAPI::ResourceSetOperationResult.new(:ok, resource_set, result_options)
+      JSONAPI::ResourceSetOperationResult.new(:ok, resource_set, result_options)
     end
 
     def show_relationship
       parent_key = params[:parent_key]
       relationship_type = params[:relationship_type].to_sym
+      relationship = resource_klass._relationship(relationship_type)
       paginator = params[:paginator]
       sort_criteria = params[:sort_criteria]
       include_directives = params[:include_directives]
@@ -117,25 +116,26 @@ module JSONAPI
 
       parent_resource = resource_klass.find_by_key(parent_key, context: context)
 
-      find_options = {
-          context: context,
-          sort_criteria: sort_criteria,
-          paginator: paginator,
-          fields: fields,
-          include_directives: include_directives
+      options = {
+        context: context,
+        sort_criteria: sort_criteria,
+        paginator: paginator,
+        fields: fields,
+        include_directives: include_directives
       }
 
-      resource_id_tree = find_related_resource_id_tree(resource_klass,
-                                                       JSONAPI::ResourceIdentity.new(resource_klass, parent_key),
-                                                       relationship_type,
-                                                       find_options,
-                                                       nil)
-
-      return JSONAPI::RelationshipOperationResult.new(:ok,
-                                                      parent_resource,
-                                                      resource_klass._relationship(relationship_type),
-                                                      resource_id_tree.fragments.keys,
-                                                      result_options)
+      resource_tree = find_related_resource_tree(
+        parent_resource,
+        relationship,
+        options,
+        nil
+      )
+
+      JSONAPI::RelationshipOperationResult.new(:ok,
+                                               parent_resource,
+                                               relationship,
+                                               resource_tree.fragments.keys,
+                                               result_options)
     end
 
     def show_related_resource
@@ -146,11 +146,11 @@ module JSONAPI
       serializer = params[:serializer]
       fields = params[:fields]
 
-      find_options = {
-          context: context,
-          fields: fields,
-          filters: {},
-          include_directives: include_directives
+      options = {
+        context: context,
+        fields: fields,
+        filters: {},
+        include_directives: include_directives
       }
 
       source_resource = source_klass.find_by_key(source_id, context: context, fields: fields)
@@ -158,11 +158,11 @@ module JSONAPI
       resource_set = find_related_resource_set(source_resource,
                                                relationship_type,
                                                include_directives,
-                                               find_options)
+                                               options)
 
-      resource_set.populate!(serializer, context, find_options)
+      resource_set.populate!(serializer, context, options)
 
-      return JSONAPI::ResourceSetOperationResult.new(:ok, resource_set, result_options)
+      JSONAPI::ResourceSetOperationResult.new(:ok, resource_set, result_options)
     end
 
     def show_related_resources
@@ -178,8 +178,8 @@ module JSONAPI
 
       verified_filters = resource_klass.verify_filters(filters, context)
 
-      find_options = {
-        filters:  verified_filters,
+      options = {
+        filters: verified_filters,
         sort_criteria: sort_criteria,
         paginator: paginator,
         fields: fields,
@@ -192,19 +192,21 @@ module JSONAPI
       resource_set = find_related_resource_set(source_resource,
                                                relationship_type,
                                                include_directives,
-                                               find_options)
+                                               options)
 
-      resource_set.populate!(serializer, context, find_options)
+      resource_set.populate!(serializer, context, options)
 
       opts = result_options
       if ((JSONAPI.configuration.top_level_meta_include_record_count) ||
-          (paginator && paginator.class.requires_record_count) ||
-          (JSONAPI.configuration.top_level_meta_include_page_count))
+        (paginator && paginator.class.requires_record_count) ||
+        (JSONAPI.configuration.top_level_meta_include_page_count))
+
+        relationship = source_resource.class._relationship(relationship_type)
 
         opts[:record_count] = source_resource.class.count_related(
-            source_resource.identity,
-            relationship_type,
-            find_options)
+          source_resource,
+          relationship,
+          options)
       end
 
       if (JSONAPI.configuration.top_level_meta_include_page_count && opts[:record_count])
@@ -219,11 +221,11 @@ module JSONAPI
                                    {}
                                  end
 
-      return JSONAPI::RelatedResourcesSetOperationResult.new(:ok,
-                                                             source_resource,
-                                                             relationship_type,
-                                                             resource_set,
-                                                             opts)
+      JSONAPI::RelatedResourcesSetOperationResult.new(:ok,
+                                                      source_resource,
+                                                      relationship_type,
+                                                      resource_set,
+                                                      opts)
     end
 
     def create_resource
@@ -235,20 +237,18 @@ module JSONAPI
       resource = resource_klass.create(context)
       result = resource.replace_fields(data)
 
-      find_options = {
-          context: context,
-          fields: fields,
-          filters: { resource_klass._primary_key => resource.id },
-          include_directives: include_directives
+      options = {
+        context: context,
+        fields: fields,
+        filters: { resource_klass._primary_key => resource.id },
+        include_directives: include_directives
       }
 
-      resource_set = find_resource_set(resource_klass,
-                                       include_directives,
-                                       find_options)
+      resource_set = find_resource_set(include_directives, options)
 
-      resource_set.populate!(serializer, context, find_options)
+      resource_set.populate!(serializer, context, options)
 
-      return JSONAPI::ResourceSetOperationResult.new((result == :completed ? :created : :accepted), resource_set, result_options)
+      JSONAPI::ResourceSetOperationResult.new((result == :completed ? :created : :accepted), resource_set, result_options)
     end
 
     def remove_resource
@@ -257,7 +257,7 @@ module JSONAPI
       resource = resource_klass.find_by_key(resource_id, context: context)
       result = resource.remove
 
-      return JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
+      JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
     end
 
     def replace_fields
@@ -272,20 +272,18 @@ module JSONAPI
 
       result = resource.replace_fields(data)
 
-      find_options = {
-          context: context,
-          fields: fields,
-          filters: { resource_klass._primary_key => resource.id },
-          include_directives: include_directives
+      options = {
+        context: context,
+        fields: fields,
+        filters: { resource_klass._primary_key => resource.id },
+        include_directives: include_directives
       }
 
-      resource_set = find_resource_set(resource_klass,
-                                       include_directives,
-                                       find_options)
+      resource_set = find_resource_set(include_directives, options)
 
-      resource_set.populate!(serializer, context, find_options)
+      resource_set.populate!(serializer, context, options)
 
-      return JSONAPI::ResourceSetOperationResult.new((result == :completed ? :ok : :accepted), resource_set, result_options)
+      JSONAPI::ResourceSetOperationResult.new((result == :completed ? :ok : :accepted), resource_set, result_options)
     end
 
     def replace_to_one_relationship
@@ -296,7 +294,7 @@ module JSONAPI
       resource = resource_klass.find_by_key(resource_id, context: context)
       result = resource.replace_to_one_link(relationship_type, key_value)
 
-      return JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
+      JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
     end
 
     def replace_polymorphic_to_one_relationship
@@ -308,7 +306,7 @@ module JSONAPI
       resource = resource_klass.find_by_key(resource_id, context: context)
       result = resource.replace_polymorphic_to_one_link(relationship_type, key_value, key_type)
 
-      return JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
+      JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
     end
 
     def create_to_many_relationships
@@ -319,7 +317,7 @@ module JSONAPI
       resource = resource_klass.find_by_key(resource_id, context: context)
       result = resource.create_to_many_links(relationship_type, data)
 
-      return JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
+      JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
     end
 
     def replace_to_many_relationships
@@ -330,7 +328,7 @@ module JSONAPI
       resource = resource_klass.find_by_key(resource_id, context: context)
       result = resource.replace_to_many_links(relationship_type, data)
 
-      return JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
+      JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
     end
 
     def remove_to_many_relationships
@@ -347,7 +345,7 @@ module JSONAPI
           complete = false
         end
       end
-      return JSONAPI::OperationResult.new(complete ? :no_content : :accepted, result_options)
+      JSONAPI::OperationResult.new(complete ? :no_content : :accepted, result_options)
     end
 
     def remove_to_one_relationship
@@ -357,7 +355,7 @@ module JSONAPI
       resource = resource_klass.find_by_key(resource_id, context: context)
       result = resource.remove_to_one_link(relationship_type)
 
-      return JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
+      JSONAPI::OperationResult.new(result == :completed ? :no_content : :accepted, result_options)
     end
 
     def result_options
@@ -366,91 +364,48 @@ module JSONAPI
       options
     end
 
-    def find_resource_set(resource_klass, include_directives, options)
-      include_related = include_directives.include_directives[:include_related] if include_directives
+    def find_resource_set(include_directives, options)
+      include_related = include_directives[:include_related] if include_directives
 
-      resource_id_tree = find_resource_id_tree(resource_klass, options, include_related)
+      resource_tree = find_resource_tree(options, include_related)
 
-      JSONAPI::ResourceSet.new(resource_id_tree)
+      JSONAPI::ResourceSet.new(resource_tree)
     end
 
     def find_related_resource_set(resource, relationship_name, include_directives, options)
-      include_related = include_directives.include_directives[:include_related] if include_directives
+      include_related = include_directives[:include_related] if include_directives
 
-      resource_id_tree = find_resource_id_tree_from_resource_relationship(resource, relationship_name, options, include_related)
+      resource_tree = find_resource_tree_from_relationship(resource, relationship_name, options, include_related)
 
-      JSONAPI::ResourceSet.new(resource_id_tree)
+      JSONAPI::ResourceSet.new(resource_tree)
     end
 
-    private
-    def find_related_resource_id_tree(resource_klass, source_id, relationship_name, find_options, include_related)
-      options = find_options.except(:include_directives)
+    def find_resource_tree(options, include_related)
       options[:cache] = resource_klass.caching?
 
-      fragments = resource_klass.find_included_fragments([source_id], relationship_name, options)
-
-      primary_resource_id_tree = PrimaryResourceIdTree.new
-      primary_resource_id_tree.add_resource_fragments(fragments, include_related)
-
-      load_included(resource_klass, primary_resource_id_tree, include_related, options)
-
-      primary_resource_id_tree
+      fragments = resource_klass.find_fragments(options[:filters], options)
+      PrimaryResourceTree.new(fragments: fragments, include_related: include_related, options: options)
     end
 
-    def find_resource_id_tree(resource_klass, find_options, include_related)
-      options = find_options
+    def find_related_resource_tree(parent_resource, relationship, options, include_related)
+      options = options.except(:include_directives)
       options[:cache] = resource_klass.caching?
 
-      fragments = resource_klass.find_fragments(find_options[:filters], options)
+      parent_resource_fragment = parent_resource.fragment(primary: true)
 
-      primary_resource_id_tree = PrimaryResourceIdTree.new
-      primary_resource_id_tree.add_resource_fragments(fragments, include_related)
-
-      load_included(resource_klass, primary_resource_id_tree, include_related, options)
-
-      primary_resource_id_tree
+      fragments = resource_klass.find_related_fragments(parent_resource_fragment, relationship, options)
+      PrimaryResourceTree.new(fragments: fragments, include_related: include_related, options: options)
     end
 
-    def find_resource_id_tree_from_resource_relationship(resource, relationship_name, find_options, include_related)
+    def find_resource_tree_from_relationship(resource, relationship_name, options, include_related)
       relationship = resource.class._relationship(relationship_name)
 
-      options = find_options.except(:include_directives)
+      options = options.except(:include_directives)
       options[:cache] = relationship.resource_klass.caching?
 
-      fragments = resource.class.find_related_fragments([resource.identity], relationship_name, options)
-
-      primary_resource_id_tree = PrimaryResourceIdTree.new
-      primary_resource_id_tree.add_resource_fragments(fragments, include_related)
-
-      load_included(resource_klass, primary_resource_id_tree, include_related, options)
+      fragments = resource.class.find_related_fragments(resource.fragment, relationship, options)
 
-      primary_resource_id_tree
-    end
-
-    def load_included(resource_klass, source_resource_id_tree, include_related, options)
-      source_rids = source_resource_id_tree.fragments.keys
-
-      include_related.try(:each_key) do |key|
-        relationship = resource_klass._relationship(key)
-        relationship_name = relationship.name.to_sym
-
-        find_related_resource_options = options.except(:filters, :sort_criteria, :paginator)
-        find_related_resource_options[:sort_criteria] = relationship.resource_klass.default_sort
-        find_related_resource_options[:cache] = resource_klass.caching?
-
-        related_fragments = resource_klass.find_included_fragments(
-          source_rids, relationship_name, find_related_resource_options
-        )
-
-        related_resource_id_tree = source_resource_id_tree.fetch_related_resource_id_tree(relationship)
-        related_resource_id_tree.add_resource_fragments(related_fragments, include_related[key][include_related])
-
-        # Now recursively get the related resources for the currently found resources
-        load_included(relationship.resource_klass,
-                      related_resource_id_tree,
-                      include_related[relationship_name][:include_related],
-                      options)
-      end
+      PrimaryResourceTree.new(fragments: fragments, include_related: include_related, options: options)
     end
   end
 end

data/lib/jsonapi/relationship.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Relationship
     attr_reader :acts_as_set, :foreign_key, :options, :name,
-                :class_name, :polymorphic, :always_include_optional_linkage_data,
+                :class_name, :polymorphic, :always_include_optional_linkage_data, :exclude_linkage_data,
                 :parent_resource, :eager_load_on_include, :custom_methods,
-                :inverse_relationship, :allow_include, :use_related_resource_records_for_joins
+                :inverse_relationship, :allow_include, :hidden, :use_related_resource_records_for_joins
 
     attr_writer :allow_include
 
@@ -15,7 +17,7 @@ module JSONAPI
       @acts_as_set = options.fetch(:acts_as_set, false) == true
       @foreign_key = options[:foreign_key] ? options[:foreign_key].to_sym : nil
       @parent_resource = options[:parent_resource]
-      @relation_name = options.fetch(:relation_name, @name)
+      @relation_name = options[:relation_name]
       @polymorphic = options.fetch(:polymorphic, false) == true
       @polymorphic_types = options[:polymorphic_types]
       if options[:polymorphic_relations]
@@ -28,15 +30,19 @@ module JSONAPI
                                                        else
                                                          JSONAPI.configuration.use_related_resource_records_for_joins
                                                        end
-      
+
       @use_related_resource_records_for_joins = options.fetch(:use_related_resource_records_for_joins,
                                                               use_related_resource_records_for_joins_default) == true
 
+      @hidden = options.fetch(:hidden, false) == true
+
+      @exclude_linkage_data = options[:exclude_linkage_data]
       @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
+      @eager_load_on_include = options.fetch(:eager_load_on_include, true) == true
       @allow_include = options[:allow_include]
       @class_name = nil
-      @inverse_relationship = nil
+
+      @inverse_relationship = options[:inverse_relationship]&.to_sym
 
       @_routed = false
       @_warned_missing_route = false
@@ -66,12 +72,26 @@ module JSONAPI
       # :nocov:
     end
 
+    def inverse_relationship
+      unless @inverse_relationship
+        @inverse_relationship ||= if resource_klass._relationship(@parent_resource._type.to_s.singularize).present?
+                                    @parent_resource._type.to_s.singularize.to_sym
+                                  elsif resource_klass._relationship(@parent_resource._type).present?
+                                    @parent_resource._type.to_sym
+                                  else
+                                    nil
+                                  end
+      end
+
+      @inverse_relationship
+    end
+
     def self.polymorphic_types(name)
       @poly_hash ||= {}.tap do |hash|
         ObjectSpace.each_object do |klass|
           next unless Module === klass
           if ActiveRecord::Base > klass
-            klass.reflect_on_all_associations(:has_many).select{|r| r.options[:as] }.each do |reflection|
+            klass.reflect_on_all_associations(:has_many).select { |r| r.options[:as] }.each do |reflection|
               (hash[reflection.options[:as]] ||= []) << klass.name.underscore
             end
           end
@@ -82,7 +102,7 @@ module JSONAPI
 
     def resource_types
       if polymorphic? && belongs_to?
-        @polymorphic_types ||= self.class.polymorphic_types(@relation_name).collect {|t| t.pluralize}
+        @polymorphic_types ||= self.class.polymorphic_types(_relation_name).collect { |t| t.pluralize }
       else
         [resource_klass._type.to_s.pluralize]
       end
@@ -93,15 +113,15 @@ module JSONAPI
     end
 
     def relation_name(options)
-      case @relation_name
-        when Symbol
-          # :nocov:
-          @relation_name
-          # :nocov:
-        when String
-          @relation_name.to_sym
-        when Proc
-          @relation_name.call(options)
+      case _relation_name
+      when Symbol
+        # :nocov:
+        _relation_name
+        # :nocov:
+      when String
+        _relation_name.to_sym
+      when Proc
+        _relation_name.call(options)
       end
     end
 
@@ -117,14 +137,14 @@ module JSONAPI
 
     def exclude_links(exclude)
       case exclude
-        when :default, "default"
-          @_exclude_links = [:self, :related]
-        when :none, "none"
-          @_exclude_links = []
-        when Array
-          @_exclude_links = exclude.collect {|link| link.to_sym}
-        else
-          fail "Invalid exclude_links"
+      when :default, "default"
+        @_exclude_links = [:self, :related]
+      when :none, "none"
+        @_exclude_links = []
+      when Array
+        @_exclude_links = exclude.collect { |link| link.to_sym }
+      else
+        fail "Invalid exclude_links"
       end
     end
 
@@ -136,6 +156,10 @@ module JSONAPI
       _exclude_links.include?(link.to_sym)
     end
 
+    def _relation_name
+      @relation_name || @name
+    end
+
     class ToOne < Relationship
       attr_reader :foreign_key_on
 
@@ -144,9 +168,16 @@ module JSONAPI
         @class_name = options.fetch(:class_name, name.to_s.camelize)
         @foreign_key ||= "#{name}_id".to_sym
         @foreign_key_on = options.fetch(:foreign_key_on, :self)
-        if parent_resource
-          @inverse_relationship = options.fetch(:inverse_relationship, parent_resource._type)
+        # if parent_resource
+        #   @inverse_relationship = options.fetch(:inverse_relationship, parent_resource._type)
+        # end
+
+        if options.fetch(:create_implicit_polymorphic_type_relationships, true) == true && polymorphic?
+          # Setup the implicit relationships for the polymorphic types and exclude linkage data
+          setup_implicit_relationships_for_polymorphic_types
         end
+
+        @polymorphic_type_relationship_for = options[:polymorphic_type_relationship_for]
       end
 
       def to_s
@@ -161,11 +192,30 @@ module JSONAPI
         # :nocov:
       end
 
+      def hidden?
+        @hidden || @polymorphic_type_relationship_for.present?
+      end
+
       def polymorphic_type
         "#{name}_type" if polymorphic?
       end
 
+      def setup_implicit_relationships_for_polymorphic_types(exclude_linkage_data: true)
+        types = self.class.polymorphic_types(_relation_name)
+        unless types.present?
+          warn "No polymorphic types found for #{parent_resource.name} #{_relation_name}"
+          return
+        end
+
+        types.each do |type|
+          parent_resource.has_one(type.to_s.underscore.singularize,
+                                  exclude_linkage_data: exclude_linkage_data,
+                                  polymorphic_type_relationship_for: name)
+        end
+      end
+
       def include_optional_linkage_data?
+        return false if @exclude_linkage_data
         @always_include_optional_linkage_data || JSONAPI::configuration.always_include_to_one_linkage_data
       end
 
@@ -176,10 +226,10 @@ module JSONAPI
                      @allow_include
                    end
 
-        if !!strategy == strategy #check for boolean
+        if !!strategy == strategy # check for boolean
           return strategy
         elsif strategy.is_a?(Symbol) || strategy.is_a?(String)
-          parent_resource.send(strategy, context)
+          parent_resource_klass.send(strategy, context)
         else
           strategy.call(context)
         end
@@ -194,17 +244,21 @@ module JSONAPI
         @class_name = options.fetch(:class_name, name.to_s.camelize.singularize)
         @foreign_key ||= "#{name.to_s.singularize}_ids".to_sym
         @reflect = options.fetch(:reflect, true) == true
-        if parent_resource
-          @inverse_relationship = options.fetch(:inverse_relationship, parent_resource._type.to_s.singularize.to_sym)
-        end
+        # if parent_resource
+        #   @inverse_relationship = options.fetch(:inverse_relationship, parent_resource._type.to_s.singularize.to_sym)
+        # end
       end
 
       def to_s
         # :nocov: useful for debugging
-        "#{parent_resource}.#{name}(ToMany)"
+        "#{parent_resource_klass}.#{name}(ToMany)"
         # :nocov:
       end
 
+      def hidden?
+        @hidden
+      end
+
       def include_optional_linkage_data?
         # :nocov:
         @always_include_optional_linkage_data || JSONAPI::configuration.always_include_to_many_linkage_data
@@ -218,10 +272,10 @@ module JSONAPI
                      @allow_include
                    end
 
-        if !!strategy == strategy #check for boolean
+        if !!strategy == strategy # check for boolean
           return strategy
         elsif strategy.is_a?(Symbol) || strategy.is_a?(String)
-          parent_resource.send(strategy, context)
+          parent_resource_klass.send(strategy, context)
         else
           strategy.call(context)
         end