activerecord-cursor 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2535f2c0d21228e6cfba576bc8ee249fb1e5fbe
+  data.tar.gz: df2ba240dcc29b2b5b9113a3fd74d89b7c6f080a
+SHA512:
+  metadata.gz: 4346da805065a8595341f7d5a993e533ade462b4a72584c886db54ef36f4a33f64d970a3240bf8a7a134d5a08a4ee7297ad6155ee9a14d44c09d2edc487a60f3
+  data.tar.gz: 4a8cb139ef303251fe7d198a815e957a90153954b6e21c9966123e055c5d1e6bf208171c5ce27581291c815275b505625f79124b400b52d10814e298bd498596

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_from: .rubocop_todo.yml
+
+Style/Documentation:
+  Enabled: false
+Style/FileName:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,26 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-12-31 19:03:18 +0900 using RuboCop version 0.61.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 18
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 7
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 116

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler

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 activerecord-cursor.gemspec
+gemspec

data/README.md

@@ -0,0 +1,57 @@
+# ActiveRecord::Cursor
+
+cursor pagination for ActiveRecord
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-cursor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-cursor
+
+## Usage
+
+```ruby
+Post.all
+=> [
+  #<Post id: 1, published: true, score: 0, created_at: "2018-12-30 19:38:27", updated_at: "2018-12-30 19:38:27">,
+  #<Post id: 2, published: false, score: 1, created_at: "2018-12-30 19:38:28", updated_at: "2018-12-30 19:38:28">,
+  #<Post id: 3, published: true, score: 1, created_at: "2018-12-30 19:38:29", updated_at: "2018-12-30 19:38:29">,
+  #<Post id: 4, published: false, score: 2, created_at: "2018-12-30 19:38:30", updated_at: "2018-12-30 19:38:30">
+]
+Post.cursor(key: :created_at)
+=> [#<Post id: 1, published: false, created_at: "2018-12-30 19:38:27", updated_at: "2018-12-30 19:38:27">]
+Post.where(published: true).cursor(key: :created_at, reverse: true)
+=> [#<Post id: 3, published: true, score: 1, created_at: "2018-12-30 19:38:29", updated_at: "2018-12-30 19:38:29">]
+Post.where(published: true).cursor(key: :created_at, reverse: true, start: Post.next_cursor) # Get next page
+=> [#<Post id: 1, published: true, score: 0, created_at: "2018-12-30 19:38:27", updated_at: "2018-12-30 19:38:27">]
+Post.where(published: true).cursor(key: :created_at, reverse: true, stop: Post.prev_cursor) # Get previous page
+=> [#<Post id: 3, published: true, score: 1, created_at: "2018-12-30 19:38:29", updated_at: "2018-12-30 19:38:29">]
+```
+
+### Options
+
+- `key`: Cursor key. Defult: 'id'
+- `reverse`: Set it to true, if your set are ordered descendingly (DESC). Default: false
+- `size`: Page size. Default: 1
+- `start`: Cursor value
+- `stop`: Cursor value
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/tsuwatch/activerecord-cursor.

data/Rakefile

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

data/activerecord-cursor.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/cursor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-cursor'
+  spec.version       = ActiveRecord::Cursor::VERSION
+  spec.authors       = ['Tomohiro Suwa']
+  spec.email         = ['neoen.gsn@gmail.com']
+
+  spec.summary       = 'pagination using cursors for ActiveRecord'
+  spec.description   = 'pagination using cursors for ActiveRecord'
+  spec.homepage      = 'https://github.com/tsuwatch/activerecord-curosr'
+
+  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.add_dependency 'activerecord'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sqlite3'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'activerecord/cursor'
+
+# 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/activerecord-cursor.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'activerecord/cursor/version'
+
+module ActiveRecord
+  module Cursor
+    class InvalidCursor < StandardError; end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  require 'activerecord/cursor/extension'
+  ActiveRecord::Base.send(:include, ActiveRecord::Cursor::Extension)
+end

data/lib/activerecord/cursor/extension.rb

@@ -0,0 +1,22 @@
+require 'activerecord/cursor/model_extension'
+
+module ActiveRecord
+  module Cursor
+    module Extension
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def inherited(kls)
+          super
+          kls.public_send(:include, ActiveRecord::Cursor::ModelExtension) if kls.superclass == ActiveRecord::Base
+        end
+      end
+
+      included do
+        descendants.each do |kls|
+          kls.public_send(:include, ActiveRecord::Cursor::ModelExtension) if kls.superclass == ApplicationRecord
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/cursor/model_extension.rb

