grape-pagy 0.3.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 180207f3b3894998bebb7bc777378787eaf71586a4312e75cd3c60e4e960fae3
-  data.tar.gz: a3282f12ca6025c12f22079c51e868ad8b2ca2dfbcddd84d2bdc3c97c474bf6f
+  metadata.gz: ca339ac7f54bf525cd93e7df3da9e4d881ab83825c28e500afcb1774ad6a7991
+  data.tar.gz: 5bd4e7028e53d7b6ed9770d08298fe21b6e2253edc006906c652f2227b645cf2
 SHA512:
-  metadata.gz: a061f3ff334f5a1872811c3789b07c8186794fd6a695b14f0acace8d2b821a10db7e31c352c5f9f078aecd1ccc888a955bb1bbe32e2df3b3fa35ff55948a6cf5
-  data.tar.gz: 60c01e34bbd0867f74d7327f97c12fef04396903c16550cb32f5cd9bae2f6f62a00aaa1c59f54b19247bd36cc1a71affccbebcc90a6a6f89becf9c0e761bdd9e
+  metadata.gz: 31f94b19fbf94f33622333385075376149a694653da7297864945f6cb9afd11a38b355fc63dd426e0d887b5b8b295f4c4969826aad07b7ced9fdf32048f556db
+  data.tar.gz: 8126538a4b3592a3eb259ebdbe597add3749ab9297a08494414dc571231ea5ebc2370b4fc9ad4aeac8bbafbfee8566fd447b4f3a6b67baa10b961d3c73d998d6

data/.github/workflows/ruby.yml

@@ -11,9 +11,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.6", "2.7"]
+        ruby-version: ["3.0", "3.1"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}

data/.gitignore

@@ -46,7 +46,7 @@ build-iPhoneSimulator/
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock
-# .ruby-version
+.ruby-version
 # .ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:

data/.rubocop.yml

@@ -6,7 +6,7 @@ inherit_mode:
     - Exclude
 
 AllCops:
-  TargetRubyVersion: "2.6"
+  TargetRubyVersion: "3.0"
 
 Naming/FileName:
   Exclude: ["lib/grape-pagy.rb"]

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.5.0
+
+- Pin to Pagy 5.x.
+
+### 0.4.0
+
+- Pin to Pagy 4.x.
+
 ### 0.3.1
 
 - Pin to Pagy 3.x.

data/Gemfile.lock

@@ -1,33 +1,28 @@
 PATH
   remote: .
   specs:
-    grape-pagy (0.3.1)
+    grape-pagy (0.5.1)
       grape (>= 1.5)
