grape-pagy 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae85f7bb6472d19bcbedad2d0e03e0960a75615960819251b1a35ed793a0cb65
-  data.tar.gz: 3fa36e9bcd909ae16e54c44c0c9b65499fa8f4ad7dbf94c75b8d7192897932b5
+  metadata.gz: 5956682171c97b589bba13991d1f810f73bcdbc95ef24ca169d16a4f19085713
+  data.tar.gz: 590ec8ca32ad36c166875b095e874036b46f45f0c32a53999ee8f7f083cfb0b7
 SHA512:
-  metadata.gz: 74772e142b4277e609bdca9ce59e5a3de4ed35e940fbbf3a8a0dd79122bdacf9327acf832177b9ce92cb074a81be34c1fae30ea9a2871e36800ba6d19fd68905
-  data.tar.gz: 65407c449ede7a7cfa7a3e1d7428530bc761b5c776a30a0db90baeacd234596e7b5fc933e34d50aa8cbf2011359a65a68bd9e9f29819c637edb1986f2a66a36e
+  metadata.gz: 77257d503b9a5ab54e33d722f971ff2b095e0317010820f6388f1a1a19eaff47fc5fb1baae3a83b856eb26e2561f140df3d084b1055dfd297ffd5aadbb92a30a
+  data.tar.gz: a8491d340672664083ebebfb4b66df017a8272eade89966a8a38bf92be001ee526ce8d1b9efe105a09caf0e580a533687b2dd913d0a2077bc3071e3e45a1c302

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.3.0
+
+* Allow countless usage [#2](https://github.com/bsm/grape-pagy/pull/2).
+
 ### 0.2.0
 
 * Improved, simplified and stabilised API [#1](https://github.com/bsm/grape-pagy/pull/1).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape-pagy (0.2.0)
+    grape-pagy (0.3.0)
       grape (>= 1.5)
       pagy
 
@@ -94,10 +94,10 @@ GEM
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.8)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby

data/grape-pagy.gemspec

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

data/lib/grape/pagy.rb

@@ -2,6 +2,7 @@ require 'grape'
 require 'pagy'
 require 'pagy/extras/arel'
 require 'pagy/extras/array'
+require 'pagy/extras/countless'
 require 'pagy/extras/headers'
 require 'pagy/extras/items'
 require 'pagy/extras/overflow'
@@ -11,15 +12,15 @@ module Grape
     Wrapper = Struct.new :request, :params do
       include ::Pagy::Backend
 
-      def paginate(collection, via: nil, **opts, &block)
+      def paginate(collection, using: nil, **opts, &block)
         pagy_with_items(opts)
-        via ||= if collection.respond_to?(:arel_table)
-                  :arel
-                elsif collection.is_a?(Array)
-                  :array
-                end
+        using ||= if collection.respond_to?(:arel_table)
+                    :arel
+                  elsif collection.is_a?(Array)
+                    :array
+                  end
 
-        method = [:pagy, via].compact.join('_')
+        method = [:pagy, using].compact.join('_')
         page, scope = send(method, collection, **opts)
 
         pagy_headers(page).each(&block)

data/spec/grape/pagy_spec.rb

@@ -50,6 +50,25 @@ describe Grape::Pagy do
     expect(last_response.body).to eq(%([]))
   end
 
+  it 'should allow 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 'should inherit helper' do
     get '/sub'
     expect(last_response.status).to eq(200)

data/spec/spec_helper.rb

@@ -7,6 +7,16 @@ 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
 
@@ -17,6 +27,13 @@ class TestAPI < Grape::API
     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

metadata

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