grape-kaminari 0.2.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0ae809ad4c135dcf91437d3e66be5aeade55263df274f958da45e3518643121
-  data.tar.gz: 6444fd46138c8e330a9c74254f27d0512ea861df07eb90cde07f070a1e43a0e6
+  metadata.gz: 5282850782bd08c0a0719eaad85f84b406f1a7419b9755162f939dc7f7aa71bc
+  data.tar.gz: 1fbe1503fe2149f82413c3e934452c85bfe190657077fbd1607e6a10beb812b2
 SHA512:
-  metadata.gz: 5633fb0d0acecfe2aa68eaff97e29aabddd087922b0ab17a439b26a6fd8ac3889f5f3c902dff54b1729bace30fe6c81c2972a1075785653ea0785b5326ad79e0
-  data.tar.gz: 25fbc7a3ad61bc457e237da7ccf9dfbced16c76b291cec006ed45ac9504fc9e208d3f5ac2e3f30f9f94396d7b157214f106aeec05bd8d121e1b6ee06e614025a
+  metadata.gz: 644acde6f381781e2ef22c484c72fd9c754f7b72382e88fb3047bd71686c9284f65ba4154d887ba66ed45dc164fbb2d1902dfefbcb9310ea42124b5f9146e8cc
+  data.tar.gz: 12552dd5e9ce60c46726554e51cdffc01d1782b7a026f5298141f6c9b60e29ab0c05ce799eab01ae73acc14f458a08a6127b06d2357948ebc89b60681e5f3b71

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.5", "2.6", "2.7", "3.0"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.rubocop.yml

@@ -1,26 +1,13 @@
+inherit_gem:
+  rubocop-bsm:
+    - default.yml
+inherit_mode:
+  merge:
+    - Exclude
+
 AllCops:
   TargetRubyVersion: "2.5"
-  NewCops: enable
-
-Metrics/AbcSize:
-  Enabled: false
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*_spec.rb
-Metrics/MethodLength:
-  Max: 20
 
 Naming/FileName:
   Exclude:
     - lib/grape-kaminari.rb
