Merge pull request #107 from StefSchenkelaars/exclude-total

Remove last link header when include total option is false

Author: davidcelis

README.md

@@ -55,6 +55,11 @@ ApiPagination.configure do |config|
   config.per_page_param do |params|
     params[:page][:size]
   end
+ 
+  # Optional: Include the total and last_page link header
+  # By default, this is set to true
+  # Note: When using kaminari, this prevents the count call to the database
+  config.include_total = false 
 end
 ```
 

lib/api-pagination.rb

@@ -30,7 +30,7 @@ def pages_from(collection, options = {})
         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
@@ -76,7 +76,7 @@ def pagy_pages_from(pagy)
         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 +90,9 @@ def paginate_with_kaminari(collection, options, paginate_array_options = {})
       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)

spec/api-pagination_spec.rb

@@ -2,23 +2,45 @@
 
 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

spec/grape_spec.rb

@@ -6,7 +6,8 @@
 
 describe NumbersAPI do
   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 +140,12 @@
         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
 

spec/rails_spec.rb

@@ -8,7 +8,8 @@
   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 @@
         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
 

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

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