Refactor ActiveRelationResourceFinder into ActiveRelationResource

Make Resource derive from ActiveRelationResource

Support concept of `root_resource` for when we need to walk back up
the resource ancestor chain since there can now be more than one root
resource class (not just `JSONAPI::Resource`).

Author: lgebhardt

lib/jsonapi-resources.rb

@@ -1,6 +1,8 @@
 require 'jsonapi/resources/railtie'
 require 'jsonapi/naive_cache'
 require 'jsonapi/compiled_json'
+require 'jsonapi/basic_resource'
+require 'jsonapi/active_relation_resource'
 require 'jsonapi/resource'
 require 'jsonapi/cached_response_fragment'
 require 'jsonapi/response_document'
@@ -25,8 +27,8 @@
 require 'jsonapi/operation_result'
 require 'jsonapi/callbacks'
 require 'jsonapi/link_builder'
-require 'jsonapi/active_relation_resource_finder'
-require 'jsonapi/active_relation_resource_finder/join_manager'
+require 'jsonapi/active_relation/adapters/join_left_active_record_adapter'
+require 'jsonapi/active_relation/join_manager'
 require 'jsonapi/resource_identity'
 require 'jsonapi/resource_fragment'
 require 'jsonapi/resource_id_tree'

lib/jsonapi/active_relation_resource_finder/adapters/join_left_active_record_adapter.rb renamed to lib/jsonapi/active_relation/adapters/join_left_active_record_adapter.rb

@@ -1,5 +1,5 @@
 module JSONAPI
-  module ActiveRelationResourceFinder
+  module ActiveRelation
     module Adapters
       module JoinLeftActiveRecordAdapter
 

lib/jsonapi/active_relation_resource_finder/join_manager.rb renamed to lib/jsonapi/active_relation/join_manager.rb

@@ -1,5 +1,5 @@
 module JSONAPI
-  module ActiveRelationResourceFinder
+  module ActiveRelation
 
   # Stores relationship paths starting from the resource_klass, consolidating duplicate paths from
   # relationships, filters and sorts. When joins are made the table aliases are tracked in join_details

lib/jsonapi/active_relation_resource_finder.rb renamed to lib/jsonapi/active_relation_resource.rb

@@ -1,13 +1,8 @@
-require 'jsonapi/active_relation_resource_finder/adapters/join_left_active_record_adapter'
-
 module JSONAPI
-  module ActiveRelationResourceFinder
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
+  class ActiveRelationResource < BasicResource
+    root_resource
 
+    class << self
       # Finds Resources using the `filters`. Pagination and sort options are used when provided
       #
       # @param filters [Hash] the filters hash
@@ -19,9 +14,9 @@ module ClassMethods
       def find(filters, options = {})
         sort_criteria = options.fetch(:sort_criteria) { [] }
 
-        join_manager = JoinManager.new(resource_klass: self,
-                                    filters: filters,
-                                    sort_criteria: sort_criteria)
+        join_manager = ActiveRelation::JoinManager.new(resource_klass: self,
+                                                       filters: filters,
+                                                       sort_criteria: sort_criteria)
 
         paginator = options[:paginator]
 
@@ -41,8 +36,8 @@ def find(filters, options = {})
       #
       # @return [Integer] the count
       def count(filters, options = {})
