Change Spec suite to actually paginate over an Array

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

Author: davidcelis

Gemfile

@@ -3,5 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in api_pagination.gemspec
 gemspec
 
+gem 'kaminari', require: false
+gem 'will_paginate', require: false
+
 gem 'rake', require: false
 gem 'coveralls', require: false

api-pagination.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'grape'
+  s.add_development_dependency 'railties', '>= 3.0.0'
   s.add_development_dependency 'actionpack', '>= 3.0.0'
 end

lib/api-pagination.rb

@@ -40,5 +40,3 @@ def total_from(collection)
     end
   end
 end
-
-ApiPagination::Hooks.init

lib/api-pagination/hooks.rb

@@ -45,3 +45,5 @@ def last_page?() !next_page end
     end
   end
 end
+
+ApiPagination::Hooks.init

spec/grape_spec.rb

@@ -10,14 +10,14 @@
     let(:total) { last_response.headers['Total'].to_i }
 
     context 'without enough items to give more than one page' do
-      before { get :numbers, :count => 20 }
+      before { get :numbers, :count => 10 }
 
       it 'should not paginate' do
         expect(last_response.headers.keys).not_to include('Link')
       end
 
       it 'should give a Total header' do
-        expect(total).to eq(20)
+        expect(total).to eq(10)
       end
     end
 
@@ -35,7 +35,7 @@
       end
 
       context 'when on the last page' do
-        before { get :numbers, :count => 100, :page => 4 }
+        before { get :numbers, :count => 100, :page => 10 }
 
         it_behaves_like 'an endpoint with a last page'
       end

spec/rails_spec.rb

@@ -12,13 +12,14 @@
     let(:total) { response.headers['Total'].to_i }
 
     context 'without enough items to give more than one page' do
-      before { get :index, :count => 20 }
+      before { get :index, :count => 10 }
+
       it 'should not paginate' do
         expect(response.headers.keys).not_to include('Link')
       end
 
       it 'should give a Total header' do
-        expect(total).to eq(20)
+        expect(total).to eq(10)
       end
     end
 
@@ -36,7 +37,7 @@
       end
 
       context 'when on the last page' do
-        before { get :index, :count => 100, :page => 4 }
+        before { get :index, :count => 100, :page => 10 }
 
         it_behaves_like 'an endpoint with a last page'
       end

spec/spec_helper.rb

@@ -5,39 +5,19 @@
 require 'support/numbers_api'
 require 'api-pagination'
 
-# Quacks like Kaminari and will_paginate
-PaginatedSet = Struct.new(:current_page, :per_page, :total_count) do
-  def total_pages
-    total_count.zero? ? 1 : (total_count.to_f / per_page).ceil
-  end
-
-  def first_page?() current_page == 1 end
-  def last_page?() current_page == total_pages end
-
-  def page(page)
-    current_page = page
-    self
-  end
-
-  def per(per)
-    per_page = per
-    self
-  end
-
-  def paginate(options = {})
-    page(options[:page]).per(options[:per_page])
-  end
-
-  alias :total_entries :total_count
-end
-
 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
 
+if ApiPagination.paginator == :kaminari
+  Kaminari::Hooks.init
+elsif ApiPagination.paginator == :will_paginate
+  require 'will_paginate/array'
+end
+
 RSpec.configure do |config|
   config.include Rack::Test::Methods
   config.include ControllerExampleGroup, :type => :controller

spec/support/numbers_api.rb

@@ -5,7 +5,7 @@ class NumbersAPI < Grape::API
   format :json
 
   desc 'Return some paginated set of numbers'
-  paginate :per_page => 25
+  paginate :per_page => 10
   params do
     requires :count, :type => Integer
     optional :with_headers, :default => false, :type => Boolean
@@ -18,6 +18,6 @@ class NumbersAPI < Grape::API
       header 'Link', %(<#{url}?#{query.to_query}>; rel="without")
     end
 
-    paginate PaginatedSet.new(params[:page], params[:per_page], params[:count])
+    paginate (1..params[:count]).to_a
   end
 end

spec/support/numbers_controller.rb

@@ -57,7 +57,7 @@ def index
       headers['Link'] = %(<#{numbers_url}?#{query.to_param}>; rel="without")
     end
 
-    @numbers = PaginatedSet.new(page, 25, total)
+    @numbers = (1..total).to_a
     render :json => @numbers
   end
 end

spec/support/shared_examples/existing_headers.rb

@@ -5,7 +5,7 @@
 
   it 'should contain pagination Links' 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"')
+    expect(links).to include('<http://example.org/numbers?count=30&page=3&with_headers=true>; rel="last"')
   end
 
   it 'should give a Total header' do

spec/support/shared_examples/first_page.rb

@@ -8,7 +8,7 @@
   end
 
   it 'should give a link with rel "last"' do
-    expect(links).to include('<http://example.org/numbers?count=100&page=4>; rel="last"')
+    expect(links).to include('<http://example.org/numbers?count=100&page=10>; rel="last"')
   end
 
   it 'should give a link with rel "next"' do

spec/support/shared_examples/last_page.rb

@@ -12,7 +12,7 @@
   end
 
   it 'should give a link with rel "prev"' do
-    expect(links).to include('<http://example.org/numbers?count=100&page=3>; rel="prev"')
+    expect(links).to include('<http://example.org/numbers?count=100&page=9>; rel="prev"')
   end
 
   it 'should give a Total header' do

spec/support/shared_examples/middle_page.rb

@@ -1,7 +1,7 @@
 shared_examples 'an endpoint with a middle page' do
   it 'should give all pagination links' do
     expect(links).to include('<http://example.org/numbers?count=100&page=1>; rel="first"')
-    expect(links).to include('<http://example.org/numbers?count=100&page=4>; rel="last"')
+    expect(links).to include('<http://example.org/numbers?count=100&page=10>; rel="last"')
     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