kaminari 0.14.1 → 0.17.0

data/lib/kaminari/version.rb

@@ -1,3 +1,3 @@
 module Kaminari
-  VERSION = '0.14.1'
+  VERSION = '0.17.0'
 end

data/lib/kaminari.rb

@@ -10,15 +10,16 @@ end
 
 $stderr.puts <<-EOC if !defined?(Rails) && !defined?(Sinatra) && !defined?(Grape)
 warning: no framework detected.
-would you check out if your Gemfile appropriately configured?
+
+Your Gemfile might not be configured properly.
 ---- e.g. ----
-when Rails:
+Rails:
     gem 'kaminari'
 
-when Sinatra/Padrino:
+Sinatra/Padrino:
     gem 'kaminari', :require => 'kaminari/sinatra'
 
-when Grape:
+Grape:
     gem 'kaminari', :require => 'kaminari/grape'
 
 EOC

data/spec/config/config_spec.rb

@@ -73,4 +73,19 @@ describe Kaminari::Configuration do
       end
     end
   end
+
+  describe 'max_pages' do
+    context 'by default' do
+      its(:max_pages) { should == nil }
+    end
+    context 'configure via config block' do
+      before do
+        Kaminari.configure {|c| c.max_pages = 5}
+      end
+      its(:max_pages) { should == 5 }
+      after do
+        Kaminari.configure {|c| c.max_pages = nil}
+      end
+    end
+  end
 end

data/spec/fake_app/active_record/config.rb

@@ -1,3 +1,3 @@
 # database
 ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
-ActiveRecord::Base.establish_connection('test')
+ActiveRecord::Base.establish_connection :test

data/spec/fake_app/active_record/models.rb

@@ -10,7 +10,7 @@ class User < ActiveRecord::Base
     User.joins(:books_read => :authors).where(:authors_books => {:id => self})
   end
 