@@ -0,0 +1,118 @@
+require 'activerecord/cursor/params'
+
+module ActiveRecord
+  module Cursor
+    module ModelExtension
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def cursor(options = {})
+          @options = default_options.merge!(options).symbolize_keys!
+          @options[:direction] =
+            if @options.key?(:start) || @options.key?(:stop)
+              @options.key?(:start) ? :start : :stop
+            end
+          @cursor = Params.decode(@options[@options[:direction]]).value
+          @records = on_cursor.in_order.limit(@options[:size] + 1)
+          set_cursor
+          @records
+        rescue ActiveRecord::StatementInvalid
+          raise Cursor::InvalidCursor
+        end
+
+        def next_cursor
+          @next
+        end
+
+        def prev_cursor
+          @prev
+        end
+
+        def on_cursor
+          if @cursor.nil?
+            where(nil)
+          else
+            where(
+              "(#{column} = ? AND #{table_name}.id #{sign_of_inequality} ?) OR (#{column} #{sign_of_inequality} ?)",
+              @cursor[:key],
+              @cursor[:id],
+              @cursor[:key]
+            )
+          end
+        end
+
+        def in_order
+          reorder("#{column} #{by}", "#{table_name}.id #{by}")
+        end
+
+        private
+
+        def default_options
+          { key: 'id', reverse: false, size: 1 }
+        end
+
+        def column
+          "#{table_name}.#{@options[:key]}"
+        end
+
+        def sign_of_inequality
+          case @options[:reverse]
+          when true
+            @options[:direction] == :start ? '<' : '>'
+          when false
+            @options[:direction] == :start ? '>' : '<'
+          end
+        end
+
+        def by
+          direction = @options[:direction]
+          case @options[:reverse]
+          when true
+            direction == :start || direction.nil? ? 'desc' : 'asc'
+          when false
+            direction == :start || direction.nil? ? 'asc' : 'desc'
+          end
+        end
+
+        def set_cursor
+          @next = nil
+          @prev = nil
+          if @options[:direction] == :start
+            set_cursor_on_start
+          elsif @options[:direction] == :stop
+            set_cursor_on_stop
+          elsif @records.size == @options[:size] + 1
+            @records = @records.limit(@options[:size])
+            @next = generate_cursor(@records[@records.size - 1])
+          end
+        end
+
+        def set_cursor_on_start
+          record = @records[0]
+          @prev = generate_cursor(record) if record
+          size = @records.size
+          @records = @records.limit(@options[:size])
+          return unless size == @options[:size] + 1
+
+          @next = generate_cursor(@records[@records.size - 1])
+        end
+
+        def set_cursor_on_stop
+          record = @records[0]
+          @next = generate_cursor(record) if record
+          size = @records.size
+          @records = @records.limit(@options[:size]).sort do |a, b|
+            b.public_send(@options[:key]) <=> a.public_send(@options[:key])
+          end
+          return unless size == @options[:size] + 1
+
+          @prev = generate_cursor(record)
+        end
+
+        def generate_cursor(record)
+          Params.new(id: record.id, key: record.public_send(@options[:key])).encoded
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/cursor/params.rb

@@ -0,0 +1,32 @@
+module ActiveRecord
+  module Cursor
+    class Params
+      attr_reader :cursor
+
+      def initialize(cursor)
+        @cursor = cursor
+      end
+
+      def self.decode(cursor)
+        if cursor.nil?
+          new nil
+        else
+          new YAML.safe_load(
+            Base64.urlsafe_decode64(cursor),
+            [Symbol, Time, ActiveSupport::TimeZone, ActiveSupport::TimeWithZone]
+          ).with_indifferent_access
+        end
+      rescue Psych::SyntaxError
+        raise InvalidCursor
+      end
+
+      def encoded
+        Base64.urlsafe_encode64 cursor.to_yaml
+      end
+
+      def value
+        @cursor
+      end
+    end
+  end
+end

data/lib/activerecord/cursor/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Cursor
+    VERSION = '0.2.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-cursor
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Tomohiro Suwa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: database_cleaner
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: 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'
+description: pagination using cursors for ActiveRecord
+email:
+- neoen.gsn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activerecord-cursor.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord-cursor.rb
+- lib/activerecord/cursor/extension.rb
+- lib/activerecord/cursor/model_extension.rb
+- lib/activerecord/cursor/params.rb
+- lib/activerecord/cursor/version.rb
+homepage: https://github.com/tsuwatch/activerecord-curosr
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: pagination using cursors for ActiveRecord
+test_files: []