Allow users to skip the Total header

If a table is very large, calculating the number of rows in it may be
very costly. We should allow users to skip that query and forego the
Total header altogether. Fixes #35

Signed-off-by: David Celis <[email protected]>

Author: davidcelis

lib/api-pagination.rb

@@ -45,12 +45,12 @@ def paginator
     end
 
     def per_page_header
-      warn "[DEPRECATION] ApiPagination.paginator is deprecated. Please use ApiPagination.config.per_page_header"
+      warn "[DEPRECATION] ApiPagination.per_page_header is deprecated. Please use ApiPagination.config.per_page_header"
       config.per_page_header
     end
 
     def total_header
-      warn "[DEPRECATION] ApiPagination.paginator is deprecated. Please use ApiPagination.config.total_header"
+      warn "[DEPRECATION] ApiPagination.total_header is deprecated. Please use ApiPagination.config.total_header"
       config.total_header
     end
 

lib/api-pagination/configuration.rb

@@ -6,6 +6,8 @@ class Configuration
 
     attr_accessor :page_header
 
+    attr_accessor :include_total
+
     def configure(&block)
       yield self
     end
@@ -14,6 +16,7 @@ def initialize
       @total_header    = 'Total'
       @per_page_header = 'Per-Page'
       @page_header     = nil
+      @include_total   = true
     end
 
     def paginator

lib/grape/pagination.rb

@@ -23,9 +23,10 @@ def paginate(collection)
           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
 
           header 'Link',          links.join(', ') unless links.empty?
-          header total_header,    ApiPagination.total_from(collection)
+          header total_header,    ApiPagination.total_from(collection) if include_total
           header per_page_header, options[:per_page].to_s
           header page_header,     options[:page].to_s unless page_header.nil?
 

lib/rails/pagination.rb

@@ -42,9 +42,10 @@ def _paginate_collection(collection, options={})
       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
 
       headers['Link']          = links.join(', ') unless links.empty?
-      headers[total_header]    = ApiPagination.total_from(collection)
+      headers[total_header]    = ApiPagination.total_from(collection) if include_total
       headers[per_page_header] = options[:per_page].to_s
       headers[page_header]     = options[:page].to_s unless page_header.nil?
 

spec/grape_spec.rb

@@ -110,6 +110,18 @@
       end
     end
 
+    context 'configured not to include the total' do
+      before { ApiPagination.config.include_total = false }
+
+      it 'should not include a Total header' do
+        get '/numbers', count: 10
+
+        expect(last_response.header['Total']).to be_nil
+      end
+
+      after { ApiPagination.config.include_total = true }
+    end
+
     context 'with query string including array parameter' do
       before do
         get '/numbers', { count: 100, parity: ['odd', 'even']}

spec/rails_spec.rb

@@ -111,5 +111,17 @@
         expect(page).to eq(1)
       end
     end
+
+    context 'configured not to include the total' do
+      before { ApiPagination.config.include_total = false }
+
+      it 'should not include a Total header' do
+        get :index, count: 10
+
+        expect(response.header['Total']).to be_nil
+      end
+
+      after { ApiPagination.config.include_total = true }
+    end
   end
 end