api-pagination 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39ada68101786c8ae919218460cd300a41c03dab
-  data.tar.gz: e738863fb5ca287442afa734d7b87a01c0173e86
+  metadata.gz: 9a9271269dab6d4d3b99562c1262975c14c76efc
+  data.tar.gz: 3f98efbf74253877c9c2e0e99da24ac5a798e041
 SHA512:
-  metadata.gz: 332904cbbbcb0bbfee70edab279f0aecb400d8c3d4e8b76db5ecbec51ff532132467060b5b8a238436c846ab8b4f48b5927eb8575bf1878cc31e74227a8bcb0f
-  data.tar.gz: 3d9bad3a6aff7918d9f104abb8fa351566c7d8c745afe0178d0bb1afed61a611bb95a01c7bb7abef07687ec82b747421d2e663ca1aa7e615e3b3aab9ce8793c7
+  metadata.gz: 84f99de16f079a1a9e5acc30f3405b8798b2d5f215a022bb7cc5d3b98990bad16f3318aa2ae04fe234d454905144604091b31cea3aa5b1cb36fb3bb9f790fcab
+  data.tar.gz: c122d6e8e2fec923b1ca0ad30eed0bc6d502a64c34c197c51b9de75e3cafe2e8c6fa6b89bbe514aa0bb57380910b67915569915a80c5caa227741a0b7632b574

data/lib/api-pagination.rb

@@ -3,19 +3,16 @@ require 'api-pagination/version'
 
 module ApiPagination
   class << self
-    attr_writer :kaminari
-    attr_writer :will_paginate
-
-    def kaminari?() !!@kaminari end
-    def will_paginate?() !!@will_paginate end
+    attr_reader :paginator
 
     def paginate(collection, options = {}, &block)
       options[:page]     ||= 1
       options[:per_page] ||= 10
 
-      if ApiPagination.kaminari?
+      case ApiPagination.paginator
+      when :kaminari
         collection.page(options[:page]).per(options[:per_page]).tap(&block)
-      elsif ApiPagination.will_paginate?
+      when :will_paginate
         collection.paginate(:page => options[:page], :per_page => options[:per_page]).tap(&block)
       end
     end
@@ -33,6 +30,13 @@ module ApiPagination
         end
       end
     end
+
+    def total_from(collection)
+      case ApiPagination.paginator
+        when :kaminari      then collection.total_count
+        when :will_paginate then collection.total_entries
+      end
+    end
   end
 end
 

data/lib/api-pagination/hooks.rb

@@ -26,12 +26,12 @@ module ApiPagination
           def last_page?() !next_page end
         end
 
-        ApiPagination.will_paginate = true
+        ApiPagination.instance_variable_set(:@paginator, :will_paginate)
       end
 
       begin; require 'kaminari'; rescue LoadError; end
       if defined?(Kaminari)
-        ApiPagination.kaminari = true
+        ApiPagination.instance_variable_set(:@paginator, :kaminari)
       end
 
       STDERR.puts <<-EOC unless defined?(Kaminari) || defined?(WillPaginate)

data/lib/api-pagination/version.rb

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

data/lib/grape/pagination.rb

@@ -15,6 +15,7 @@ module Grape
             end
 
             header 'Link', links.join(', ') unless links.empty?
+            header 'Total', ApiPagination.total_from(collection)
           end
 
           ApiPagination.paginate(collection, params, &block)

data/lib/rails/pagination.rb

@@ -15,7 +15,8 @@ module Rails
             links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
           end
 
-          headers['Link'] = links.join(', ') unless links.empty?
+          headers['Link']  = links.join(', ') unless links.empty?
+          headers['Total'] = ApiPagination.total_from(collection)
         end
 
         ApiPagination.paginate(collection, params, &block)

data/spec/grape_spec.rb

@@ -7,12 +7,18 @@ require 'support/shared_examples/last_page'
 describe NumbersAPI do
   describe 'GET #index' do
     let(:links) { last_response.headers['Link'].split(', ') }
+    let(:total) { last_response.headers['Total'].to_i }
 
     context 'without enough items to give more than one page' do
+      before { get :numbers, :count => 20 }
+
       it 'should not paginate' do
-        get :numbers, :count => 20
         expect(last_response.headers.keys).not_to include('Link')
       end
+
+      it 'should give a Total header' do
+        expect(total).to eq(20)
+      end
     end
 
     context 'with existing Link headers' do

data/spec/rails_spec.rb

@@ -6,14 +6,20 @@ require 'support/shared_examples/last_page'
 
 describe NumbersController, :type => :controller do
   before { request.host = 'example.org' }
+
   describe 'GET #index' do
     let(:links) { response.headers['Link'].split(', ') }
+    let(:total) { response.headers['Total'].to_i }
 
     context 'without enough items to give more than one page' do
+      before { get :index, :count => 20 }
       it 'should not paginate' do
-        get :index, :count => 20
         expect(response.headers.keys).not_to include('Link')
       end
+
+      it 'should give a Total header' do
+        expect(total).to eq(20)
+      end
     end
 
     context 'with existing Link headers' do

data/spec/spec_helper.rb

@@ -24,10 +24,16 @@ PaginatedSet = Struct.new(:current_page, :per_page, :total_count) do
   def paginate(options = {})
     page(options[:page]).per(options[:per_page])
   end
+
+  alias :total_entries :total_count
 end
 
-ApiPagination.kaminari      = ENV['PAGINATOR'] == 'kaminari'
-ApiPagination.will_paginate = ENV['PAGINATOR'] == 'will_paginate'
+if ENV['PAGINATOR']
+  ApiPagination.instance_variable_set(:@paginator, ENV['PAGINATOR'].to_sym)
+else
+  warn 'No PAGINATOR set. Defaulting to kaminari. To test against will_paginate, run `PAGINATOR=will_paginate bundle exec rspec`'
+  ApiPagination.instance_variable_set(:@paginator, :kaminari)
+end
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods

data/spec/support/shared_examples/existing_headers.rb

@@ -7,4 +7,8 @@ shared_examples 'an endpoint with existing Link headers' do
     expect(links).to include('<http://example.org/numbers?count=30&page=2&with_headers=true>; rel="next"')
     expect(links).to include('<http://example.org/numbers?count=30&page=2&with_headers=true>; rel="last"')
   end
+
+  it 'should give a Total header' do
+    expect(total).to eq(30)
+  end
 end

data/spec/support/shared_examples/first_page.rb

@@ -14,4 +14,8 @@ shared_examples 'an endpoint with a first page' do
   it 'should give a link with rel "next"' do
     expect(links).to include('<http://example.org/numbers?count=100&page=2>; rel="next"')
   end
+
+  it 'should give a Total header' do
+    expect(total).to eq(100)
+  end
 end

data/spec/support/shared_examples/last_page.rb

@@ -14,4 +14,8 @@ shared_examples 'an endpoint with a last page' do
   it 'should give a link with rel "prev"' do
     expect(links).to include('<http://example.org/numbers?count=100&page=3>; rel="prev"')
   end
+
+  it 'should give a Total header' do
+    expect(total).to eq(100)
+  end
 end

data/spec/support/shared_examples/middle_page.rb

@@ -5,4 +5,8 @@ shared_examples 'an endpoint with a middle page' do
     expect(links).to include('<http://example.org/numbers?count=100&page=3>; rel="next"')
     expect(links).to include('<http://example.org/numbers?count=100&page=1>; rel="prev"')
   end
+
+  it 'should give a Total header' do
+    expect(total).to eq(100)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-17 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec