grape-pagy 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cf4286de9e78c7b5a4f4f9ea1fdf9ad8c5e688a64b44e4551c26e300509d42c
-  data.tar.gz: ca06ad206ff3fb7dadc9dcf9f37848afd58645d35f9b8af0dbe7819182694c1e
+  metadata.gz: 37ebea78807a69b217decab0117ac82528ae01db94c909b18025e3c85e6a2c6f
+  data.tar.gz: 03547b0d4bd43a7241237c7c8acf7a204d919f55fec94339edca859daab4c2fc
 SHA512:
-  metadata.gz: 0b6094898f98b12b1bf636963d9e3254efa554469f6a179c0ea047022955c9f716c01c1961756d31b53a77f18947026d1929e4eaea80352de47771c2f92769c9
-  data.tar.gz: 8141124754f358828ae5c248fac72acd3dcd4788aac64b3db54e9afbcbbc7b7e366739227c0e081b5249d6e010e6596293f18f06e1dfe5286241bc46b0ed4ac7
+  metadata.gz: 20e8746a4919de9dc56870934e3f24ca0ff18be31470713c614073c24901d13ab4e4f27bf87706d271397af7c61f78a423bc2d13111b2833e081e8fef42078ab
+  data.tar.gz: 2530fe8611153f8a1f7958207e416056ecb4cbafcb9c97442e5d37946f62b9fc7e6036a63ca7e613d21f67fc1a4fd3c9a7c381812ae9b6929d2e7dd904525485

data/.github/workflows/ruby.yml

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

data/Gemfile

@@ -1,2 +1,8 @@
 source 'https://rubygems.org'
 gemspec
+
+gem 'bundler'
+gem 'rack-test'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop-bsm'

data/Gemfile.lock

@@ -1,116 +1,110 @@
 PATH
   remote: .
   specs:
-    grape-pagy (0.5.0)
+    grape-pagy (0.6.0)
       grape (>= 1.5)
-      pagy (>= 5.4)
+      pagy (>= 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
+    activesupport (7.0.4.2)
       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.13.0)
+    concurrent-ruby (1.2.0)
+    diff-lcs (1.5.0)
+    dry-core (1.0.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.6)
-    dry-container (0.9.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.13, >= 0.13.0)
-    dry-core (0.7.1)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.0)
       concurrent-ruby (~> 1.0)
-    dry-inflector (0.2.1)
-    dry-logic (1.2.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5)
-    dry-types (1.5.1)
-      concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.5, >= 0.5)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 1.0, >= 1.0.2)
-    grape (1.6.0)
+      dry-core (~> 1.0, < 2)
+      dry-inflector (~> 1.0, < 2)
+      dry-logic (>= 1.4, < 2)
+      zeitwerk (~> 2.6)
+    grape (1.7.0)
       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.3)
+    minitest (5.17.0)
+    mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
-    mustermann-grape (1.0.1)
+    mustermann-grape (1.0.2)
       mustermann (>= 1.0.0)
-    pagy (5.4.0)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    pagy (6.0.1)
+    parallel (1.22.1)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
-    rack (2.2.3)
+    rack (3.0.4.1)
     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.6.2)
     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.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.13.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.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.24.1, < 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)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-bsm (0.6.1)
       rubocop (~> 1.0)
       rubocop-performance
-      rubocop-rails
       rubocop-rake
       rubocop-rspec
-    rubocop-performance (1.10.2)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.15.2)
+      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.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby
@@ -124,4 +118,4 @@ DEPENDENCIES
   rubocop-bsm
 
 BUNDLED WITH
-   2.2.21
+   2.4.1

data/grape-pagy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'grape-pagy'
-  spec.version       = '0.5.0'
+  spec.version       = '0.6.0'
   spec.authors       = ['Black Square Media']
   spec.email         = ['info@blacksquaremedia.com']
   spec.description   = 'Pagy paginator for grape API'
@@ -9,16 +9,11 @@ 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 = '>= 3.0'
 
   spec.add_runtime_dependency 'grape', '>= 1.5'
-  spec.add_runtime_dependency 'pagy', '>= 5.4'
+  spec.add_runtime_dependency 'pagy', '>= 6.0'
 
-  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

@@ -31,15 +31,16 @@ module Grape
     module Helpers
       extend Grape::API::Helpers
 
-      params :pagy do |opts|
+      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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-pagy
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -30,84 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: rack-test
-  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: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '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-bsm
-  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'
+        version: '6.0'
 description: Pagy paginator for grape API
 email:
 - info@blacksquaremedia.com
@@ -127,12 +57,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:
@@ -148,10 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.4.1
 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,94 +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&items=5>; rel="first", ' \
-                        '<http://example.org/?page=2&items=5>; rel="next", ' \
-                        '<http://example.org/?page=3&items=5>; 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&items=3>; rel="first"),
-        %(<http://example.org/countless?page=1&items=3>; rel="prev"),
-        %(<http://example.org/countless?page=3&items=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::DEFAULT[:items] = 10
-Pagy::DEFAULT[:max_items] = 20
-
-class TestArray < Array
-  def limit(num)
-    self.class.new slice(0, num)
-  end
-
-  def offset(num)
-    self.class.new 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