page_cursor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 932517a4e798874d1d618d79ec7d96957a27997e3bcf7b755a8922e13b1d6563
+  data.tar.gz: a4e27daca15f4d1f4fc83a8dbd467de05e35319e0ddfefdfa5495cd54371783e
+SHA512:
+  metadata.gz: 56a5c40258fc216d7dbcaf61e44514f400f5dc2e52d9cfa81020e5f4b6a3e587f806c7ff29c62e1d7c6ad4d57ba57aebcf614b2e714ce9d2e61442dac1174e41
+  data.tar.gz: d49481ae21e0667fef99733800187caaed9dbecbcb173de4e42bf762cefd138015aa299ef345e198070963ee6d79865c7043bb45656a8f1a45c1a90272f4b20b

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Matthias Kadenbach
+
+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,20 @@
+# page_cursor
+
+Cursor-based pagination for Rails.
+
+```ruby
+gem 'page_cursor'
+```
+
+## Usage
+
+```ruby
+@cursor, @records = paginate(User.where(active: true)) # in controller
+
+<%= pagination_nav @cursor %> # in view
+```
+
+Please note that you'll have to create the `pagination_nav` helper yourself. Have a look
+at an [example helper](test/dummy/app/helpers/application_helper.rb) with its rendered
+[example partial](test/dummy/app/views/layouts/_pagination_nav.html.erb).
+

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PageCursor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/page_cursor.rb

@@ -0,0 +1,2 @@
+require "page_cursor/cursor"
+require "page_cursor/railtie"

data/lib/page_cursor/cursor.rb

@@ -0,0 +1,66 @@
+module PageCursor
+  module ActionControllerExtension
+    # paginate returns a cursor-enabled pagination.
+    # It uses params[:after] and params[:before] request variables.
+    # It assumes @record's primary key is sortable.
+    #
+    # Example usage:
+    # ```
+    # @cursor, @records = paginate(@records) # in controller
+    # <%= pagination_nav @cursor %>          # in view
+    # ```
+    #
+    # @cursor is a hash returning the next (`after`)
+    # and previous (`before`) primary key, if more records are available.
+    #
+    # Caveat: All collection's order statements are overwritten by paginate.
+    def paginate(collection, direction = :asc, limit = 10)
+      fail "direction must be :asc or :desc" unless [:asc, :desc].include?(direction)
+      fail "limit must be >= 1" unless limit >= 1
+
+      after = params[:after]
+      before = params[:before]
+      fail "only provide one, either params[:after] or params[:before]" if after.present? && before.present?
+
+      # reference the table's primary key attribute
+      pk = collection.arel_table[collection.primary_key]
+
+      # return limit + 1 to see if there are more records
+      collection = collection.limit(limit + 1)
+
+      if after.present?
+        if direction == :asc
+          collection = collection.where(pk.send("gt", after)).reorder(pk.send(:asc))
+        elsif direction == :desc
+          collection = collection.where(pk.send("lt", after)).reorder(pk.send(:desc))
+        end
+        r = collection.all
+
+        return { :after => nil, :before => r.first&.id }, r if r.size <= limit
+        r = r.first(r.size - 1)
+        return { :after => r.last&.id, :before => r.first&.id }, r
+
+        # ---
+      elsif before.present?
+        if direction == :asc
+          collection = collection.where(pk.send("lt", before)).reorder(pk.send(:desc))
+        elsif direction == :desc
+          collection = collection.where(pk.send("gt", before)).reorder(pk.send(:asc))
+        end
+        r = collection.all.reverse
+
+        return { :after => r.last&.id, :before => nil }, r if r.size <= limit
+        r = r.last(r.size - 1)
+        return { :after => r.last&.id, :before => r.first&.id }, r
+
+        # ---
+      else
+        # if after and before are both missing
+        r = collection.reorder(pk.send(direction)).all
+        return { :after => nil, :before => nil }, r if r.size <= limit
+        r = r.first(r.size - 1)
+        return { :after => r.last&.id, :before => nil }, r
+      end
+    end
+  end
+end

data/lib/page_cursor/railtie.rb

@@ -0,0 +1,9 @@
+module PageCursor
+  class Railtie < ::Rails::Railtie
+    initializer "page_cursor" do |app|
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.include PageCursor::ActionControllerExtension
+      end
+    end
+  end
+end

data/lib/page_cursor/version.rb

@@ -0,0 +1,3 @@
+module PageCursor
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: page_cursor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthias Kadenbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !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: ksuid
+  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: Cursor-based pagination for Rails.
+email:
+- matthias.kadenbach@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/page_cursor.rb
+- lib/page_cursor/cursor.rb
+- lib/page_cursor/railtie.rb
+- lib/page_cursor/version.rb
+homepage: https://github.com/mattes/ruby_page_cursor
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Cursor-based pagination
+test_files: []