api-pagination 4.7.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcd1a8e55bce363ef14c8fca2ff4a06ea1cf325e61fe2eba564d6bcbcb0cbb43
-  data.tar.gz: 66a8a77cc4e1fa163ce3e644c2828388778efaab24783967c2c9e7986a83ac30
+  metadata.gz: ba0df72041cd862671500fd9efe94c7fe8e35975877e0e9bbcd1c0b77860e4a4
+  data.tar.gz: debcf49e29dcda50d93cd31a2e9efec2332541dbe38f6bdaa488b450e5bb7d09
 SHA512:
-  metadata.gz: 475209b5986a009d9bc52cded5269fec22998e6d94c419635772950ee17ea7a1b0a01818b6791f009fe9da545022522f2ba0303a5fae93d81a364f3bc740cb1e
-  data.tar.gz: 355d8e7786bf49318941d48ea57ff6fd81fd6cf9b97d9e185fb1302eb20dc4144100f3fce675809d73bffc0341b0f100e37fb3f12a2e6c51ea9b98e4d9db5a03
+  metadata.gz: 4661d9bfa18456e1c6fcfb837ef4c3acbc9e35dd983299201340dc077056e3f5632c39a8f718b285d66b4e3985aec23da68a56c8c278f0fc850f27626352bb0b
+  data.tar.gz: 688fae38d680fb9f1b133a627172d687c7fa6f56186039a88a5bfe238e396c5310359266580644d7719b981d6f3589ac884f6b6d88688c497c8516cbffd122cd

data/lib/api-pagination/configuration.rb

@@ -10,6 +10,8 @@ module ApiPagination
 
     attr_accessor :base_url
 
+    attr_accessor :response_formats
+
     def configure(&block)
       yield self
     end
@@ -20,6 +22,7 @@ module ApiPagination
       @page_header     = nil
       @include_total   = true
       @base_url   = nil
+      @response_formats = [:json, :xml]
     end
 
     ['page', 'per_page'].each do |param_name|
@@ -50,11 +53,17 @@ module ApiPagination
     end
 
     def paginator
-      @paginator || set_paginator
+      if instance_variable_defined? :@paginator
+        @paginator
+      else
+        set_paginator
+      end
     end
 
     def paginator=(paginator)
       case paginator.to_sym
+      when :pagy
+        use_pagy
       when :kaminari
         use_kaminari
       when :will_paginate
@@ -67,11 +76,12 @@ module ApiPagination
     private
 
     def set_paginator
-      if defined?(Kaminari) && defined?(WillPaginate::CollectionMethods)
+      conditions = [defined?(Pagy), defined?(Kaminari), defined?(WillPaginate::CollectionMethods)]
+      if conditions.compact.size > 1
         Kernel.warn <<-WARNING
-Warning: api-pagination relies on either Kaminari or WillPaginate, but both are
-currently active. If possible, you should remove one or the other. If you can't,
-you _must_ configure api-pagination on your own. For example:
+Warning: api-pagination relies on Pagy, Kaminari, or WillPaginate, but more than
+one are currently active. If possible, you should remove one or the other. If
+you can't, you _must_ configure api-pagination on your own. For example:
 
 ApiPagination.configure do |config|
   config.paginator = :kaminari
@@ -86,13 +96,19 @@ Kaminari.configure do |config|
 end
 
 WARNING
+      elsif defined?(Pagy)
+        use_pagy
       elsif defined?(Kaminari)
-        return use_kaminari
+        use_kaminari
       elsif defined?(WillPaginate::CollectionMethods)
-        return use_will_paginate
+        use_will_paginate
       end
     end
 
+    def use_pagy
+      @paginator = :pagy
+    end
+
     def use_kaminari
       require 'kaminari/models/array_extension'
       @paginator = :kaminari

data/lib/api-pagination/hooks.rb

@@ -1,17 +1,26 @@
 begin; require 'grape'; rescue LoadError; end
 if defined?(Grape::API)
   require 'grape/pagination'
-  Grape::API.send(:include, Grape::Pagination)
+
+  klass = if Grape::VERSION >= '1.2.0' || defined?(Grape::API::Instance)
+    Grape::API::Instance
+  else
+    Grape::API
+  end
+
+  klass.send(:include, Grape::Pagination)
 end
 
+begin; require 'pagy';          rescue LoadError; end
 begin; require 'kaminari';      rescue LoadError; end
 begin; require 'will_paginate'; rescue LoadError; end
 
-unless defined?(Kaminari) || defined?(WillPaginate::CollectionMethods)
+unless defined?(Pagy) || defined?(Kaminari) || defined?(WillPaginate::CollectionMethods)
   Kernel.warn <<-WARNING.gsub(/^\s{4}/, '')
-    Warning: api-pagination relies on either Kaminari or WillPaginate. Please
-    install either dependency by adding one of the following to your Gemfile:
+    Warning: api-pagination relies on either Pagy, Kaminari, or WillPaginate.
+    Please install a paginator by adding one of the following to your Gemfile:
 
+    gem 'pagy'
     gem 'kaminari'
     gem 'will_paginate'
   WARNING

data/lib/api-pagination/version.rb

@@ -1,8 +1,8 @@
 module ApiPagination
   class Version
-    MAJOR = 4
-    MINOR = 7
-    PATCH = 2
+    MAJOR = 5
+    MINOR = 0
+    PATCH = 0
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/lib/api-pagination.rb

@@ -9,6 +9,8 @@ module ApiPagination
       options[:per_page] = options[:per_page].to_i
 
       case ApiPagination.config.paginator
+      when :pagy
+        paginate_with_pagy(collection, options)
       when :kaminari
         paginate_with_kaminari(collection, options, options[:paginate_array_options] || {})
       when :will_paginate
@@ -18,7 +20,9 @@ module ApiPagination
       end
     end
 
-    def pages_from(collection)
+    def pages_from(collection, options = {})
+      return pagy_pages_from(collection) if ApiPagination.config.paginator == :pagy && collection.is_a?(Pagy)
+
       {}.tap do |pages|
         unless collection.first_page?
           pages[:first] = 1
@@ -26,7 +30,7 @@ module ApiPagination
         end
 
         unless collection.last_page? || (ApiPagination.config.paginator == :kaminari && collection.out_of_range?)
-          pages[:last] = collection.total_pages
+          pages[:last] = collection.total_pages if ApiPagination.config.include_total
           pages[:next] = collection.current_page + 1
         end
       end
@@ -34,6 +38,7 @@ module ApiPagination
 
     def total_from(collection)
       case ApiPagination.config.paginator
+        when :pagy          then collection.count.to_s
         when :kaminari      then collection.total_count.to_s
         when :will_paginate then collection.total_entries.to_s
       end
@@ -41,6 +46,47 @@ module ApiPagination
 
     private
 
+    def paginate_with_pagy(collection, options)
+      if Pagy::DEFAULT[:max_per_page] && options[:per_page] > Pagy::DEFAULT[:max_per_page]
+        options[:per_page] = Pagy::DEFAULT[:max_per_page]
+      elsif options[:per_page] <= 0
+        options[:per_page] = Pagy::DEFAULT[:items]
+      end
+
+      pagy = pagy_from(collection, options)
+      collection = if collection.respond_to?(:offset) && collection.respond_to?(:limit)
+        collection.offset(pagy.offset).limit(pagy.items)
+      else
+        collection[pagy.offset, pagy.items]
+      end
+
+      return [collection, pagy]
+    end
+
+    def pagy_from(collection, options)
+      if options[:count]
+        count = options[:count]
+      else
+        count = collection.is_a?(Array) ? collection.count : collection.count(:all)
+      end
+
+      Pagy.new(count: count, items: options[:per_page], page: options[:page])
+    end
+
+    def pagy_pages_from(pagy)
+      {}.tap do |pages|
+        unless pagy.page == 1
+          pages[:first] = 1
+          pages[:prev]  = pagy.prev
+        end
+
+        unless pagy.page == pagy.pages
+          pages[:last] = pagy.pages if ApiPagination.config.include_total
+          pages[:next] = pagy.next
+        end
+      end
+    end
+
     def paginate_with_kaminari(collection, options, paginate_array_options = {})
       if Kaminari.config.max_per_page && options[:per_page] > Kaminari.config.max_per_page
         options[:per_page] = Kaminari.config.max_per_page