-  scope :by_name, order(:name)
+  scope :by_name, lambda { order(:name) }
   scope :by_read_count, lambda {
     cols = if connection.adapter_name == "PostgreSQL"
       column_names.map { |column| %{"users"."#{column}"} }.join(", ")
@@ -42,6 +42,13 @@ class User::Address < ActiveRecord::Base
   belongs_to :user
 end
 
+# a class that uses abstract class
+class Product < ActiveRecord::Base
+  self.abstract_class = true
+end
+class Device < Product
+end
+
 #migrations
 class CreateAllTables < ActiveRecord::Migration
   def self.up
@@ -51,6 +58,7 @@ class CreateAllTables < ActiveRecord::Migration
     create_table(:readerships) {|t| t.integer :user_id; t.integer :book_id }
     create_table(:authorships) {|t| t.integer :user_id; t.integer :book_id }
     create_table(:user_addresses) {|t| t.string :street; t.integer :user_id }
+    create_table(:devices) {|t| t.string :name; t.integer :age}
   end
 end
 ActiveRecord::Migration.verbose = false

data/spec/fake_app/mongo_mapper/config.rb

@@ -1,2 +1,2 @@
-MongoMapper.connection = Mongo::Connection.new 'localhost', 27017
+MongoMapper.connection = Mongo::Connection.new '0.0.0.0', 27017
 MongoMapper.database = 'kaminari_test'

data/spec/fake_app/mongoid/config.rb

@@ -3,13 +3,17 @@
 # Psych does not yet support YAML 1.1 merge keys.
 # Merge keys is often used in mongoid.yml
 # See: http://redmine.ruby-lang.org/issues/show/4300
-if RUBY_VERSION >= '1.9.2'
+require 'mongoid/version'
+
+if RUBY_VERSION >= '1.9.2' && RUBY_VERSION < '2.2.0'
   YAML::ENGINE.yamler = 'syck'
 end
 
 Mongoid.configure do |config|
-  if Mongoid::VERSION =~ /^3/
-    config.sessions = {:default => {:hosts => ['localhost:27017'], :database => 'kaminari_test'}}
+  if Mongoid::VERSION >= '5.0.0'
+    config.connect_to 'kaminari_test'
+  elsif Mongoid::VERSION > '3.0.0'
+    config.sessions = {:default => {:hosts => ['0.0.0.0:27017'], :database => 'kaminari_test'}}
   else
     config.master = Mongo::Connection.new.db('kaminari_test')
   end

data/spec/fake_app/mongoid/models.rb

@@ -1,5 +1,9 @@
 class User
   include ::Mongoid::Document
+  if Mongoid::VERSION >= '4.0.0'
+    include Mongoid::Attributes::Dynamic
+  end
+
   field :name, :type => String
   field :age, :type => Integer
 end
@@ -8,6 +12,18 @@ class User::Address
   include ::Mongoid::Document
 end
 
+class Product
+  include ::Mongoid::Document
+end
+
+class Device < Product
+  paginates_per 100
+end
+
+class Android < Device
+  paginates_per 200
+end
+
 class MongoMongoidExtensionDeveloper
   include ::Mongoid::Document
   field :salary, :type => Integer

data/spec/fake_app/rails_app.rb

@@ -11,6 +11,7 @@ app = Class.new(Rails::Application)
 app.config.secret_token = '3b7cd727ee24e8444053437c36cc66c4'
 app.config.session_store :cookie_store, :key => '_myapp_session'
 app.config.active_support.deprecation = :log
+app.config.eager_load = false
 # Rais.root
 app.config.root = File.dirname(__FILE__)
 Rails.backtrace_cleaner.remove_silencers!

data/spec/fake_app/views/alternative/kaminari/_first_page.html.erb

@@ -0,0 +1 @@
+<b><%= current_page %></b>

data/spec/fake_app/views/alternative/kaminari/_paginator.html.erb

@@ -0,0 +1,3 @@
+<%= paginator.render do -%>
+  <%= first_page_tag %>
+<% end -%>

data/spec/fake_app/views/kaminari/bootstrap/_page.html.erb

@@ -0,0 +1 @@
+<li class="bootstrap-page-link"><%= link_to page, url %></li>

data/spec/fake_app/views/kaminari/bootstrap/_paginator.html.erb

@@ -0,0 +1,7 @@
+<div class="bootstrap-paginator">
+<%= paginator.render do -%>
+<%    each_page do |page| %>
+<%=     page_tag(page) -%>
+<%    end %>
+<%  end %>
+</div>

data/spec/fake_gem.rb

@@ -1,4 +1,20 @@
-# Simulate a gem providing a subclass of ActiveRecord::Base before the Railtie is loaded.
+module Kaminari
+  module FakeGem
+    extend ActiveSupport::Concern
 
-class GemDefinedModel < ActiveRecord::Base
+    module ClassMethods
+      def inherited(kls)
+        super
+        def kls.fake_gem_defined_method; end
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::Base.send :include, Kaminari::FakeGem
+
+  # Simulate a gem providing a subclass of ActiveRecord::Base before the Railtie is loaded.
+  class GemDefinedModel < ActiveRecord::Base
+  end
 end

data/spec/generators/views_generator_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+if defined?(Rails)
+  require 'rails/generators'
+  require 'generators/kaminari/views_generator'
+
+  describe Kaminari::Generators::GitHubApiHelper, :generator_spec => true do
+    describe '.get_files_in_master' do
+      subject { Kaminari::Generators::GitHubApiHelper.get_files_in_master }
+      it { should include(["README", "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"]) }
+    end
+
+    describe '.get_content_for' do
+      subject { Kaminari::Generators::GitHubApiHelper.get_content_for("README") }
+      it { should == "" }
+    end
+  end
+end

data/spec/helpers/action_view_extension_spec.rb

@@ -1,11 +1,12 @@
 require 'spec_helper'
 
-describe 'Kaminari::ActionViewExtension' do
+describe 'Kaminari::ActionViewExtension', :if => defined?(Rails)do
   describe '#paginate' do
     before do
       50.times {|i| User.create! :name => "user#{i}"}
       @users = User.page(1)
     end
+
     subject { helper.paginate @users, :params => {:controller => 'users', :action => 'index'} }
     it { should be_a String }
 
@@ -14,30 +15,53 @@ describe 'Kaminari::ActionViewExtension' do
         lambda { helper.escape_javascript(helper.paginate @users, :params => {:controller => 'users', :action => 'index'}) }.should_not raise_error
       end
     end
+
+    context 'accepts :theme option' do
+      before { helper.controller.append_view_path "spec/fake_app/views" }
+      subject { helper.paginate @users, :theme => "bootstrap", :params => {:controller => 'users', :action => 'index'} }
+      it { should match(/bootstrap-paginator/) }
+      it { should match(/bootstrap-page-link/) }
+    end
+
+    context 'accepts :view_prefix option' do
+      before { helper.controller.append_view_path "spec/fake_app/views" }
+      subject { helper.paginate @users, :views_prefix => "alternative/", :params => {:controller => 'users', :action => 'index'} }
+      it { should eq("  <b>1</b>\n") }
+    end
+
+    context "num_pages: 3" do
+      subject { helper.paginate @users, :num_pages => 3, :params => {:controller => 'users', :action => 'index'} }
+      it { should match(/<a href="\/users\?page=3">Last/) }
+    end
   end
 
   describe '#link_to_previous_page' do
     before do
       50.times {|i| User.create! :name => "user#{i}"}
     end
+
     context 'having previous pages' do
       before do
         @users = User.page(50)
       end
+
       context 'the default behaviour' do
         subject { helper.link_to_previous_page @users, 'Previous', :params => {:controller => 'users', :action => 'index'} }
         it { should be_a String }
         it { should match(/rel="previous"/) }
       end
+
       context 'overriding rel=' do
         subject { helper.link_to_previous_page @users, 'Previous', :rel => 'external', :params => {:controller => 'users', :action => 'index'} }
         it { should match(/rel="external"/) }
       end
     end
+
     context 'the first page' do
       before do
         @users = User.page(1)
       end
+
       subject { helper.link_to_previous_page @users, 'Previous', :params => {:controller => 'users', :action => 'index'} }
       it { should_not be }
     end
@@ -47,24 +71,29 @@ describe 'Kaminari::ActionViewExtension' do
     before do
       50.times {|i| User.create! :name => "user#{i}"}
     end
+
     context 'having more page' do
       before do
         @users = User.page(1)
       end
+
       context 'the default behaviour' do
         subject { helper.link_to_next_page @users, 'More', :params => {:controller => 'users', :action => 'index'} }
         it { should be_a String }
         it { should match(/rel="next"/) }
       end
+
       context 'overriding rel=' do
         subject { helper.link_to_next_page @users, 'More', :rel => 'external', :params => {:controller => 'users', :action => 'index'} }
         it { should match(/rel="external"/) }
       end
     end
+
     context 'the last page' do
       before do
         @users = User.page(2)
       end
+
       subject { helper.link_to_next_page @users, 'More', :params => {:controller => 'users', :action => 'index'} }
       it { should_not be }
     end
@@ -75,9 +104,10 @@ describe 'Kaminari::ActionViewExtension' do
       before do
         @users = User.page(1).per(25)
       end
+
       context 'having no entries' do
         subject { helper.page_entries_info @users, :params => {:controller => 'users', :action => 'index'} }
-        it      { should == 'No entries found' }
+        it      { should == 'No users found' }
 
         context 'setting the entry name option to "member"' do
           subject { helper.page_entries_info @users, :entry_name => 'member', :params => {:controller => 'users', :action => 'index'} }
@@ -90,6 +120,7 @@ describe 'Kaminari::ActionViewExtension' do
           User.create! :name => 'user1'
           @users = User.page(1).per(25)
         end
+
         subject { helper.page_entries_info @users, :params => {:controller => 'users', :action => 'index'} }
         it      { should == 'Displaying <b>1</b> user' }
 
@@ -104,6 +135,7 @@ describe 'Kaminari::ActionViewExtension' do
           10.times {|i| User.create! :name => "user#{i}"}
           @users = User.page(1).per(25)
         end
+
         subject { helper.page_entries_info @users, :params => {:controller => 'users', :action => 'index'} }
         it      { should == 'Displaying <b>all 10</b> users' }
 
@@ -122,6 +154,7 @@ describe 'Kaminari::ActionViewExtension' do
           before do
             @users = User.page(1).per(25)
           end
+
           subject { helper.page_entries_info @users, :params => {:controller => 'users', :action => 'index'} }
           it      { should == 'Displaying users <b>1&nbsp;-&nbsp;25</b> of <b>50</b> in total' }
 
@@ -135,6 +168,7 @@ describe 'Kaminari::ActionViewExtension' do
           before do
             @users = User.page(2).per(25)
           end
+
           subject { helper.page_entries_info @users, :params => {:controller => 'users', :action => 'index'} }
           it      { should == 'Displaying users <b>26&nbsp;-&nbsp;50</b> of <b>50</b> in total' }
 
@@ -143,15 +177,28 @@ describe 'Kaminari::ActionViewExtension' do
             it      { should == 'Displaying members <b>26&nbsp;-&nbsp;50</b> of <b>50</b> in total' }
           end
         end
+
+        describe 'the last page' do
+          before do
+            User.max_pages_per 4
+            @users = User.page(4).per(10)
+          end
+
+          after { User.max_pages_per nil }
+
+          subject { helper.page_entries_info @users, :params => {:controller => 'users', :action => 'index'} }
+          it      { should == 'Displaying users <b>31&nbsp;-&nbsp;40</b> of <b>50</b> in total' }
+        end
       end
     end
     context 'on a model with namespace' do
       before do
         @addresses = User::Address.page(1).per(25)
       end
+
       context 'having no entries' do
         subject { helper.page_entries_info @addresses, :params => {:controller => 'addresses', :action => 'index'} }
-        it      { should == 'No entries found' }
+        it      { should == 'No addresses found' }
       end
 
       context 'having 1 entry' do
@@ -159,6 +206,7 @@ describe 'Kaminari::ActionViewExtension' do
           User::Address.create!
           @addresses = User::Address.page(1).per(25)
         end
+
         subject { helper.page_entries_info @addresses, :params => {:controller => 'addresses', :action => 'index'} }
         it      { should == 'Displaying <b>1</b> address' }
 
@@ -173,6 +221,7 @@ describe 'Kaminari::ActionViewExtension' do
           10.times {|i| User::Address.create!}
           @addresses = User::Address.page(1).per(25)
         end
+
         subject { helper.page_entries_info @addresses, :params => {:controller => 'addresses', :action => 'index'} }
         it      { should == 'Displaying <b>all 10</b> addresses' }
 
@@ -191,6 +240,7 @@ describe 'Kaminari::ActionViewExtension' do
           before do
             @addresses = User::Address.page(1).per(25)
           end
+
           subject { helper.page_entries_info @addresses, :params => {:controller => 'addresses', :action => 'index'} }
           it      { should == 'Displaying addresses <b>1&nbsp;-&nbsp;25</b> of <b>50</b> in total' }
 
@@ -204,6 +254,7 @@ describe 'Kaminari::ActionViewExtension' do
           before do
             @addresses = User::Address.page(2).per(25)
           end
+
           subject { helper.page_entries_info @addresses, :params => {:controller => 'addresses', :action => 'index'} }
           it      { should == 'Displaying addresses <b>26&nbsp;-&nbsp;50</b> of <b>50</b> in total' }
 
@@ -219,6 +270,7 @@ describe 'Kaminari::ActionViewExtension' do
       before do
         @numbers = Kaminari.paginate_array(%w{one two three}).page(1)
       end
+
       subject { helper.page_entries_info @numbers }
       it      { should == 'Displaying <b>all 3</b> entries' }
     end
@@ -226,37 +278,41 @@ describe 'Kaminari::ActionViewExtension' do
 
   describe '#rel_next_prev_link_tags' do
     before do
-      75.times {|i| User.create! :name => "user#{i}"}
+      80.times {|i| User.create! :name => "user#{i}"}
     end
+
     context 'the first page' do
       before do
         @users = User.page(1).per(25)
       end
 
       subject { helper.rel_next_prev_link_tags @users, :params => {:controller => 'users', :action => 'index'} }
-      it { should be_a String }
-      it { should match(/rel="next"/) }
       it { should_not match(/rel="prev"/) }
+      it { should match(/rel="next"/) }
+      it { should match(/\?page=2/) }
     end
+
     context 'the middle page' do
       before do
-        @users = User.page(2).per(25)
+        @users = User.page(3).per(25)
       end
 
       subject { helper.rel_next_prev_link_tags @users, :params => {:controller => 'users', :action => 'index'} }
-      it { should be_a String }
-      it { should match(/rel="next"/) }
       it { should match(/rel="prev"/) }
+      it { should match(/\?page=2/) }
+      it { should match(/rel="next"/) }
+      it { should match(/\?page=4/) }
     end
+
     context 'the last page' do
       before do
-        @users = User.page(3).per(25)
+        @users = User.page(4).per(25)
       end
 
       subject { helper.rel_next_prev_link_tags @users, :params => {:controller => 'users', :action => 'index'} }
-      it { should be_a String }
-      it { should_not match(/rel="next"/) }
       it { should match(/rel="prev"/) }
+      it { should match(/\?page=3"/) }
+      it { should_not match(/rel="next"/) }
     end
   end
 end

data/spec/helpers/helpers_spec.rb

@@ -8,10 +8,19 @@ describe 'Kaminari::Helpers::Paginator' do
       params { {} }
       options { {} }
       url_for {|h| "/foo?page=#{h[:page]}"}
+      link_to { "<a href='#'>link</a>" }
     end
     r
   end
 
+  describe "view helper methods delegated to template" do
+    before do
+      @paginator = Paginator.new(template, :params => {})
+    end
+    subject { @paginator.link_to("link", "#") }
+    it { should == "<a href='#'>link</a>" }
+  end
+
   describe '#params' do
     before do
       @paginator = Paginator.new(template, :params => {:controller => 'foo', :action => 'bar'})

data/spec/helpers/sinatra_helpers_spec.rb

@@ -12,6 +12,17 @@ if defined? Sinatra
   </div>
 EOT
 
+  ERB_TEMPLATE_FOR_PREVIOUS_PAGE = <<EOT
+  <div>
+  <ul>
+  <% @users.each do |user| %>
+    <li class="user_info"><%= user.id %></li>
+  <% end %>
+  </ul>
+  <%= link_to_previous_page(@users, "Previous!", {:id => 'previous_page_link'}.merge(@options || {})) %>
+  </div>
+EOT
+
   ERB_TEMPLATE_FOR_NEXT_PAGE = <<EOT
   <div>
   <ul>
@@ -125,6 +136,48 @@ EOT
       end
     end
 
+    describe '#link_to_previous_page' do
+      before do
+        mock_app do
+          register Kaminari::Helpers::SinatraHelpers
+          get '/users' do
+            @page = params[:page] || 2
+            @users = User.page(@page)
+            erb ERB_TEMPLATE_FOR_PREVIOUS_PAGE
+          end
+
+          get '/users_placeholder' do
+            @page = params[:page] || 2
+            @options = {:placeholder => %{<span id='no_previous_page'>No Previous Page</span>}}
+            @users = User.page(@page)
+            erb ERB_TEMPLATE_FOR_PREVIOUS_PAGE
+          end
+        end
+      end
+
+      context 'having more page' do
+        it 'should have a more page link' do
+          get '/users'
+          last_document.search('a#previous_page_link').should be_present
+          last_document.search('a#previous_page_link').text.should match(/Previous!/)
+        end
+      end
+
+      context 'the first page' do
+        it 'should not have a more page link' do
+          get '/users?page=1'
+          last_document.search('a#previous_page_link').should be_empty
+        end
+
+        it 'should have a no more page notation using placeholder' do
+          get '/users_placeholder?page=1'
+          last_document.search('a#previous_page_link').should be_empty
+          last_document.search('span#no_previous_page').should be_present
+          last_document.search('span#no_previous_page').text.should match(/No Previous Page/)
+        end
+      end
+    end
+
     describe '#link_to_next_page' do
       before do
         mock_app do

data/spec/models/active_record/active_record_relation_methods_spec.rb

@@ -14,15 +14,62 @@ if defined? ActiveRecord
         @books.each {|book| book.readers << @readers }
       end
 
+      context "when the scope is cloned" do
+        it "should reset total_coount momoization" do
+          User.page.tap(&:total_count).where(:name => 'author').total_count.should == 1
+        end
+      end
+
       context "when the scope includes an order which references a generated column" do
         it "should successfully count the results" do
           @author.readers.by_read_count.page(1).total_count.should == @readers.size
         end
       end
+
       context "when the scope use conditions on includes" do
         it "should keep includes and successfully count the results" do
           # Only @author and @author2 have books titled with the title00x partern
-          User.includes(:books_authored).where("books.title LIKE 'title00%'").page(1).total_count.should == 2
+          if ActiveRecord::VERSION::STRING >= "4.1.0"
+            User.includes(:books_authored).references(:books).where("books.title LIKE 'title00%'").page(1).total_count.should == 2
+          else
+            User.includes(:books_authored).where("books.title LIKE 'title00%'").page(1).total_count.should == 2
+          end
+        end
+      end
+
+      context 'when the Relation has custom select clause' do
+        specify do
+          lambda { User.select('*, 1 as one').page(1).total_count }.should_not raise_exception
+        end
+      end
+
+      context "when total_count receives options" do
+        it "should return a distinct total count for rails < 4.1" do
+          if ActiveRecord::VERSION::STRING < "4.1.0"
+            User.page(1).total_count(:name, :distinct => true).should == 4
+          end
+        end
+
+        it "should ignore the options for rails 4.1+" do
+          if ActiveRecord::VERSION::STRING >= "4.1.0"
+            User.page(1).total_count(:name, :distinct => true).should == 7
+          end
+        end
+      end
+
+      if ActiveRecord::VERSION::STRING < '4.1.0'
+        context 'when count receives options' do
+          it 'should return a distinct set by column for rails < 4.1' do
+            User.page(1).count(:name, :distinct => true).should == 4
+          end
+        end
+      end
+
+      context "when the scope returns an ActiveSupport::OrderedHash" do
+        it "should not throw exception by passing options to count" do
+          lambda {
+            @author.readers.by_read_count.page(1).total_count(:name, :distinct => true)
+          }.should_not raise_exception
         end
       end
     end

data/spec/models/active_record/inherited_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+if defined? ActiveRecord
+  describe Kaminari::ActiveRecordModelExtension do
+    subject { Class.new(ActiveRecord::Base) }
+    it { should respond_to :page }
+    it { should respond_to :fake_gem_defined_method }
+  end
+end