pagy_cursor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa7b0eb244dfd858e6b30a19f6cc404e92a44b98979dc4d373717ee1db1581c8
+  data.tar.gz: b57b29a7e131887d72773d58b91d7b253c67ee199b6d4cb6c259764b40c4e295
+SHA512:
+  metadata.gz: 86002b6d143da2abd8128937af5929fa8006757f90f7d9c6ec920dd464d30ebc29e1a5af0aa853747204578fcdc652af9d7f714107db82aef07ff644a959b7a9
+  data.tar.gz: 8ae7edaf9e1c406c0ac221d5c7475d2b26cd9f9d661749fc47db2eea21eb826daecf848624a0bb7a3f76cf9c2065176d3a169bb2180d578cafe959392511721a

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+gemfiles/*.lock
+log
+*.sqlite3

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,29 @@
+
+sudo: false
+
+language: ruby
+
+cache: bundler
+
+services:
+  - postgresql
+  - mysql
+
+rvm:
+  - 2.6.3
+  - 2.5.5
+  - 2.4.5
+  - 2.3.8
+
+gemfile:
+  - gemfiles/active_record_52.gemfile
+  - gemfiles/active_record_51.gemfile
+  - gemfiles/active_record_50.gemfile
+
+env:
+  - DB=sqlite3
+  - DB=postgresql
+  - DB=mysql
+
+before_install: gem install bundler -v 1.17.3
+script: bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at uysimty@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Uysim
+
+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,45 @@
+
+# PagyCursor
+![](https://travis-ci.org/Uysim/pagy-cursor.svg?branch=master)
+
+Extra [Pagy](https://github.com/ddnexus/pagy) to work with cursor pagination
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pagy_cursor'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Include the backend in some controller:
+```ruby
+require "pagy_cursor"
+
+include Pagy::Backend
+```
+Default
+```ruby
+pagy_cursor(Post.all)
+```
+Before and After
+```ruby
+pagy_cursor(Post.all, after: 10)
+pagy_cursor(Post.all, before: 10)
+```
+With UUID
+```ruby
+pagy_uuid_cursor(Post.all, after: "ce5d2741-4e52-49b2-bb76-c41b67ab3aad")
+pagy_uuid_cursor(Post.all, before: "ce5d2741-4e52-49b2-bb76-c41b67ab3aad")
+```
+
+## 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 "pagy_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/gemfiles/active_record_50.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "rails", "~> 5.0.0"
+gem "pg"
+gem "sqlite3", '~> 1.3.6'
+gem "mysql2"
+gem "pry"
+# Specify your gem's dependencies in pagy_cursor.gemspec
+gemspec path: "../"

data/gemfiles/active_record_51.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "rails", "~> 5.1.0"
+gem "pg"
+gem "sqlite3", '~> 1.3.6'
+gem "mysql2"
+gem "pry"
+# Specify your gem's dependencies in pagy_cursor.gemspec
+gemspec path: "../"

data/gemfiles/active_record_52.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "rails", "~> 5.2.0"
+gem "pg"
+gem "sqlite3", '~> 1.3.13'
+gem "mysql2"
+gem "pry"
+# Specify your gem's dependencies in pagy_cursor.gemspec
+gemspec path: "../"

data/lib/pagy_cursor.rb

@@ -0,0 +1,6 @@
+require "pagy"
+require "pagy_cursor/version"
+module PagyCursor
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/pagy_cursor/pagy/cursor.rb

@@ -0,0 +1,44 @@
+class Pagy
+
+  class Cursor < Pagy
+    attr_reader :before, :after, :arel_table, :primary_key, :order, :comparation, :position
+    attr_accessor :has_more
+    alias_method :has_more?, :has_more
+
+    def initialize(vars)
+      @vars = VARS.merge(vars.delete_if{|_,v| v.nil? || v == '' })
+      @items = vars[:items] || VARS[:items]
+      @before = vars[:before]
+      @after = vars[:after]
+      @arel_table = vars[:arel_table]
+      @primary_key = vars[:primary_key]
+      if @before.present? and @after.present?
+        raise(ArgumentError, 'before and after can not be both mentioned')
+      end
+
+      if vars[:backend] == 'uuid'
+
+        @comparation = 'lt' # arel table less than
+        @position = @before
+        @order = { :created_at => :desc , @primary_key => :desc }
+
+        if @after.present?
+          @comparation = 'gt' # arel table greater than
+          @position = @after
+          @order = { :created_at => :asc , @primary_key => :asc }
+        end
+      else
+
+        @comparation = 'lt'
+        @position = @before
+        @order = { @primary_key => :desc }
+
+        if @after.present?
+          @comparation = 'gt'
+          @position = @after
+          @order = { @primary_key => :asc }
+        end
+      end
+    end
+  end
+ end

data/lib/pagy_cursor/pagy/extras/cursor.rb

@@ -0,0 +1,37 @@
+require 'pagy_cursor/pagy/cursor'
+class Pagy
+
+  module Backend ; private         # the whole module is private so no problem with including it in a controller
+
+    # Return Pagy object and items
+    def pagy_cursor(collection, vars={}, options={})
+      pagy = Pagy::Cursor.new(pagy_cursor_get_vars(collection, vars))
+
+      items =  pagy_cursor_get_items(collection, pagy, pagy.position)
+      pagy.has_more =  pagy_cursor_has_more?(items, pagy)
+
+      return pagy, items
+    end
+
+    def pagy_cursor_get_vars(collection, vars)
+      vars[:arel_table] = collection.arel_table
+      vars[:primary_key] = collection.primary_key
+      vars[:backend] = 'sequence'
+      vars
+    end
+
+    def pagy_cursor_get_items(collection, pagy, position=nil)
+      if position.present?
+        sql_comparation = pagy.arel_table[pagy.primary_key].send(pagy.comparation, position)
+        collection.where(sql_comparation).reorder(pagy.order).limit(pagy.items)
+      else
+        collection.reorder(pagy.order).limit(pagy.items)
+      end
+    end
+
+    def pagy_cursor_has_more?(collection, pagy)
+      next_position = collection.last[pagy.primary_key]
+      pagy_cursor_get_items(collection, pagy, next_position).exists?
+    end
+  end
+end

data/lib/pagy_cursor/pagy/extras/uuid_cursor.rb

@@ -0,0 +1,40 @@
+require 'pagy_cursor/pagy/cursor'
+class Pagy
+
+  module Backend ; private         # the whole module is private so no problem with including it in a controller
+
+    # Return Pagy object and items
+    def pagy_uuid_cursor(collection, vars={})
+      pagy = Pagy::Cursor.new(pagy_uuid_cursor_get_vars(collection, vars))
+      items =  pagy_uuid_cursor_get_items(collection, pagy, pagy.position)
+      pagy.has_more =  pagy_uuid_cursor_has_more?(items, pagy)
+
+      return pagy, items
+    end
+
+    def pagy_uuid_cursor_get_vars(collection, vars)
+      vars[:arel_table] = collection.arel_table
+      vars[:primary_key] = collection.primary_key
+      vars[:backend] = 'uuid'
+      vars
+    end
+
+    def pagy_uuid_cursor_get_items(collection, pagy, position=nil)
+      if position.present?
+        arel_table = pagy.arel_table
+
+        select_created_at = arel_table.project(arel_table[:created_at]).where(arel_table[pagy.primary_key].eq(position))
+        select_the_sample_created_at = arel_table[:created_at].eq(select_created_at).and(arel_table[pagy.primary_key].send(pagy.comparation, position))
+        sql_comparation = arel_table[:created_at].send(pagy.comparation, select_created_at).or(select_the_sample_created_at)
+
+        collection = collection.where(sql_comparation)
+      end
+      collection.reorder(pagy.order).limit(pagy.items)
+    end
+
+    def pagy_uuid_cursor_has_more?(collection, pagy)
+      next_position = collection.last[pagy.primary_key]
+      pagy_uuid_cursor_get_items(collection, pagy, next_position).exists?
+    end
+  end
+end

data/lib/pagy_cursor/version.rb

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

data/pagy_cursor.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pagy_cursor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pagy_cursor"
+  spec.version       = PagyCursor::VERSION
+  spec.authors       = ["Uysim"]
+  spec.email         = ["uysimty@gmail.com"]
+
+  spec.summary       = "cursor paginations for pagy"
+  spec.description   = "use pagy for cursor paginations with rails"
+  spec.homepage      = "https://github.com/Uysim/pagy-cursor"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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"]
+  spec.add_dependency "pagy"
+  spec.add_dependency "activerecord", ">= 5"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: pagy_cursor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Uysim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pagy
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: use pagy for cursor paginations with rails
+email:
+- uysimty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/active_record_50.gemfile
+- gemfiles/active_record_51.gemfile
+- gemfiles/active_record_52.gemfile
+- lib/pagy_cursor.rb
+- lib/pagy_cursor/pagy/cursor.rb
+- lib/pagy_cursor/pagy/extras/cursor.rb
+- lib/pagy_cursor/pagy/extras/uuid_cursor.rb
+- lib/pagy_cursor/version.rb
+- pagy_cursor.gemspec
+homepage: https://github.com/Uysim/pagy-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 paginations for pagy
+test_files: []