bootstrap_pager 0.9.0

data/spec/helpers/sinatra_helpers_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+if defined? 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 'BootstrapPager::Helpers::SinatraHelper' do
+    before do
+      50.times {|i| User.create! :name => "user#{i}"}
+    end
+
+    describe '#paginate' do
+      before do
+        mock_app do
+          register BootstrapPager::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 BootstrapPager::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 BootstrapPager::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 BootstrapPager::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 BootstrapPager::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
+        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
+end

data/spec/helpers/tags_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+include BootstrapPager::Helpers
+
+describe 'BootstrapPager::Helpers' do
+  describe 'Paginator' do
+    describe 'Paginator::PageProxy' do
+      describe '#current?' do
+        context 'current_page == page' do
+          subject { Paginator::PageProxy.new({:current_page => 26}, 26, nil) }
+          its(:current?) { should be_true }
+        end
+        context 'current_page != page' do
+          subject { Paginator::PageProxy.new({:current_page => 13}, 26, nil) }
+          its(:current?) { should_not be_true }
+        end
+      end
+
+      describe '#first?' do
+        context 'page == 1' do
+          subject { Paginator::PageProxy.new({:current_page => 26}, 1, nil) }
+          its(:first?) { should be_true }
+        end
+        context 'page != 1' do
+          subject { Paginator::PageProxy.new({:current_page => 13}, 2, nil) }
+          its(:first?) { should_not be_true }
+        end
+      end
+
+      describe '#last?' do
+        context 'current_page == page' do
+          subject { Paginator::PageProxy.new({:total_pages => 39}, 39, nil) }
+          its(:last?) { should be_true }
+        end
+        context 'current_page != page' do
+          subject { Paginator::PageProxy.new({:total_pages => 39}, 38, nil) }
+          its(:last?) { should_not be_true }
+        end
+      end
+
+      describe '#next?' do
+        context 'page == current_page + 1' do
+          subject { Paginator::PageProxy.new({:current_page => 52}, 53, nil) }
+          its(:next?) { should be_true }
+        end
+        context 'page != current_page + 1' do
+          subject { Paginator::PageProxy.new({:current_page => 52}, 77, nil) }
+          its(:next?) { should_not be_true }
+        end
+      end
+
+      describe '#prev?' do
+        context 'page == current_page - 1' do
+          subject { Paginator::PageProxy.new({:current_page => 77}, 76, nil) }
+          its(:prev?) { should be_true }
+        end
+        context 'page != current_page + 1' do
+          subject { Paginator::PageProxy.new({:current_page => 77}, 80, nil) }
+          its(:prev?) { should_not be_true }
+        end
+      end
+
+      describe '#left_outer?' do
+        context 'current_page == left' do
+          subject { Paginator::PageProxy.new({:left => 3}, 3, nil) }
+          its(:left_outer?) { should be_true }
+        end
+        context 'current_page == left + 1' do
+          subject { Paginator::PageProxy.new({:left => 3}, 4, nil) }
+          its(:left_outer?) { should_not be_true }
+        end
+        context 'current_page == left + 2' do
+          subject { Paginator::PageProxy.new({:left => 3}, 5, nil) }
+          its(:left_outer?) { should_not be_true }
+        end
+      end
+
+      describe '#right_outer?' do
+        context 'total_pages - page > right' do
+          subject { Paginator::PageProxy.new({:total_pages => 10, :right => 3}, 6, nil) }
+          its(:right_outer?) { should_not be_true }
+        end
+        context 'total_pages - page == right' do
+          subject { Paginator::PageProxy.new({:total_pages => 10, :right => 3}, 7, nil) }
+          its(:right_outer?) { should_not be_true }
+        end
+        context 'total_pages - page < right' do
+          subject { Paginator::PageProxy.new({:total_pages => 10, :right => 3}, 8, nil) }
+          its(:right_outer?) { should be_true }
+        end
+      end
+
+      describe '#inside_window?' do
+        context 'page > current_page' do
+          context 'page - current_page > window' do
+            subject { Paginator::PageProxy.new({:current_page => 4, :window => 5}, 10, nil) }
+            its(:inside_window?) { should_not be_true }
+          end
+          context 'page - current_page == window' do
+            subject { Paginator::PageProxy.new({:current_page => 4, :window => 6}, 10, nil) }
+            its(:inside_window?) { should be_true }
+          end
+          context 'page - current_page < window' do
+            subject { Paginator::PageProxy.new({:current_page => 4, :window => 7}, 10, nil) }
+            its(:inside_window?) { should be_true }
+          end
+        end
+        context 'current_page > page' do
+          context 'current_page - page > window' do
+            subject { Paginator::PageProxy.new({:current_page => 15, :window => 4}, 10, nil) }
+            its(:inside_window?) { should_not be_true }
+          end
+          context 'current_page - page == window' do
+            subject { Paginator::PageProxy.new({:current_page => 15, :window => 5}, 10, nil) }
+            its(:inside_window?) { should be_true }
+          end
+          context 'current_page - page < window' do
+            subject { Paginator::PageProxy.new({:current_page => 15, :window => 6}, 10, nil) }
+            its(:inside_window?) { should be_true }
+          end
+        end
+      end
+      describe '#was_truncated?' do
+        before do
+          stub(@template = Object.new) do
+            options { {} }
+            params { {} }
+          end
+        end
+        context 'last.is_a? Gap' do
+          subject { Paginator::PageProxy.new({}, 10, Gap.new(@template)) }
+          its(:was_truncated?) { should be_true }
+        end
+        context 'last.is not a Gap' do
+          subject { Paginator::PageProxy.new({}, 10, Page.new(@template)) }
+          its(:was_truncated?) { should_not be_true }
+        end
+      end
+    end
+  end
+end

