api-pagination 4.8.1 → 4.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bb99a6e4283fff7d5fa69b46f58e2b464817aa85a9377c0dee0712ec53e2966
-  data.tar.gz: ea909de1558e7d1db8492b61cb6140acaf4b97431d77716995fd9878f4c47b1b
+  metadata.gz: e0006fcbe882c8a54820796eaf3d573d04b3dd2057cb9d6130b56389dff36790
+  data.tar.gz: b585330048fb81eb9b83c377af32ea85d3fd80afcc864b70a01426e0d51c1bf4
 SHA512:
-  metadata.gz: 3d648ef5559a8200612186dac182f1fee3b8babb294c54762e241f41b9e7f4ffc673ba21aa51ece2dff4bfa39a17bf6b9f78d3a44bd52d2f581aba63e7a4051f
-  data.tar.gz: 0c90a0cb15d533248f848fb590694a190b62eb13df4ddea426889740d848e9ed0d9eac64d7a5dc40b5aec222d995f91fac8070d60eea0ae3750cb6d0f48220ef
+  metadata.gz: e79b9e403a5a30834d9bd94e11687a79e08ac049463fe749b025dc98cd476ed11b98e0667b6e01f13315c9bf374d19fb500af6e0a98a1cecb1bf2753101be9ef
+  data.tar.gz: '0398d5cab6c18f426823f8d99ef02a3796380047f87c99864600cfd0ff52bb86246f4d3091f8b3d95decd1f34827323792eebe2d77502abe05bcc235a7993382'

data/lib/api-pagination.rb

@@ -30,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
@@ -64,7 +64,12 @@ module ApiPagination
     end
 
     def pagy_from(collection, options)
-      count = collection.is_a?(Array) ? collection.count : collection.count(:all)
+      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
 
@@ -76,7 +81,7 @@ module ApiPagination
         end
 
         unless pagy.page == pagy.pages
-          pages[:last] = pagy.pages
+          pages[:last] = pagy.pages if ApiPagination.config.include_total
           pages[:next] = pagy.next
         end
       end
@@ -90,7 +95,9 @@ module ApiPagination
       end
 
       collection = Kaminari.paginate_array(collection, paginate_array_options) if collection.is_a?(Array)
-      [collection.page(options[:page]).per(options[:per_page]), nil]
+      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)
@@ -111,24 +118,23 @@ module ApiPagination
 
     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/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,7 +53,11 @@ module ApiPagination
     end
 
     def paginator
-      @paginator || set_paginator
+      if instance_variable_defined? :@paginator
+        @paginator
+      else
+        set_paginator
+      end
     end
 
     def paginator=(paginator)

data/lib/api-pagination/hooks.rb

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

data/lib/api-pagination/version.rb

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

data/lib/grape/pagination.rb

@@ -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,6 +24,12 @@ 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)

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,23 +2,45 @@ 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
     if ENV['PAGINATOR'].to_sym == :kaminari
       context 'Using kaminari' do
-        it 'should accept paginate_array_options option' do
-          expect(Kaminari).to receive(:paginate_array)
-                                .with(collection, paginate_array_options)
-                                .and_call_original
-
-          ApiPagination.paginate(
-            collection,
-            {
-              per_page:               30,
-              paginate_array_options: paginate_array_options
-            }
-          )
+        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
+
+            ApiPagination.paginate(
+              collection,
+              {
+                per_page: 30,
+                paginate_array_options: paginate_array_options
+              }
+            )
+          end
+
+          context 'configured not to include the total' do
+            before { ApiPagination.config.include_total = false }
+
+            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

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
 
@@ -255,13 +262,21 @@ describe NumbersController, :type => :controller do
           end
         end
 
+        after :all do 
+          class Fixnum
+            class << self
+              undef_method :default_per_page, :per_page
+            end
+          end
+        end
+
         it 'should use default per page from model' do
           get :index_with_no_per_page, params: {count: 100}
 
           expect(response.header['Per-Page']).to eq('6')
         end
 
-        it 'should not fail if model does not respond to per page' do
+        it 'should not fail if the model yields nil for per page' do
           class Fixnum
             @default_per_page = nil
             @per_page = nil
@@ -279,5 +294,19 @@ describe NumbersController, :type => :controller do
         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
+        get :index_with_no_per_page, params: {count: 100}
+
+        expect(response.header['Per-Page']).to eq(
+          case ApiPagination.config.paginator
+          when :pagy          then Pagy::VARS[: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
-end
+end

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 4.8.1
+  version: 4.8.2
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.9.0
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.9
 description: Link header pagination for Rails and Grape APIs
 email:
 - me@davidcel.is
@@ -94,11 +108,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
@@ -132,9 +149,12 @@ summary: Link header pagination for Rails and Grape APIs. Don't use the request
 test_files:
 - spec/spec_helper.rb
 - spec/api-pagination_spec.rb
+- spec/active_record_spec.rb
 - spec/sequel_spec.rb
 - spec/support/numbers_api.rb
 - spec/support/numbers_controller.rb
+- spec/support/active_record/foo.rb
+- spec/support/active_record/schema.rb
 - spec/support/shared_examples/first_page.rb
 - spec/support/shared_examples/middle_page.rb
 - spec/support/shared_examples/last_page.rb