@@ -48,8 +94,10 @@ module ApiPagination
         options[:per_page] = get_default_per_page_for_kaminari(collection)
       end
 
-      collection = Kaminari.paginate_array(collection, paginate_array_options) if collection.is_a?(Array)
-      collection.page(options[:page]).per(options[:per_page])
+      collection = Kaminari.paginate_array(collection, **paginate_array_options) if collection.is_a?(Array)
+      collection = collection.page(options[:page]).per(options[:per_page])
+      collection.without_count if !collection.is_a?(Array) && !ApiPagination.config.include_total
+      [collection, nil]
     end
 
     def paginate_with_will_paginate(collection, options)
@@ -57,35 +105,36 @@ module ApiPagination
         options[:per_page] = default_per_page_for_will_paginate(collection)
       end
 
-      if defined?(Sequel::Dataset) && collection.kind_of?(Sequel::Dataset)
+      collection = if defined?(Sequel::Dataset) && collection.kind_of?(Sequel::Dataset)
         collection.paginate(options[:page], options[:per_page])
       else
         supported_options = [:page, :per_page, :total_entries]
         options = options.dup.keep_if { |k,v| supported_options.include?(k.to_sym) }
         collection.paginate(options)
       end
+
+      [collection, nil]
     end
 
     def get_default_per_page_for_kaminari(collection)
       default = Kaminari.config.default_per_page
-      detect_model(collection).default_per_page || default
-    rescue
-      default
+      extract_per_page_from_model(collection, :default_per_page) || default
     end
 
     def default_per_page_for_will_paginate(collection)
       default = WillPaginate.per_page
-      detect_model(collection).per_page || default
-    rescue
-      default
+      extract_per_page_from_model(collection, :per_page) || default
     end
 
-    def detect_model(collection)
-      if collection.respond_to?(:table_name)
-        collection.table_name.classify.constantize
+    def extract_per_page_from_model(collection, accessor)
+      klass = if collection.respond_to?(:klass)
+        collection.klass
       else
         collection.first.class
       end
+
+      return unless klass.respond_to?(accessor)
+      klass.send(accessor)
     end
   end
 end

data/lib/grape/pagination.rb

@@ -9,11 +9,11 @@ module Grape
             :page     => ApiPagination.config.page_param(params),
             :per_page => [per_page, route_setting(:max_per_page)].compact.min
           }
-          collection = ApiPagination.paginate(collection, options)
+          collection, pagy = ApiPagination.paginate(collection, options)
 
           links = (header['Link'] || "").split(',').map(&:strip)
           url   = request.url.sub(/\?.*$/, '')
-          pages = ApiPagination.pages_from(collection)
+          pages = ApiPagination.pages_from(pagy || collection, options)
 
           pages.each do |k, v|
             old_params = Rack::Utils.parse_nested_query(request.query_string)
@@ -27,7 +27,7 @@ module Grape
           include_total   = ApiPagination.config.include_total
 
           header 'Link',          links.join(', ') unless links.empty?
-          header total_header,    ApiPagination.total_from(collection).to_s if include_total
+          header total_header,    ApiPagination.total_from(pagy || collection).to_s if include_total
           header per_page_header, options[:per_page].to_s
           header page_header,     options[:page].to_s unless page_header.nil?
 
@@ -46,7 +46,7 @@ module Grape
           params do
             optional :page,     :type   => Integer, :default => 1,
                                 :desc   => 'Page of results to fetch.'
-            optional :per_page, :type   => Integer,
+            optional :per_page, :type   => Integer, :default => options[:per_page],
                                 :desc   => 'Number of results to return per page.',
                                 :values => per_page_values
           end

data/lib/rails/pagination.rb

@@ -8,11 +8,12 @@ module Rails
 
       return _paginate_collection(collection, options) if collection
 
-      collection = options[:json] || options[:xml]
+      response_format = _discover_format(options)
+
+      collection = options[response_format]
       collection = _paginate_collection(collection, options)
 
-      options[:json] = collection if options[:json]
-      options[:xml]  = collection if options[:xml]
+      options[response_format] = collection if options[response_format]
 
       render options
     end
@@ -23,15 +24,21 @@ module Rails
 
     private
 
