bootstrap_pager 0.9.0

data/spec/fake_app/mongo_mapper/config.rb

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

data/spec/fake_app/mongo_mapper/models.rb

@@ -0,0 +1,9 @@
+class User
+  include ::MongoMapper::Document
+  key :name, String
+  key :age, Integer
+end
+
+class User::Address
+  include ::MongoMapper::Document
+end

data/spec/fake_app/mongoid/config.rb

@@ -0,0 +1,16 @@
+# Ensure we use 'syck' instead of 'psych' in 1.9.2
+# RubyGems >= 1.5.0 uses 'psych' on 1.9.2, but
+# 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'
+  YAML::ENGINE.yamler = 'syck'
+end
+
+Mongoid.configure do |config|
+  if Mongoid::VERSION =~ /^3/
+    config.sessions = {:default => {:hosts => ['localhost:27017'], :database => 'bootstrap_pager_test'}}
+  else
+    config.master = Mongo::Connection.new.db('bootstrap_pager_test')
+  end
+end

data/spec/fake_app/mongoid/models.rb

@@ -0,0 +1,22 @@
+class User
+  include ::Mongoid::Document
+  field :name, :type => String
+  field :age, :type => Integer
+end
+
+class User::Address
+  include ::Mongoid::Document
+end
+
+class MongoMongoidExtensionDeveloper
+  include ::Mongoid::Document
+  field :salary, :type => Integer
+  embeds_many :frameworks
+end
+
+class Framework
+  include ::Mongoid::Document
+  field :name, :type => String
+  field :language, :type => String
+  embedded_in :mongo_mongoid_extension_developer
+end

data/spec/fake_app/rails_app.rb

@@ -0,0 +1,67 @@
+# require 'rails/all'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+require 'fake_app/active_record/config' if defined? ActiveRecord
+require 'fake_app/data_mapper/config' if defined? DataMapper
+require 'fake_app/mongoid/config' if defined? Mongoid
+require 'fake_app/mongo_mapper/config' if defined? MongoMapper
+# config
+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!
+app.initialize!
+
+# fake engine
+module MyEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace MyEngine
+    routes.draw do
+      resources :items
+    end
+  end
+end
+
+# routes
+app.routes.draw do
+  mount MyEngine::Engine, :at => '/mounted_engine'
+  resources :users
+end
+
+#models
+require 'fake_app/active_record/models' if defined? ActiveRecord
+require 'fake_app/data_mapper/models' if defined? DataMapper
+require 'fake_app/mongoid/models' if defined? Mongoid
+require 'fake_app/mongo_mapper/models' if defined? MongoMapper
+
+# controllers
+class ApplicationController < ActionController::Base; end
+class UsersController < ApplicationController
+  def index
+    @users = User.page params[:page]
+    render :inline => <<-ERB
+<%= @users.map(&:name).join("\n") %>
+<%= paginate @users %>
+ERB
+  end
+end
+
+if defined? ActiveRecord
+  class AddressesController < ApplicationController
+    def index
+      @addresses = User::Address.page params[:page]
+      render :inline => <<-ERB
+  <%= @addresses.map(&:street).join("\n") %>
+  <%= paginate @addresses %>
+  ERB
+    end
+  end
+end
+
+# helpers
+Object.const_set(:ApplicationHelper, Module.new)

data/spec/fake_app/sinatra_app.rb

@@ -0,0 +1,22 @@
+require 'fake_app/active_record/config' if defined? ActiveRecord
+require 'fake_app/data_mapper/config' if defined? DataMapper
+require 'fake_app/mongoid/config' if defined? Mongoid
+require 'fake_app/mongo_mapper/config' if defined? MongoMapper
+
+#models
+require 'fake_app/active_record/models' if defined? ActiveRecord
+require 'fake_app/data_mapper/models' if defined? DataMapper
+require 'fake_app/mongoid/models' if defined? Mongoid
+require 'fake_app/mongo_mapper/models' if defined? MongoMapper
+
+class SinatraApp < Sinatra::Base
+  register BootstrapPager::Helpers::SinatraHelpers
+
+  get '/users' do
+    @users = User.page params[:page]
+    erb <<-ERB
+<%= @users.map(&:name).join("\n") %>
+<%= paginate @users %>
+ERB
+  end
+end

data/spec/fake_gem.rb

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

data/spec/helpers/action_view_extension_spec.rb

