kaminari 0.12.4 → 0.13.0

data/lib/kaminari/models/mongo_mapper_extension.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'plucky_criteria_methods')
+require 'kaminari/models/plucky_criteria_methods'
 
 module Kaminari
   module MongoMapperExtension
@@ -9,10 +9,10 @@ module Kaminari
       included do
         # Fetch the values at the specified page number
         #   Model.page(5)
-        scope :page, Proc.new {|num|
+        scope Kaminari.config.page_method_name, Proc.new {|num|
           limit(default_per_page).offset(default_per_page * ([num.to_i, 1].max - 1))
         }
       end
     end
   end
-end
+end

data/lib/kaminari/models/mongoid_criteria_methods.rb

@@ -1,17 +1,22 @@
 module Kaminari
   module MongoidCriteriaMethods
-    extend ActiveSupport::Concern
-    module InstanceMethods
-      def limit_value #:nodoc:
-        options[:limit]
-      end
+    def limit_value #:nodoc:
+      options[:limit]
+    end
 
-      def offset_value #:nodoc:
-        options[:skip]
-      end
+    def offset_value #:nodoc:
+      options[:skip]
+    end
+
+    def total_count #:nodoc:
+      embedded? ? unpage.count : count
+    end
 
-      def total_count #:nodoc:
-        count
+    private
+    def unpage
+      clone.tap do |crit|
+        crit.options.delete :limit
+        crit.options.delete :skip
       end
     end
   end

data/lib/kaminari/models/mongoid_extension.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'mongoid_criteria_methods')
+require 'kaminari/models/mongoid_criteria_methods'
 
 module Kaminari
   module MongoidExtension
@@ -6,9 +6,11 @@ module Kaminari
       extend ActiveSupport::Concern
 
       included do
-        def page(*args)
-          self.klass.page(*args).criteria.merge(self)
-        end
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{Kaminari.config.page_method_name}(*args)
+            super(*args).criteria.merge(self)
+          end
+        RUBY
       end
     end
 
@@ -19,7 +21,7 @@ module Kaminari
       included do
         # Fetch the values at the specified page number
         #   Model.page(5)
-        scope :page, Proc.new {|num|
+        scope Kaminari.config.page_method_name, Proc.new {|num|
           limit(default_per_page).offset(default_per_page * ([num.to_i, 1].max - 1))
         } do
           include Kaminari::MongoidCriteriaMethods

data/lib/kaminari/models/page_scope_methods.rb

@@ -1,36 +1,37 @@
 module Kaminari
   module PageScopeMethods
-    extend ActiveSupport::Concern
-    module InstanceMethods
-      # Specify the <tt>per_page</tt> value for the preceding <tt>page</tt> scope
-      #   Model.page(3).per(10)
-      def per(num)
-        if (n = num.to_i) <= 0
-          self
-        else
-          limit(n).offset(offset_value / limit_value * n)
-        end
+    # Specify the <tt>per_page</tt> value for the preceding <tt>page</tt> scope
+    #   Model.page(3).per(10)
+    def per(num)
+      if (n = num.to_i) <= 0
+        self
+      else
+        limit(n).offset(offset_value / limit_value * n)
       end
+    end
 
-      # Total number of pages
-      def num_pages
-        (total_count.to_f / limit_value).ceil
-      end
+    def padding(num)
+      offset(offset_value + num.to_i)
+    end
 
-      # Current page number
-      def current_page
-        (offset_value / limit_value) + 1
-      end
+    # Total number of pages
+    def num_pages
+      (total_count.to_f / limit_value).ceil
+    end
 
-      # First page of the collection ?
-      def first_page?
-        current_page == 1
-      end
+    # Current page number
+    def current_page
+      (offset_value / limit_value) + 1
+    end
 
-      # Last page of the collection?
-      def last_page?
-        current_page >= num_pages
-      end
+    # First page of the collection ?
+    def first_page?
+      current_page == 1
+    end
+
+    # Last page of the collection?
+    def last_page?
+      current_page >= num_pages
     end
   end
 end

data/lib/kaminari/models/plucky_criteria_methods.rb

@@ -1,18 +1,15 @@
 module Kaminari
   module PluckyCriteriaMethods
-    extend ActiveSupport::Concern
-    module InstanceMethods
-      def limit_value #:nodoc:
-        options[:limit]
-      end
+    def limit_value #:nodoc:
+      options[:limit]
+    end
 
-      def offset_value #:nodoc:
-        options[:skip]
-      end
+    def offset_value #:nodoc:
+      options[:skip]
+    end
 
-      def total_count #:nodoc:
-        count
-      end
+    def total_count #:nodoc:
+      count
     end
   end
-end
+end

data/lib/kaminari/railtie.rb

@@ -1,36 +1,7 @@
-require 'rails'
-# ensure ORMs are loaded *before* initializing Kaminari
-begin; require 'mongoid'; rescue LoadError; end
-begin; require 'mongo_mapper'; rescue LoadError; end
-
-require File.join(File.dirname(__FILE__), 'config')
-require File.join(File.dirname(__FILE__), 'helpers/action_view_extension')
-require File.join(File.dirname(__FILE__), 'helpers/paginator')
-require File.join(File.dirname(__FILE__), 'models/page_scope_methods')
-require File.join(File.dirname(__FILE__), 'models/configuration_methods')
-
 module Kaminari
   class Railtie < ::Rails::Railtie #:nodoc:
     initializer 'kaminari' do |app|
-      ActiveSupport.on_load(:active_record) do
-        require File.join(File.dirname(__FILE__), 'models/active_record_extension')
-        ::ActiveRecord::Base.send :include, Kaminari::ActiveRecordExtension
-      end
-      if defined? ::Mongoid
-        require File.join(File.dirname(__FILE__), 'models/mongoid_extension')
-        ::Mongoid::Document.send :include, Kaminari::MongoidExtension::Document
-        ::Mongoid::Criteria.send :include, Kaminari::MongoidExtension::Criteria
-      end
-      if defined? ::MongoMapper
-        require File.join(File.dirname(__FILE__), 'models/mongo_mapper_extension')
-        ::MongoMapper::Document.send :include, Kaminari::MongoMapperExtension::Document
-        ::Plucky::Query.send :include, Kaminari::PluckyCriteriaMethods
-        ::Plucky::Query.send :include, Kaminari::PageScopeMethods
-      end
-      require File.join(File.dirname(__FILE__), 'models/array_extension')
-      ActiveSupport.on_load(:action_view) do
-        ::ActionView::Base.send :include, Kaminari::ActionViewExtension
-      end
+      Kaminari::Hooks.init!
     end
   end
-end
+end

data/lib/kaminari/sinatra.rb

@@ -0,0 +1,13 @@
+begin
+  require 'sinatra/base'
+rescue LoadError
+  raise LoadError, "couldn't load `sinatra/base`, check out if appropriately bundled sinatra gem?"
+end
+
+require 'kaminari'
+module Kaminari::Helpers
+end
+require 'kaminari/helpers/sinatra_helpers'
+
+Kaminari::Hooks.init!
+

data/lib/kaminari/version.rb

@@ -1,3 +1,3 @@
 module Kaminari
-  VERSION = '0.12.4'
+  VERSION = '0.13.0'
 end

data/spec/config/config_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', File.dirname(__FILE__))
+require 'spec_helper'
 
 describe Kaminari::Configuration do
   subject { Kaminari.config }

data/spec/fake_app.rb

@@ -53,6 +53,9 @@ class Book < ActiveRecord::Base
   has_many :authors, :through => :authorships, :source => :user
   has_many :readers, :through => :readerships, :source => :user
 end
+# a model that is a descendant of AR::Base but doesn't directly inherit AR::Base
+class Admin < User
+end
 
 # controllers
 class ApplicationController < ActionController::Base; end
@@ -72,6 +75,7 @@ Object.const_set(:ApplicationHelper, Module.new)
 #migrations
 class CreateAllTables < ActiveRecord::Migration
   def self.up
+    create_table(:gem_defined_models) { |t| t.string :name; t.integer :age }
     create_table(:users) {|t| t.string :name; t.integer :age}
     create_table(:books) {|t| t.string :title}
     create_table(:readerships) {|t| t.integer :user_id; t.integer :book_id }

data/spec/fake_gem.rb

@@ -0,0 +1,6 @@
+# Simulate a gem providing a subclass of ActiveRecord::Base before the Railtie is loaded.
+
+require 'active_record'
+
+class GemDefinedModel < ActiveRecord::Base
+end

data/spec/helpers/action_view_extension_spec.rb

@@ -1,19 +1,114 @@
-require File.expand_path('../spec_helper', File.dirname(__FILE__))
-include Kaminari::ActionViewExtension
+require 'spec_helper'
 
 describe 'Kaminari::ActionViewExtension' do
   describe '#paginate' do
     before do
-      @author = User.create! :name => 'author'
-      @books = 2.times.map { @author.books_authored.create! }
-      @books = Book.page(1)
+      50.times {|i| User.create! :name => "user#{i}"}
+      @users = User.page(1)
     end
-    subject { paginate( @books ) }
-    it { should be_a(String) }
+    subject { helper.paginate @users, :params => {:controller => 'users', :action => 'index'} }
+    it { should be_a String }
 
-    context "escaping the pagination for javascript" do
-      it "should escape for javascript" do
-        lambda { escape_javascript( paginate( @books ) ) }.should_not raise_error
+    context 'escaping the pagination for javascript' do
+      it 'should escape for javascript' do
+        lambda { escape_javascript(helper.paginate @users, :params => {:controller => 'users', :action => 'index'}) }.should_not raise_error
+      end
+    end
+  end
+
+  describe '#link_to_next_page' 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
+  end
+
+  describe '#page_entries_info' 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' }
+    end
+
+    context 'having 1 entry' do
+      before do
+        User.create!
+        @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' }
+
+      context 'setting the entry name option to "member"' do
+        subject { helper.page_entries_info @users, :entry_name => 'member', :params => {:controller => 'users', :action => 'index'} }
+        it      { should == 'Displaying <b>1</b> member' }
+      end
+    end
+
+    context 'having more than 1 but less than a page of entries' do
+      before do
+        10.times {|i| User.create!}
+        @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' }
+
+      context 'setting the entry name option to "member"' do
+        subject { helper.page_entries_info @users, :entry_name => 'member', :params => {:controller => 'users', :action => 'index'} }
+        it      { should == 'Displaying <b>all 10</b> members' }
+      end
+    end
+
+    context 'having more than one page of entries' do
+      before do
+        50.times {|i| User.create!}
+      end
+
+      describe 'the first page' 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' }
+
+        context 'setting the entry name option to "member"' do
+          subject { helper.page_entries_info @users, :entry_name => 'member', :params => {:controller => 'users', :action => 'index'} }
+          it      { should == 'Displaying members <b>1&nbsp;-&nbsp;25</b> of <b>50</b> in total' }
+        end
+      end
+
+      describe 'the next page' 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' }
+
+        context 'setting the entry name option to "member"' do
+          subject { helper.page_entries_info @users, :entry_name => 'member', :params => {:controller => 'users', :action => 'index'} }
+          it      { should == 'Displaying members <b>26&nbsp;-&nbsp;50</b> of <b>50</b> in total' }
+        end
       end
     end
   end

data/spec/helpers/helpers_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', File.dirname(__FILE__))
+require 'spec_helper'
 include Kaminari::Helpers
 
 describe 'Kaminari::Helpers::Paginator' do

data/spec/helpers/sinatra_helpers_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+require 'spec_helper_for_sinatra'
+
+ERB_TEMPLATE_FOR_PAGINATE = <<EOT
+<div>
+<ul>
+<% @users.each do |user| %>
+  <li class="user_info"><%= user.id %></li>
+<% end %>
+</ul>
+<%= paginate @users, @options %>
+</div>
+EOT
+
+ERB_TEMPLATE_FOR_NEXT_PAGE = <<EOT
+<div>
+<ul>
+<% @users.each do |user| %>
+  <li class="user_info"><%= user.id %></li>
+<% end %>
+</ul>
+<%= link_to_next_page(@users, "Next!", {:id => 'next_page_link'}.merge(@options || {})) %>
+</div>
+EOT
+
+describe 'Kaminari::Helpers::SinatraHelper' do
+  before do
+    50.times {|i| User.create! :name => "user#{i}"}
+  end
+
+  describe '#paginate' do
+    before do
+      mock_app do
+        register Kaminari::Helpers::SinatraHelpers
+        get '/users' do
+          @page = params[:page] || 1
+          @users = User.page(@page)
+          @options = {}
+          erb ERB_TEMPLATE_FOR_PAGINATE
+        end
+      end
+    end
+
+    context 'normal paginations with Sinatra' do
+      before { get '/users' }
+
+      it 'should have a navigation tag' do
+        last_document.search('nav.pagination').should_not be_empty
+      end
+
+      it 'should have pagination links' do
+        last_document.search('.page a').should have_at_least(1).items
+        last_document.search('.next a').should have_at_least(1).items
+        last_document.search('.last a').should have_at_least(1).items
+      end
+
+      it 'should point to current page' do
+        last_document.search('.current').text.should match /1/
+
+        get '/users?page=2'
+        last_document.search('.current').text.should match /2/
+      end
+
+      it 'should load 25 users' do
+        last_document.search('li.user_info').should have(25).items
+      end
+
+      it 'should preserve params' do
+        get '/users?foo=bar'
+        last_document.search('.page a').should(be_all do |elm|
+          elm.attribute('href').value =~ /foo=bar/
+        end)
+      end
+    end
+
+    context 'optional paginations with Sinatra' do
+      it 'should have 5 windows with 1 gap' do
+        mock_app do
+          register Kaminari::Helpers::SinatraHelpers
+          get '/users' do
+            @page = params[:page] || 1
+            @users = User.page(@page).per(5)
+            @options = {}
+            erb ERB_TEMPLATE_FOR_PAGINATE
+          end
+        end
+
+        get '/users'
+        last_document.search('.page').should have(6).items
+        last_document.search('.gap').should have(1).item
+      end
+
+      it 'should controll the inner window size' do
+        mock_app do
+          register Kaminari::Helpers::SinatraHelpers
+          get '/users' do
+            @page = params[:page] || 1
+            @users = User.page(@page).per(3)
+            @options = {:window => 10}
+            erb ERB_TEMPLATE_FOR_PAGINATE
+          end
+        end
+
+        get '/users'
+        last_document.search('.page').should have(12).items
+        last_document.search('.gap').should have(1).item
+      end
+
+      it 'should specify a page param name' do
+        mock_app do
+          register Kaminari::Helpers::SinatraHelpers
+          get '/users' do
+            @page = params[:page] || 1
+            @users = User.page(@page).per(3)
+            @options = {:param_name => :user_page}
+            erb ERB_TEMPLATE_FOR_PAGINATE
+          end
+        end
+
+        get '/users'
+        last_document.search('.page a').should(be_all do |elm|
+          elm.attribute('href').value =~ /user_page=\d+/
+        end)
+      end
+    end
+  end
+
+  describe '#link_to_next_page' do
+    before do
+      mock_app do
+        register Kaminari::Helpers::SinatraHelpers
+        get '/users' do
+          @page = params[:page] || 1
+          @users = User.page(@page)
+          erb ERB_TEMPLATE_FOR_NEXT_PAGE
+        end
+
+        get '/users_placeholder' do
+          @page = params[:page] || 1
+          @options = {:placeholder => %{<span id='no_next_page'>No Next Page</span>}}
+          @users = User.page(@page)
+          erb ERB_TEMPLATE_FOR_NEXT_PAGE
+        end
+      end
+    end
+
+    context 'having more page' do
+      it 'should have a more page link' do
+        get '/users'
+        last_document.search('a#next_page_link').should be_present
+        last_document.search('a#next_page_link').text.should match /Next!/
+      end
+    end
+
+    context 'the last page' do
+      before do
+        User.delete_all
+        50.times {|i| User.create! :name => "user#{i}"}
+      end
+
+      it 'should not have a more page link' do
+        get '/users?page=2'
+        last_document.search('a#next_page_link').should be_empty
+      end
+
+      it 'should have a no more page notation using placeholder' do
+        get '/users_placeholder?page=2'
+        last_document.search('a#next_page_link').should be_empty
+        last_document.search('span#no_next_page').should be_present
+        last_document.search('span#no_next_page').text.should match /No Next Page/
+      end
+    end
+  end
+end