+    def _discover_format(options)
+      for response_format in ApiPagination.config.response_formats
+        return response_format if options.key?(response_format)
+      end
+    end
+
     def _paginate_collection(collection, options={})
       options[:page] = ApiPagination.config.page_param(params)
       options[:per_page] ||= ApiPagination.config.per_page_param(params)
 
-      collection = ApiPagination.paginate(collection, options)
+      collection, pagy = ApiPagination.paginate(collection, options)
 
       links = (headers['Link'] || '').split(',').map(&:strip)
       url   = base_url + request.path_info
-      pages = ApiPagination.pages_from(collection)
+      pages = ApiPagination.pages_from(pagy || collection, options)
 
       pages.each do |k, v|
         new_params = request.query_parameters.merge(:page => v)
@@ -46,7 +53,7 @@ module Rails
       headers['Link'] = links.join(', ') unless links.empty?
       headers[per_page_header] = options[:per_page].to_s
       headers[page_header] = options[:page].to_s unless page_header.nil?
-      headers[total_header] = total_count(collection, options).to_s if include_total
+      headers[total_header] = total_count(pagy || collection, options).to_s if include_total
 
       return collection
     end
@@ -62,6 +69,5 @@ module Rails
     def base_url
       ApiPagination.config.base_url || request.base_url
     end
-
   end
 end

data/spec/active_record_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'support/active_record/foo'
+require 'nulldb_rspec'
+
+ActiveRecord::Base.establish_connection(
+  adapter: :nulldb,
+  schema: 'spec/support/active_record/schema.rb'
+)
+
+NullDB.configure { |ndb| def ndb.project_root; Dir.pwd; end; }
+
+shared_examples 'produces_correct_sql' do 
+  it 'produces correct sql for first page' do
+    allow(collection).to receive(:count).and_return(collection_size)
+    paginated_sql, _ = ApiPagination.paginate(collection, per_page: per_page)
+    expect(paginated_sql.to_sql).to eql(Foo.limit(per_page).offset(0).to_sql)
+  end
+end
+
+describe 'ActiveRecord Support' do 
+  let(:collection) { Foo.all }
+  let(:collection_size) { 50 }
+  let(:per_page) { 5 }
+  
+  if ApiPagination.config.paginator == :will_paginate
+    require 'will_paginate/active_record'
+  end
+
+  context "pagination with #{ApiPagination.config.paginator}" do 
+    include_examples 'produces_correct_sql'
+  end
+
+
+  if ApiPagination.config.paginator != :pagy
+    context 'reflections' do
+      it 'invokes the correct methods to determine type' do 
+        expect(collection).to receive(:klass).at_least(:once)
+                                             .and_call_original
+        ApiPagination.paginate(collection)
+      end
+
+      it 'does not fail if table name is not snake cased class name' do
+        allow(collection).to receive(:table_name).and_return(SecureRandom.uuid)
+        expect { ApiPagination.paginate(collection) }.to_not raise_error
+      end
+    end
+  end
+end
+
+

data/spec/api-pagination_spec.rb

@@ -2,63 +2,73 @@ require 'spec_helper'
 
 describe ApiPagination do
   let(:collection) {(1..100).to_a}
+  let(:active_record_relation) {double("ActiveRecord_Relation").as_null_object}
   let(:paginate_array_options) {{ total_count: 1000 }}
 
   describe "#paginate" do
-    context 'Using kaminari' do
-      before do
-        ApiPagination.config.paginator = :kaminari
-      end
+    if ENV['PAGINATOR'].to_sym == :kaminari
+      context 'Using kaminari' do
+        describe '.paginate' do
+          it 'should accept paginate_array_options option' do
+            expect(Kaminari).to receive(:paginate_array)
+              .with(collection, **paginate_array_options)
+              .and_call_original
 
-      after do
-        ApiPagination.config.paginator = ENV['PAGINATOR'].to_sym
-      end
+            ApiPagination.paginate(
+              collection,
+              {
+                per_page: 30,
+                paginate_array_options: paginate_array_options
+              }
+            )
+          end
 
-      it 'should accept paginate_array_options option' do
-        expect(Kaminari).to receive(:paginate_array)
-                              .with(collection, paginate_array_options)
-                              .and_call_original
+          context 'configured not to include the total' do
+            before { ApiPagination.config.include_total = false }
 
