sequel-seek-pagination 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c6ce6e2a2e78ab2b3741bc2037a2ef40bb85cc7
+  data.tar.gz: 4d1dd2e3c9852312ba44ad35b389d45de5aca54a
+SHA512:
+  metadata.gz: c189067b2cc80490d41c684a891ec3486eaa0a675f599bfe3bcb066fceb5a698ce79fdc2aceb0e7f683f37e6a30e0af20f763ba82b3a883004fc53960dbca3a2
+  data.tar.gz: 040bfa003540c47c7faa0367685c0d718bfe19955ce26fed037835a22ec3319e89da21e60123134830f540aef1f8693cc21dcec92f849af39c7a033f5fb70de4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'minitest',    '5.5.1'
+  gem 'minitest-rg', '5.1.0'
+
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris Hanks
+
+MIT License
+
+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,56 @@
+# Sequel::SeekPagination
+
+This gem provides support for seek pagination (aka keyset pagination) to
+Sequel and PostgreSQL. In seek pagination, you pass the pagination function
+the last data you saw, and it returns the next page in the set. Example:
+
+```ruby
+# Activate the extension:
+Sequel::Database.extension :seek_pagination
+# or
+DB.extension :seek_pagination
+# or
+ds = DB[:seek]
+ds.extension(:seek_pagination)
+
+# Use the new Dataset#seek_paginate method to get the first page.
+DB[:seek].order(:id).seek_paginate(50) # SELECT * FROM "seek" ORDER BY "id" LIMIT 50
+
+# Use the last data you saw to get the second page.
+# (suppose the id of the last row you got was 1456)
+DB[:seek].order(:id).seek_paginate(50, after: 1456) # SELECT * FROM "seek" WHERE ("id" > 1456) ORDER BY "id" LIMIT 50
+
+# Also works when sorting by multiple columns.
+DB[:seek].order(:col1, :col2).seek_paginate(50) # SELECT * FROM "seek" ORDER BY "col1", "col2" LIMIT 50
+DB[:seek].order(:col1, :col2).seek_paginate(50, after: [12, 56]) # SELECT * FROM "seek" WHERE (("col1", "col2") > (12, 56)) ORDER BY "col1", "col2" LIMIT 50
+```
+
+### Why Seek Pagination?
+
+Performance. The WHERE conditions generated above can use an index much more
+efficiently on deeper pages. For example, using traditional LIMIT/OFFSET
+pagination, retrieving the 9th page of 30 records requires that the database
+process at least 270 rows to get the ones you want. With seek pagination,
+getting the 100th page is just as efficient as getting the second.
+
+Additionally, there's no slow count(*) of the entire table to get the number
+of pages that are available. This is especially valuable when you're querying
+on a complex join or the like.
+
+### Why Not Seek Pagination?
+
+The total number of pages isn't available (unless you do a count(*) yourself),
+and you can't jump to a specific page in the table. This makes seek pagination
+ideal for infinitely scrolling pages.
+
+### Caveats
+
+It's advisable for the column set you're sorting on to be unique, or else
+there's the risk that results will be duplicated if multiple rows have the
+same value across a page break. You may be able to get away with doing this on
+non-unique column sets if they have very high cardinality (for example, if one
+of the columns is a timestamp that will rarely be repeated). If you need to
+enforce a unique column set to get a stable sort, you can always add a unique
+column to the end of the ordering (the primary key, for example).
+
+The gem is tested on PostgreSQL. It may or may not work for other databases.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+
+Dir["./tasks/*.rb"].sort.each &method(:require)

data/lib/sequel-seek-pagination.rb

@@ -0,0 +1 @@
+require 'sequel/extensions/seek_pagination'

data/lib/sequel/extensions/seek_pagination.rb

