Merge pull request #1244 from cerebris/abandon_resource_finders

Abandon resource finders

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)