grape-kaminari 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 690c3b70419498572169fa3e2daee43ba5adef9c93e46ba8b0da6944f2afdcc0
-  data.tar.gz: 49f722ee554da32f4ecc3351abc2e5edc44454882046cfadf39f0d99c7ba2ba5
+  metadata.gz: 5be6c20ba0aef343949970af43c69d6781e945ed043b3baa3b6c258570f4300b
+  data.tar.gz: f9f31a5f31560e5cd751b31109d5720410ea4f8c523a1d0b4b050c1eef039247
 SHA512:
-  metadata.gz: c08980fd147c292e51c546c19166a095b012fe0727e95a30d5ac9a5682eecfd66fdbf907167b0c2c5160c854269728ecca34cee6808009660e02075eaed67d35
-  data.tar.gz: ffdf0838305fd025f5fda2fb96ee6c58b9f46bfbe0fe511f13de9b06d9683f1f6651d45a23d8b923434974f65d930242bcfb00723a3042dffa9cdecd6dba8960
+  metadata.gz: c1205ab3b90b586436aaeeb2f94ce4443acdbd372b72a6e1acda2cb250081f976e4b9743eb4f36bdc92d82dc0174d16289202c61128536a1ca440c64f5c3d923
+  data.tar.gz: 3c8f039a3f9596fc78bb9fd79adf917e79a662b372f480da7aa0bf35a75a07d1b40cc20557c9038300b92e3f12f566ad512ad6a9aede7c4f18f11b3b778c8997

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+### 0.5.0 (Next)
+
+#### Features
+
+* Your contribution here.
+
+#### Fixes
+
+* Your contribution here.
+
+### 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,14 +1,14 @@
 PATH
   remote: .
   specs:
-    grape-kaminari (0.3.0)
+    grape-kaminari (0.4.0)
       grape (>= 1.0, != 1.4.0)
       kaminari-grape
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.2)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -29,7 +29,7 @@ GEM
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-logic (1.0.6)
+    dry-logic (1.0.8)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
@@ -40,7 +40,7 @@ GEM
       dry-equalizer (~> 0.3)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    grape (1.3.3)
+    grape (1.5.0)
       activesupport
       builder
       dry-types (>= 1.1)
@@ -53,13 +53,13 @@ GEM
     kaminari-grape (1.0.1)
       grape
       kaminari-core (~> 1.0)
-    minitest (5.14.1)
+    minitest (5.14.2)
     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.4)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
     rack (2.2.3)
     rack-accept (0.4.5)
@@ -68,13 +68,13 @@ GEM
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.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-core (3.9.3)
       rspec-support (~> 3.9.3)
     rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -83,17 +83,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.89.0)
+    rubocop (0.92.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 0.5.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
     thread_safe (0.3.6)

data/README.md

@@ -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/lib/grape/kaminari.rb

@@ -9,10 +9,30 @@ module Grape
 
     included do
       helpers HelperMethods
-      base_instance.extend DSLMethods
     end
 
     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,
+        )
+
+        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)
         collection.page(params[:page].to_i)
                   .per(params[:per_page].to_i)
@@ -30,24 +50,12 @@ module Grape
     end
 
     module DSLMethods # :nodoc:
-      def paginate(**options)
-        options.reverse_merge!(
-          per_page: ::Kaminari.config.default_per_page || 10,
-          max_per_page: ::Kaminari.config.max_per_page,
-          offset: 0,
-        )
+      def paginate(opts = {})
         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
+          use(:pagination, opts)
         end
       end
     end
+    Grape::API::Instance.extend(DSLMethods)
   end
 end

data/lib/grape/kaminari/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Kaminari
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/spec/kaminari_spec.rb

@@ -1,130 +1,131 @@
 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) }
+  subject { Class.new(PaginatedAPI) }
 