-        ApiPagination.paginate(
-          collection,
-          {
-            per_page:               30,
-            paginate_array_options: paginate_array_options
-          }
-        )
-      end
+            context 'and paginating an array' do
+              it 'should not call without_count on the collection' do
+                expect(collection).to_not receive :without_count
+                ApiPagination.paginate(collection)
+              end
+            end
+            context 'and paginating an active record relation' do
+              it 'should call without_count on the relation' do
+                expect(active_record_relation).to receive :without_count
+                ApiPagination.paginate(active_record_relation)
+              end
+            end
+
+            after { ApiPagination.config.include_total = true }
+          end
+        end
 
-      describe '.pages_from' do
-        subject {described_class.pages_from collection}
+        describe '.pages_from' do
+          subject { described_class.pages_from(collection) }
 
-        context 'on empty collection' do
-          let(:collection) {ApiPagination.paginate [], page: 1}
+          context 'on empty collection' do
+            let(:collection) { ApiPagination.paginate([], page: 1).first }
 
-          it {is_expected.to be_empty}
+            it { is_expected.to be_empty }
+          end
         end
       end
     end
 
-    context 'Using will_paginate' do
-      before do
-        ApiPagination.config.paginator = :will_paginate
-      end
-
-      after do
-        ApiPagination.config.paginator = ENV['PAGINATOR'].to_sym
-      end
-
-      context 'passing in total_entries in options' do
-        it 'should set total_entries using the passed in value' do
-          paginated_collection = ApiPagination.paginate(collection, total_entries: 3000)
-          expect(paginated_collection.total_entries).to eq(3000)
+    if ENV['PAGINATOR'].to_sym == :will_paginate
+      context 'Using will_paginate' do
+        context 'passing in total_entries in options' do
+          it 'should set total_entries using the passed in value' do
+            paginated_collection = ApiPagination.paginate(collection, total_entries: 3000).first
+            expect(paginated_collection.total_entries).to eq(3000)
+          end
         end
-      end
 
-      context 'passing in collection only' do
-        it 'should set total_entries using the size of the collection ' do
-          paginated_collection = ApiPagination.paginate(collection)
-          expect(paginated_collection.total_entries).to eq(100)
+        context 'passing in collection only' do
+          it 'should set total_entries using the size of the collection ' do
+            paginated_collection = ApiPagination.paginate(collection).first
+            expect(paginated_collection.total_entries).to eq(100)
+          end
         end
       end
     end

data/spec/grape_spec.rb

@@ -5,8 +5,11 @@ require 'support/shared_examples/middle_page'
 require 'support/shared_examples/last_page'
 
 describe NumbersAPI do
+  it { is_expected.to be_kind_of(Grape::Pagination) }
+
   describe 'GET #index' do
-    let(:links) { last_response.headers['Link'].split(', ') }
+    let(:link) { last_response.headers['Link'] }
+    let(:links) { link.split(', ') }
     let(:total) { last_response.headers['Total'].to_i }
     let(:per_page) { last_response.headers['Per-Page'].to_i }
 
@@ -139,6 +142,12 @@ describe NumbersAPI do
         expect(last_response.header['Total']).to be_nil
       end
 
+      it 'should not include a link with rel "last"' do
+        get '/numbers', count: 100
+
+        expect(link).to_not include('rel="last"')
+      end
+
       after { ApiPagination.config.include_total = true }
     end
 

data/spec/rails_spec.rb

@@ -8,7 +8,8 @@ describe NumbersController, :type => :controller do
   before { request.host = 'example.org' }
 
   describe 'GET #index' do
-    let(:links) { response.headers['Link'].split(', ') }
+    let(:link) { response.headers['Link'] }
+    let(:links) { link.split(', ') }
     let(:total) { response.headers['Total'].to_i }
     let(:per_page) { response.headers['Per-Page'].to_i }
 
@@ -134,6 +135,12 @@ describe NumbersController, :type => :controller do
         expect(response.header['Total']).to be_nil
       end
 
+      it 'should not include a link with rel "last"' do
+        get :index, params: { count: 100 }
+
+        expect(link).to_not include('rel="last"')
+      end
+
       after { ApiPagination.config.include_total = true }
     end
 
@@ -214,8 +221,11 @@ describe NumbersController, :type => :controller do
       end
     end
 
