api-pagination 5.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0df72041cd862671500fd9efe94c7fe8e35975877e0e9bbcd1c0b77860e4a4
-  data.tar.gz: debcf49e29dcda50d93cd31a2e9efec2332541dbe38f6bdaa488b450e5bb7d09
+  metadata.gz: 6e0fe91ed44af366ebdeb56315b67d307d70b4bf9885ea8d64573a20b77d7782
+  data.tar.gz: 8efc6d6ebee6ce84b2c14117858e8168c6eecf75f178172e58f6044fe63c86ac
 SHA512:
-  metadata.gz: 4661d9bfa18456e1c6fcfb837ef4c3acbc9e35dd983299201340dc077056e3f5632c39a8f718b285d66b4e3985aec23da68a56c8c278f0fc850f27626352bb0b
-  data.tar.gz: 688fae38d680fb9f1b133a627172d687c7fa6f56186039a88a5bfe238e396c5310359266580644d7719b981d6f3589ac884f6b6d88688c497c8516cbffd122cd
+  metadata.gz: 1cb85390ee04fe7c8f696230d17c7008112c232ed22e96e45963057e05c4f9b60c7923b9e94de7b6362523110e04c0e11f92e55c94edf2423fa0c59ea99f46f2
+  data.tar.gz: 717a43cb3df244ec6164be3340f215f9974ce2355336ff0aa5656ad345e4729057ad066ade421a2c041e6bdaf4cffed8acdcefb3e41e4b9f780b578b31ad6229

data/lib/api-pagination/configuration.rb

@@ -17,15 +17,15 @@ module ApiPagination
     end
 
     def initialize
-      @total_header    = 'Total'
-      @per_page_header = 'Per-Page'
-      @page_header     = nil
-      @include_total   = true
-      @base_url   = nil
+      @total_header = "Total"
+      @per_page_header = "Per-Page"
+      @page_header = nil
+      @include_total = true
+      @base_url = nil
       @response_formats = [:json, :xml]
     end
 
-    ['page', 'per_page'].each do |param_name|
+    ["page", "per_page"].each do |param_name|
       method_name = "#{param_name}_param"
       instance_variable_name = "@#{method_name}"
 
@@ -37,7 +37,7 @@ module ApiPagination
 
         if instance_variable_get(instance_variable_name).nil?
           # use :page & :per_page by default
-          instance_variable_set(instance_variable_name, (lambda { |p| p[param_name.to_sym] }))
+          instance_variable_set(instance_variable_name, lambda { |p| p[param_name.to_sym] })
         end
 
         instance_variable_get(instance_variable_name).call(params)
@@ -45,7 +45,7 @@ module ApiPagination
 
       define_method "#{method_name}=" do |param|
         if param.is_a?(Symbol) || param.is_a?(String)
-          instance_variable_set(instance_variable_name, (lambda { |params| params[param] }))
+          instance_variable_set(instance_variable_name, lambda { |params| params[param] })
         else
           raise ArgumentError, "Cannot set page_param option"
         end
@@ -78,24 +78,24 @@ module ApiPagination
     def set_paginator
       conditions = [defined?(Pagy), defined?(Kaminari), defined?(WillPaginate::CollectionMethods)]
       if conditions.compact.size > 1
-        Kernel.warn <<-WARNING
-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
-end
-
-You should also configure Kaminari to use a different `per_page` method name as
-using these gems together causes a conflict; some information can be found at
-https://github.com/activeadmin/activeadmin/wiki/How-to-work-with-will_paginate
-
-Kaminari.configure do |config|
-  config.page_method_name = :per_page_kaminari
-end
-
-WARNING
+        Kernel.warn <<~WARNING
+          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
+          end
+          
+          You should also configure Kaminari to use a different `per_page` method name as
+          using these gems together causes a conflict; some information can be found at
+          https://github.com/activeadmin/activeadmin/wiki/How-to-work-with-will_paginate
+          
+          Kaminari.configure do |config|
+            config.page_method_name = :per_page_kaminari
+          end
+          
+        WARNING
       elsif defined?(Pagy)
         use_pagy
       elsif defined?(Kaminari)
@@ -110,14 +110,19 @@ WARNING
     end
 
     def use_kaminari
-      require 'kaminari/models/array_extension'
+      require "kaminari/models/array_extension"
       @paginator = :kaminari
     end
 
     def use_will_paginate
       WillPaginate::CollectionMethods.module_eval do
-        def first_page?() !previous_page end
-        def last_page?() !next_page end
+        def first_page?
+          !previous_page
+        end
+
+        def last_page?
+          !next_page
+        end
       end
 
       @paginator = :will_paginate
@@ -132,6 +137,6 @@ WARNING
     def config
       @config ||= Configuration.new
     end
-    alias :configuration :config
+    alias_method :configuration, :config
   end
 end

data/lib/api-pagination/hooks.rb

@@ -1,8 +1,8 @@
-begin; require 'grape'; rescue LoadError; end
+begin; require "grape"; rescue LoadError; end
 if defined?(Grape::API)
-  require 'grape/pagination'
+  require "grape/pagination"
 
-  klass = if Grape::VERSION >= '1.2.0' || defined?(Grape::API::Instance)
+  klass = if Grape::VERSION >= "1.2.0" || defined?(Grape::API::Instance)
     Grape::API::Instance
   else
     Grape::API
@@ -11,12 +11,12 @@ if defined?(Grape::API)
   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
+begin; require "pagy"; rescue LoadError; end
+begin; require "kaminari"; rescue LoadError; end
+begin; require "will_paginate"; rescue LoadError; end
 
 unless defined?(Pagy) || defined?(Kaminari) || defined?(WillPaginate::CollectionMethods)
-  Kernel.warn <<-WARNING.gsub(/^\s{4}/, '')
+  Kernel.warn <<-WARNING.gsub(/^\s{4}/, "")
     Warning: api-pagination relies on either Pagy, Kaminari, or WillPaginate.
     Please install a paginator by adding one of the following to your Gemfile:
 
@@ -39,5 +39,5 @@ if defined?(Rails)
     end
   end
 
-  require 'api-pagination/railtie'
+  require "api-pagination/railtie"
 end

data/lib/api-pagination/railtie.rb

@@ -1,10 +1,10 @@
-require 'rails/railtie'
+require "rails/railtie"
 
 module ApiPagination
   class Railtie < ::Rails::Railtie
     initializer :api_pagination do
       ActiveSupport.on_load(:action_controller) do
-        require 'rails/pagination'
+        require "rails/pagination"
 
         klass = if Rails::VERSION::MAJOR >= 5 || defined?(ActionController::API)
           ActionController::API

data/lib/api-pagination/version.rb

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

data/lib/api-pagination.rb

@@ -1,11 +1,11 @@
-require 'api-pagination/configuration'
-require 'api-pagination/version'
+require "api-pagination/configuration"
+require "api-pagination/version"
 
 module ApiPagination
   class << self
     def paginate(collection, options = {})
-      options[:page]     = options[:page].to_i
-      options[:page]     = 1 if options[:page] <= 0
+      options[:page] = options[:page].to_i
+      options[:page] = 1 if options[:page] <= 0
       options[:per_page] = options[:per_page].to_i
 
       case ApiPagination.config.paginator
@@ -26,10 +26,10 @@ module ApiPagination
       {}.tap do |pages|
         unless collection.first_page?
           pages[:first] = 1
-          pages[:prev]  = collection.current_page - 1
+          pages[:prev] = collection.current_page - 1
         end
 
-        unless collection.last_page? || (ApiPagination.config.paginator == :kaminari && collection.out_of_range?)
+        if !(collection.last_page? || (ApiPagination.config.paginator == :kaminari && collection.out_of_range?))
           pages[:last] = collection.total_pages if ApiPagination.config.include_total
           pages[:next] = collection.current_page + 1
         end
@@ -38,46 +38,49 @@ 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
+      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
     end
 
     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]
+      if Pagy.options[:max_per_page] && options[:per_page] > Pagy.options[:max_per_page]
+        options[:per_page] = Pagy.options[:max_per_page]
       elsif options[:per_page] <= 0
-        options[:per_page] = Pagy::DEFAULT[:items]
+        options[:per_page] = Pagy.options[:limit]
       end
 
       pagy = pagy_from(collection, options)
       collection = if collection.respond_to?(:offset) && collection.respond_to?(:limit)
-        collection.offset(pagy.offset).limit(pagy.items)
+        collection.offset(pagy.offset).limit(pagy.limit)
       else
-        collection[pagy.offset, pagy.items]
+        collection[pagy.offset, pagy.limit]
       end
 
-      return [collection, pagy]
+      [collection, pagy]
     end
 
     def pagy_from(collection, options)
-      if options[:count]
-        count = options[:count]
+      count = if options[:count]
+        options[:count]
       else
-        count = collection.is_a?(Array) ? collection.count : collection.count(:all)
+        collection.is_a?(Array) ? collection.count : collection.count(:all)
       end
 
-      Pagy.new(count: count, items: options[:per_page], page: options[:page])
+      # Pagy 9.x requires keyword arguments
+      # Use explicit keyword argument syntax to avoid Ruby version quirks
+      pagy_options = {count: count, limit: options[:per_page], page: options[:page]}
+      Pagy::Offset.new(**pagy_options)
     end
 
     def pagy_pages_from(pagy)
       {}.tap do |pages|
         unless pagy.page == 1
           pages[:first] = 1
-          pages[:prev]  = pagy.prev
+          pages[:prev] = pagy.previous
         end
 
         unless pagy.page == pagy.pages
@@ -105,11 +108,11 @@ module ApiPagination
         options[:per_page] = default_per_page_for_will_paginate(collection)
       end
 
-      collection = if defined?(Sequel::Dataset) && collection.kind_of?(Sequel::Dataset)
+      collection = if defined?(Sequel::Dataset) && collection.is_a?(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) }
+        options = options.dup.keep_if { |k, v| supported_options.include?(k.to_sym) }
         collection.paginate(options)
       end
 
@@ -139,4 +142,4 @@ module ApiPagination
   end
 end
 
-require 'api-pagination/hooks'
+require "api-pagination/hooks"

data/lib/grape/pagination.rb

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

data/lib/rails/pagination.rb

@@ -3,7 +3,7 @@ module Rails
     protected
 
     def paginate(*options_or_collection)
-      options    = options_or_collection.extract_options!
+      options = options_or_collection.extract_options!
       collection = options_or_collection.first
 
       return _paginate_collection(collection, options) if collection
@@ -25,37 +25,35 @@ module Rails
     private
 
     def _discover_format(options)
-      for response_format in ApiPagination.config.response_formats
-        return response_format if options.key?(response_format)
-      end
+      ApiPagination.config.response_formats.find { |format| options.key?(format) }
     end
 
-    def _paginate_collection(collection, options={})
+    def _paginate_collection(collection, options = {})
       options[:page] = ApiPagination.config.page_param(params)
       options[:per_page] ||= ApiPagination.config.per_page_param(params)
 
       collection, pagy = ApiPagination.paginate(collection, options)
 
-      links = (headers['Link'] || '').split(',').map(&:strip)
-      url   = base_url + request.path_info
+      links = (headers["Link"] || "").split(",").map(&:strip)
+      url = base_url + request.path_info
       pages = ApiPagination.pages_from(pagy || collection, options)
 
       pages.each do |k, v|
-        new_params = request.query_parameters.merge(:page => v)
+        new_params = request.query_parameters.merge(page: v)
         links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
       end
 
-      total_header    = ApiPagination.config.total_header
+      total_header = ApiPagination.config.total_header
       per_page_header = ApiPagination.config.per_page_header
-      page_header     = ApiPagination.config.page_header
-      include_total   = ApiPagination.config.include_total
+      page_header = ApiPagination.config.page_header
+      include_total = ApiPagination.config.include_total
 
-      headers['Link'] = links.join(', ') unless links.empty?
+      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(pagy || collection, options).to_s if include_total
 
-      return collection
+      collection
     end
 
     def total_count(collection, options)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 7.0.0
 platform: ruby
 authors:
 - David Celis
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kaminari
@@ -36,20 +35,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.1.2
+        version: '43.0'
   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
+        version: '43.0'
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
@@ -104,40 +97,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -158,14 +139,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.9.0
 description: Link header pagination for Rails and Grape APIs
 email:
 - me@davidcel.is
@@ -180,25 +161,10 @@ 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
-- spec/support/shared_examples/first_page.rb
-- spec/support/shared_examples/last_page.rb
-- spec/support/shared_examples/middle_page.rb
 homepage: https://github.com/davidcelis/api-pagination
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -213,22 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Link header pagination for Rails and Grape APIs. Don't use the request body.
-test_files:
-- 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/last_page.rb
-- spec/support/shared_examples/middle_page.rb
+test_files: []

data/spec/active_record_spec.rb

@@ -1,50 +0,0 @@
-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
-
-