kaminari-rspec 0.14.1 → 0.16.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGZjNzljZTRkMjlkOTU1ZDUzNzgyMTk2M2IyZjEwMzMzYjhiYTNkZA==
-  data.tar.gz: !binary |-
-    MmNlMDM5ZTFiNjQyYTQ3MzUzODkyMTVkMjZkODU1M2U2YmQ4YzVhNw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YzJkYTY0ZmMwNzljNWI1MmQwMzExMTJhYjkzZjZmZmM0NzRlMmEzZGY3MjM0
-    MmFiMDM3M2U5ZGJiNDg0MWUyYjkzMTk0NjNjMzE0NzhjM2ZlNDEyNWI3N2Zj
-    ZDhkYWE0ZTQ4YTNlYjU5MGZkOTE1ODYyNDZmYjZiYzBkZTk3Yjk=
-  data.tar.gz: !binary |-
-    MTU5YjMwYjJhYzVlOTc4YzA3MTY4YTM4MWRlY2MwNmU4MWU2NWZiYmJhOGM5
-    OTc5MDQ3NWU4YTk4MjY2OTdjMDUxZDZiNTdjM2RjYWYyMmM5Njc2NzNmMDEy
-    MDQzMTRjMzcyYTY1ZTNjNjEwNmI5NzdjMzc0NGJkOWM3ZGRmZTg=
+SHA1:
+  metadata.gz: 56f7deeae8acd80adacd2543b50f4b9678b13946
+  data.tar.gz: 21176d5117f8185275cae357c2a8fd7f3399faeb
+SHA512:
+  metadata.gz: 60d6345a21f3b339f085cd33dadaa7a56c0ab5c2871b8858fc65dcd763163bf1f5714ff0b5243619e1d06d00fbe46876ea26ce223f8ebe31441f07f9ba64ef36
+  data.tar.gz: df7b7a4cdeee8d71258e3699022e761e002236bdf80c012e76b2b1b47e8922fd9c316a30b8b0387c8bb98c7e150fa73adca9b2e5c76144cdb320d0c35502aec3

data/.gitignore

@@ -1,4 +1,6 @@
 Gemfile.lock
 pkg
 .ruby-gemset
-.ruby-version
+.ruby-version
+doc
+.yardoc

data/README.md