@@ -0,0 +1,183 @@
+require 'sequel'
+require 'sequel/extensions/seek_pagination/version'
+
+module Sequel
+  module SeekPagination
+    class Error < StandardError; end
+
+    def seek_paginate(count, from: nil, after: nil, from_pk: nil, after_pk: nil, not_null: nil)
+      order = opts[:order]
+      model = @model
+
+      if order.nil? || order.length.zero?
+        raise Error, "cannot seek_paginate on a dataset with no order"
+      elsif from && after
+        raise Error, "cannot pass both :from and :after params to seek_paginate"
+      elsif model.nil? && (from_pk || after_pk)
+        raise Error, "passed the :#{from_pk ? 'from' : 'after'}_pk option to seek_paginate on a dataset that doesn't have an associated model"
+      end
+
+      ds = limit(count)
+
+      if values = from || after
+        values = Array(values)
+
+        if values.length != order.length
+          raise Error, "passed the wrong number of values in the :#{from ? 'from' : 'after'} option to seek_paginate"
+        end
+      elsif pk = from_pk || after_pk
+        # Need to load the order expressions for that pk from the DB.
+        selections = order.map { |o| Sequel::SQL::OrderedExpression === o ? o.expression : o }
+
+        # #get won't like it if we pass it bare expressions, so give it aliases for everything.
+        gettable = selections.zip(:a..:z).map{|s,a| Sequel.as(s, a)}
+
+        values = where(model.qualified_primary_key_hash(pk)).get(gettable)
+      end
+
+      if values
+        if not_null.nil?
+          not_null = []
+
+          # If the dataset was chained off a model, use its stored schema
+          # information to figure out what columns are not null.
+          if model
+            model.db_schema.each do |column, schema|
+              not_null << column if schema[:allow_null] == false
+            end
+          end
+        end
+
+        # If we're paginating with a :from value, we want to include the row
+        # that has those exact values.
+        OrderedColumnSet.new(order.zip(values), include_exact_match: !!(from || from_pk), not_null: not_null).apply(ds)
+      else
+        ds
+      end
+    end
+
+    private
+
+    class OrderedColumnSet
+      attr_reader :not_null, :include_exact_match, :orders
+
+      def initialize(order_values, include_exact_match:, not_null:)
+        @not_null = not_null
+        @include_exact_match = include_exact_match
+        @orders = order_values.map { |order, value| OrderedColumn.new(self, order, value) }
+      end
+
+      def apply(dataset)
+        length = orders.length
+
+        conditions =
+          # Handle the common case where we can do a simpler (and faster)
+          # WHERE (non_nullable_1, non_nullable_2) > (1, 2) clause.
+          if length > 1 && orders.all?(&:not_null) && has_uniform_order_direction?
+            method = orders.first.direction == :asc ? '>' : '<'
+            method << '='.freeze if include_exact_match
+            Sequel.virtual_row{|o| o.__send__(method, orders.map(&:name), orders.map(&:value))}
+          else
+            Sequel.&(
+              *length.times.map { |i|
+                allow_equal = include_exact_match || i != length - 1
+                conditions = orders[0..i]
+
+                if i.zero?
+                  conditions[0].ineq(eq: allow_equal)
+                else
+                  c = conditions[-2]
+
+                  list = if filter = conditions[-1].ineq(eq: allow_equal)
+                           [Sequel.&(c.eq_filter, filter)]
+                         else
+                           [c.eq_filter]
+                         end
+
+                  list += conditions[0..-2].map { |c| c.ineq(eq: false) }
+
+                  Sequel.|(*list.compact)
+                end
+              }.compact
+            )
+          end
+
+        dataset.where(conditions)
+      end
+
+      private
+
+      def has_uniform_order_direction?
+        direction = nil
+        orders.each do |order|
+          direction ||= order.direction
+          return false unless direction == order.direction
+        end
+        true
+      end
+    end
+
+    class OrderedColumn
+      attr_reader :name, :direction, :nulls, :value, :not_null
+
+      def initialize(set, order, value)
+        @set = set
+        @value = value
+        @name, @direction, @nulls =
+          case order
+          when Sequel::SQL::OrderedExpression
+            direction = order.descending ? :desc : :asc
+            nulls = order.nulls || default_nulls_option(direction)
+            [order.expression, direction, nulls]
+          else
+            [order, :asc, :last]
+          end
+
+        @not_null = set.not_null.include?(@name)
+      end
+
+      def nulls_option_is_default?
+        nulls == default_nulls_option(direction)
+      end
+
+      def eq_filter
+        {name => value}
+      end
+
+      def null_filter
+        {name => nil}
+      end
+
+      def ineq(eq: true)
+        nulls_upcoming = !not_null && nulls == :last
+
+        if !value.nil?
+          method = "#{direction == :asc ? '>' : '<'}#{'=' if eq}"
+          filter = Sequel.virtual_row{|o| o.__send__(method, name, value)}
+          nulls_upcoming ? Sequel.|(filter, null_filter) : filter
+        else
+          if nulls_upcoming && eq
+            null_filter
+          elsif !nulls_upcoming && !eq
+            Sequel.~(null_filter)
+          end
+        end
+      end
+
+      private
+
+      # By default, Postgres sorts NULLs as higher than any other value. So we
+      # can treat a plain column ASC as column ASC NULLS LAST, and a plain
+      # column DESC as column DESC NULLS FIRST.
+      def default_nulls_option(direction)
+        case direction
+        when :asc  then :last
+        when :desc then :first
+        else raise "Bad direction: #{direction.inspect}"
+        end
+      end
+    end
+  end
+
+  Dataset.register_extension(:seek_pagination, SeekPagination)
+end

