Add per_page option to #paginate in Rails

Signed-off-by: David Celis <[email protected]>

Author: davidcelis

README.md

@@ -40,19 +40,17 @@ class MoviesController < ApplicationController
     actors = Movie.find(params[:id]).actors
 
     # Override how many Actors get returned. The default is 10.
-    params[:per_page] = 25
-
-    paginate json: actors
+    paginate json: actors, per_page: 25
   end
 end
 ```
 
 `paginate` will:
 
-* Pull your collection from `json:` or `xml:`
-* Use `params[:page]` and `params[:per_page]` to paginate your collection for you
-* Use the paginated collection to render `Link` headers
-* Call `ActionController::Base#render` with whatever you passed to `paginate`.
+1. Pull your collection from `json:` or `xml:`
+2. Use `params[:page]` and `params[:per_page]` to paginate your collection for you
+3. Use the paginated collection to render `Link` headers
+4. Call `ActionController::Base#render` with whatever you passed to `paginate`.
 
 The collection sent to `paginate` _must_ respond to your paginator's methods. For Kaminari, `Kaminari.paginate_array` will be called for you behind-the-scenes. For WillPaginate, you're out of luck unless you somewhere `require 'will_paginate/array'`. Because this pollutes `Array`, it won't be done for you automatically.
 

lib/api-pagination.rb

@@ -5,16 +5,16 @@ module ApiPagination
   class << self
     attr_reader :paginator
 
-    def paginate(collection, options = {}, &block)
+    def paginate(collection, options = {})
       options[:page]     ||= 1
       options[:per_page] ||= 10
 
       case ApiPagination.paginator
       when :kaminari
         collection = Kaminari.paginate_array(collection) if collection.is_a?(Array)
-        collection.page(options[:page]).per(options[:per_page]).tap(&block)
+        collection.page(options[:page]).per(options[:per_page])
       when :will_paginate
-        collection.paginate(:page => options[:page], :per_page => options[:per_page]).tap(&block)
+        collection.paginate(:page => options[:page], :per_page => options[:per_page])
       end
     end
 

lib/grape/pagination.rb

@@ -3,22 +3,22 @@ module Pagination
     def self.included(base)
       Grape::Endpoint.class_eval do
         def paginate(collection)
-          block = Proc.new do |collection|
-            links = (header['Link'] || "").split(',').map(&:strip)
-            url   = request.url.sub(/\?.*$/, '')
-            pages = ApiPagination.pages_from(collection)
+          collection = ApiPagination.paginate(collection, params)
 
-            pages.each do |k, v|
-              old_params = Rack::Utils.parse_query(request.query_string)
-              new_params = old_params.merge('page' => v)
-              links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
-            end
+          links = (header['Link'] || "").split(',').map(&:strip)
+          url   = request.url.sub(/\?.*$/, '')
+          pages = ApiPagination.pages_from(collection)
 
-            header 'Link', links.join(', ') unless links.empty?
-            header 'Total', ApiPagination.total_from(collection)
+          pages.each do |k, v|
+            old_params = Rack::Utils.parse_query(request.query_string)
+            new_params = old_params.merge('page' => v)
+            links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
           end
 
-          ApiPagination.paginate(collection, params, &block)
+          header 'Link', links.join(', ') unless links.empty?
+          header 'Total', ApiPagination.total_from(collection)
+
+          return collection
         end
       end
 

lib/rails/pagination.rb

@@ -5,7 +5,7 @@ module Pagination
     def paginate(options)
       collection = options[:json] || options[:xml]
 
-      collection     = _paginate_collection(collection)
+      collection     = _paginate_collection(collection, options)
       options[:json] = collection if options[:json]
       options[:xml]  = collection if options[:xml]
 
@@ -18,22 +18,23 @@ def paginate_with(collection)
 
     private
 
-    def _paginate_collection(collection)
-      block = Proc.new do |collection|
-        links = (headers['Link'] || "").split(',').map(&:strip)
-        url   = request.original_url.sub(/\?.*$/, '')
-        pages = ApiPagination.pages_from(collection)
+    def _paginate_collection(collection, options)
+      params[:per_page] = options.delete(:per_page) if options[:per_page]
+      collection = ApiPagination.paginate(collection, params)
 
-        pages.each do |k, v|
-          new_params = request.query_parameters.merge(:page => v)
-          links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
-        end
+      links = (headers['Link'] || "").split(',').map(&:strip)
+      url   = request.original_url.sub(/\?.*$/, '')
+      pages = ApiPagination.pages_from(collection)
 
-        headers['Link']  = links.join(', ') unless links.empty?
-        headers['Total'] = ApiPagination.total_from(collection)
+      pages.each do |k, v|
+        new_params = request.query_parameters.merge(:page => v)
+        links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
       end
 
-      ApiPagination.paginate(collection, params, &block)
+      headers['Link']  = links.join(', ') unless links.empty?
+      headers['Total'] = ApiPagination.total_from(collection)
+
+      return collection
     end
   end
 end