data/spec/models/active_record/active_record_relation_methods_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+if defined? ActiveRecord
+  describe BootstrapPager::ActiveRecordRelationMethods do
+    describe '#total_count' do
+      before do
+        @author = User.create! :name => 'author'
+        @author2 = User.create! :name => 'author2'
+        @author3 = User.create! :name => 'author3'
+        @books = 2.times.map {|i| @author.books_authored.create!(:title => "title%03d" % i) }
+        @books2 = 3.times.map {|i| @author2.books_authored.create!(:title => "title%03d" % i) }
+        @books3 = 4.times.map {|i| @author3.books_authored.create!(:title => "subject%03d" % i) }
+        @readers = 4.times.map { User.create! :name => 'reader' }
+        @books.each {|book| book.readers << @readers }
+      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
+        end
+      end
+      context "when total_count receives options" do
+        it "should return a distinct total count" do
+          User.page(1).total_count(:name, :distinct => true).should == 4
+        end
+      end
+      context "when count receives options" do
+        it "should return a distinct set by column" do
+          User.page(1).count(:name, :distinct => true).should == 4
+        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
+  end
+end

data/spec/models/active_record/default_per_page_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+if defined? ActiveRecord
+
+  describe 'default per_page' do
+    describe 'AR::Base' do
+      subject { ActiveRecord::Base }
+      it { should_not respond_to :paginates_per }
+    end
+
+    subject { User.page 0 }
+
+    context 'by default' do
+      its(:limit_value) { should == 25 }
+    end
+
+    context 'when explicitly set via paginates_per' do
+      before { User.paginates_per 1326 }
+      its(:limit_value) { should == 1326 }
+      after { User.paginates_per nil }
+    end
+
+    describe "default per_page value's independency per model" do
+      context "when User's default per_page was changed" do
+        before { User.paginates_per 1326 }
+        subject { Book.page 0 }
+        its(:limit_value) { should == 25 }
+        after { User.paginates_per nil }
+      end
+    end
+  end
+end

data/spec/models/active_record/max_pages_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+if defined? ActiveRecord
+
+  describe 'max pages' do
+    describe 'AR::Base' do
+      subject { ActiveRecord::Base }
+      it { should_not respond_to :max_pages_per }
+    end
+
+    subject { User.page 0 }
+
+    context 'by default' do
+      its(:max_pages) { should == nil }
+    end
+
+    context 'when explicitly set via max_pages_per' do
+      before { User.max_pages_per 3 }
+      its(:max_pages) { should == 3 }
+      after { User.max_pages_per nil }
+    end
+  end
+end

data/spec/models/active_record/max_per_page_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+if defined? ActiveRecord
+
+  describe 'max per_page' do
+    describe 'AR::Base' do
+      subject { ActiveRecord::Base }
+      it { should_not respond_to :max_paginates_per }
+    end
+
+    subject { User.page(0).per(100) }
+
+    context 'by default' do
+      its(:limit_value) { should == 100 }
+    end
+
+    context 'when explicitly set via max_paginates_per' do
+      before { User.max_paginates_per 10 }
+      its(:limit_value) { should == 10 }
+      after { User.max_paginates_per nil }
+    end
+
+    describe "max per_page value's independency per model" do
+      context "when User's max per_page was changed" do
+        before { User.max_paginates_per 10 }
+        subject { Book.page(0).per(100) }
+        its(:limit_value) { should == 100 }
+        after { User.max_paginates_per nil }
+      end
+    end
+  end
+end

data/spec/models/active_record/scopes_spec.rb

@@ -0,0 +1,242 @@
+require 'spec_helper'
+
+if defined? ActiveRecord
+
+  shared_examples_for 'the first page' do
+    it { should have(25).users }
+    its('first.name') { should == 'user001' }
+  end
+
+  shared_examples_for 'blank page' do
+    it { should have(0).users }
+  end
+
+  describe BootstrapPager::ActiveRecordExtension do
+    before do
+      1.upto(100) {|i| User.create! :name => "user#{'%03d' % i}", :age => (i / 10)}
+      1.upto(100) {|i| GemDefinedModel.create! :name => "user#{'%03d' % i}", :age => (i / 10)}
+    end
+
+    [User, Admin, GemDefinedModel].each do |model_class|
+      context "for #{model_class}" do
+        describe '#page' do
+          context 'page 1' do
+            subject { model_class.page 1 }
+            it_should_behave_like 'the first page'
+          end
+
+          context 'page 2' do
+            subject { model_class.page 2 }
+            it { should have(25).users }
+            its('first.name') { should == 'user026' }
+          end
+
+          context 'page without an argument' do
+            subject { model_class.page }
+            it_should_behave_like 'the first page'
+          end
+
+          context 'page < 1' do
+            subject { model_class.page 0 }
+            it_should_behave_like 'the first page'
+          end
+
+          context 'page > max page' do
+            subject { model_class.page 5 }
+            it_should_behave_like 'blank page'
+          end
+
+          describe 'ensure #order_values is preserved' do
+            subject { model_class.order('id').page 1 }
+            its('order_values.uniq') { should == ['id'] }
+          end
+        end
+
+        describe '#per' do
+          context 'page 1 per 5' do
+            subject { model_class.page(1).per(5) }
+            it { should have(5).users }
+            its('first.name') { should == 'user001' }
+          end
+
+          context "page 1 per nil (using default)" do
+            subject { model_class.page(1).per(nil) }
+            it { should have(model_class.default_per_page).users }
+          end
+        end
+
+        describe '#padding' do
+          context 'page 1 per 5 padding 1' do
+            subject { model_class.page(1).per(5).padding(1) }
+            it { should have(5).users }
+            its('first.name') { should == 'user002' }
+          end
+
+          context 'page 19 per 5 padding 5' do
+            subject { model_class.page(19).per(5).padding(5) }
+            its(:current_page) { should == 19 }
+            its(:total_pages) { should == 19 }
+          end
+        end
+
+        describe '#total_pages' do
+          context 'per 25 (default)' do
+            subject { model_class.page }
+            its(:total_pages) { should == 4 }
+          end
+
+          context 'per 7' do
+            subject { model_class.page(2).per(7) }
+            its(:total_pages) { should == 15 }
+          end
+
+          context 'per 65536' do
+            subject { model_class.page(50).per(65536) }
+            its(:total_pages) { should == 1 }
+          end
+
+          context 'per 0 (using default)' do
+            subject { model_class.page(50).per(0) }
+            its(:total_pages) { should == 4 }
+          end
+
+          context 'per -1 (using default)' do
+            subject { model_class.page(5).per(-1) }
+            its(:total_pages) { should == 4 }
+          end
+
+          context 'per "String value that can not be converted into Number" (using default)' do
+            subject { model_class.page(5).per('aho') }
+            its(:total_pages) { should == 4 }
+          end
+
+          context 'with max_pages < total pages count from database' do
+            before { model_class.max_pages_per 3 }
+            subject { model_class.page }
+            its(:total_pages) { should == 3 }
+            after { model_class.max_pages_per nil }
+          end
+
+          context 'with max_pages > total pages count from database' do
+            before { model_class.max_pages_per 11 }
+            subject { model_class.page }
+            its(:total_pages) { should == 4 }
+            after { model_class.max_pages_per nil }
+          end
+
+          context 'with max_pages is nil' do
+            before { model_class.max_pages_per nil }
+            subject { model_class.page }
+            its(:total_pages) { should == 4 }
+          end
+
+          context "with per(nil) using default" do
+            subject { model_class.page.per(nil) }
+            its(:total_pages) { should == 4 }
+          end
+        end
+
+        describe '#current_page' do
+          context 'page 1' do
+            subject { model_class.page }
+            its(:current_page) { should == 1 }
+          end
+
+          context 'page 2' do
+            subject { model_class.page(2).per 3 }
+            its(:current_page) { should == 2 }
+          end
+        end
+
+        describe '#next_page' do
+          context 'page 1' do
+            subject { model_class.page }
+            its(:next_page) { should == 2 }
+          end
+
+          context 'page 5' do
+            subject { model_class.page(5) }
+            its(:next_page) { should be_nil }
+          end
+        end
+
+        describe '#prev_page' do
+          context 'page 1' do
+            subject { model_class.page }
+            its(:prev_page) { should be_nil }
+          end
+
+          context 'page 5' do
+            subject { model_class.page(5) }
+            its(:prev_page) { should == 4 }
+          end
+        end
+
+        describe '#first_page?' do
+          context 'on first page' do
+            subject { model_class.page(1).per(10) }
+            its(:first_page?) { should == true }
+          end
+
+          context 'not on first page' do
+            subject { model_class.page(5).per(10) }
+            its(:first_page?) { should == false }
+          end
+        end
+
+        describe '#last_page?' do
+          context 'on last page' do
+            subject { model_class.page(10).per(10) }
+            its(:last_page?) { should == true }
+          end
+
+          context 'not on last page' do
+            subject { model_class.page(1).per(10) }
+            its(:last_page?) { should == false }
+          end
+        end
+
+        describe '#out_of_range?' do
+          context 'on last page' do
+            subject { model_class.page(10).per(10) }
+            its(:out_of_range?) { should == false }
+          end
+
+          context 'within range' do
+            subject { model_class.page(1).per(10) }
+            its(:out_of_range?) { should == false }
+          end
+
+          context 'out of range' do
+            subject { model_class.page(11).per(10) }
+            its(:out_of_range?) { should == true }
+          end
+        end
+
+        describe '#count' do
+          context 'page 1' do
+            subject { model_class.page }
+            its(:count) { should == 25 }
+          end
+
+          context 'page 2' do
+            subject { model_class.page 2 }
+            its(:count) { should == 25 }
+          end
+        end
+
+        context 'chained with .group' do
+          subject { model_class.group('age').page(2).per 5 }
+          # 0..10
+          its(:total_count) { should == 11 }
+          its(:total_pages) { should == 3 }
+        end
+
+        context 'activerecord descendants' do
+          subject { ActiveRecord::Base.descendants }
+          its(:length) { should_not == 0 }
+        end
+      end
+    end
+  end
+end