-    context 'paginate array options' do
-      shared_examples 'properly set Total header' do
+    if ApiPagination.config.paginator.to_sym == :kaminari
+      context 'paginate array options' do
+        let(:paginate_array_total_count) { 300 }
+        let(:total_header) { 300 }
+        let(:count) { 50 }
         let(:params) do
           {
             paginate_array_total_count: paginate_array_total_count,
@@ -223,80 +233,75 @@ describe NumbersController, :type => :controller do
           }
         end
 
-        specify do
+        it 'has a properly set Total header' do
           get :index_with_paginate_array_options, params: params
 
           expect(response.header['Total']).to be_kind_of(String)
           expect(response.header['Total'].to_i).to eq total_header
         end
       end
+    end
 
-      context 'kaminari' do
-        around do |example|
-          paginator = ApiPagination.config.paginator
-          ApiPagination.config.paginator = :kaminari
-          example.run
-          ApiPagination.config.paginator = paginator
-        end
+    if [:will_paginate, :kaminari].include?(ApiPagination.config.paginator.to_sym)
+      context 'default per page in model' do
+        before do
+          class Fixnum
+            @default_per_page = 6
+            @per_page = 6
 
-        it_should_behave_like 'properly set Total header' do
-          let(:paginate_array_total_count) { 300 }
-          let(:total_header) { 300 }
-          let(:count) { 50 }
+            class << self
+              attr_accessor :default_per_page, :per_page
+            end
+          end
         end
-      end
 
-      context 'will_paginate' do
-        around do |example|
-          paginator = ApiPagination.config.paginator
-          ApiPagination.config.paginator = :will_paginate
-          example.run
-          ApiPagination.config.paginator = paginator
+        after do
+          class Fixnum
+            @default_per_page = 25
+            @per_page = 25
+          end
         end
 
-        it_should_behave_like 'properly set Total header' do
-          let(:paginate_array_total_count) { 300 }
-          let(:total_header) { 50 }
-          let(:count) { 50 }
+        after :all do
+          class Fixnum
+            class << self
+              undef_method :default_per_page, :per_page
+            end
+          end
         end
-      end
-    end
 
-    context 'default per page in model' do
-      before do
-        class Fixnum
-          @default_per_page = 6
-          @per_page = 6
+        it 'should use default per page from model' do
+          get :index_with_no_per_page, params: {count: 100}
 
-          class << self
-            attr_accessor :default_per_page, :per_page
-          end
+          expect(response.header['Per-Page']).to eq('6')
         end
-      end
 
-      after do
-        class Fixnum
-          @default_per_page = 25
-          @per_page = 25
-        end
-      end
+        it 'should not fail if the model yields nil for per page' do
+          class Fixnum
+            @default_per_page = nil
+            @per_page = nil
+          end
 
-      it 'should use default per page from model' do
-        get :index_with_no_per_page, params: {count: 100}
+          get :index_with_no_per_page, params: {count: 100}
 
-        expect(response.header['Per-Page']).to eq('6')
+          expect(response.header['Per-Page']).to eq(
+            case ApiPagination.config.paginator
+            when :pagy          then Pagy::DEFAULT[:items].to_s
+            when :kaminari      then Kaminari.config.default_per_page.to_s
+            when :will_paginate then WillPaginate.per_page.to_s
+            end
+          )
+        end
       end
+    end
 
+    context 'default per page in objects without paginator defaults' do
       it 'should not fail if model does not respond to per page' do
