rb_pager 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf018c14e4ab9b25829e3400dee85caa296f7fcbd4cbdd96020eff0c620c5beb
-  data.tar.gz: 5629f3891861dda8bc388adcf3fd8196ba569bfb408ed2377bf80d61b1144871
+  metadata.gz: '08d892ce787fddafc76730efd1e2712da4424f483cfb93d17ec217e70530cefc'
+  data.tar.gz: 1cbe5622d6f768047495fcc4a86eb87aabcab41cfc835a6e312d4c63acff9114
 SHA512:
-  metadata.gz: 370e67a57d010703c5d75dc4c0378876a39ad06d72da1d018d63eff8fc5ead95dce518cc2e4312dcc6181ea0c454e511fce210925686e8325f5e5b5b578106c9
-  data.tar.gz: 293378b679c82b97df6a25c35105e2024f3e1a8ad835261de14694cc23ffc34720b919fc8e26df8b136d0b8cb56171ffaf924a9c2e20dcfdd88bf5fb39bc10f7
+  metadata.gz: abf2b7864075d88dc03fc3e615033cb428ca773e972338013199f0bf0490dbb5d6c8e8b95917b910b522499339c240756324ffab15a1475f8b6b5d1bf9a7d79f
+  data.tar.gz: 2995f411fa986b57b746ffee5c5148a3fab4241cdd22e0f6b09ba60e575a1e5179244c577e2ee44289f1cc7f1defc1b76b0914e2814ad4f476145cce673af782

data/.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Setup System
+      run: |
+          sudo apt-get install libsqlite3-dev
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile

@@ -2,6 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in pager.gemspec
 gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    rb_pager (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 5.2)
+  pry
+  rake (~> 13.0)
+  rb_pager!
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,6 +1,7 @@
 
 # Pager
-
+[![Gem Version](https://badge.fury.io/rb/rb_pager.svg)](https://badge.fury.io/rb/rb_pager)
+![build](https://github.com/BambangSinaga/rb_pager/workflows/build/badge.svg)
 
 Cursor-based pagination (aka keyset pagination) is a  [common](https://slack.engineering/evolving-api-pagination-at-slack-1c1f644f8e12)  [pagination strategy](https://www.citusdata.com/blog/2016/03/30/five-ways-to-paginate/)  that avoids many of the pitfalls of “offset–limit” pagination.
 

data/lib/rb_pager.rb

@@ -1,9 +1,10 @@
 require 'active_record'
 require 'rb_pager/version'
-require "rb_pager/configuration"
+require 'rb_pager/configuration'
+require 'pry'
 
 module RbPager
-  class Error < StandardError; end
+  class InvalidLimitValueError < StandardError; end
 
   class << self
     attr_accessor :configuration

data/lib/rb_pager/orm/pager_active_record.rb

@@ -6,9 +6,12 @@ module RbPager
       AR_ORDER = { '+' => :asc, '-' => :desc }
       AREL_ORDER = { asc: :gt, desc: :lt }
 
-      def pager(after:, limit: nil, sort: nil)
+      def pager(after: nil, limit: nil, sort: nil)
         page_limit = limit || RbPager.configuration.limit
         sort_params = sort
+
+        raise InvalidLimitValueError if limit && limit < 1
+
         sorted_columns, sorter = build_order_expression(sort)
         collection = if after.nil?
                        order(sorter).extending(ActiveRecordRelationMethods).limit(page_limit)
@@ -81,7 +84,7 @@ module RbPager
         next_cursor = next_cursor(collection, sorted_columns)
 
         meta = { next_cursor: next_cursor }
-        [collection.to_a, meta]
+        [collection, meta]
       end
 
       def next_cursor(collection, sorted_columns)

data/lib/rb_pager/version.rb

@@ -1,3 +1,3 @@
 module RbPager
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/rb_pager.gemspec

@@ -7,8 +7,10 @@ Gem::Specification.new do |spec|
   spec.email         = ["mejbambang@gmail.com"]
 
   spec.summary       = "Cursor based pagination for active_record currently"
-  spec.description   = %q{ActiveRecord plugin for cursor based pagination for Ruby on Rails. \n
-    Cursor-based pagination (aka keyset pagination) is a common pagination strategy that avoids many of the pitfalls of “offset–limit” pagination.}
+  spec.description   = <<~DESC
+    ActiveRecord plugin for cursor based pagination for Ruby on Rails.
+    Cursor-based pagination (aka keyset pagination) is a common pagination strategy that avoids many of the pitfalls of “offset–limit” pagination.
+  DESC
   spec.homepage      = "https://github.com/BambangSinaga/rb_pager"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -19,9 +21,11 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "https://github.com/BambangSinaga/rb_pager"
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
+  spec.add_development_dependency "activerecord", ">= 5.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "activerecord"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
 
   # 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.

metadata

@@ -1,31 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: rb_pager
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - BambangSinaga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,19 +80,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |-
-  ActiveRecord plugin for cursor based pagination for Ruby on Rails. \n
-      Cursor-based pagination (aka keyset pagination) is a common pagination strategy that avoids many of the pitfalls of “offset–limit” pagination.
+description: |
+  ActiveRecord plugin for cursor based pagination for Ruby on Rails.
+  Cursor-based pagination (aka keyset pagination) is a common pagination strategy that avoids many of the pitfalls of “offset–limit” pagination.
 email:
 - mejbambang@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile