Extract shared spec tests

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

Author: davidcelis

Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in api_pagination.gemspec
 gemspec
+gem 'pry'

lib/rails/pagination.rb

@@ -1,3 +1,4 @@
+require 'pry'
 module Rails
   module Pagination
     protected

spec/grape_spec.rb

@@ -1,82 +1,43 @@
 require 'spec_helper'
+require 'support/shared_examples/existing_headers'
+require 'support/shared_examples/first_page'
+require 'support/shared_examples/middle_page'
+require 'support/shared_examples/last_page'
 
 describe NumbersAPI do
   describe 'GET #index' do
+    let(:links) { last_response.headers['Link'].split(', ') }
+
     context 'without enough items to give more than one page' do
       it 'should not paginate' do
-        get :numbers, count: 20
+        get :numbers, :count => 20
         expect(last_response.headers.keys).not_to include('Link')
       end
     end
 
     context 'with existing Link headers' do
-      before { get :numbers, count: 30, with_headers: true }
-      let(:links) { last_response.headers['Link'].split(', ') }
-
-      it 'should keep existing Links' do
-        expect(links).to include('<http://example.org/numbers?count=30>; rel="without"')
-      end
+      before { get :numbers, :count => 30, :with_headers => true }
 
-      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"')
-      end
+      it_behaves_like 'an endpoint with existing Link headers'
     end
 
     context 'with enough items to paginate' do
       context 'when on the first page' do
         before { get :numbers, :count => 100 }
-        let(:links) { last_response.headers['Link'].split(', ') }
-
-        it 'should not give a link with rel "first"' do
-          expect(links).not_to include('rel="first"')
-        end
-
-        it 'should not give a link with rel "prev"' do
-          expect(links).not_to include('rel="prev"')
-        end
 
-        it 'should give a link with rel "last"' do
-          expect(links).to include('<http://example.org/numbers?count=100&page=4>; rel="last"')
-        end
-
-        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_behaves_like 'an endpoint with a first page'
       end
 
       context 'when on the last page' do
         before { get :numbers, :count => 100, :page => 4 }
-        let(:links) { last_response.headers['Link'].split(', ') }
-
-        it 'should not give a link with rel "last"' do
-          expect(links).not_to include('rel="last"')
-        end
-
-        it 'should not give a link with rel "next"' do
-          expect(links).not_to include('rel="next"')
-        end
 
-        it 'should give a link with rel "first"' do
-          expect(links).to include('<http://example.org/numbers?count=100&page=1>; rel="first"')
-        end
-
-        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_behaves_like 'an endpoint with a last page'
       end
 
       context 'when somewhere comfortably in the middle' do
-        it 'should give all pagination links' do
-          get :numbers, count: 100, page: 2
-
-          links = last_response.headers['Link'].split(', ')
+        before { get :numbers, :count => 100, :page => 2 }
 
-          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=3>; rel="next"')
-          expect(links).to include('<http://example.org/numbers?count=100&page=1>; rel="prev"')
-        end
+        it_behaves_like 'an endpoint with a middle page'
       end
     end
   end

spec/rails_spec.rb

@@ -1,91 +1,44 @@
 require 'spec_helper'
+require 'support/shared_examples/existing_headers'
+require 'support/shared_examples/first_page'
+require 'support/shared_examples/middle_page'
+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(', ') }
+
     context 'without enough items to give more than one page' do
       it 'should not paginate' do
-        get :index, count: 20
+        get :index, :count => 20
         expect(response.headers.keys).not_to include('Link')
       end
     end
 
     context 'with existing Link headers' do
-      before do
-        get :index, count: 30, with_headers: true
-
-        @links = response.headers['Link'].split(', ')
-      end
-
-      it 'should keep existing Links' do
-        expect(@links).to include('<http://test.host/numbers?count=30>; rel="without"')
-      end
+      before { get :index, :count => 30, :with_headers => true }
 
-      it 'should contain pagination Links' do
-        expect(@links).to include('<http://test.host/numbers?count=30&page=2>; rel="next"')
-        expect(@links).to include('<http://test.host/numbers?count=30&page=2>; rel="last"')
-      end
+      it_behaves_like 'an endpoint with existing Link headers'
     end
 
     context 'with enough items to paginate' do
       context 'when on the first page' do
-        before do
-          get :index, count: 100
-
-          @links = response.headers['Link'].split(', ')
-        end
-
-        it 'should not give a link with rel "first"' do
-          expect(@links).not_to include('rel="first"')
-        end
+        before { get :index, :count => 100 }
 
-        it 'should not give a link with rel "prev"' do
-          expect(@links).not_to include('rel="prev"')
-        end
-
-        it 'should give a link with rel "last"' do
-          expect(@links).to include('<http://test.host/numbers?count=100&page=4>; rel="last"')
-        end
-
-        it 'should give a link with rel "next"' do
-          expect(@links).to include('<http://test.host/numbers?count=100&page=2>; rel="next"')
-        end
+        it_behaves_like 'an endpoint with a first page'
       end
 
       context 'when on the last page' do
-        before do
-          get :index, count: 100, page: 4
-
-          @links = response.headers['Link'].split(', ')
-        end
-
-        it 'should not give a link with rel "last"' do
-          expect(@links).not_to include('rel="last"')
-        end
+        before { get :index, :count => 100, :page => 4 }
 
-        it 'should not give a link with rel "next"' do
-          expect(@links).not_to include('rel="next"')
-        end
-
-        it 'should give a link with rel "first"' do
-          expect(@links).to include('<http://test.host/numbers?count=100&page=1>; rel="first"')
-        end
-
-        it 'should give a link with rel "prev"' do
-          expect(@links).to include('<http://test.host/numbers?count=100&page=3>; rel="prev"')
-        end
+        it_behaves_like 'an endpoint with a last page'
       end
 
       context 'when somewhere comfortably in the middle' do
-        it 'should give all pagination links' do
-          get :index, count: 100, page: 2
-
-          links = response.headers['Link'].split(', ')
+        before { get :index, :count => 100, :page => 2 }
 
-          expect(links).to include('<http://test.host/numbers?count=100&page=1>; rel="first"')
-          expect(links).to include('<http://test.host/numbers?count=100&page=4>; rel="last"')
-          expect(links).to include('<http://test.host/numbers?count=100&page=3>; rel="next"')
-          expect(links).to include('<http://test.host/numbers?count=100&page=1>; rel="prev"')
-        end
+        it_behaves_like 'an endpoint with a middle page'
       end
     end
   end

spec/support/numbers_controller.rb

@@ -52,9 +52,9 @@ def index
     total = params.fetch(:count).to_i
 
     if params[:with_headers]
-      query = request.query_parameters
+      query = request.query_parameters.dup
       query.delete(:with_headers)
-      headers['Link'] = %(<#{numbers_url}?#{query.to_param}>; rel="without") if params[:with_headers]
+      headers['Link'] = %(<#{numbers_url}?#{query.to_param}>; rel="without")
     end
 
     @numbers = PaginatedSet.new(page, 25, total)

spec/support/shared_examples/existing_headers.rb

@@ -0,0 +1,10 @@
+shared_examples 'an endpoint with existing Link headers' do
+  it 'should keep existing Links' do
+    expect(links).to include('<http://example.org/numbers?count=30>; rel="without"')
+  end
+
+  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"')
+  end
+end

spec/support/shared_examples/first_page.rb

@@ -0,0 +1,17 @@
+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"')
+  end
+
+  it 'should not give a link with rel "prev"' do
+    expect(links).not_to include('rel="prev"')
+  end
+
+  it 'should give a link with rel "last"' do
+    expect(links).to include('<http://example.org/numbers?count=100&page=4>; rel="last"')
+  end
+
+  it 'should give a link with rel "next"' do
+    expect(links).to include('<http://example.org/numbers?count=100&page=2>; rel="next"')
+  end
+end

spec/support/shared_examples/last_page.rb

@@ -0,0 +1,17 @@
+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"')
+  end
+
+  it 'should not give a link with rel "next"' do
+    expect(links).not_to include('rel="next"')
+  end
+
+  it 'should give a link with rel "first"' do
+    expect(links).to include('<http://example.org/numbers?count=100&page=1>; rel="first"')
+  end
+
+  it 'should give a link with rel "prev"' do
+    expect(links).to include('<http://example.org/numbers?count=100&page=3>; rel="prev"')
+  end
+end

spec/support/shared_examples/middle_page.rb

@@ -0,0 +1,8 @@
+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=3>; rel="next"')
+    expect(links).to include('<http://example.org/numbers?count=100&page=1>; rel="prev"')
+  end
+end