rb_pager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf018c14e4ab9b25829e3400dee85caa296f7fcbd4cbdd96020eff0c620c5beb
+  data.tar.gz: 5629f3891861dda8bc388adcf3fd8196ba569bfb408ed2377bf80d61b1144871
+SHA512:
+  metadata.gz: 370e67a57d010703c5d75dc4c0378876a39ad06d72da1d018d63eff8fc5ead95dce518cc2e4312dcc6181ea0c454e511fce210925686e8325f5e5b5b578106c9
+  data.tar.gz: 293378b679c82b97df6a25c35105e2024f3e1a8ad835261de14694cc23ffc34720b919fc8e26df8b136d0b8cb56171ffaf924a9c2e20dcfdd88bf5fb39bc10f7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pager.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 BambangSinaga
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+
+# Pager
+
+
+Cursor-based pagination (aka keyset pagination) is a  [common](https://slack.engineering/evolving-api-pagination-at-slack-1c1f644f8e12)  [pagination strategy](https://www.citusdata.com/blog/2016/03/30/five-ways-to-paginate/)  that avoids many of the pitfalls of “offset–limit” pagination.
+
+For example, with offset–limit pagination, if an item from a prior page is deleted while the client is paginating, all subsequent results will be shifted forward by one. Therefore, when the client requests the next page, there’s one result that it will skip over and never see. Conversely, if a result is added to the list of results as the client is paginating, the client may see the same result multiple times, on different pages. Cursor-based pagination can prevent both of these possibilities.
+
+Cursor-based pagination also performs better for large data sets under most implementations.
+
+To support cursor-based pagination, this specification defines three query parameters `after`, `limit`, `sort`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rb_pager'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rb_pager
+
+Add the [rb_pager.rb](https://github.com/BambangSinaga/rb_pager/blob/master/lib/config/rb_pager.rb)
+
+If you use Rails, put it into the `config/initializers` dir
+
+## Usage
+
+Once the gem installed on your project, usually you don't need to do anything.
+The system use 	`Base64.strict_decode64` and `Base64.strict_encode64` for cursor values
+
+```ruby
+# return first 20 employee records, by default limit set to 20
+Employee.pager(after:  nil)
+
+# return first 15 employee records
+Employee.pager(after:  nil, limit: 15)
+
+# return first 10 employee records order by created_at asc
+# /employee?limit=10&sort=created_at
+Employee.pager(after:  nil, limit:  10, sort:  'created_at')
+
+# return first 10 employee records order by created_at desc
+# /employee?limit=10&sort=-created_at
+Employee.pager(after:  nil, limit:  10, sort:  '-created_at')
+
+# [order by non uniq column](https://engineering.shopify.com/blogs/engineering/pagination-relative-cursors)
+# /employee?limit=10&sort=name,id
+Employee.pager(after:  nil, limit:  10, sort:  'name,id')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/BambangSinaga/rb_pager. This project is intended to be a safe, welcoming space for collaboration, and contributors.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pager"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/config/rb_pager.rb

@@ -0,0 +1,4 @@
+# Pager.configure do |config|
+#   config.limit = 15
+#   config.max_limit = 100
+# end

data/lib/rb_pager.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+require 'rb_pager/version'
+require "rb_pager/configuration"
+
+module RbPager
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end
+
+if defined?(ActiveRecord)
+  require 'rb_pager/orm/pager_active_record'
+  ActiveRecord::Base.send :include, RbPager::ActiveRecord
+end

data/lib/rb_pager/configuration.rb

@@ -0,0 +1,14 @@
+module RbPager
+  class Configuration
+    attr_accessor :limit, :max_limit
+
+    def initialize
+      @limit = 20
+      @max_limit = 100
+    end
+
+    def limit=(val)
+      @limit = [val, @max_limit].min
+    end
+  end
+end

data/lib/rb_pager/orm/pager_active_record.rb

@@ -0,0 +1,133 @@
+module RbPager
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      AR_ORDER = { '+' => :asc, '-' => :desc }
+      AREL_ORDER = { asc: :gt, desc: :lt }
+
+      def pager(after:, limit: nil, sort: nil)
+        page_limit = limit || RbPager.configuration.limit
+        sort_params = sort
+        sorted_columns, sorter = build_order_expression(sort)
+        collection = if after.nil?
+                       order(sorter).extending(ActiveRecordRelationMethods).limit(page_limit)
+                     else
+                       custom_expression = create_custom_expression(after, sorted_columns)
+                       where(custom_expression).order(sorter).extending(ActiveRecordRelationMethods).limit(page_limit)
+                     end
+
+        create_paginate_meta(collection, sorted_columns)
+      end
+
+      private
+
+      def create_custom_expression(cursor_params, sorted_columns)
+        decode_cursor_params = JSON.parse(Base64.strict_decode64(cursor_params))
+        return arel_table[primary_key].gt(decode_cursor_params[primary_key]) if sorted_columns.blank?
+
+        filter_ordered_columns = filter_with_ordered_columns(decode_cursor_params, sorted_columns)
+        filter_primary_key = filter_with_primary_key(decode_cursor_params)
+
+        filter_ordered_columns.or(filter_primary_key)
+      end
+
+      def filter_with_ordered_columns(decode_cursor_params, sorted_columns)
+        result = self
+        sorted_columns.each_with_index do |(column, type), index|
+          result = if index.zero?
+                     result.arel_table[column].send(AREL_ORDER[type])
+                   else
+                     result.or(arel_table[column].send(AREL_ORDER[type]))
+                   end
+        end
+
+        result
+      end
+
+      def filter_with_primary_key(decode_cursor_params)
+        result = self
+
+        decode_cursor_params.each_with_index do |(column, value), index|
+          result = if index.zero?
+                     result.arel_table[column].gt(value)
+                   else
+                     result.and(arel_table[column].eq(value))
+                   end
+        end
+
+        result
+      end
+
+      def build_order_expression(sort_params)
+        return {} if sort_params.nil?
+
+        sort_order = { '+' => 'ASC', '-' => 'DESC' }
+        sorted_params = {}
+        arel_orders = []
+
+        sort_params.split(',').each do |field|
+          next unless attribute_names.include?(field)
+
+          sort_sign = field =~ /\A[+-]/ ? field.slice!(0) : '+'
+          arel_orders << arel_table[field].send(AR_ORDER[sort_sign])
+          sorted_params[field] = AR_ORDER[sort_sign]
+        end
+
+        [sorted_params, arel_orders]
+      end
+
+      def create_paginate_meta(collection, sorted_columns)
+        next_cursor = next_cursor(collection, sorted_columns)
+
+        meta = { next_cursor: next_cursor }
+        [collection.to_a, meta]
+      end
+
+      def next_cursor(collection, sorted_columns)
+        return '' unless collection.left_over?
+
+        next_cursor = { 'id': collection.last.id }
+
+        sorted_columns.each do |key, _value|
+          next_cursor.merge!(Hash[key, collection.last.send(key)])
+        end
+
+        Base64.strict_encode64(next_cursor.to_json)
+      end
+    end
+
+    module ActiveRecordRelationMethods
+      def left_over?
+        @left_over ||= begin
+          # Cache #size otherwise multiple calls to the database will occur.
+          size.positive? && size < total_size
+        end
+      end
+
+      # Returns number of records that exist in scope of the current cursor
+      def total_size(column_name = :all) #:nodoc:
+        # #count overrides the #select which could include generated columns
+        # referenced in #order, so skip #order here, where it's irrelevant to the
+        # result anyway.
+        @total_size ||= begin
+          context = except(:offset, :limit, :order)
+
+          # Remove includes only if they are irrelevant
+          context = context.except(:includes) unless references_eager_loaded_tables?
+
+          args = [column_name]
+
+          # .group returns an OrderedHash that responds to #count
+          context = context.count(*args)
+
+          if context.is_a?(Hash) || context.is_a?(ActiveSupport::OrderedHash)
+            context.count
+          else
+            context.respond_to?(:count) ? context.count(*args) : context
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rb_pager/version.rb

@@ -0,0 +1,3 @@
+module RbPager
+  VERSION = "0.1.0"
+end

data/rb_pager.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/rb_pager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rb_pager"
+  spec.version       = RbPager::VERSION
+  spec.authors       = ["BambangSinaga"]
+  spec.email         = ["mejbambang@gmail.com"]
+
+  spec.summary       = "Cursor based pagination for active_record currently"
+  spec.description   = %q{ActiveRecord plugin for cursor based pagination for Ruby on Rails. \n
+    Cursor-based pagination (aka keyset pagination) is a common pagination strategy that avoids many of the pitfalls of “offset–limit” pagination.}
+  spec.homepage      = "https://github.com/BambangSinaga/rb_pager"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/BambangSinaga/rb_pager"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "rspec"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rb_pager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BambangSinaga
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  ActiveRecord plugin for cursor based pagination for Ruby on Rails. \n
+      Cursor-based pagination (aka keyset pagination) is a common pagination strategy that avoids many of the pitfalls of “offset–limit” pagination.
+email:
+- mejbambang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/config/rb_pager.rb
+- lib/rb_pager.rb
+- lib/rb_pager/configuration.rb
+- lib/rb_pager/orm/pager_active_record.rb
+- lib/rb_pager/version.rb
+- rb_pager.gemspec
+homepage: https://github.com/BambangSinaga/rb_pager
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/BambangSinaga/rb_pager
+  source_code_uri: https://github.com/BambangSinaga/rb_pager
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Cursor based pagination for active_record currently
+test_files: []