pageturner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 128baac342d6a592fff5b5c7d5064c589a94fa20
+  data.tar.gz: 0533f51c7ae40bc2975e1c8cc57241a989e07353
+SHA512:
+  metadata.gz: d2f9071c28a1371e973a49e8905c9adfca6deb60bece647380cfb17a9a1f6917766ab841a2f3945d6a3ad80f2ff92361dd8577a955270713943128ca9997013b
+  data.tar.gz: 8e0e0e40e10a493e840bdd400b5f21719e7cdcf077c773ed1fdb4cb975c2299cef6915a3957ba2094a4798f53e7531657004621ef40cabdcc8bcbe73d0751cbc

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pageturner.gemspec
+gemspec

data/README.md

@@ -0,0 +1,78 @@
+# Pageturner
+
+Value based pagination for `ActiveRecord::Relation` instances.
+
+TODO: remove page size. let the caller limit the relation accordingly
+TODO: remove the path helper. expose the cursor instead and let the caller generate the next link
+TODO: automate testing setup that requires installing mysql, starting the server, creating the database, etc.
+TODO: make gem database agnostic
+
+## Usage
+
+In your controllers:
+
+```ruby
+@pagination = Pageturner.new(
+  anchor_column: "name",
+  anchor_id: params[:last_id],
+  anchor_value: params[:last_value],
+  ar_relation: Model.where(params[:filters]),
+  sort_direction: Pageturner::DESC,
+  path_helper: lambda do |anchor_column:, anchor_value:, sort_direction:, anchor_id:|
+    models_path(
+      anchor_column: anchor_column,
+      anchor_value: anchor_value,
+      sort_direction: sort_direction,
+      anchor_id: anchor_id
+    )
+  end
+)
+```
+
+In your views:
+
+```ruby
+json.models @pagination.resources do |resource|
+  json.partial! 'attributes', model: resource
+end
+
+json.pagination do
+  json.next_page @pagination.next_page
+end
+```
+
+## API
+
+### `#next_page`
+
+Returns the next page's path.
+
+### `#resources`
+
+Returns the current page's collection.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pageturner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pageturner
+
+## 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/crzrcn/pageturner.

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 "pageturner"
+
+# 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/pageturner.rb