-      pagy (>= 3.8, < 4.0)
+      pagy (>= 5.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.8)
-    diff-lcs (1.4.4)
-    dry-configurable (0.12.1)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    dry-container (0.10.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
-    dry-container (0.7.2)
+    dry-core (0.8.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.5.0)
-      concurrent-ruby (~> 1.0)
-    dry-inflector (0.2.0)
-    dry-logic (1.1.1)
+    dry-inflector (0.3.0)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
     dry-types (1.5.1)
@@ -36,81 +31,77 @@ GEM
       dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    grape (1.5.3)
+    grape (1.6.2)
       activesupport
       builder
       dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    i18n (1.8.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    mustermann (1.1.1)
+    json (2.6.2)
+    minitest (5.16.2)
+    mustermann (2.0.1)
       ruby2_keywords (~> 0.0.1)
-    mustermann-grape (1.0.1)
+    mustermann-grape (1.0.2)
       mustermann (>= 1.0.0)
-    pagy (3.13.0)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    pagy (5.10.1)
+      activesupport
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    rack (2.2.3)
+    rack (2.2.4)
     rack-accept (0.4.5)
       rack (>= 0.4)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.13.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.31.2)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-bsm (0.5.8)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-bsm (0.6.0)
       rubocop (~> 1.0)
       rubocop-performance
-      rubocop-rails
       rubocop-rake
       rubocop-rspec
-    rubocop-performance (1.10.2)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
-      activesupport (>= 4.2.0)
-      rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
-    tzinfo (2.0.4)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   ruby
@@ -124,4 +115,4 @@ DEPENDENCIES
   rubocop-bsm
 
 BUNDLED WITH
-   2.1.4
+   2.3.16

data/README.md

@@ -1,6 +1,6 @@
 # Grape::Pagy
 
-[![Build Status](https://travis-ci.org/bsm/grape-pagy.png?branch=master)](https://travis-ci.org/bsm/grape-pagy)
+[![Ruby](https://github.com/bsm/grape-pagy/actions/workflows/ruby.yml/badge.svg)](https://github.com/bsm/grape-pagy/actions/workflows/ruby.yml)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 [Pagy](https://github.com/ddnexus/pagy) pagination for [grape](https://github.com/ruby-grape/grape) API framework.
@@ -47,7 +47,7 @@ class MyApi < Grape::API
   resource :strings do
     desc 'Supports arrays as well as relations.'
     params do
-      # Override defaults by setting Pagy::VARS or by passing options.
+      # Override defaults by setting Pagy::DEFAULT or by passing options.
       use :pagy,
           items_param: :per_page, # Accept per_page=N param to limit items.
           items: 2,               # If per_page param is blank, default to 2.

data/grape-pagy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'grape-pagy'
-  spec.version       = '0.3.1'
+  spec.version       = '0.5.1'
   spec.authors       = ['Black Square Media']
   spec.email         = ['info@blacksquaremedia.com']
   spec.description   = 'Pagy paginator for grape API'
@@ -9,16 +9,16 @@ Gem::Specification.new do |spec|
   spec.license       = 'Apache-2.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.start_with?('spec/') }
-  spec.test_files    = `git ls-files -z -- spec/*`.split("\x0")
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.add_runtime_dependency 'grape', '>= 1.5'
-  spec.add_runtime_dependency 'pagy', '>= 3.8', '< 4.0'
+  spec.add_runtime_dependency 'pagy', '>= 5.4'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop-bsm'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/grape/pagy.rb

@@ -13,7 +13,7 @@ module Grape
       include ::Pagy::Backend
 
       def paginate(collection, using: nil, **opts, &block)
-        pagy_with_items(opts)
+        opts = pagy_countless_get_vars(nil, opts)
         using ||= if collection.respond_to?(:arel_table)
                     :arel
                   elsif collection.is_a?(Array)
@@ -31,20 +31,22 @@ module Grape
     module Helpers
       extend Grape::API::Helpers
 
-      params :pagy do |items: nil, page: nil, **opts|
-        items ||= ::Pagy::VARS[:items]
-        page ||= ::Pagy::VARS[:page]
-        page_param = opts[:page_param] || ::Pagy::VARS[:page_param]
-        items_param = opts[:items_param] || ::Pagy::VARS[:items_param]
+      params :pagy do |opts|
+        items = opts.delete(:items) || ::Pagy::DEFAULT[:items]
+        page = opts.delete(:page) || ::Pagy::DEFAULT[:page]
+        page_param = opts[:page_param] || ::Pagy::DEFAULT[:page_param]
+        items_param = opts[:items_param] || ::Pagy::DEFAULT[:items_param]
+        max_items = opts[:max_items] || ::Pagy::DEFAULT[:max_items]
 
         @api.route_setting(:pagy_options, opts)
         optional page_param, type: Integer, default: page, desc: 'Page offset to fetch.'
-        optional items_param, type: Integer, default: items, desc: 'Number of items to return per page.'
+        optional items_param, type: Integer, default: items, desc: "Number of items to return per page. Maximum value: #{max_items}"
       end
 
       # @param [Array|ActiveRecord::Relation] collection the collection or relation.
       def pagy(collection, **opts)
         defaults = route_setting(:pagy_options) || {}
+
         Wrapper.new(request, params).paginate(collection, **defaults, **opts) do |key, value|
           header key, value
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-pagy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -30,20 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -133,12 +127,11 @@ files:
 - grape-pagy.gemspec
 - lib/grape-pagy.rb
 - lib/grape/pagy.rb
-- spec/grape/pagy_spec.rb
-- spec/spec_helper.rb
 homepage: ''
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -147,17 +140,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: ''
-test_files:
-- spec/grape/pagy_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/spec/grape/pagy_spec.rb

@@ -1,92 +0,0 @@
-require 'spec_helper'
-
-describe Grape::Pagy do
-  include Rack::Test::Methods
-
-  let(:app) { TestAPI }
-
-  it 'paginates' do
-    get '/'
-    expect(last_response.status).to eq(200)
-    expect(last_response.headers).to include(
-      'Current-Page' => '1',
-      'Link'         => %(<http://example.org/?page=1>; rel="first", <http://example.org/?page=2>; rel="next", <http://example.org/?page=3>; rel="last"),
-      'Page-Items'   => '5',
-      'Total-Count'  => '12',
-      'Total-Pages'  => '3',
-    )
-    expect(last_response.body).to eq(%([1, 2, 3, 4, 5]))
-  end
-
-  it 'accepts page and items parameters' do
-    get '/?page=2&items=3'
-    expect(last_response.status).to eq(200)
-    expect(last_response.headers).to include(
-      'Current-Page' => '2',
-      'Page-Items'   => '3',
-      'Total-Count'  => '12',
-      'Total-Pages'  => '4',
-    )
-    expect(last_response.body).to eq(%([4, 5, 6]))
-  end
-
-  it 'caps items' do
-    get '/?items=10'
-    expect(last_response.headers).to include('Page-Items' => '6')
-    expect(last_response.body).to eq(%([1, 2, 3, 4, 5, 6]))
-
-    get '/?items=3'
-    expect(last_response.headers).to include('Page-Items' => '3')
-    expect(last_response.body).to eq(%([1, 2, 3]))
-  end
-
-  it 'ignores overflow' do
-    get '/?page=99'
-    expect(last_response.status).to eq(200)
-    expect(last_response.headers).to include(
-      'Current-Page' => '99',
-      'Total-Pages'  => '3',
-    )
-    expect(last_response.body).to eq(%([]))
-  end
-
-  it 'allows countless mode' do
-    get '/countless?page=2'
-    expect(last_response.status).to eq(200)
-    expect(last_response.headers).to include(
-      'Current-Page' => '2',
-      'Page-Items'   => '3',
-      'Link'         => [
-        %(<http://example.org/countless?page=1>; rel="first"),
-        %(<http://example.org/countless?page=1>; rel="prev"),
-        %(<http://example.org/countless?page=3>; rel="next"),
-      ].join(', '),
-    )
-    expect(last_response.headers).not_to include(
-      'Total-Count',
-      'Total-Pages',
-    )
-    expect(last_response.body).to eq(%([4, 5, 6]))
-  end
-
-  it 'inherits helper' do
-    get '/sub'
-    expect(last_response.status).to eq(200)
-    expect(last_response.headers).to include(
-      'Current-Page' => '1',
-      'Page-Items'   => '10',
-      'Total-Count'  => '13',
-      'Total-Pages'  => '2',
-    )
-    expect(last_response.body).to eq(%([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]))
-
-    get '/sub?per_page=20'
-    expect(last_response.status).to eq(200)
-    expect(last_response.headers).to include(
-      'Current-Page' => '1',
-      'Page-Items'   => '20',
-      'Total-Count'  => '13',
-      'Total-Pages'  => '1',
-    )
-  end
-end

data/spec/spec_helper.rb

@@ -1,50 +0,0 @@
-ENV['RACK_ENV'] ||= 'test'
-
-require 'rspec'
-require 'grape/pagy'
-require 'rack/test'
-
-Pagy::VARS[:items] = 10
-Pagy::VARS[:max_items] = 20
-
-class TestArray < Array
-  def limit(num)
-    slice!(0, num)
-  end
-
-  def offset(num)
-    slice!(num..-1)
-  end
-end
-
-class TestAPI < Grape::API
-  helpers Grape::Pagy::Helpers
-
-  params do
-    use :pagy, items: 5, max_items: 6
-  end
-  get '' do
-    pagy (1..12).to_a
-  end
-
-  params do
-    use :pagy, items: 3
-  end
-  get '/countless' do
-    pagy TestArray.new((1..12).to_a), using: :countless
-  end
-
-  resource :sub do
-    params do
-      use :pagy, items_param: :per_page
-    end
-    get '/' do
-      pagy (1..12).to_a, count: 13
-    end
-  end
-end
-
-RSpec.configure do |config|
-  config.include Rack::Test::Methods
-  config.raise_errors_for_deprecations!
-end