@@ -0,0 +1,292 @@
+require 'spec_helper'
+
+describe 'BootstrapPager::ActionViewExtension' 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 }
+
+    context 'escaping the pagination for javascript' do
+      it 'should escape for javascript' do
+        lambda { helper.escape_javascript(helper.paginate @users, :params => {:controller => 'users', :action => 'index'}) }.should_not raise_error
+      end
+    end
+
+    if defined? Rails
+      context 'using custom engine namespace' do
+      subject { helper.paginate @users, :params => {:controller => 'my_engine/items', :action => 'index'}, :engine_namespace => my_engine }
+        it { should match(%r(/mounted_engine/items)) }
+      end
+    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
+      if defined? Rails
+        context 'using custom engine namespace' do
+          subject { helper.link_to_previous_page @users, 'Previous', :params => {:controller => 'my_engine/items', :action => 'index'}, :engine_namespace => my_engine }
+          it { should match(%r(/mounted_engine/items)) }
+        end
+      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
+  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
+      if defined? Rails
+        context 'using custom engine namespace' do
+          subject { helper.link_to_next_page @users, 'More', :params => {:controller => 'my_engine/items', :action => 'index'}, :engine_namespace => my_engine }
+          it { should match(%r(/mounted_engine/items)) }
+        end
+      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
+    context 'on a model without namespace' 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 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'} }
+          it      { should == 'No members found' }
+        end
+      end
+
+      context 'having 1 entry' do
+        before 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' }
+
+        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! :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' }
+
+        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! :name => "user#{i}"}
+        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
+    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 addresses found' }
+      end
+
+      context 'having 1 entry' do
+        before 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' }
+
+        context 'setting the entry name option to "place"' do
+          subject { helper.page_entries_info @addresses, :entry_name => 'place', :params => {:controller => 'addresses', :action => 'index'} }
+          it      { should == 'Displaying <b>1</b> place' }
+        end
+      end
+
+      context 'having more than 1 but less than a page of entries' do
+        before 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' }
+
+        context 'setting the entry name option to "place"' do
+          subject { helper.page_entries_info @addresses, :entry_name => 'place', :params => {:controller => 'addresses', :action => 'index'} }
+          it      { should == 'Displaying <b>all 10</b> places' }
+        end
+      end
+
+      context 'having more than one page of entries' do
+        before do
+          50.times {|i| User::Address.create!}
+        end
+
+        describe 'the first page' 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' }
+
+          context 'setting the entry name option to "place"' do
+            subject { helper.page_entries_info @addresses, :entry_name => 'place', :params => {:controller => 'addresses', :action => 'index'} }
+            it      { should == 'Displaying places <b>1&nbsp;-&nbsp;25</b> of <b>50</b> in total' }
+          end
+        end
+
+        describe 'the next page' 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' }
+
+          context 'setting the entry name option to "place"' do
+            subject { helper.page_entries_info @addresses, :entry_name => 'place', :params => {:controller => 'addresses', :action => 'index'} }
+            it      { should == 'Displaying places <b>26&nbsp;-&nbsp;50</b> of <b>50</b> in total' }
+          end
+        end
+      end
+    end
+
+    context 'on a PaginatableArray' do
+      before do
+        @numbers = BootstrapPager.paginate_array(%w{one two three}).page(1)
+      end
+      subject { helper.page_entries_info @numbers }
+      it      { should == 'Displaying <b>all 3</b> entries' }
+    end
+  end
+
+  describe '#rel_next_prev_link_tags' do
+    shared_context 'using custom engine namespace' do
+      if defined? Rails
+         context 'using custom engine namespace' do
+           subject { helper.rel_next_prev_link_tags @users, :params => {:controller => 'my_engine/items', :action => 'index'}, :engine_namespace => my_engine }
+           it { should match(%r(/mounted_engine/items)) }
+         end
+      end
+    end
+    before do
+      75.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"/) }
+      include_context 'using custom engine namespace'
+    end
+    context 'the middle page' do
+      before do
+        @users = User.page(2).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"/) }
+      include_context 'using custom engine namespace'
+    end
+    context 'the last page' do
+      before do
+        @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_not match(/rel="next"/) }
+      it { should match(/rel="prev"/) }
+      include_context 'using custom engine namespace'
+    end
+  end
+end