@@ -0,0 +1,169 @@
+class Pageturner
+  ASC = "asc"
+  COMPARATOR_INTERNAL_BUG = "sort_direction input has an unexpected value. Contact Pageturner mantainer for support."
+  DESC = "desc"
+  GREATER_THAN_OPERATOR = ">"
+  LESS_THAN_OPERATOR = "<"
+  PAGE_SIZE = 3 # TODO: remove since it's a caller concern.
+
+  # @param [String] anchor_column - Field to paginate on.
+  # @param [String|Number|nil] anchor_value - Value of the anchor_column for the record to paginate from.
+  # @param [ActiveRecord::Relation] ar_relation - Resource collection to paginate.
+  # @param [String] sort_direction - Order of the pagination. Valid values: Pageturner::ASC, Pageturner::DESC.
+  # @param [Proc] path_helper - Function that generates the next page link. This function should have any state that's not relevant to pagination partially applied.
+  # @param [Number] anchor_id - ID of the record to paginate from.
+  def initialize(anchor_column:, anchor_value:, ar_relation:, sort_direction:, path_helper:, anchor_id:)
+    # To be used outside dynamic SQL statements.
+    @anchor_column = anchor_column
+
+    # To be used in dynamic SQL queries.
+    @sql_anchor_column = ActiveRecord::Base.connection.quote_column_name(anchor_column)
+
+    @anchor_value = anchor_value
+
+    @ar_relation = ar_relation
+
+    # Always select id to use it as secondary sort to prevent non-deterministic ordering when primary sort is on a non-unique column.
+    unless primary_key_selected?(@ar_relation)
+      raise Exception::PrimaryKeyNotSelected, "The provided ActiveRecord::Relation does not have the primary key selected. Cursor pagination requires a primary key to paginate undeterministic columns."
+    end
+
+    @sort_direction = sort_direction
+    @path_helper = path_helper
+    @anchor_id = anchor_id
+
+    unless [Pageturner::ASC, Pageturner::DESC].include?(@sort_direction)
+      raise Exception::InvalidSortDirection, "The provided order is not supported. Supported order values are: '#{ASC}', '#{DESC}'"
+    end
+  end
+
+  def resources
+    # Memoize expensive querying.
+    return @result if defined?(@result)
+
+    @result = calculate_resources
+  end
+
+  def next_page
+    anchor_value =
+      if external_anchor_column?
+        public_send_chain_from_sql(self.resources.last, @anchor_column)
+      else
+        self.resources.last&.public_send(@anchor_column)
+      end
+
+    @path_helper.call(
+      anchor_column: @anchor_column,
+      anchor_value: anchor_value,
+      sort_direction: @sort_direction,
+      anchor_id: self.resources.last&.id
+    )
+  end
+
+  private
+
+  def calculate_resources
+    resources =
+      if can_calculate_nth_page?
+        calculate_next_page
+      else
+        calculate_first_page
+      end
+
+    resources
+  end
+
+  def comparator_for_fetching_resources
+    if @sort_direction == Pageturner::ASC
+      GREATER_THAN_OPERATOR
+    elsif @sort_direction == Pageturner::DESC
+      LESS_THAN_OPERATOR
+    else
+      raise COMPARATOR_INTERNAL_BUG
+    end
+  end
+
+  def can_calculate_nth_page?
+    @anchor_column && @anchor_id
+  end
+
+  def calculate_first_page
+    apply_sort_direction(@ar_relation)
+  end
+
+  def calculate_next_page
+    if external_anchor_column?
+      table, column = @anchor_column.split(".")
+
+      qualified_anchor_column = "`#{table}`.`#{column}`"
+    else
+      qualified_anchor_column = "#{@ar_relation.quoted_table_name}.#{@sql_anchor_column}"
+    end
+
+    qualified_anchor_pk_column = "#{@ar_relation.quoted_table_name}.#{@ar_relation.quoted_primary_key}"
+
+    where_clause =
+      if nulls_listed_first? && !@anchor_value.nil?
+        @ar_relation.where("(#{qualified_anchor_column}, #{qualified_anchor_pk_column}) #{comparator_for_fetching_resources} (?, ?)", @anchor_value, @anchor_id)
+      elsif nulls_listed_first? && @anchor_value.nil?
+        @ar_relation.where("(#{qualified_anchor_column} IS NULL AND #{qualified_anchor_pk_column} #{comparator_for_fetching_resources} ?) OR (#{qualified_anchor_column} IS NOT NULL)", @anchor_id)
+      elsif nulls_listed_last? && !@anchor_value.nil?
+        @ar_relation.where("(#{qualified_anchor_column} IS NULL) OR ((#{qualified_anchor_column}, #{qualified_anchor_pk_column}) #{comparator_for_fetching_resources} (?, ?))", @anchor_value, @anchor_id)
+      elsif nulls_listed_last? && @anchor_value.nil?
+        @ar_relation.where("#{qualified_anchor_column} IS NULL AND #{qualified_anchor_pk_column} #{comparator_for_fetching_resources} ?", @anchor_id)
+      end
+
+    apply_sort_direction(where_clause)
+  end
+
+  def apply_sort_direction(ar_relation)
+    ar_relation
+      .order("#{@anchor_column} #{@sort_direction}", @ar_relation.primary_key => @sort_direction)
+      .limit(PAGE_SIZE)
+  end
+
+  def nulls_listed_first?
+    # MySQL sorts nulls first for ascending order, and null last for descending order.
+    # TODO:
+    #   The concept of null ordering should be database agnostic and modifiable.
+    #   For example, UX might decide that we need some other type of ordering.
+    @sort_direction == Pageturner::ASC
+  end
+
+  def nulls_listed_last?
+    !nulls_listed_first?
+  end
+
+  def primary_key_selected?(ar_relation)
+    ar_relation.select_values.empty? || ar_relation.select_values.include?(@ar_relation.primary_key.to_sym)
+  end
+
+  # Gets an ActiveRecord instance's associated attribute via its qualified column sql identifier.
+  #
+  # Given qualified_column_sql_identifier = "joined_tables.column", it will call `.joined_table.column` on `object`.
+  # `object` must be an ActiveRecord instance.
+  def public_send_chain_from_sql(object, qualified_column_sql_identifier)
+    # We limit `split` to 2 because we are assuming that the SQL identifier is in table.column format.
+    association, attribute = qualified_column_sql_identifier.split(".", 2).each_with_index.map do |string, index|
+      # The first element should be the joined table's sql identifier.
+      # These are always pluralized, so we must singularize it in order to use it as a method call.
+      index == 0 ? string.singularize : string
+    end
+
+    object.try!(association).try!(attribute)
+  end
+
+  # Heuristic to check if the `anchor_column` is a joined column.
+  def external_anchor_column?
+    @anchor_column.include?(".")
+  end
+
+  class Exception
+    class InvalidSortDirection < StandardError
+    end
+
+    class PrimaryKeyNotSelected < StandardError
+    end
+  end
+end
+

data/pageturner.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "pageturner"
+  spec.version       = "1.0.0"
+  spec.authors       = ["crzrcn"]
+  spec.email         = ["fernanlink@gmail.com"]
+
+  spec.summary       = %q{ Write a short summary, because RubyGems requires one.}
+  spec.description   = %q{ Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/crzrcn/pageturner"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+  spec.license       = "MPL-2.0"
+
+  spec.add_dependency "activerecord", [">= 4.2", "<= 5.1"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "mysql2", "~> 0.4"
+  spec.add_development_dependency "pry-byebug", "~> 3.5"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: pageturner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- crzrcn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: " Write a longer description or delete this line."
+email:
+- fernanlink@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pageturner.rb
+- pageturner.gemspec
+homepage: https://github.com/crzrcn/pageturner
+licenses:
+- MPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []