api-pagination 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48cb5f06eb2928aab44c8b41c50ad8ac87d8907f
-  data.tar.gz: f4f14870f987d37dfe508217a27ee9905de4137e
+  metadata.gz: d8bd6ee617ad9ee01273cb7b36548cdb197110aa
+  data.tar.gz: b24a83cb8d231b98d7ed1670adb7f23680a80210
 SHA512:
-  metadata.gz: d159ecc56ea17eeb912638cccb5db3d8d9e188ea7939fb6f4254aaa1f7912b6341ae3d78d9657ae985f6c4d0f56e47c3d40704c0403d47d629f424604cb48540
-  data.tar.gz: a87c54ba5f0bc1761efc5fdf793df7b19d60a7bef57cf41d5b778aef31ace3712aef4ebed963600211c116505ec3050f91849557998c9af8d81dc0934e6b744c
+  metadata.gz: 729785a6c4835d934f1f6fdab6159ca54f2003aecb4368774581478bb40640b62b1790b332e9d567c2b02b55ae980bd37ae6b01b30fbf5288657f2c87e111cce
+  data.tar.gz: aba98e01b6082d375864506e0ba1d6d6483961e6ef6d5bc61f8c4662fa81b6a785b5ca21029d237dead8e4a8aad28309c8f4c28e9be3924a53cd2eb00362e8c1

data/lib/api-pagination/version.rb

@@ -1,7 +1,7 @@
 module ApiPagination
   class Version
     MAJOR = 4
-    MINOR = 3
+    MINOR = 4
     PATCH = 0
 
     def self.to_s

data/lib/rails/pagination.rb

@@ -24,13 +24,9 @@ module Rails
     private
 
     def _paginate_collection(collection, options={})
-      options = {
-        :page     => ApiPagination.config.page_param(params),
-        :per_page => (
-          options.delete(:per_page) ||
-          ApiPagination.config.per_page_param(params)
-        )
-      }
+      options[:page] = ApiPagination.config.page_param(params)
+      options[:per_page] ||= ApiPagination.config.per_page_param(params)
+
       collection = ApiPagination.paginate(collection, options)
 
       links = (headers['Link'] || "").split(',').map(&:strip)
@@ -47,12 +43,20 @@ module Rails
       page_header     = ApiPagination.config.page_header
       include_total   = ApiPagination.config.include_total
 
-      headers['Link']          = links.join(', ') unless links.empty?
-      headers[total_header]    = ApiPagination.total_from(collection) if include_total
+      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[page_header] = options[:page].to_s unless page_header.nil?
+      headers[total_header] = total_count(collection, options) if include_total
 
       return collection
     end
+
+    def total_count(collection, options)
+      total_count = if ApiPagination.config.paginator == :kaminari
+        paginate_array_options = options[:paginate_array_options]
+        paginate_array_options[:total_count] if paginate_array_options
+      end
+      total_count || ApiPagination.total_from(collection)
+    end
   end
 end

data/spec/rails_spec.rb

@@ -201,6 +201,52 @@ describe NumbersController, :type => :controller do
       end
     end
 
+    context 'paginate array options' do
+      shared_examples 'properly set Total header' do
+        let(:params) do
+          {
+            paginate_array_total_count: paginate_array_total_count,
+            count: count,
+          }
+        end
+
+        specify do
+          get :index_with_paginate_array_options, params
+          expect(response.header['Total'].to_i).to eq total_header
+        end
+      end
+
+      context 'kaminari' do
+        around do |example|
+          paginator = ApiPagination.config.paginator
+          ApiPagination.config.paginator = :kaminari
+          example.run
+          ApiPagination.config.paginator = paginator
+        end
+
+        it_should_behave_like 'properly set Total header' do
+          let(:paginate_array_total_count) { 300 }
+          let(:total_header) { 300 }
+          let(:count) { 50 }
+        end
+      end
+
+      context 'will_paginate' do
+        around do |example|
+          paginator = ApiPagination.config.paginator
+          ApiPagination.config.paginator = :will_paginate
+          example.run
+          ApiPagination.config.paginator = paginator
+        end
+
+        it_should_behave_like 'properly set Total header' do
+          let(:paginate_array_total_count) { 300 }
+          let(:total_header) { 50 }
+          let(:count) { 50 }
+        end
+      end
+    end
+
     context 'default per page in model' do
       before do
         class Fixnum

data/spec/spec_helper.rb

@@ -2,15 +2,14 @@ require 'support/numbers_controller'
 require 'support/numbers_api'
 require 'api-pagination'
 
-if ENV['PAGINATOR']
-  require ENV['PAGINATOR']
-  ApiPagination.config.paginator = ENV['PAGINATOR'].to_sym
-else
+if ENV['PAGINATOR'].nil?
   warn 'No PAGINATOR set. Defaulting to kaminari. To test against will_paginate, run `PAGINATOR=will_paginate bundle exec rspec`'
-  require 'kaminari'
-  ApiPagination.config.paginator = :kaminari
+  ENV['PAGINATOR'] = 'kaminari'
 end
 
+require ENV['PAGINATOR']
+ApiPagination.config.paginator = ENV['PAGINATOR'].to_sym
+
 require 'will_paginate/array'
 
 RSpec.configure do |config|

data/spec/support/numbers_controller.rb

@@ -40,8 +40,11 @@ end
 
 Rails.application.routes.draw do
   resources :numbers, :only => [:index] do
-    get :index_with_custom_render, on: :collection
-    get :index_with_no_per_page,   on: :collection
+    collection do
+      get :index_with_custom_render
+      get :index_with_no_per_page
+      get :index_with_paginate_array_options
+    end
   end
 end
 
@@ -85,4 +88,13 @@ class NumbersController < ActionController::Base
 
     render json: NumbersSerializer.new(numbers)
   end
+
+  def index_with_paginate_array_options
+    count = params.fetch(:count).to_i
+    total_count = params.fetch(:paginate_array_total_count).to_i
+    numbers = (1..count).to_a
+    numbers = paginate numbers, paginate_array_options: {total_count: total_count}
+
+    render json: NumbersSerializer.new(numbers)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -140,4 +140,3 @@ test_files:
 - spec/support/shared_examples/first_page.rb
 - spec/support/shared_examples/last_page.rb
 - spec/support/shared_examples/middle_page.rb
-has_rdoc: