add cursor based pagination

Author: accessd

.travis.yml

@@ -7,3 +7,4 @@ script: bundle exec rspec
 env:
   - PAGINATOR=kaminari
   - PAGINATOR=will_paginate
+  - PAGINATOR=cursor

CONTRIBUTING.md

@@ -3,6 +3,6 @@
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes and tests (`git commit -am 'Add some feature'`)
-4. Run the tests (`PAGINATOR=kaminari bundle exec rspec; PAGINATOR=will_paginate bundle exec rspec`)
+4. Run the tests (`PAGINATOR=kaminari bundle exec rspec; PAGINATOR=will_paginate bundle exec rspec; PAGINATOR=cursor bundle exec rspec`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request

README.md

@@ -113,6 +113,32 @@ class API::ApplicationController < ActionController::Base
 end
 ```
 
+### Cursor based pagination
+
+In brief, it's really great in case of API when your entities create/destroy frequently.
+For more information about subject please follow
+[https://www.sitepoint.com/paginating-real-time-data-cursor-based-pagination](https://www.sitepoint.com/paginating-real-time-data-cursor-based-pagination)
+
+Current implementation based on Kaminari and compatible with it model scoped config options.
+You can use it independently of Kaminari or WillPaginate.
+
+Just use `cursor_paginate` method instead of `pagination`:
+
+      def cast
+        actors = Movie.find(params[:id]).actors
+        cursor_paginate json: actors, per_page: 10
+      end
+
+You can configure the following default values by overriding these values using `Cursor.configure` method.
+
+    default_per_page  # 25 by default
+    max_per_page      # nil by default
+
+Btw you can use cursor pagination as standalone feature:
+
+    movies = Movie.cursor_page(after: 10).per(10) # Get 10 movies where id > 10
+    movies = Movie.cursor_page(before: 51).per(10) # Get 10 moview where id < 51
+
 ## Grape
 
 With Grape, `paginate` is used to declare that your endpoint takes a `:page` and `:per_page` param. You can also directly specify a `:max_per_page` that users aren't allowed to go over. Then, inside your API endpoint, it simply takes your collection:
@@ -158,6 +184,20 @@ Per-Page: 10
 # ...
 ```
 
+And example for cursor based pagination:
+
+```bash
+$ curl --include 'https://localhost:3000/movies?after=60'
+HTTP/1.1 200 OK
+Link: <http://localhost:3000/movies>; rel="first",
+  <http://localhost:3000/movies?after=90>; rel="last",
+  <http://localhost:3000/movies?after=70>; rel="next",
+  <http://localhost:3000/movies?before=61>; rel="prev"
+Total: 100
+Per-Page: 10
+```
+
+
 ## A Note on Kaminari and WillPaginate
 
 api-pagination requires either Kaminari or WillPaginate in order to function, but some users may find themselves in situations where their application includes both. For example, you may have included [ActiveAdmin][activeadmin] (which uses Kaminari for pagination) and WillPaginate to do your own pagination. While it's suggested that you remove one paginator gem or the other, if you're unable to do so, you _must_ configure api-pagination explicitly:

api-pagination.gemspec

@@ -20,5 +20,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'grape', '>= 0.10.0'
   s.add_development_dependency 'railties', '>= 3.0.0'
   s.add_development_dependency 'actionpack', '>= 3.0.0'
+  s.add_development_dependency 'activerecord', '>= 3.0.0'
   s.add_development_dependency 'sequel', '>= 4.9.0'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'database_cleaner'
 end

lib/api-pagination/configuration.rb

@@ -56,6 +56,8 @@ def paginator=(paginator)
         use_kaminari
       when :will_paginate
         use_will_paginate
+      when :cursor
+        use_cursor_paginator
       else
         raise StandardError, "Unknown paginator: #{paginator}"
       end
@@ -103,6 +105,10 @@ def last_page?() !next_page end
 
       @paginator = :will_paginate
     end
+
+    def use_cursor_paginator
+      @paginator = :cursor
+    end
   end
 
   class << self

lib/api-pagination/hooks.rb

@@ -19,6 +19,11 @@ def self.rails_parent_controller
   ActiveSupport.on_load(:action_controller) do
     ApiPagination::Hooks.rails_parent_controller.send(:include, Rails::Pagination)
   end
+
+  ActiveSupport.on_load(:active_record) do
+    require_relative '../cursor/active_record_extension'
+    ::ActiveRecord::Base.send :include, Cursor::ActiveRecordExtension
+  end
 end
 
 begin; require 'grape'; rescue LoadError; end

lib/cursor/active_record_extension.rb

@@ -0,0 +1,22 @@
+require 'cursor/active_record_model_extension'
+
+module Cursor
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Future subclasses will pick up the model extension
+      def inherited(kls) #:nodoc:
+        super
+        kls.send(:include, Cursor::ActiveRecordModelExtension) if kls.superclass == ::ActiveRecord::Base
+      end
+    end
+
+    included do
+      # Existing subclasses pick up the model extension as well
+      self.descendants.each do |kls|
+        kls.send(:include, Cursor::ActiveRecordModelExtension) if kls.superclass == ::ActiveRecord::Base
+      end
+    end
+  end
+end

lib/cursor/active_record_model_extension.rb

@@ -0,0 +1,41 @@
+require_relative 'config'
+require_relative 'configuration_methods'
+require_relative 'page_scope_methods'
+
+module Cursor
+  module ActiveRecordModelExtension
+    extend ActiveSupport::Concern
+
+    class_methods do
+      cattr_accessor :total_count
+    end
+
+    included do
+      self.send(:include, Cursor::ConfigurationMethods)
+
+      def self.cursor_page(options = {})
+        (options || {}).to_hash.symbolize_keys!
+        options[:direction] = options.keys.include?(:after) ? :after : :before
+
+        cursor_id = options[options[:direction]]
+        self.total_count = self.count
+        on_cursor(cursor_id, options[:direction]).
+          in_direction(options[:direction]).
+          limit(options[:per_page] || default_per_page).
+          extending(Cursor::PageScopeMethods)
+      end
+
+      def self.on_cursor(cursor_id, direction)
+        if cursor_id.nil?
+          where(nil)
+        else
+          where(["#{self.table_name}.id #{direction == :after ? '>' : '<'} ?", cursor_id])
+        end
+      end
+
+      def self.in_direction(direction)
+        reorder("#{self.table_name}.id #{direction == :after ? 'ASC' : 'DESC'}")
+      end
+    end
+  end
+end

lib/cursor/config.rb

@@ -0,0 +1,31 @@
+require 'active_support/configurable'
+
+module Cursor
+  # Configures global settings for Divination
+  #   Cursor.configure do |config|
+  #     config.default_per_page = 10
+  #   end
+  def self.configure(&block)
+    yield @config ||= Cursor::Configuration.new
+  end
+
+  # Global settings for Cursor
+  def self.config
+    @config
+  end
+
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor :default_per_page
+    config_accessor :max_per_page
+
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
+    end
+  end
+
+  configure do |config|
+    config.default_per_page = 25
+    config.max_per_page = nil
+  end
+end

lib/cursor/configuration_methods.rb

@@ -0,0 +1,36 @@
+module Cursor
+  module ConfigurationMethods
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Overrides the default +per_page+ value per model
+      #   class Article < ActiveRecord::Base
+      #     paginates_per 10
+      #   end
+      def paginates_per(val)
+        @_default_per_page = val
+      end
+
+      # This model's default +per_page+ value
+      # returns +default_per_page+ value unless explicitly overridden via <tt>paginates_per</tt>
+      def default_per_page
+        (defined?(@_default_per_page) && @_default_per_page) || Cursor.config.default_per_page
+      end
+
+      # Overrides the max +per_page+ value per model
+      #   class Article < ActiveRecord::Base
+      #     max_paginates_per 100
+      #   end
+      def max_paginates_per(val)
+        @_max_per_page = val
+      end
+
+      # This model's max +per_page+ value
+      # returns +max_per_page+ value unless explicitly overridden via <tt>max_paginates_per</tt>
+      def max_per_page
+        (defined?(@_max_per_page) && @_max_per_page) || Cursor.config.max_per_page
+      end
+
+    end
+  end
+end