-
-Style/Documentation:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: false
-Style/TrailingCommaInArguments:
-  EnforcedStyleForMultiline: consistent_comma
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: consistent_comma
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+### 0.5.0 (Next)
+
+#### Features
+
+* Your contribution here.
+
+#### Fixes
+
+* Your contribution here.
+
+### 0.4.1
+
+#### Features
+
+* [#58](https://github.com/bsm/grape-kaminari/pull/58): Allow to paginate without counting - [@dim](https://github.com/dim).
+
+### 0.4.0
+
+#### Features
+
+* [#57](https://github.com/bsm/grape-kaminari/pull/57): Introduce new params based API - [@dim](https://github.com/dim).
+* [#56](https://github.com/bsm/grape-kaminari/pull/56): Introduce a CHANGELOG - [@dim](https://github.com/dim).
+
+#### Fixes
+
+* [#57](https://github.com/bsm/grape-kaminari/pull/57): Fix issues related to Grape v1.5 release - [@dim](https://github.com/dim).
+
+### 0.3.0 (2020/08/10)
+
+* [#54](https://github.com/bsm/grape-kaminari/pull/54): Inherit paginate helper - [@dim](https://github.com/dim).
+
+### 0.2.1 (2020/06/18)
+
+#### Fixes
+
+* [#52](https://github.com/bsm/grape-kaminari/pull/52): Skip per-page range validation for non-integer values - [@dim](https://github.com/dim).
+
+### 0.2.0 (2020/06/18)
+
+Revived project, migrated to [github.com/bsm/grape-kaminari](github.com/bsm/grape-kaminari).
+
+#### Features
+
+* [#51](https://github.com/bsm/grape-kaminari/pull/51): Support for Grape 1.x - [@dim](https://github.com/dim).
+
+#### Fixes
+
+* [#51](https://github.com/bsm/grape-kaminari/pull/51): Fixed code style - [@dim](https://github.com/dim).

data/Gemfile.lock

@@ -1,106 +1,119 @@
 PATH
   remote: .
   specs:
-    grape-kaminari (0.2.1)
-      grape (>= 1.0)
+    grape-kaminari (0.4.2)
+      grape (>= 1.6.1, != 1.4.0)
       kaminari-grape
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.2)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
+      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.6)
-    diff-lcs (1.3)
-    dry-configurable (0.11.5)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.5.0)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-logic (1.0.6)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-types (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    grape (1.3.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.3)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     kaminari-core (1.2.1)
     kaminari-grape (1.0.1)
       grape
       kaminari-core (~> 1.0)
-    minitest (5.14.1)
+    minitest (5.14.4)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-grape (1.0.1)
       mustermann (>= 1.0.0)
-    parallel (1.19.2)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
     rack (2.2.3)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    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)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.85.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.13.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-bsm (0.5.9)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rails
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.11.1)
+      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.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -111,7 +124,7 @@ DEPENDENCIES
   rack-test
   rake
   rspec
-  rubocop
+  rubocop-bsm
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,6 +1,6 @@
 # Grape::Kaminari
 
-[![Build Status](https://travis-ci.org/bsm/grape-kaminari.png?branch=master)](https://travis-ci.org/bsm/grape-kaminari)
+[![Test](https://github.com/bsm/grape-kaminari/actions/workflows/test.yml/badge.svg)](https://github.com/bsm/grape-kaminari/actions/workflows/test.yml)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 [kaminari](https://github.com/kaminari/kaminari) paginator integration for [grape](https://github.com/intridea/grape) API framework.
@@ -35,7 +35,6 @@ class MyApi < Grape::API
   resource :posts do
     desc 'Return a list of posts.'
 
-    # Annotate action with `paginate`.
     # This will add three optional params: page, per_page, and offset
     #
     # You can optionally overwrite the default :per_page setting (10)
@@ -45,8 +44,9 @@ class MyApi < Grape::API
     # You can disable the offset parameter from appearing in the API
     # documentation by setting it to false.
     #
-    paginate per_page: 20, max_per_page: 30, offset: 5
-
+    params do
+      use :pagination, per_page: 20, max_per_page: 30, offset: 5
+    end
     get do
       posts = Post.where(...)
 

data/grape-kaminari.gemspec

@@ -12,17 +12,17 @@ Gem::Specification.new do |spec|
   spec.homepage      = ''
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.start_with?('spec/') }
+  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.5'
 
-  spec.add_runtime_dependency 'grape', '>= 1.0'
+  spec.add_runtime_dependency 'grape', '>= 1.6.1', '!= 1.4.0'
   spec.add_runtime_dependency 'kaminari-grape'
 
   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'
+  spec.add_development_dependency 'rubocop-bsm'
 end

data/lib/grape/kaminari/max_value_validator.rb

@@ -1,6 +1,6 @@
 module Grape
   module Kaminari
-    class MaxValueValidator < Grape::Validations::Base
+    class MaxValueValidator < Grape::Validations::Validators::Base
       def validate_param!(attr_name, params)
         attr = params[attr_name]
         return unless attr.is_a?(Integer) && @option && attr > @option

data/lib/grape/kaminari/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Kaminari
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.4.2'.freeze
   end
 end

data/lib/grape/kaminari.rb

@@ -5,47 +5,61 @@ require 'kaminari/grape'
 
 module Grape
   module Kaminari
-    module HelperMethods # :nodoc:
-      def paginate(collection)
-        collection.page(params[:page].to_i)
-                  .per(params[:per_page].to_i)
-                  .padding(params[:offset].to_i)
-                  .tap do |data|
-          header 'X-Total',       data.total_count.to_s
-          header 'X-Total-Pages', data.total_pages.to_s
-          header 'X-Per-Page',    data.limit_value.to_s
-          header 'X-Page',        data.current_page.to_s
-          header 'X-Next-Page',   data.next_page.to_s
-          header 'X-Prev-Page',   data.prev_page.to_s
-          header 'X-Offset',      params[:offset].to_s
-        end
-      end
+    extend ActiveSupport::Concern
+
+    included do
+      helpers HelperMethods
     end
 
-    module ClassMethods # :nodoc:
-      def paginate(**options)
-        options.reverse_merge!(
+    module HelperMethods # :nodoc:
+      extend Grape::API::Helpers
+
+      params :pagination do |opts = {}|
+        opts.reverse_merge!(
           per_page: ::Kaminari.config.default_per_page || 10,
           max_per_page: ::Kaminari.config.max_per_page,
           offset: 0,
         )
-        params do
-          optional :page,     type: Integer, default: 1,
-                              desc: 'Page offset to fetch.'
-          optional :per_page, type: Integer, default: options[:per_page],
-                              desc: 'Number of results to return per page.',
-                              max_value: options[:max_per_page]
-          if  options[:offset].is_a? Numeric
-            optional :offset, type: Integer, default: options[:offset],
-                              desc: 'Pad a number of results.'
-          end
+
+        optional :page, type: Integer, default: 1,
+                        desc: 'Page offset to fetch.'
+        optional :per_page, type: Integer, default: opts[:per_page],
+                            desc: 'Number of results to return per page.',
+                            max_value: opts[:max_per_page]
+
+        if opts[:offset].is_a?(Integer)
+          optional :offset, type: Integer, default: opts[:offset],
+                            desc: 'Pad a number of results.'
         end
       end
+
+      def paginate(collection, without_count: false)
+        coll = collection.page(params[:page].to_i)
+                         .per(params[:per_page].to_i)
+                         .padding(params[:offset].to_i)
+        coll = coll.without_count if without_count && coll.respond_to?(:without_count)
+
+        unless without_count
+          header 'X-Total', coll.total_count.to_s
+          header 'X-Total-Pages', coll.total_pages.to_s
+        end
+        header 'X-Per-Page',    coll.limit_value.to_s
+        header 'X-Page',        coll.current_page.to_s
+        header 'X-Next-Page',   coll.next_page.to_s
+        header 'X-Prev-Page',   coll.prev_page.to_s
+        header 'X-Offset',      params[:offset].to_s
+
+        coll
+      end
     end
 
-    def self.included(base)
-      base.helpers HelperMethods
-      base.extend ClassMethods
+    module DSLMethods # :nodoc:
+      def paginate(opts = {})
+        params do
+          use(:pagination, opts)
+        end
+      end
     end
+    Grape::API::Instance.extend(DSLMethods)
   end
 end

data/spec/grape/kaminari_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+describe Grape::Kaminari do
+  subject do
+    Class.new(Grape::API) do
+      include Grape::Kaminari
+    end
+  end
+
+  def declared_params
+    subject.namespace_stackable(:declared_params).flatten
+  end
+
+  it 'adds to declared parameters' do
+    subject.params { use :pagination }
+    expect(declared_params).to eq(%i[page per_page offset])
+  end
+
+  it 'may exclude :offset' do
+    subject.params { use :pagination, offset: false }
+    expect(declared_params).to eq(%i[page per_page])
+  end
+
+  it 'supports legacy declarations' do
+    subject.paginate
+    expect(declared_params).to eq(%i[page per_page offset])
+  end
+
+  it 'does not stumble across repeated declarations' do
+    subject.paginate offset: false
+    subject.params do
+      optional :extra
+    end
+    expect(declared_params).to eq(%i[page per_page extra])
+  end
+
+  describe 'descriptions, validation, and defaults' do
+    let(:params) { subject.routes.first.params }
+
+    before do
+      subject.params { use :pagination }
+      subject.get('/') { 'OK' }
+    end
+
+    it 'does not require :page' do
+      expect(params['page'][:required]).to eq(false)
+    end
+
+    it 'does not require :per_page' do
+      expect(params['per_page'][:required]).to eq(false)
+    end
+
+    it 'does not require :offset' do
+      expect(params['offset'][:required]).to eq(false)
+    end
+
+    it 'describes :page' do
+      expect(params['page'][:desc]).to eq('Page offset to fetch.')
+    end
+
+    it 'describes :per_page' do
+      expect(params['per_page'][:desc]).to eq('Number of results to return per page.')
+    end
+
+    it 'describes :offset' do
+      expect(params['offset'][:desc]).to eq('Pad a number of results.')
+    end
+
+    it 'validates :page as Integer' do
+      expect(params['page'][:type]).to eq('Integer')
+    end
+
+    it 'validates :per_page as Integer' do
+      expect(params['per_page'][:type]).to eq('Integer')
+    end
+
+    it 'validates :offset as Integer' do
+      expect(params['offset'][:type]).to eq('Integer')
+    end
+
+    it 'defaults :page to 1' do
+      expect(params['page'][:default]).to eq(1)
+    end
+
+    it 'defaults :per_page to Kaminari.config.default_per_page' do
+      expect(params['per_page'][:default]).to eq(::Kaminari.config.default_per_page)
+    end
+
+    it 'defaults :offset to 0' do
+      expect(params['offset'][:default]).to eq(0)
+    end
+  end
+
+  describe 'custom paginated api' do
+    let(:app) { subject }
+    let(:params) { subject.routes.first.params }
+
+    before do
+      subject.params do
+        use :pagination, per_page: 99, max_per_page: 999, offset: 9
+      end
+      subject.get('/') { 'OK' }
+    end
+
+    it 'defaults :per_page to customized value' do
+      expect(params['per_page'][:default]).to eq(99)
+    end
+
+    it 'succeeds when :per_page is within :max_value' do
+      get('/', page: 1, per_page: 999)
+      expect(last_response.status).to eq(200)
+    end
+
+    it 'ensures :per_page is within :max_value' do
+      get('/', page: 1, per_page: 1_000)
+      expect(last_response.status).to eq(400)
+      expect(last_response.body).to match(/per_page must be less than or equal 999/)
+    end
+
+    it 'ensures :per_page is numeric' do
+      get('/', page: 1, per_page: 'foo')
+      expect(last_response.status).to eq(400)
+      expect(last_response.body).to match(/per_page is invalid/)
+    end
+
+    it 'defaults :offset to customized value' do
+      expect(params['offset'][:default]).to eq(9)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@ require 'rack/test'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir[File.expand_path('./support/**/*.rb', __dir__)].sort.each { |f| require f }
+Dir[File.expand_path('./support/**/*.rb', __dir__)].sort.each {|f| require f }
 
 I18n.enforce_available_locales = false
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-kaminari
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Tymon Tobolski
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -17,14 +17,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.6.1
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.6.1
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: kaminari-grape
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +102,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-bsm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,9 +122,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -129,8 +136,7 @@ files:
 - lib/grape/kaminari.rb
 - lib/grape/kaminari/max_value_validator.rb
 - lib/grape/kaminari/version.rb
-- spec/kaminari_spec.rb
-- spec/paginate_helper_spec.rb
+- spec/grape/kaminari_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -151,11 +157,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: kaminari integration for grape
 test_files:
-- spec/kaminari_spec.rb
-- spec/paginate_helper_spec.rb
+- spec/grape/kaminari_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.7
-  - 2.6
-  - 2.5

data/spec/kaminari_spec.rb

@@ -1,130 +0,0 @@
-require 'spec_helper'
-
-class UnPaginatedAPI < Grape::API
-  # Intentionally not including Grape::Kaminari
-end
-
-class PaginatedAPI < Grape::API
-  include Grape::Kaminari
-end
-
-describe Grape::Kaminari do
-  describe 'unpaginated api' do
-    subject { Class.new(UnPaginatedAPI) }
-
-    it 'raises an error' do
-      expect { subject.paginate }.to raise_error(NoMethodError, /undefined method `paginate' for/i)
-    end
-  end
-
-  describe 'default paginated api' do
-    subject { Class.new(PaginatedAPI) }
-
-    it 'adds to declared parameters' do
-      subject.paginate
-      expect(subject.inheritable_setting.route[:declared_params]).to eq(%i[page per_page offset])
-    end
-
-    describe 'descriptions, validation, and defaults' do
-      let(:params) { subject.routes.first.params }
-
-      before do
-        subject.paginate
-        subject.get('/') {}
-      end
-
-      it 'does not require :page' do
-        expect(params['page'][:required]).to eq(false)
-      end
-
-      it 'does not require :per_page' do
-        expect(params['per_page'][:required]).to eq(false)
-      end
-
-      it 'does not require :offset' do
-        expect(params['offset'][:required]).to eq(false)
-      end
-
-      it 'describes :page' do
-        expect(params['page'][:desc]).to eq('Page offset to fetch.')
-      end
-
-      it 'describes :per_page' do
-        expect(params['per_page'][:desc]).to eq('Number of results to return per page.')
-      end
-
-      it 'describes :offset' do
-        expect(params['offset'][:desc]).to eq('Pad a number of results.')
-      end
-
-      it 'validates :page as Integer' do
-        expect(params['page'][:type]).to eq('Integer')
-      end
-
-      it 'validates :per_page as Integer' do
-        expect(params['per_page'][:type]).to eq('Integer')
-      end
-
-      it 'validates :offset as Integer' do
-        expect(params['offset'][:type]).to eq('Integer')
-      end
-
-      it 'defaults :page to 1' do
-        expect(params['page'][:default]).to eq(1)
-      end
-
-      it 'defaults :per_page to Kaminari.config.default_per_page' do
-        expect(params['per_page'][:default]).to eq(::Kaminari.config.default_per_page)
-      end
-
-      it 'defaults :offset to 0' do
-        expect(params['offset'][:default]).to eq(0)
-      end
-    end
-  end
-
-  describe 'custom paginated api' do
-    subject { Class.new(PaginatedAPI) }
-    let(:app) { subject }
-    let(:params) { subject.routes.first.params }
-
-    before do
-      subject.paginate per_page: 99, max_per_page: 999, offset: 9
-      subject.get('/') {}
-    end
-
-    it 'defaults :per_page to customized value' do
-      expect(params['per_page'][:default]).to eq(99)
-    end
-
-    it 'succeeds when :per_page is within :max_value' do
-      get('/', page: 1, per_page: 999)
-      expect(last_response.status).to eq(200)
-    end
-
-    it 'ensures :per_page is within :max_value' do
-      get('/', page: 1, per_page: 1_000)
-      expect(last_response.status).to eq(400)
-      expect(last_response.body).to match(/per_page must be less than or equal 999/)
-    end
-
-    it 'ensures :per_page is numeric' do
-      get('/', page: 1, per_page: 'foo')
-      expect(last_response.status).to eq(400)
-      expect(last_response.body).to match(/per_page is invalid/)
-    end
-
-    it 'defaults :offset to customized value' do
-      expect(params['offset'][:default]).to eq(9)
-    end
-  end
-
-  describe 'paginated api without :offset' do
-    subject { Class.new(PaginatedAPI) }
-
-    it 'excludes :offset from declared params' do
-      subject.paginate offset: false
-      expect(subject.inheritable_setting.route[:declared_params]).not_to include(:offset)
-    end
-  end
-end

data/spec/paginate_helper_spec.rb

@@ -1,55 +0,0 @@
-require 'spec_helper'
-require 'json'
-
-class PaginatedAPI < Grape::API
-  include Grape::Kaminari
-
-  paginate
-  get '' do
-    paginate(Kaminari.paginate_array((1..10).to_a))
-  end
-
-  paginate offset: false
-  get 'no-offset' do
-    paginate(Kaminari.paginate_array((1..10).to_a))
-  end
-end
-
-describe Grape::Kaminari do
-  subject { PaginatedAPI.new }
-  def app
-    subject
-  end
-  let(:json) { JSON.parse(last_response.body) }
-  let(:header) { last_response.header }
-
-  describe 'paginated helper' do
-    it 'returns the first page' do
-      get '/', page: 1, per_page: 3
-      expect(json).to eq [1, 2, 3]
-    end
-
-    it 'returns the second page' do
-      get '/', page: 2, per_page: 3
-      expect(json).to eq [4, 5, 6]
-    end
-
-    # This is here to ensure that Kaminari can handle `padding(false)`
-    # and still do the right thing.
-    it 'works when offset is false' do
-      get '/no-offset', page: 1, per_page: 3
-      expect(json).to eq [1, 2, 3]
-    end
-
-    it 'sets headers' do
-      get '/', page: 3, per_page: 2, offset: 1
-      expect(header['X-Total']).to eq '10'
-      expect(header['X-Total-Pages']).to eq '5'
-      expect(header['X-Per-Page']).to eq '2'
-      expect(header['X-Page']).to eq '3'
-      expect(header['X-Next-Page']).to eq '4'
-      expect(header['X-Prev-Page']).to eq '2'
-      expect(header['X-Offset']).to eq '1'
-    end
-  end
-end