grape-pagy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52b012ea708cc341716fae9dc594335ef2b2de57498dca9643e89cb38caf97e2
-  data.tar.gz: 264bcfea9ce1e8e7310c12e2e68e9e70a5482d6a7d2fd6f506c5d8ed9bac6715
+  metadata.gz: ae85f7bb6472d19bcbedad2d0e03e0960a75615960819251b1a35ed793a0cb65
+  data.tar.gz: 3fa36e9bcd909ae16e54c44c0c9b65499fa8f4ad7dbf94c75b8d7192897932b5
 SHA512:
-  metadata.gz: ac1d11277bb770f7a56f9b88d966ba2e948d593fec46f28140a1b7961c2a14df95b2c7e48f48a59a4dafa8008c4498e89ea7d1050956398a54a9a1816bdfd9fc
-  data.tar.gz: 8e23241b263e2fa2164674847b915517d93831ede7da6a49add2b4f5252ddb2a3621d215922799649335d79459a2727c8372fdfd563e8a0b64f4300fd29f6a26
+  metadata.gz: 74772e142b4277e609bdca9ce59e5a3de4ed35e940fbbf3a8a0dd79122bdacf9327acf832177b9ce92cb074a81be34c1fae30ea9a2871e36800ba6d19fd68905
+  data.tar.gz: 65407c449ede7a7cfa7a3e1d7428530bc761b5c776a30a0db90baeacd234596e7b5fc933e34d50aa8cbf2011359a65a68bd9e9f29819c637edb1986f2a66a36e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.2.0
+
+* Improved, simplified and stabilised API [#1](https://github.com/bsm/grape-pagy/pull/1).
+
 ### 0.1.0
 
-* Initial release
+* Initial release.

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    grape-pagy (0.1.0)
+    grape-pagy (0.2.0)
       grape (>= 1.5)
       pagy
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.3)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)

data/README.md

@@ -36,27 +36,26 @@ class MyApi < Grape::API
     desc 'Return a list of posts.'
     params do
       # This will add two optional params: :page and :items.
-      # The parameter names can be globally configured by adjusting
-      # global Pagy::VARS[:page_param] and Pagy::VARS[:item_param]
-      # settings.
-      use :pagination
+      use :pagy
     end
     get do
       posts = Post.all.order(created_at: :desc)
-      paginate(posts)
+      pagy(posts)
     end
   end
 
   resource :strings do
+    desc 'Supports arrays as well as relations.'
     params do
-      # Override the number items returned, defaults to Pagy::VARS[:items].
-      use :pagination, items: 2
+      # Override defaults by setting Pagy::VARS 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.
+          max_items: 10           # Restrict per_page to maximum 10.
     end
     get do
-      words = %w[an array of words]
-      # This supports array as well as relations.
-      # Allows to override global Pagy::VARS settings.
-      paginate(words, max_items: )
+      words = %w[this is a plain array of words]
+      pagy(words)
     end
   end
 end

data/grape-pagy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'grape-pagy'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Black Square Media']
   spec.email         = ['info@blacksquaremedia.com']
   spec.description   = 'Pagy paginator for grape API'

data/lib/grape/pagy.rb

@@ -8,7 +8,7 @@ require 'pagy/extras/overflow'
 
 module Grape
   module Pagy
-    Pager = Struct.new :request, :params do
+    Wrapper = Struct.new :request, :params do
       include ::Pagy::Backend
 
       def paginate(collection, via: nil, **opts, &block)
@@ -30,13 +30,21 @@ module Grape
     module Helpers
       extend Grape::API::Helpers
 
-      params :pagination do |items: ::Pagy::VARS[:items]|
-        optional ::Pagy::VARS[:page_param], type: Integer, default: 1, desc: 'Page offset to fetch.'
-        optional ::Pagy::VARS[:items_param], type: Integer, default: items, desc: 'Number of items to return per page.'
+      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]
+
+        @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.'
       end
 
-      def paginate(collection, via: nil, **opts)
-        Pager.new(request, params).paginate(collection, via: via, **opts) do |key, value|
+      # @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
       end

data/spec/grape/pagy_spec.rb

@@ -56,17 +56,17 @@ describe Grape::Pagy do
     expect(last_response.headers).to include(
       'Current-Page' => '1',
       'Page-Items'   => '10',
-      'Total-Count'  => '12',
+      'Total-Count'  => '13',
       'Total-Pages'  => '2',
     )
     expect(last_response.body).to eq(%([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]))
 
-    get '/sub?items=20'
+    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'  => '12',
+      'Total-Count'  => '13',
       'Total-Pages'  => '1',
     )
   end

data/spec/spec_helper.rb

@@ -11,18 +11,18 @@ class TestAPI < Grape::API
   helpers Grape::Pagy::Helpers
 
   params do
-    use :pagination, items: 5
+    use :pagy, items: 5, max_items: 6
   end
   get '' do
-    paginate (1..12).to_a, max_items: 6
+    pagy (1..12).to_a
   end
 
   resource :sub do
     params do
-      use :pagination
+      use :pagy, items_param: :per_page
     end
     get '/' do
-      paginate (1..12).to_a
+      pagy (1..12).to_a, count: 13
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-pagy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape