cursor_page 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20c87b6d5e00835d8b3ea037f05717811b32cdaa
+  data.tar.gz: 1c5b2ff7f2f945450e92414ce4a8a3a09a85b726
+SHA512:
+  metadata.gz: f9dc086329acef7f22b5b83c3acf5146f034f09daf87594116bd119f7ae257d3086215a8270e21c94bb2acbf1ff2cda58f99b741a06205e09a9ee64273bf60ff
+  data.tar.gz: 86de021ad49b40920f5ab52fb697ea1f43e6180b9099df92d0c19b65d44e5ad24aae079724fb3ac6b2c6dc2919f156311f1e972dba4ca1f792875d7d4f2f0df8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cursor_page.gemspec
+gemspec

data/README.md

@@ -0,0 +1,71 @@
+# CursorPage
+
+Cursor based pagination gem.
+
+무한 스크롤 UI에서 흔히 사용하는 커서 기반의 페이징 플러그인입니다.
+
+이 Gem은 [루비 대림절 달력](https://ruby-korea.github.io/advent-calendar/)을 위해 제작하였습니다. 구현 내용을 설명하는 글을 작성하려고 했지만, 소스가 너무 간단한 관계로 작성할 내용이 없어져버렸습니다;;;
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cursor_page'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cursor_page
+
+## Usage
+
+### The `cursor_page` Scope
+
+To fetch the posts that ID value less then 2.
+
+```ruby
+Post.cursor_page(before: 2)
+```
+
+To fetch the 10 posts that ID value greater then 10.
+
+```ruby
+Post.cursor_page(after: 10).limit(10)
+```
+
+To fetch the posts that ts value greater then 1482495565.
+
+```ruby
+Post.cursor_page(key: 'ts', after: 1482495565)
+```
+
+### The `cursor` Value
+
+Get current cursor value
+
+```ruby
+@posts = Post.cursor_page(before: 2)
+@posts.cursor # {:key=>"id", :before=>2, :after=>nil}
+```
+
+### `to_cursor_param` method
+
+Get cursor parameters for response json
+
+```ruby
+@posts = Post.cursor_page(before: 3)
+@posts.to_cursor_param # {:before=>"MQ==", :after=>"Mg=="}
+```
+
+## Todo
+
+- [ ] Add test code
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/remotty/cursor_page.

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 "cursor_page"
+
+# 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

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/cursor_page.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cursor_page/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cursor_page"
+  spec.version       = CursorPage::VERSION
+  spec.authors       = ["subicura"]
+  spec.email         = ["subicura@subicura.com"]
+
+  spec.summary       = %q{A cursor based pagination plugin for Rails 4+}
+  spec.description   = %q{CursorPage is a cursor based pagination plugin}
+  spec.homepage      = "https://github.com/remotty/cursor_page"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '>= 4.1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cursor_page.rb

@@ -0,0 +1,2 @@
+require "cursor_page/version"
+require 'cursor_page/activerecord'

data/lib/cursor_page/activerecord.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'active_support/lazy_load_hooks'
+
+ActiveSupport.on_load :active_record do
+  require 'cursor_page/activerecord/extension'
+  ::ActiveRecord::Base.send :include, CursorPage::ActiveRecordExtension
+  ::ActiveRecord::Relation.send :include, CursorPage::ActiveRecordRelationExtension
+end

data/lib/cursor_page/activerecord/extension.rb

@@ -0,0 +1,62 @@
+module CursorPage
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def cursor_page(options = {})
+        key = options.fetch(:key, self.primary_key)
+        before = options.fetch(:before, nil)
+        after = options.fetch(:after, nil)
+
+        scope = if before
+          where("#{key} < ?", before).order(Hash[key, :desc])
+        elsif after
+          where("#{key} > ?", after).order(Hash[key, :asc])
+        else
+          order("#{key} desc")
+        end
+
+        scope.cursor = {
+          key: key,
+          before: before,
+          after: after
+        }
+        scope
+      end
+    end
+  end
+
+  module ActiveRecordRelationExtension
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :cursor
+    end
+
+    def reset #:nodoc:
+      @cursor = nil
+      super
+    end
+
+    def to_cursor_param
+      cursor_param = {}
+
+      if @cursor[:after].nil?
+        cursor_param = {
+          before: Base64.strict_encode64(last.try(@cursor[:key]).to_s),
+          after: Base64.strict_encode64(first.try(@cursor[:key]).to_s)
+        }
+      else
+        cursor_param = {
+          before: Base64.strict_encode64(first.try(@cursor[:key]).to_s),
+          after: Base64.strict_encode64(last.try(@cursor[:key]).to_s)
+        }
+      end
+
+      cursor_param
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, CursorPage::ActiveRecordExtension)
+ActiveRecord::Relation.send(:include, CursorPage::ActiveRecordRelationExtension)

data/lib/cursor_page/version.rb

@@ -0,0 +1,3 @@
+module CursorPage
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: cursor_page
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- subicura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: CursorPage is a cursor based pagination plugin
+email:
+- subicura@subicura.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cursor_page.gemspec
+- lib/cursor_page.rb
+- lib/cursor_page/activerecord.rb
+- lib/cursor_page/activerecord/extension.rb
+- lib/cursor_page/version.rb
+homepage: https://github.com/remotty/cursor_page
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1
+signing_key: 
+specification_version: 4
+summary: A cursor based pagination plugin for Rails 4+
+test_files: []