-    it 'raises an error' do
-      expect { subject.paginate }.to raise_error(NoMethodError, /undefined method `paginate' for/i)
-    end
+  def declared_params
+    subject.namespace_stackable(:declared_params).flatten
   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 'adds to declared parameters' do
+    subject.params { use :pagination }
+    expect(declared_params).to eq(%i[page per_page offset])
+  end
 
-      it 'does not require :offset' do
-        expect(params['offset'][:required]).to eq(false)
-      end
+  it 'may exclude :offset' do
+    subject.params { use :pagination, offset: false }
+    expect(declared_params).to eq(%i[page per_page])
+  end
 
-      it 'describes :page' do
-        expect(params['page'][:desc]).to eq('Page offset to fetch.')
-      end
+  it 'should support legacy declarations' do
+    subject.paginate
+    expect(declared_params).to eq(%i[page per_page offset])
+  end
 
-      it 'describes :per_page' do
-        expect(params['per_page'][:desc]).to eq('Number of results to return per page.')
-      end
+  it 'should 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
 
-      it 'describes :offset' do
-        expect(params['offset'][:desc]).to eq('Pad a number of results.')
-      end
+  describe 'descriptions, validation, and defaults' do
+    let(:params) { subject.routes.first.params }
 
-      it 'validates :page as Integer' do
-        expect(params['page'][:type]).to eq('Integer')
-      end
+    before do
+      subject.params { use :pagination }
+      subject.get('/') {}
+    end
 
-      it 'validates :per_page as Integer' do
-        expect(params['per_page'][:type]).to eq('Integer')
-      end
+    it 'does not require :page' do
+      expect(params['page'][:required]).to eq(false)
+    end
 
-      it 'validates :offset as Integer' do
-        expect(params['offset'][:type]).to eq('Integer')
-      end
+    it 'does not require :per_page' do
+      expect(params['per_page'][:required]).to eq(false)
+    end
 
-      it 'defaults :page to 1' do
-        expect(params['page'][:default]).to eq(1)
-      end
+    it 'does not require :offset' do
+      expect(params['offset'][:required]).to eq(false)
+    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 'describes :page' do
+      expect(params['page'][:desc]).to eq('Page offset to fetch.')
+    end
 
-      it 'defaults :offset to 0' do
-        expect(params['offset'][:default]).to eq(0)
-      end
+    it 'describes :per_page' do
+      expect(params['per_page'][:desc]).to eq('Number of results to return per page.')
     end
-  end
 
-  describe 'custom paginated api' do
-    subject { Class.new(PaginatedAPI) }
-    let(:app) { subject }
-    let(:params) { subject.routes.first.params }
+    it 'describes :offset' do
+      expect(params['offset'][:desc]).to eq('Pad a number of results.')
+    end
 
-    before do
-      subject.paginate per_page: 99, max_per_page: 999, offset: 9
-      subject.get('/') {}
+    it 'validates :page as Integer' do
+      expect(params['page'][:type]).to eq('Integer')
     end
 
-    it 'defaults :per_page to customized value' do
-      expect(params['per_page'][:default]).to eq(99)
+    it 'validates :per_page as Integer' do
+      expect(params['per_page'][:type]).to eq('Integer')
     end
 
-    it 'succeeds when :per_page is within :max_value' do
-      get('/', page: 1, per_page: 999)
-      expect(last_response.status).to eq(200)
+    it 'validates :offset as Integer' do
+      expect(params['offset'][:type]).to eq('Integer')
     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/)
+    it 'defaults :page to 1' do
+      expect(params['page'][:default]).to eq(1)
     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/)
+    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 customized value' do
-      expect(params['offset'][:default]).to eq(9)
+    it 'defaults :offset to 0' do
+      expect(params['offset'][:default]).to eq(0)
     end
   end
+end
 
-  describe 'paginated api without :offset' do
-    subject { Class.new(PaginatedAPI) }
+describe 'custom paginated api' do
+  subject { Class.new(PaginatedAPI) }
+  let(:app) { subject }
+  let(:params) { subject.routes.first.params }
 
-    it 'excludes :offset from declared params' do
-      subject.paginate offset: false
-      expect(subject.inheritable_setting.route[:declared_params]).not_to include(:offset)
+  before do
+    subject.params do
+      use :pagination, per_page: 99, max_per_page: 999, offset: 9
     end
+    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

data/spec/paginate_helper_spec.rb

@@ -4,18 +4,24 @@ require 'json'
 class PaginatedAPI < Grape::API
   include Grape::Kaminari
 
-  paginate
+  params do
+    use :pagination
+  end
   get '' do
     paginate(Kaminari.paginate_array((1..10).to_a))
   end
 
-  paginate offset: false
+  params do
+    use :pagination, offset: false
+  end
   get 'no-offset' do
     paginate(Kaminari.paginate_array((1..10).to_a))
   end
 
   resource :sub do
-    paginate per_page: 2
+    params do
+      use :pagination, per_page: 2
+    end
     get '/' do
       paginate(Kaminari.paginate_array((1..10).to_a))
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-kaminari
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tymon Tobolski
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -125,6 +125,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt