Paginator Order Context

README.md

@@ -427,9 +427,9 @@ from the configuration settings is used.
 
 ###### Custom Paginators
 
-Custom `paginators` can be used. These should derive from `Paginator`. The `apply` method takes a `relation` and is 
-expected to return a `relation`. The `initialize` method receives the parameters from the `page` request parameters. It 
-is up to the paginator author to parse and validate these parameters.
+Custom `paginators` can be used. These should derive from `Paginator`. The `apply` method takes a `relation` and
+`order_options` and is expected to return a `relation`. The `initialize` method receives the parameters from the `page`
+request parameters. It is up to the paginator author to parse and validate these parameters.
 
 For example, here is a very simple single record at a time paginator:
 
@@ -440,7 +440,7 @@ class SingleRecordPaginator < JSONAPI::Paginator
     @page = params.to_i
   end
 
-  def apply(relation)
+  def apply(relation, order_options)
     relation.offset(@page).limit(1)
   end
 end

lib/jsonapi/paginator.rb

@@ -3,7 +3,7 @@ class Paginator
     def initialize(params)
     end
 
-    def apply(relation)
+    def apply(relation, order_options)
       # relation
     end
 
@@ -22,7 +22,7 @@ def initialize(params)
     verify_pagination_params
   end
 
-  def apply(relation)
+  def apply(relation, order_options)
     relation.offset(@offset).limit(@limit)
   end
 
@@ -63,7 +63,7 @@ def initialize(params)
     verify_pagination_params
   end
 
-  def apply(relation)
+  def apply(relation, order_options)
     offset = (@number - 1) * @size
     relation.offset(offset).limit(@size)
   end

lib/jsonapi/resource.rb

@@ -311,9 +311,9 @@ def apply_includes(records, directives)
         records
       end
 
-      def apply_pagination(records, paginator)
+      def apply_pagination(records, paginator, order_options)
         if paginator
-          records = paginator.apply(records)
+          records = paginator.apply(records, order_options)
         end
         records
       end
@@ -354,13 +354,15 @@ def apply_filters(records, filters)
       end
 
       def filter_records(filters, options)
-        sort_criteria = options.fetch(:sort_criteria) { [] }
         include_directives = options[:include_directives]
 
         records = records(options)
         records = apply_includes(records, include_directives)
-        records = apply_filters(records, filters)
-        apply_sort(records, construct_order_options(sort_criteria))
+        apply_filters(records, filters)
+      end
+
+      def sort_records(records, order_options)
+        apply_sort(records, order_options)
       end
 
       def find_count(filters, options = {})
@@ -372,7 +374,12 @@ def find(filters, options = {})
         context = options[:context]
 
         records = filter_records(filters, options)
-        records = apply_pagination(records, options[:paginator])
+
+        sort_criteria = options.fetch(:sort_criteria) { [] }
+        order_options = construct_order_options(sort_criteria)
+        records = sort_records(records, order_options)
+
+        records = apply_pagination(records, options[:paginator], order_options)
 
         resources = []
         records.each do |model|
@@ -587,11 +594,13 @@ def _associate(klass, *attrs)
               paginator = options[:paginator]
 
               resources = []
+
               if resource_class
                 records = public_send(associated_records_method_name)
                 records = resource_class.apply_filters(records, filters)
-                records = resource_class.apply_sort(records, self.class.construct_order_options(sort_criteria))
-                records = resource_class.apply_pagination(records, paginator)
+                order_options = self.class.construct_order_options(sort_criteria)
+                records = resource_class.apply_sort(records, order_options)
+                records = resource_class.apply_pagination(records, paginator, order_options)
                 records.each do |record|
                   resources.push resource_class.new(record, @context)
                 end

test/unit/resource/resource_test.rb

@@ -189,7 +189,7 @@ def test_has_many_association_pagination
 
     # define apply_filters method on post resource to not respect filters
     PostResource.instance_eval do
-      def apply_pagination(records, criteria)
+      def apply_pagination(records, criteria, order_options)
         records
       end
     end
@@ -200,7 +200,7 @@ def initialize(params)
         @page = params.to_i
       end
 
-      def apply(relation)
+      def apply(relation, order_options)
         relation.offset(@page).limit(1)
       end
     end
@@ -210,7 +210,7 @@ def apply(relation)
 
     # reset method to original implementation
     PostResource.instance_eval do
-      def apply_pagination(records, criteria)
+      def apply_pagination(records, criteria, order_options)
         super
       end
     end