@@ -6,7 +6,7 @@
 [![Build Status](https://travis-ci.org/nessche/kaminari-rspec.png)](https://travis-ci.org/nessche/kaminari-rspec)
 
 
-`kaminari-rspec` is a ruby gem that aims at simplifying writing the specs for views where Kaminari is used for pagination
+`kaminari-rspec` is a ruby gem that aims at simplifying writing the specs for views where [Kaminari](https://github.com/amatsuda/kaminari) is used for pagination
 
 ## Installing
 
@@ -26,9 +26,9 @@ to fork this repo and update the version and the code as needed.
 ## Rendering views with RSpec's render_view
 
 If you are rendering the views from your controller spec using render_views AND you are mocking
-the data returned from the db with something along the lines of
+the data returned from the db with something along the lines of (RSpec syntax)
 
-    Model.stub_chain(:order, :page, :per).and_return([model_mock])
+    allow(Model).to receive_message_chain(:order, :page, :per).and_return(model_mock)
 
 you may want to also stub the methods needed by the pagination partials, in order to do that, just
 add the following to your `spec_helper`
@@ -37,17 +37,23 @@ add the following to your `spec_helper`
 
 and then modify your controller spec to look like
 
-    Model.stub_chain(:order, :page, :per).and_return(stub_pagination([model_mock]))
+    allow(Model).to receive_message_chain(:order, :page, :per).and_return(stub_pagination(model_mock))
 
-the stubs will return the values needed to set the pagination as being on the first and only page.
+the stubs will return the values needed to set the pagination as being on the desired page, with the desired
+total page count (see options below how to set these parameters).
 
 ### Pagination options
 
-If specific pagination values are needed they can be defined using a hash. The following values are supported:
+If specific pagination values are needed they can be defined using a hash passed as the second parameter to method
+
+    stub_pagination(resource, options = {})
+
+The following values are supported:
 
 * `:total_count` : the total number of elements to be paginated. It defaults to `resource.length` if resource is a collection,
 otherwise to 1
-* `:per_page` : the amount of elements per page, defaults to 25
+* `:per_page` : the amount of elements per page, defaults to 25. If `resource` does not contain enough elements to fill
+on page, no padding will occur. If `resource` contains more elements, only the first ones needed to fill the page will be shown
 * `:current_page` : the current page of the pagination. Defaults to 1. Notice that `current_page` is anyway always
   set such that it respects the values passed in `total_count` and `per_page`, i.e. if you pass a
   total count of 95 and a per page value of 10, current page will be capped to 10
@@ -57,7 +63,8 @@ As an example
     stub_pagination(resource, :total_count => 50, :current_page => 3, :per_page => 10)
 
 will create the pagination links for a total count of 50 elements, with 10
-elements per page and page 3 being the current_page.
+elements per page and page 3 being the current_page. If `resource` contains more than 10
+elements, only the first 10 will be shown.
 
 ## Detecting mocking framework
 

data/kaminari-rspec.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |s|
 
 
   # specify any dependencies here; for example:
-  s.add_runtime_dependency 'kaminari', '0.14.1'
-  s.add_development_dependency 'rspec'
+  s.add_runtime_dependency 'kaminari', '~> 0.16'
+  s.add_development_dependency 'rspec', '~> 3'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'rr'

data/lib/kaminari_rspec/test_helpers.rb

@@ -1,39 +1,63 @@
+require 'kaminari'
+require 'kaminari/models/array_extension'
+
 module KaminariRspec
+
+
   module TestHelpers
 
+    # Stubs the paginations method on the resource passed.
+    #
+    # @param resource [Object] A single object or a collection of objects
+    # @param options [Hash] The options controlling the stub behaviour
+    # @option options [String] :mock the mocking framework to be used, defaults to automatic detection based on RSpec configuration
+    # @option options [Integer] :current_page the desired current page number. Defaults to 1
+    # @option options [Integer] :per_page the desired amount of elements per page. Defaults to 25
+    # @option options [Integer] :total_count the desired total amount of elements (used to calculate the last page link)
     def stub_pagination(resource, options={})
       return nil unless resource
+      options[:current_page] ||= 1
+      options[:per_page] ||= 25
       mock_framework = options[:mock] || discover_mock_framework
       values = calculate_values(resource, options)
+      wrapped_resource = wrap_resource(resource, options)
       case mock_framework
-        when :rspec then stub_pagination_with_rspec(resource, values)
-        when :rr then stub_pagination_with_rr(resource, values)
-        when :mocha then stub_pagination_with_mocha(resource, values)
-        when :flexmock then stub_pagination_with_flexmock(resource, values)
+        when :rspec then stub_pagination_with_rspec(wrapped_resource, values)
+        when :rr then stub_pagination_with_rr(wrapped_resource, values)
+        when :mocha then stub_pagination_with_mocha(wrapped_resource, values)
+        when :flexmock then stub_pagination_with_flexmock(wrapped_resource, values)
         when :nothing then resource
         else
           raise ArgumentError, "Invalid mock argument #{options[:mock]} / framework not supported"
       end
     end
 
+  private
+
     def discover_mock_framework
 
       mock_framework = RSpec.configuration.mock_framework
       return mock_framework.framework_name if mock_framework.respond_to? :framework_name
       puts('WARNING: Could not detect mocking framework, defaulting to :nothing, use :mock option to override')
-      return :nothing
+      :nothing
+
+    end
 
+    def wrap_resource(resource, options)
+      return resource if resource.respond_to? :total_count
+      wrappable = resource.respond_to?(:length) ? resource : [resource]
+      Kaminari::paginate_array(wrappable).page(1).per([wrappable.length, options[:per_page]].min)
     end
 
 
-    def calculate_values(resource, options={})
+    def calculate_values(resource, options)
 
       values = {}
       values[:total_count] = options[:total_count] || (resource.respond_to?(:length) ? resource.length : 1)
-      values[:limit_value] = options[:per_page] || 25
-      values[:total_pages] = (values[:total_count] / values[:limit_value]) + ((values[:total_count] % values[:limit_value]) == 0 ? 0 : 1)
-      values[:current_page] = [(options[:current_page] || 1), values[:total_pages]].min
-      return values
+      values[:limit] = options[:per_page]
+      values[:total_pages] = (values[:total_count] / values[:limit]) + ((values[:total_count] % values[:limit]) == 0 ? 0 : 1)
+      values[:current_page] = [options[:current_page], values[:total_pages]].min
+      values
     end
 
     def stub_pagination_with_rspec(resource, values)
@@ -42,7 +66,7 @@ module KaminariRspec
         allow(resource).to receive(key).and_return(value)
       end
 
-      return resource
+      resource
 
     end
 
@@ -52,7 +76,7 @@ module KaminariRspec
         eval "stub(resource).#{key} { #{value} }"
       end
 
-      return resource
+      resource
 
     end
 
@@ -62,7 +86,7 @@ module KaminariRspec
         resource.stubs(key).returns(value)
       end
 
-      return resource
+      resource
 
     end
 
@@ -74,7 +98,7 @@ module KaminariRspec
         mock.should_receive(key).zero_or_more_times.and_return(value)
       end
 
-      return mock
+      mock
 
     end
 

data/lib/kaminari_rspec/version.rb

@@ -1,3 +1,5 @@
 module KaminariRspec
-  VERSION = '0.14.1'
+
+  VERSION = '0.16.1'
+
 end

data/spec/lib/kaminari_rspec/flexmock/spec_helper_flexmock.rb

@@ -1,3 +1,4 @@
+require 'minitest/autorun'
 require 'flexmock'
 
 RSpec.configure do |config|

data/spec/lib/kaminari_rspec/rspec/spec_helper_rspec.rb

@@ -1,3 +1,8 @@
 RSpec.configure do |config|
   config.mock_framework = :rspec
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
 end

data/spec/lib/kaminari_rspec/rspec/test_helpers_spec.rb

@@ -40,6 +40,14 @@ describe 'KaminariRspec::TestHelpers::'  do
         discover_mock_framework.should == :rspec
       end
 
+      it 'should correctly mock the pagination' do
+        resource = [Object.new, Object.new]
+        stubbed_resource = stub_pagination(resource, total_count: 45, current_page: 3, per_page: 10)
+        expect(stubbed_resource.total_count).to eq(45)
+        expect(stubbed_resource.current_page).to eq(3)
+
+      end
+
     end
 
   end

data/spec/lib/kaminari_rspec/test_helpers_spec.rb

@@ -13,7 +13,7 @@ describe 'KaminariRspec::TestHelpers' do
 
         it 'sets total_count to 1' do
 
-          values = calculate_values(Object.new)
+          values = calculate_values(Object.new, current_page: 1, per_page: 25)
           values[:total_count].should == 1
 
         end
@@ -24,7 +24,7 @@ describe 'KaminariRspec::TestHelpers' do
 
         it 'sets total_count to the length of the object' do
 
-          values = calculate_values([ Object.new, Object.new])
+          values = calculate_values([ Object.new, Object.new], current_page: 1, per_page: 25)
           values[:total_count].should == 2
 
         end
@@ -38,51 +38,18 @@ describe 'KaminariRspec::TestHelpers' do
 
       it 'sets the total_count to the specified value' do
 
-        values = calculate_values(Object.new, :total_count => 13)
+        values = calculate_values(Object.new, current_page: 1, total_count: 13, per_page: 25)
         values[:total_count].should == 13
 
       end
 
     end
 
-    context 'when per_page is not specified' do
-
-      it 'set per_page to the default of 25' do
-
-        values = calculate_values(Object.new)
-        values[:limit_value].should == 25
-
-      end
-
-    end
-
-    context 'when per_page is specified' do
-
-      it 'sets limit_value to the specified value' do
-
-        values = calculate_values(Object.new, :per_page => 17)
-        values[:limit_value].should == 17
-
-      end
-
-    end
-
     it 'sets total_pages based on total_count and per_page' do
-      values = calculate_values(Object.new, :total_count => 50, :per_page => 25)
+      values = calculate_values(Object.new, current_page: 1, :total_count => 50, :per_page => 25)
       values[:total_pages].should == 2
     end
 
-    context 'when current_page is not specified' do
-
-      it 'set current_page to the default of 1' do
-
-        values = calculate_values(Object.new)
-        values[:current_page].should == 1
-
-      end
-
-    end
-
     context 'when current_page is specified' do
 
       context 'and the current_page value is <= num_pages'do
@@ -108,6 +75,7 @@ describe 'KaminariRspec::TestHelpers' do
       end
 
     end
+
   end
 
 

data/spec/spec_helper.rb

@@ -6,6 +6,10 @@ require 'rspec'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  config.color_enabled = true
-  config.formatter     = 'documentation'
+  config.color     = true
+  config.formatter = 'documentation'
+
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
 end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: kaminari-rspec
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.16.1
 platform: ruby
 authors:
 - Marco Sandrini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-18 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: flexmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A Rspec Helper library for the Kaminari gem
@@ -115,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - License.txt
 - README.md
@@ -145,17 +145,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Rspec Helper library for the Kaminari gem