-        join_manager = JoinManager.new(resource_klass: self,
-                                    filters: filters)
+        join_manager = ActiveRelation::JoinManager.new(resource_klass: self,
+                                                       filters: filters)
 
         records = apply_request_settings_to_records(records: records(options),
                                filters: filters,
@@ -101,11 +96,11 @@ def find_fragments(filters, options = {})
 
         sort_criteria = options.fetch(:sort_criteria) { [] }
 
-        join_manager = JoinManager.new(resource_klass: resource_klass,
-                                    source_relationship: nil,
-                                    relationships: linkage_relationships,
-                                    sort_criteria: sort_criteria,
-                                    filters: filters)
+        join_manager = ActiveRelation::JoinManager.new(resource_klass: resource_klass,
+                                                       source_relationship: nil,
+                                                       relationships: linkage_relationships,
+                                                       sort_criteria: sort_criteria,
+                                                       filters: filters)
 
         paginator = options[:paginator]
 
@@ -234,9 +229,9 @@ def count_related(source_rid, relationship_name, options = {})
         filters = options.fetch(:filters, {})
 
         # Joins in this case are related to the related_klass
-        join_manager = JoinManager.new(resource_klass: self,
-                                    source_relationship: relationship,
-                                    filters: filters)
+        join_manager = ActiveRelation::JoinManager.new(resource_klass: self,
+                                                       source_relationship: relationship,
+                                                       filters: filters)
 
         records = apply_request_settings_to_records(records: records(options),
                                resource_klass: related_klass,
@@ -252,7 +247,7 @@ def count_related(source_rid, relationship_name, options = {})
         count_records(records)
       end
 
-      # This resource finder (ActiveRecordResourceFinder) uses an `ActiveRecord::Relation` as the starting point for
+      # This resource class (ActiveRelationResource) uses an `ActiveRecord::Relation` as the starting point for
       # retrieving models. From this relation filters, sorts and joins are applied as needed.
       # Depending on which phase of the request processing different `records` methods will be called, giving the user
       # the opportunity to override them differently for performance and security reasons.
@@ -385,11 +380,11 @@ def find_related_monomorphic_fragments(source_rids, relationship, options, conne
           sort_criteria << { field: field, direction: sort[:direction] }
         end
 
-        join_manager = JoinManager.new(resource_klass: self,
-                                    source_relationship: relationship,
-                                    relationships: linkage_relationships,
-                                    sort_criteria: sort_criteria,
-                                    filters: filters)
+        join_manager = ActiveRelation::JoinManager.new(resource_klass: self,
+                                                       source_relationship: relationship,
+                                                       relationships: linkage_relationships,
+                                                       sort_criteria: sort_criteria,
+                                                       filters: filters)
 
         paginator = options[:paginator] if source_rids.count == 1
 
@@ -511,10 +506,10 @@ def find_related_polymorphic_fragments(source_rids, relationship, options, conne
           end
         end
 
-        join_manager = JoinManager.new(resource_klass: self,
-                                    source_relationship: relationship,
-                                    relationships: linkage_relationships,
-                                    filters: filters)
+        join_manager = ActiveRelation::JoinManager.new(resource_klass: self,
+                                                       source_relationship: relationship,
+                                                       relationships: linkage_relationships,
+                                                       filters: filters)
 
         paginator = options[:paginator] if source_rids.count == 1
 
@@ -672,14 +667,14 @@ def find_related_polymorphic_fragments(source_rids, relationship, options, conne
       end
 
       def apply_request_settings_to_records(records:,
-                       join_manager: JoinManager.new(resource_klass: self),
-                       resource_klass: self,
-                       filters: {},
-                       primary_keys: nil,
-                       sort_criteria: nil,
-                       sort_primary: nil,
-                       paginator: nil,
-                       options: {})
+                                            join_manager: ActiveRelation::JoinManager.new(resource_klass: self),
+                                            resource_klass: self,
+                                            filters: {},
+                                            primary_keys: nil,
+                                            sort_criteria: nil,
+                                            sort_primary: nil,
+                                            paginator: nil,
+                                            options: {})
 
         opts = options.dup
         records = resource_klass.apply_joins(records, join_manager, opts)

lib/jsonapi/basic_resource.rb

@@ -5,6 +5,10 @@ module JSONAPI
   class BasicResource
     include Callbacks
 
+    @abstract = true
+    @immutable = true
+    @root = true
+
     attr_reader :context
 
     define_jsonapi_resources_callbacks :create,
@@ -893,6 +897,16 @@ def _polymorphic_resource_klasses
         end
       end
 
+      def root_resource
+        @abstract = true
+        @immutable = true
+        @root = true
+      end
+
+      def root?
+        @root
+      end
+
       def abstract(val = true)
         @abstract = val
       end

lib/jsonapi/configuration.rb

@@ -1,6 +1,5 @@
 require 'jsonapi/formatter'
 require 'jsonapi/processor'
-require 'jsonapi/active_relation_resource_finder'
 require 'concurrent'
 
 module JSONAPI
@@ -17,7 +16,6 @@ class Configuration
                 :default_paginator,
                 :default_page_size,
                 :maximum_page_size,
-                :default_resource_finder,
                 :default_processor_klass,
                 :use_text_errors,
                 :top_level_links_include_pagination,
@@ -105,12 +103,6 @@ def initialize
       self.always_include_to_one_linkage_data = false
       self.always_include_to_many_linkage_data = false
 
-      # ResourceFinder Mixin
-      # The default ResourceFinder is the ActiveRelationResourceFinder which provides
-      # access to ActiveRelation backed models. Custom ResourceFinders can be specified
-      # in order to support other ORMs.
-      self.default_resource_finder = JSONAPI::ActiveRelationResourceFinder
-
       # The default Operation Processor to use if one is not defined specifically
       # for a Resource.
       self.default_processor_klass = JSONAPI::Processor
@@ -225,10 +217,6 @@ def default_processor_klass=(default_processor_klass)
       @default_processor_klass = default_processor_klass
     end
 
-    def default_resource_finder=(default_resource_finder)
-      @default_resource_finder = default_resource_finder
-    end
-
     def allow_include=(allow_include)
       ActiveSupport::Deprecation.warn('`allow_include` has been replaced by `default_allow_include_to_one` and `default_allow_include_to_many` options.')
       @default_allow_include_to_one = allow_include

lib/jsonapi/relationship.rb

@@ -27,7 +27,7 @@ def initialize(name, options = {})
       @class_name = nil
       @inverse_relationship = nil
 
-      # Custom methods are reserved for use in resource finders. Not used in the default ActiveRelationResourceFinder
+      # Custom methods are reserved for future use
       @custom_methods = options.fetch(:custom_methods, {})
     end
 

lib/jsonapi/resource.rb

@@ -0,0 +1,5 @@
+module JSONAPI
+  class Resource < ActiveRelationResource
+    root_resource
+  end
+end

lib/jsonapi/resource_serializer.rb

@@ -199,7 +199,7 @@ def supplying_attribute_fields(resource_klass)
       @_supplying_attribute_fields.fetch resource_klass do
         attrs = Set.new(resource_klass._attributes.keys.map(&:to_sym))
         cur = resource_klass
-        while cur != JSONAPI::Resource
+        while !cur.root? # do not traverse beyond the first root resource
           if @fields.has_key?(cur._type)
             attrs &= @fields[cur._type]
             break
@@ -214,7 +214,7 @@ def supplying_relationship_fields(resource_klass)
       @_supplying_relationship_fields.fetch resource_klass do
         relationships = Set.new(resource_klass._relationships.keys.map(&:to_sym))
         cur = resource_klass
-        while cur != JSONAPI::Resource
+        while !cur.root? # do not traverse beyond the first root resource
           if @fields.has_key?(cur._type)
             relationships &= @fields[cur._type]
             break

test/fixtures/active_record.rb

@@ -1503,12 +1503,10 @@ class EmployeeResource < JSONAPI::Resource
   has_many :expense_entries
 end
 
-module BreedResourceFinder
-  def self.included(base)
-    base.extend ClassMethods
-  end
+class PoroResource < JSONAPI::BasicResource
+  root_resource
 
-  module ClassMethods
+  class << self
     def find(filters, options = {})
       records = find_breeds(filters, options)
       resources_for(records, options[:context])
@@ -1563,9 +1561,7 @@ def find_breeds_by_keys(keys, options = {})
   end
 end
 
-class BreedResource < JSONAPI::Resource
-
-  resource_finder BreedResourceFinder
+class BreedResource < PoroResource
 
   attribute :name, format: :title