data/lib/sequel/extensions/seek_pagination/version.rb

@@ -0,0 +1,5 @@
+module Sequel
+  module SeekPagination
+    VERSION = '0.1.0'
+  end
+end

data/sequel-seek-pagination.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel/extensions/seek_pagination/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sequel-seek-pagination'
+  spec.version       = Sequel::SeekPagination::VERSION
+  spec.authors       = ["Chris Hanks"]
+  spec.email         = ['christopher.m.hanks@gmail.com']
+  spec.summary       = %q{Seek pagination for Sequel + PostgreSQL}
+  spec.description   = %q{Generic, flexible seek pagination implementation for Sequel and PostgreSQL}
+  spec.homepage      = 'https://github.com/chanks/sequel-seek-pagination'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pg'
+
+  spec.add_dependency 'sequel', '~> 4.0'
+end

data/spec/seek_pagination_spec.rb

@@ -0,0 +1,212 @@
+require 'spec_helper'
+
+class SeekPaginationSpec < Minitest::Spec
+  SEEK_COUNT = DB[:seek].count
+
+  def assert_equal_results(ds1, ds2)
+    assert_equal ds1.all, ds2.all
+  end
+
+  def assert_error_message(message, &block)
+    error = assert_raises(Sequel::SeekPagination::Error, &block)
+    assert_equal message, error.message
+  end
+
+  class << self
+    def it_should_seek_paginate_properly(ordering)
+      columns = ordering.map do |order|
+                  case order
+                  when Sequel::SQL::OrderedExpression then order.expression
+                  else order
+                  end
+                end
+
+      [:plain, :model].each do |dataset_type|
+        describe "for a #{dataset_type} dataset" do
+          dataset = dataset_type == :plain ? DB[:seek] : SeekModel
+          dataset = dataset.order(*ordering)
+
+          # Can't pass any random expression to #get, so give them all aliases.
+          gettable = columns.zip(:a..:z).map{|c,a| c.as(a)}
+
+          it "should limit the dataset appropriately when a starting point is not given" do
+            assert_equal_results dataset.limit(10),
+                                 dataset.seek_paginate(10)
+          end
+
+          it "should page properly when given a point to start from/after" do
+            offset = rand(SEEK_COUNT)
+            values = dataset.offset(offset).get(gettable)
+
+            assert_equal_results dataset.offset(offset).limit(100),
+                                 dataset.seek_paginate(100, from: values)
+
+            assert_equal_results dataset.offset(offset + 1).limit(100),
+                                 dataset.seek_paginate(100, after: values)
+
+            if columns.length == 1
+              # Should wrap values in an array if necessary
+              assert_equal_results dataset.offset(offset).limit(100),
+                                   dataset.seek_paginate(100, from: values.first)
+
+              assert_equal_results dataset.offset(offset + 1).limit(100),
+                                   dataset.seek_paginate(100, after: values.first)
+            end
+          end
+
+          it "should return correct results when nullability information is provided" do
+            offset = rand(SEEK_COUNT)
+            values = dataset.offset(offset).get(gettable)
+
+            assert_equal_results dataset.offset(offset).limit(100),
+                                 dataset.seek_paginate(100, from: values, not_null: [:id, :non_nullable_1, :non_nullable_2])
+
+            assert_equal_results dataset.offset(offset + 1).limit(100),
+                                 dataset.seek_paginate(100, after: values, not_null: [:id, :non_nullable_1, :non_nullable_2])
+          end
+
+          if dataset_type == :model
+            it "should page properly when given a primary key to start from/after" do
+              offset = rand(SEEK_COUNT)
+              id     = dataset.offset(offset).get(:id)
+
+              assert_equal_results dataset.offset(offset).limit(100),
+                                   dataset.seek_paginate(100, from_pk: id)
+
+              assert_equal_results dataset.offset(offset + 1).limit(100),
+                                   dataset.seek_paginate(100, after_pk: id)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe "for ordering by a single not-null column in either order" do
+    [:id.asc, :id.desc].each do |o1|
+      it_should_seek_paginate_properly [o1]
+    end
+  end
+
+  describe "for ordering by two not-null columns in any order" do
+    [:not_nullable_1.asc, :not_nullable_1.desc].each do |o1|
+      [:id.asc, :id.desc].each do |o2|
+        it_should_seek_paginate_properly [o1, o2]
+      end
+    end
+  end
+
+  describe "for ordering by three not-null columns in any order" do
+    [:not_nullable_1.asc, :not_nullable_1.desc].each do |o1|
+      [:not_nullable_2.asc, :not_nullable_2.desc].each do |o2|
+        [:id.asc, :id.desc].each do |o3|
+          it_should_seek_paginate_properly [o1, o2, o3]
+        end
+      end
+    end
+  end
+
+  describe "for ordering by a nullable column" do
+    # We still tack on :id because the ordering needs to be unique.
+    [:nullable_1.asc, :nullable_1.desc, :nullable_1.asc(nulls: :first), :nullable_1.desc(nulls: :last)].each do |o1|
+      [:id.asc, :id.desc].each do |o2|
+        it_should_seek_paginate_properly [o1, o2]
+      end
+    end
+  end
+
+  describe "for ordering by multiple nullable columns" do
+    # We still tack on :id because the ordering needs to be unique.
+    [:nullable_1.asc, :nullable_1.desc, :nullable_1.asc(nulls: :first), :nullable_1.desc(nulls: :last)].each do |o1|
+      [:nullable_2.asc, :nullable_2.desc, :nullable_2.asc(nulls: :first), :nullable_2.desc(nulls: :last)].each do |o2|
+        [:id.asc, :id.desc].each do |o3|
+          it_should_seek_paginate_properly [o1, o2, o3]
+        end
+      end
+    end
+  end
+
+  describe "for ordering by a mix of nullable and not-nullable columns" do
+    20.times do
+      columns = [
+        [:not_nullable_1, :not_nullable_1.asc, :not_nullable_1.desc],
+        [:not_nullable_2, :not_nullable_2.asc, :not_nullable_2.desc],
+        [:nullable_1, :nullable_1.asc, :nullable_1.desc, :nullable_1.asc(nulls: :first), :nullable_1.desc(nulls: :last)],
+        [:nullable_2, :nullable_2.asc, :nullable_2.desc, :nullable_2.asc(nulls: :first), :nullable_2.desc(nulls: :last)],
+      ]
+
+      testing_columns = columns.sample(rand(columns.count) + 1).map(&:sample)
+      testing_columns << [:id, :id.asc, :id.desc].sample
+
+      it_should_seek_paginate_properly(testing_columns)
+    end
+  end
+
+  describe "for ordering by a mix of expressions and columns" do
+    20.times do
+      columns = [
+        [:not_nullable_1, :not_nullable_1.asc, :not_nullable_1.desc, :not_nullable_1.sql_number % 10, (:not_nullable_1.sql_number % 10).asc, (:not_nullable_1.sql_number % 10).desc],
+        [:not_nullable_2, :not_nullable_2.asc, :not_nullable_2.desc, :not_nullable_2.sql_number % 10, (:not_nullable_2.sql_number % 10).asc, (:not_nullable_2.sql_number % 10).desc],
+        [:nullable_1, :nullable_1.asc, :nullable_1.desc, :nullable_1.asc(nulls: :first), :nullable_1.desc(nulls: :last), :nullable_1.sql_number % 10, (:nullable_1.sql_number % 10).asc, (:nullable_1.sql_number % 10).desc, (:nullable_1.sql_number % 10).asc(nulls: :first), (:nullable_1.sql_number % 10).desc(nulls: :last)],
+        [:nullable_2, :nullable_2.asc, :nullable_2.desc, :nullable_2.asc(nulls: :first), :nullable_2.desc(nulls: :last), :nullable_2.sql_number % 10, (:nullable_2.sql_number % 10).asc, (:nullable_2.sql_number % 10).desc, (:nullable_2.sql_number % 10).asc(nulls: :first), (:nullable_2.sql_number % 10).desc(nulls: :last)],
+      ]
+
+      testing_columns = columns.sample(rand(columns.count) + 1).map(&:sample)
+      testing_columns << [:id, :id.asc, :id.desc].sample
+
+      it_should_seek_paginate_properly(testing_columns)
+    end
+  end
+
+  it "should work for order clauses of many types" do
+    datasets = [
+      DB[:seek].order(:id),
+      DB[:seek].order(:seek__id),
+      DB[:seek].order(:id.asc),
+      DB[:seek].order(:seek__id.asc),
+      DB[:seek].order(:id.desc).reverse_order,
+      DB[:seek].order(:seek__id.desc).reverse_order,
+    ]
+
+    # With point to start from/after:
+    id = DB[:seek].order(:id).offset(56).get(:id)
+
+    datasets.each do |dataset|
+      assert_equal_results DB[:seek].order(:id).limit(5),
+                           dataset.seek_paginate(5)
+
+      assert_equal_results DB[:seek].order(:id).offset(56).limit(5),
+                           dataset.seek_paginate(5, from: id)
+
+      assert_equal_results DB[:seek].order(:id).offset(57).limit(5),
+                           dataset.seek_paginate(5, after: id)
+    end
+  end
+
+  it "should raise an error if the dataset is not ordered" do
+    assert_error_message("cannot seek_paginate on a dataset with no order") { DB[:seek].seek_paginate(30) }
+  end
+
+  it "should raise an error if the dataset is not ordered" do
+    assert_error_message("cannot pass both :from and :after params to seek_paginate") { DB[:seek].order(:id).seek_paginate(30, from: 3, after: 4) }
+  end
+
+  it "should raise an error if given the wrong number of values to from or after" do
+    assert_error_message("passed the wrong number of values in the :from option to seek_paginate")  { DB[:seek].order(:id, :nullable_1).seek_paginate(30, from:  [3]) }
+    assert_error_message("passed the wrong number of values in the :after option to seek_paginate") { DB[:seek].order(:id, :nullable_1).seek_paginate(30, after: [3]) }
+    assert_error_message("passed the wrong number of values in the :from option to seek_paginate")  { DB[:seek].order(:id, :nullable_1).seek_paginate(30, from:  [3, 4, 5]) }
+    assert_error_message("passed the wrong number of values in the :after option to seek_paginate") { DB[:seek].order(:id, :nullable_1).seek_paginate(30, after: [3, 4, 5]) }
+  end
+
+  it "should raise an error if from_pk or after_pk are passed to a dataset without an associated model" do
+    assert_error_message("passed the :from_pk option to seek_paginate on a dataset that doesn't have an associated model") { DB[:seek].order(:id, :nullable_1).seek_paginate(30, from_pk: 3) }
+    assert_error_message("passed the :after_pk option to seek_paginate on a dataset that doesn't have an associated model") { DB[:seek].order(:id, :nullable_1).seek_paginate(30, after_pk: 3) }
+  end
+
+  describe "when chained from a model" do
+    it "should be able to determine from the schema what columns are not null" do
+      assert_equal %(SELECT * FROM "seek" WHERE (("not_nullable_1", "not_nullable_2", "id") > (1, 2, 3)) ORDER BY "not_nullable_1", "not_nullable_2", "id" LIMIT 5),
+        SeekModel.order(:not_nullable_1, :not_nullable_2, :id).seek_paginate(5, after: [1, 2, 3]).sql
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'sequel'
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+Sequel.extension :core_extensions
+
+Sequel::Database.extension :seek_pagination
+
+DB = Sequel.connect "postgres:///sequel-seek-pagination-test"
+
+DB.drop_table? :seek
+
+DB.create_table :seek do
+  primary_key :id
+
+  integer :not_nullable_1, null: false
+  integer :not_nullable_2, null: false
+
+  integer :nullable_1
+  integer :nullable_2
+end
+
+class SeekModel < Sequel::Model(:seek)
+end
+
+DB.run <<-SQL
+  INSERT INTO seek
+    (not_nullable_1, not_nullable_2, nullable_1, nullable_2)
+  SELECT trunc(random() * 10 + 1),
+         trunc(random() * 10 + 1),
+         CASE WHEN random() > 0.5 THEN trunc(random() * 10 + 1) ELSE NULL END,
+         CASE WHEN random() > 0.5 THEN trunc(random() * 10 + 1) ELSE NULL END
+  FROM generate_series(1, 100) s
+SQL
+
+require 'pry'
+require 'minitest/autorun'
+require 'minitest/rg'

