kaminari-rails4 0.15.0

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 Kaminari::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

data/spec/models/array_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe Kaminari::PaginatableArray do
+  it { should have(0).items }
+
+  context 'specifying limit and offset when initializing' do
+    subject { Kaminari::PaginatableArray.new((1..100).to_a, :limit => 10, :offset => 20) }
+    its(:current_page) { should == 3 }
+  end
+
+  let(:array) { Kaminari::PaginatableArray.new((1..100).to_a) }
+  describe '#page' do
+    shared_examples_for 'the first page of array' do
+      it { should have(25).users }
+      its(:current_page) { should == 1 }
+      its(:first) { should == 1 }
+    end
+
+    shared_examples_for 'blank array page' do
+      it { should have(0).items }
+    end
+
+    context 'page 1' do
+      subject { array.page 1 }
+      it_should_behave_like 'the first page of array'
+    end
+
+    context 'page 2' do
+      subject { array.page 2 }
+      it { should have(25).users }
+      its(:current_page) { should == 2 }
+      its(:first) { should == 26 }
+    end
+
+    context 'page without an argument' do
+      subject { array.page }
+      it_should_behave_like 'the first page of array'
+    end
+
+    context 'page < 1' do
+      subject { array.page 0 }
+      it_should_behave_like 'the first page of array'
+    end
+
+    context 'page > max page' do
+      subject { array.page 5 }
+      it_should_behave_like 'blank array page'
+    end
+  end
+
+  describe '#per' do
+    context 'page 1 per 5' do
+      subject { array.page(1).per(5) }
+      it { should have(5).users }
+      its(:first) { should == 1 }
+    end
+  end
+
+  describe '#total_pages' do
+    context 'per 25 (default)' do
+      subject { array.page }
+      its(:total_pages) { should == 4 }
+    end
+
+    context 'per 7' do
+      subject { array.page(2).per(7) }
+      its(:total_pages) { should == 15 }
+    end
+
+    context 'per 65536' do
+      subject { array.page(50).per(65536) }
+      its(:total_pages) { should == 1 }
+    end
+
+    context 'per 0 (using default)' do
+      subject { array.page(50).per(0) }
+      its(:total_pages) { should == 4 }
+    end
+
+    context 'per -1 (using default)' do
+      subject { array.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 { array.page(5).per('aho') }
+      its(:total_pages) { should == 4 }
+    end
+
+    context 'per 25, padding 25' do
+      subject { array.page(1).padding(25) }
+      its(:total_pages) { should == 3 }
+    end
+  end
+
+  describe '#current_page' do
+    context 'page 1' do
+      subject { array.page }
+      its(:current_page) { should == 1 }
+    end
+
+    context 'page 2' do
+      subject { array.page(2).per 3 }
+      its(:current_page) { should == 2 }
+    end
+  end
+
+  describe '#next_page' do
+    context 'page 1' do
+      subject { array.page }
+      its(:next_page) { should == 2 }
+    end
+
+    context 'page 5' do
+      subject { array.page 5 }
+      its(:next_page) { should be_nil }
+    end
+  end
+
+  describe '#prev_page' do
+    context 'page 1' do
+      subject { array.page }
+      its(:prev_page) { should be_nil }
+    end
+
+    context 'page 5' do
+      subject { array.page 5 }
+      its(:prev_page) { should == 4 }
+    end
+  end
+
+  describe '#count' do
+    context 'page 1' do
+      subject { array.page }
+      its(:count) { should == 25 }
+    end
+
+    context 'page 2' do
+      subject { array.page 2 }
+      its(:count) { should == 25 }
+    end
+  end
+
+  context 'when setting total count explicitly' do
+    subject { Kaminari::PaginatableArray.new((1..10).to_a, :total_count => 9999).page(5).per(10) }
+    it { should have(10).items }
+    its(:first) { should == 1 }
+    its(:total_count) { should == 9999 }
+  end
+end

data/spec/models/data_mapper/data_mapper_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+
+if defined? DataMapper
+  describe Kaminari::DataMapperExtension do
+    before do
+      100.times do |i|
+        User.create(:name => "User#{i}", :age => i)
+      end
+
+      worker0 = User[0]
+      50.times do |i|
+        worker0.projects << Project.create(:name => "Project#{i}")
+      end
+      worker0.projects.save
+    end
+
+    describe 'Collection' do
+      subject{ User.all }
+      it { should respond_to(:page) }
+      it { should_not respond_to(:per) }
+    end
+
+    describe 'Model' do
+      subject{ User }
+      it { should respond_to(:page) }
+      it { should respond_to(:default_per_page) }
+      it { should_not respond_to(:per) }
+    end
+
+    describe '#page' do
+      context 'page 0' do
+        subject { User.all(:age.gte => 60).page 0 }
+        it { should be_a DataMapper::Collection }
+        its(:current_page) { should == 1 }
+        its(:prev_page) { should be_nil }
+        its(:next_page) { should == 2 }
+        its('query.limit') { should == 25 }
+        its('query.offset') { should == 0 }
+        its(:total_count) { should == User.count(:age.gte => 60) }
+        its(:total_pages) { should == 2 }
+      end
+
+      context 'page 1' do
+        subject { User.all(:age.gte => 0).page 1 }
+        it { should be_a DataMapper::Collection }
+        its(:current_page) { should == 1 }
+        its(:prev_page) { should be_nil }
+        its(:next_page) { should == 2 }
+        its('query.limit') { should == 25 }
+        its('query.offset') { should == 0 }
+        its(:total_count) { should == 100 }
+        its(:total_pages) { should == 4 }
+      end
+
+      context 'page 2' do
+        subject { User.page 2 }
+        it { should be_a DataMapper::Collection }
+        its(:current_page) { should == 2 }
+        its(:prev_page) { should == 1 }
+        its(:next_page) { should == 3 }
+        its(:limit_value) { should == 25 }
+        its('query.limit') { should == 25 }
+        its('query.offset') { should == 25 }
+        its(:total_count) { should == 100 }
+        its(:total_pages) { should == 4 }
+      end
+
+      context 'page "foobar"' do
+        subject { User.page 'foobar' }
+        it { should be_a DataMapper::Collection }
+        its(:current_page) { should == 1 }
+        its(:prev_page) { should be_nil }
+        its(:next_page) { should == 2 }
+        its('query.limit') { should == 25 }
+        its('query.offset') { should == 0 }
+        its(:total_count) { should == 100 }
+        its(:total_pages) { should == 4 }
+      end
+
+      context 'with criteria before' do
+        subject { User.all(:age.gt => 60).page 2 }
+        it { should be_a DataMapper::Collection }
+        its(:current_page) { should == 2 }
+        its(:prev_page) { should == 1 }
+        its(:next_page) { should be_nil }
+        its('query.limit') { should == 25 }
+        its('query.offset') { should == 25 }
+        its(:total_count) { should == User.count(:age.gt => 60) }
+        its(:total_pages) { should == 2 }
+      end
+
+      context 'with criteria after' do
+        subject { User.page(2).all(:age.gt => 60) }
+        it { should be_a DataMapper::Collection }
+        its(:current_page) { should == 2 }
+        its(:prev_page) { should == 1 }
+        its(:next_page) { should be_nil }
+        its('query.limit') { should == 25 }
+        its('query.offset') { should == 25 }
+        its(:total_count) { should == User.count(:age.gt => 60) }
+        its(:total_pages) { should == 2 }
+      end
+    end
+
+    describe '#per' do
+      context 'on simple query' do
+        subject { User.page(2).per(20) }
+        it { should be_a DataMapper::Collection }
+        its(:current_page) { should == 2 }
+        its(:prev_page) { should == 1 }
+        its(:next_page) { should == 3 }
+        its('query.limit') { should == 20 }
+        its(:limit_value) { should == 20 }
+        its('query.offset') { should == 20 }
+        its(:total_count) { should == 100 }
+        its(:total_pages) { should == 5 }
+      end
+
+      context 'on query with condition' do
+        subject { User.page(5).all(:age.lte => 80).per(13) }
+        its(:current_page) { should == 5 }
+        its(:prev_page) { should == 4 }
+        its(:next_page) { should == 6 }
+        its('query.limit') { should == 13 }
+        its('query.offset') { should == 52 }
+        its(:total_count) { should == 81 }
+        its(:total_pages) { should == 7 }
+      end
+
+      context 'on query with order' do
+        subject { User.page(5).all(:age.lte => 80, :order => [:age.asc]).per(13) }
+        it('includes user with age 52') { should include(User.first(:age => 52)) }
+        it('does not include user with age 51') { should_not include(User.first(:age => 51)) }
+        it('includes user with age 52') { should include(User.first(:age => 64)) }
+        it('does not include user with age 51') { should_not include(User.first(:age => 65)) }
+        its(:current_page) { should == 5 }
+        its(:prev_page) { should == 4 }
+        its(:next_page) { should == 6 }
+        its('query.limit') { should == 13 }
+        its('query.offset') { should == 52 }
+        its(:total_count) { should == 81 }
+        its(:total_pages) { should == 7 }
+      end
+
+      context 'on chained queries' do
+        subject { User.all(:age.gte => 50).page(3).all(:age.lte => 80).per(13) }
+        its(:current_page) { should == 3 }
+        its(:prev_page) { should == 2 }
+        its(:next_page) { should be_nil }
+        its('query.limit') { should == 13 }
+        its('query.offset') { should == 26 }
+        its(:total_count) { should == 31 }
+        its(:total_pages) { should == 3 }
+      end
+
+      context 'on query on association' do
+        subject { User[0].projects.page(3).all(:name.like => 'Project%').per(5) }
+        its(:current_page) { should == 3 }
+        its(:prev_page) { should == 2 }
+        its(:next_page) { should == 4 }
+        its('query.limit') { should == 5 }
+        its('query.offset') { should == 10 }
+        its(:total_count) { should == 50 }
+        its(:total_pages) { should == 10 }
+      end
+
+      context 'on query with association conditions' do
+        subject { User.page(3).all(:projects => Project.all).per(5) }
+        its(:current_page) { should == 3 }
+        its(:prev_page) { should == 2 }
+        its(:next_page) { should == 4 }
+        its('query.limit') { should == 5 }
+        its('query.offset') { should == 10 }
+        its(:total_count) { should == 50 }
+        its(:total_pages) { should == 10 }
+      end
+    end
+  end
+end