-        class Fixnum
-          @default_per_page = nil
-          @per_page = nil
-        end
-
         get :index_with_no_per_page, params: {count: 100}
 
         expect(response.header['Per-Page']).to eq(
           case ApiPagination.config.paginator
+          when :pagy          then Pagy::DEFAULT[:items].to_s
           when :kaminari      then Kaminari.config.default_per_page.to_s
           when :will_paginate then WillPaginate.per_page.to_s
           end

data/spec/sequel_spec.rb

@@ -23,9 +23,8 @@ if ApiPagination.config.paginator == :will_paginate
     end
 
     it 'returns a Sequel::Dataset' do
-      collection = ApiPagination.paginate(people)
+      collection = ApiPagination.paginate(people).first
       expect(collection.kind_of?(Sequel::Dataset)).to be_truthy
     end
   end
 end
-

data/spec/spec_helper.rb

@@ -3,14 +3,20 @@ require 'support/numbers_api'
 require 'api-pagination'
 
 if ENV['PAGINATOR'].nil?
-  warn 'No PAGINATOR set. Defaulting to kaminari. To test against will_paginate, run `PAGINATOR=will_paginate bundle exec rspec`'
-  ENV['PAGINATOR'] = 'kaminari'
+  warn <<-WARNING
+No PAGINATOR set. Defaulting to pagy.
+
+To test against kaminari, run `PAGINATOR=kaminari bundle exec rspec`
+To test against will_paginate, run `PAGINATOR=will_paginate bundle exec rspec`
+WARNING
+
+  ENV['PAGINATOR'] = 'pagy'
 end
 
 require ENV['PAGINATOR']
 ApiPagination.config.paginator = ENV['PAGINATOR'].to_sym
 
-require 'will_paginate/array'
+require 'will_paginate/array' if ENV['PAGINATOR'].to_sym == :will_paginate
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods

data/spec/support/active_record/foo.rb

@@ -0,0 +1,3 @@
+require 'active_record'
+
+class Foo < ActiveRecord::Base; end

data/spec/support/active_record/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(version: 0) do
+  create_table "foos", :force => true do |t|
+    t.string   "foo"
+  end
+end

data/spec/support/shared_examples/first_page.rb

@@ -1,10 +1,10 @@
 shared_examples 'an endpoint with a first page' do
   it 'should not give a link with rel "first"' do
-    expect(links).not_to include('rel="first"')
+    expect(link).not_to include('rel="first"')
   end
 
   it 'should not give a link with rel "prev"' do
-    expect(links).not_to include('rel="prev"')
+    expect(link).not_to include('rel="prev"')
   end
 
   it 'should give a link with rel "last"' do

data/spec/support/shared_examples/last_page.rb

@@ -1,10 +1,10 @@
 shared_examples 'an endpoint with a last page' do
   it 'should not give a link with rel "last"' do
-    expect(links).not_to include('rel="last"')
+    expect(link).not_to include('rel="last"')
   end
 
   it 'should not give a link with rel "next"' do
-    expect(links).not_to include('rel="next"')
+    expect(link).not_to include('rel="next"')
   end
 
   it 'should give a link with rel "first"' do

metadata

@@ -1,85 +1,171 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 4.7.2
+  version: 5.0.0
 platform: ruby
 authors:
 - David Celis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-08 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
-  name: grape
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+- !ruby/object:Gem::Dependency
+  name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 3.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.1.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.1.4.1
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.1.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.1.4.1
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: '5.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.49'
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: Link header pagination for Rails and Grape APIs
 email:
 - me@davidcel.is
@@ -94,11 +180,14 @@ files:
 - lib/api-pagination/version.rb
 - lib/grape/pagination.rb
 - lib/rails/pagination.rb
+- spec/active_record_spec.rb
 - spec/api-pagination_spec.rb
 - spec/grape_spec.rb
 - spec/rails_spec.rb
 - spec/sequel_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_record/foo.rb
+- spec/support/active_record/schema.rb
 - spec/support/numbers_api.rb
 - spec/support/numbers_controller.rb
 - spec/support/shared_examples/existing_headers.rb
@@ -109,35 +198,37 @@ homepage: https://github.com/davidcelis/api-pagination
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Link header pagination for Rails and Grape APIs. Don't use the request body.
 test_files:
-- spec/spec_helper.rb
+- spec/active_record_spec.rb
 - spec/api-pagination_spec.rb
+- spec/grape_spec.rb
+- spec/rails_spec.rb
 - spec/sequel_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record/foo.rb
+- spec/support/active_record/schema.rb
 - spec/support/numbers_api.rb
 - spec/support/numbers_controller.rb
+- spec/support/shared_examples/existing_headers.rb
 - spec/support/shared_examples/first_page.rb
-- spec/support/shared_examples/middle_page.rb
 - spec/support/shared_examples/last_page.rb
-- spec/support/shared_examples/existing_headers.rb
-- spec/grape_spec.rb
-- spec/rails_spec.rb
+- spec/support/shared_examples/middle_page.rb