data/tasks/benchmark.rb

@@ -0,0 +1,59 @@
+task :benchmark do
+  require 'sequel-seek-pagination'
+
+  RECORD_COUNT = 100000
+  ITERATION_COUNT = 10
+
+  Sequel.extension :core_extensions
+  Sequel::Database.extension :seek_pagination
+
+  DB = Sequel.connect "postgres:///sequel-seek-pagination-test"
+
+  DB.drop_table? :seek
+
+  DB.create_table :seek do
+    primary_key :id
+
+    integer :non_nullable_1, null: false
+    integer :non_nullable_2, null: false
+
+    integer :nullable_1
+    integer :nullable_2
+
+    text :content # Prevent index-only scans.
+  end
+
+  DB.run <<-SQL
+    INSERT INTO seek
+      (non_nullable_1, non_nullable_2, nullable_1, nullable_2, content)
+    SELECT trunc(random() * 10 + 1),
+           trunc(random() * 10 + 1),
+           CASE WHEN random() > 0.5 THEN trunc(random() * 10 + 1) ELSE NULL END,
+           CASE WHEN random() > 0.5 THEN trunc(random() * 10 + 1) ELSE NULL END,
+           md5(random()::text)
+    FROM generate_series(1, #{RECORD_COUNT}) s
+  SQL
+
+  DB.add_index :seek, [:non_nullable_1]
+
+  {
+    "1 column, not-null, ascending, no not-null information"  => DB[:seek].order(:id.asc ).seek_paginate(30, after: rand(RECORD_COUNT) + 1),
+    "1 column, not-null, descending, no not-null information" => DB[:seek].order(:id.desc).seek_paginate(30, after: rand(RECORD_COUNT) + 1),
+
+    "1 column, not-null, ascending, with not-null information"  => DB[:seek].order(:id.asc ).seek_paginate(30, after: rand(RECORD_COUNT) + 1, not_null: [:id, :not_nullable_1, :not_nullable_2]),
+    "1 column, not-null, descending, with not-null information" => DB[:seek].order(:id.desc).seek_paginate(30, after: rand(RECORD_COUNT) + 1, not_null: [:id, :not_nullable_1, :not_nullable_2]),
+
+    "2 columns, not-null, ascending, no not-null information"  => DB[:seek].order(:non_nullable_1.asc,  :id.asc ).seek_paginate(30, after: [5, rand(RECORD_COUNT) + 1]),
+    "2 columns, not-null, descending, no not-null information" => DB[:seek].order(:non_nullable_1.desc, :id.desc).seek_paginate(30, after: [5, rand(RECORD_COUNT) + 1]),
+
+    "2 columns, not-null, ascending, with not-null information"  => DB[:seek].order(:non_nullable_1.asc,  :id.asc ).seek_paginate(30, after: [5, rand(RECORD_COUNT) + 1], not_null: [:id, :non_nullable_1, :non_nullable_2]),
+    "2 columns, not-null, descending, with not-null information" => DB[:seek].order(:non_nullable_1.desc, :id.desc).seek_paginate(30, after: [5, rand(RECORD_COUNT) + 1], not_null: [:id, :non_nullable_1, :non_nullable_2]),
+  }.each do |description, ds|
+    puts
+    puts description + ':'
+    ds.explain(analyze: true) # Make sure everything is cached.
+    puts ds.sql
+    puts ds.explain(analyze: true)
+    puts
+  end
+end

data/tasks/specs.rb

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new :default do |t|
+  t.libs = ['spec']
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :spec => :default
+task :test => :default

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: sequel-seek-pagination
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Hanks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: pg
+  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: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Generic, flexible seek pagination implementation for Sequel and PostgreSQL
+email:
+- christopher.m.hanks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequel-seek-pagination.rb
+- lib/sequel/extensions/seek_pagination.rb
+- lib/sequel/extensions/seek_pagination/version.rb
+- sequel-seek-pagination.gemspec
+- spec/seek_pagination_spec.rb
+- spec/spec_helper.rb
+- tasks/benchmark.rb
+- tasks/specs.rb
+homepage: https://github.com/chanks/sequel-seek-pagination
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Seek pagination for Sequel + PostgreSQL
+test_files:
+- spec/seek_pagination_spec.rb
+- spec/spec_helper.rb