data/spec/helpers/helpers_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+include BootstrapPager::Helpers
+
+describe 'BootstrapPager::Helpers::Paginator' do
+  let :template do
+    stub(r = Object.new) do
+      render.with_any_args
+      params { {} }
+      options { {} }
+      url_for {|h| "/foo?page=#{h[:page]}"}
+    end
+    r
+  end
+
+  describe '#params' do
+    before do
+      @paginator = Paginator.new(template, :params => {:controller => 'foo', :action => 'bar'})
+    end
+    subject { @paginator.page_tag(template).instance_variable_get('@params') }
+    it { should == {:controller => 'foo', :action => 'bar'} }
+  end
+
+  describe '#param_name' do
+    before do
+      @paginator = Paginator.new(template, :param_name => :pagina)
+    end
+    subject { @paginator.page_tag(template).instance_variable_get('@param_name') }
+    it { should == :pagina }
+  end
+
+  #TODO test somehow...
+#   describe '#tagify_links' do
+#     def tags_with(options)
+#       PaginationRenderer.new(template, options).tagify_links
+#     end
+
+#     context '1 page in total' do
+#       subject { tags_with :total_pages => 1, :current_page => 1 }
+#       it { should have(0).tags }
+#     end
+
+#     context '10 pages in total' do
+#       context 'first page' do
+#         subject { tags_with :total_pages => 10, :current_page => 1 }
+#         it { should_not contain_tag PrevLink }
+#         it { should contain_tag PrevSpan }
+#         it { should contain_tag CurrentPage }
+#         it { should_not contain_tag FirstPageLink }
+#         it { should contain_tag LastPageLink }
+#         it { should contain_tag PageLink }
+#         it { should contain_tag NextLink }
+#         it { should_not contain_tag NextSpan }
+#         it { should contain_tag TruncatedSpan }
+#       end
+
+#       context 'second page' do
+#         subject { tags_with :total_pages => 10, :current_page => 2 }
+#         it { should contain_tag PrevLink }
+#         it { should_not contain_tag PrevSpan }
+#         it { should contain_tag CurrentPage }
+#         it { should contain_tag FirstPageLink }
+#         it { should contain_tag LastPageLink }
+#         it { should contain_tag PageLink }
+#         it { should contain_tag NextLink }
+#         it { should_not contain_tag NextSpan }
+#         it { should contain_tag TruncatedSpan }
+#       end
+
+#       context 'third page' do
+#         subject { tags_with :total_pages => 10, :current_page => 3 }
+#         it { should contain_tag PrevLink }
+#         it { should_not contain_tag PrevSpan }
+#         it { should contain_tag CurrentPage }
+#         it { should contain_tag FirstPageLink }
+#         it { should contain_tag LastPageLink }
+#         it { should contain_tag PageLink }
+#         it { should contain_tag NextLink }
+#         it { should_not contain_tag NextSpan }
+#         it { should contain_tag TruncatedSpan }
+#       end
+
+#       context 'fourth page(no truncation)' do
+#         subject { tags_with :total_pages => 10, :current_page => 4 }
+#         it { should contain_tag PrevLink }
+#         it { should_not contain_tag PrevSpan }
+#         it { should contain_tag CurrentPage }
+#         it { should contain_tag FirstPageLink }
+#         it { should contain_tag LastPageLink }
+#         it { should contain_tag PageLink }
+#         it { should contain_tag NextLink }
+#         it { should_not contain_tag NextSpan }
+#         it { should_not contain_tag TruncatedSpan }
+#       end
+
+#       context 'seventh page(no truncation)' do
+#         subject { tags_with :total_pages => 10, :current_page => 7 }
+#         it { should contain_tag PrevLink }
+#         it { should_not contain_tag PrevSpan }
+#         it { should contain_tag CurrentPage }
+#         it { should contain_tag FirstPageLink }
+#         it { should contain_tag LastPageLink }
+#         it { should contain_tag PageLink }
+#         it { should contain_tag NextLink }
+#         it { should_not contain_tag NextSpan }
+#         it { should_not contain_tag TruncatedSpan }
+#       end
+
+#       context 'eighth page' do
+#         subject { tags_with :total_pages => 10, :current_page => 8 }
+#         it { should contain_tag PrevLink }
+#         it { should_not contain_tag PrevSpan }
+#         it { should contain_tag CurrentPage }
+#         it { should contain_tag FirstPageLink }
+#         it { should contain_tag LastPageLink }
+#         it { should contain_tag PageLink }
+#         it { should contain_tag NextLink }
+#         it { should_not contain_tag NextSpan }
+#         it { should contain_tag TruncatedSpan }
+#       end
+
+#       context 'last page' do
+#         subject { tags_with :total_pages => 10, :current_page => 10 }
+#         it { should contain_tag PrevLink }
+#         it { should_not contain_tag PrevSpan }
+#         it { should contain_tag CurrentPage }
+#         it { should contain_tag FirstPageLink }
+#         it { should_not contain_tag LastPageLink }
+#         it { should contain_tag PageLink }
+#         it { should_not contain_tag NextLink }
+#         it { should contain_tag NextSpan }
+#         it { should contain_tag TruncatedSpan }
+#       end
+#     end
+#   end
+end