kaminari 0.12.1 → 0.12.2

data/CHANGELOG

@@ -1,3 +1,13 @@
+== 0.12.2
+
+* Added MongoMapper Support #101 [hamin]
+
+* Add first_page? and last_page? to page_scope_methods #51 [holinnn]
+
+* Make sure that the paginate helper always returns a String #99 [Draiken]
+
+* Don't remove includes scopes from count if they are needed #100 [flop]
+
 == 0.12.1
 
 * Slim template support #93 [detrain]
@@ -9,9 +19,6 @@ of Ruby 1.8.7 #91 [Skulli]
 
 * _paginate.html.erb isn't rendered with custom theme #97 [danlunde]
 
-* I don't know why but this version seems like working with Haml 3.1.0 #96
-[FlyboyArt]
-
 == 0.12.0
 
 * General configuration options #41 #62 [javierv, iain]

data/README.rdoc

@@ -19,7 +19,7 @@ No special collection class or anything for the paginated values, instead using
 As the whole pagination helper is basically just a collection of links and non-links, Kaminari renders each of them through its own partial template inside the Engine. So, you can easily modify their behaviour, style or whatever by overriding partial templates.
 
 === ORM & template engine agnostic
-Kaminari supports multiple ORMs (ActiveRecord, Mongoid) and multiple template engines (ERB, Haml).
+Kaminari supports multiple ORMs (ActiveRecord, Mongoid, MongoMapper) and multiple template engines (ERB, Haml).
 
 === Modern
 The pagination helper outputs the HTML5 <nav> tag by default. Plus, the helper supports Rails 3 unobtrusive Ajax.
@@ -33,7 +33,9 @@ The pagination helper outputs the HTML5 <nav> tag by default. Plus, the helper s
 
 * Haml 3
 
-* Mongoid 2 (beta)
+* Mongoid 2
+
+* MongoMapper 0.9
 
 == Install
 

data/kaminari.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler', ['>= 1.0.0']
   s.add_development_dependency 'sqlite3', ['>= 0']
   s.add_development_dependency 'mongoid', ['>= 2']
+  s.add_development_dependency 'mongo_mapper', ['>= 0.9']
   s.add_development_dependency 'rspec', ['>= 0']
   s.add_development_dependency 'rspec-rails', ['>= 0']
   s.add_development_dependency 'rr', ['>= 0']

data/lib/kaminari/helpers/action_view_extension.rb

@@ -18,7 +18,8 @@ module Kaminari
       # * <tt>:remote</tt> - Ajax? (false by default)
       # * <tt>:ANY_OTHER_VALUES</tt> - Any other hash key & values would be directly passed into each tag as :locals value.
       def paginate(scope, options = {}, &block)
-        Kaminari::Helpers::Paginator.new self, options.reverse_merge(:current_page => scope.current_page, :num_pages => scope.num_pages, :per_page => scope.limit_value, :param_name => Kaminari.config.param_name, :remote => false)
+        paginator = Kaminari::Helpers::Paginator.new self, options.reverse_merge(:current_page => scope.current_page, :num_pages => scope.num_pages, :per_page => scope.limit_value, :param_name => Kaminari.config.param_name, :remote => false)
+        paginator.to_s
       end
     end
   end

data/lib/kaminari/models/active_record_relation_methods.rb

@@ -4,7 +4,7 @@ module Kaminari
     module InstanceMethods
       # a workaround for AR 3.0.x that returns 0 for #count when page > 1
       # if +limit_value+ is specified, load all the records and count them
-      if Rails.version < '3.1'
+      if ActiveRecord::VERSION::STRING < '3.1'
         def count #:nodoc:
           limit_value ? length : super
         end
@@ -12,8 +12,11 @@ module Kaminari
 
       def total_count #:nodoc:
         # #count overrides the #select which could include generated columns referenced in #order, so skip #order here, where it's irrelevant to the result anyway
-        c = except(:offset, :limit, :includes, :order).count
+        c = except(:offset, :limit, :order)
+        # Remove includes only if they are irrelevant
+        c = c.except(:includes) unless references_eager_loaded_tables?
         # .group returns an OrderdHash that responds to #count
+        c = c.count
         c.respond_to?(:count) ? c.count : c
       end
     end

data/lib/kaminari/models/mongo_mapper_extension.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), 'plucky_criteria_methods')
+
+module Kaminari
+  module MongoMapperExtension
+    module Document
+      extend ActiveSupport::Concern
+      include Kaminari::ConfigurationMethods
+
+      included do
+        # Fetch the values at the specified page number
+        #   Model.page(5)
+        scope :page, Proc.new {|num|
+          limit(default_per_page).offset(default_per_page * ([num.to_i, 1].max - 1))
+        }
+      end
+    end
+  end
+end

data/lib/kaminari/models/page_scope_methods.rb

@@ -21,6 +21,16 @@ module Kaminari
       def current_page
         (offset_value / limit_value) + 1
       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
 end

data/lib/kaminari/models/plucky_criteria_methods.rb

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

data/lib/kaminari/railtie.rb

@@ -1,6 +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')
@@ -20,10 +21,16 @@ module Kaminari
         ::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
     end
   end
-end
+end

data/lib/kaminari/version.rb

@@ -1,3 +1,3 @@
 module Kaminari
-  VERSION = '0.12.1'
+  VERSION = '0.12.2'
 end

data/spec/helpers/action_view_extension_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+include Kaminari::ActionViewExtension
+
+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)
+    end
+    subject { paginate( @books ) }
+    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
+      end
+    end
+  end
+end
+

data/spec/models/active_record_relation_methods_spec.rb

@@ -4,7 +4,11 @@ describe Kaminari::ActiveRecordRelationMethods do
   describe '#total_count' do
     before do
       @author = User.create! :name => 'author'
-      @books = 2.times.map { @author.books_authored.create! }
+      @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
@@ -14,5 +18,11 @@ describe Kaminari::ActiveRecordRelationMethods 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    
   end
 end

data/spec/models/mongo_mapper_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+require 'mongo_mapper'
+require File.expand_path('../../lib/kaminari/models/mongo_mapper_extension', File.dirname(__FILE__))
+
+describe Kaminari::MongoMapperExtension do
+  before :all do
+    MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
+    MongoMapper.database = "kaminari_test"
+    class Developer
+      include ::MongoMapper::Document
+      key :salary, Integer
+    end
+  end
+  before do
+    stub(subject).count { 300 } # in order to avoid DB access...
+  end
+
+  describe '#page' do
+    context 'page 1' do
+      subject { Developer.page(1) }
+      it { should be_a Plucky::Query }
+      its(:current_page) { should == 1 }
+      its(:limit_value) { should == 25 }
+      its(:num_pages) { should == 12 }
+      it { should skip(0) }
+    end
+
+    context 'page 2' do
+      subject { Developer.page 2 }
+      it { should be_a Plucky::Query }
+      its(:current_page) { should == 2 }
+      its(:limit_value) { should == 25 }
+      its(:num_pages) { should == 12 }
+      it { should skip 25 }
+    end
+    
+    context 'page "foobar"' do
+      subject { Developer.page 'foobar' }
+      it { should be_a Plucky::Query }
+      its(:current_page) { should == 1 }
+      its(:limit_value) { should == 25 }
+      its(:num_pages) { should == 12 }
+      it { should skip 0 }
+    end
+    
+    context 'with criteria before' do
+      it "should have the proper criteria source" do
+        Developer.where(:salary => 1).page(2).criteria.source.should == {:salary => 1}
+      end
+      
+      subject { Developer.where(:salary => 1).page 2 }
+      its(:current_page) { should == 2 }
+      its(:limit_value) { should == 25 }
+      its(:num_pages) { should == 12 }
+      it { should skip 25 }
+    end
+    
+    context 'with criteria after' do
+      it "should have the proper criteria source" do
+        Developer.where(:salary => 1).page(2).criteria.source.should == {:salary => 1}
+      end
+      
+      subject { Developer.page(2).where(:salary => 1) }
+      its(:current_page) { should == 2 }
+      its(:limit_value) { should == 25 }
+      its(:num_pages) { should == 12 }
+      it { should skip 25 }
+    end
+
+  end
+
+  describe '#per' do
+    subject { Developer.page(2).per(10) }
+    it { should be_a Plucky::Query }
+    its(:current_page) { should == 2 }
+    its(:limit_value) { should == 10 }
+    its(:num_pages) { should == 30 }
+    it { should skip 10 }
+  end
+end

data/spec/models/scopes_spec.rb

@@ -94,6 +94,30 @@ describe Kaminari::ActiveRecordExtension do
     end
   end
 
+  describe '#first_page?' do
+    context 'on first page' do
+      subject { User.page(1).per(10) }
+      its(:first_page?) { should == true }
+    end
+
+    context 'not on first page' do
+      subject { User.page(5).per(10) }
+      its(:first_page?) { should == false }
+    end
+  end
+
+  describe '#last_page?' do
+    context 'on last page' do
+      subject { User.page(10).per(10) }
+      its(:last_page?) { should == true }
+    end
+
+    context 'not on last page' do
+      subject { User.page(1).per(10) }
+      its(:last_page?) { should == false }
+    end
+  end
+
   describe '#count' do
     context 'page 1' do
       subject { User.page }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kaminari
 version: !ruby/object:Gem::Version 
-  hash: 45
+  hash: 43
   prerelease: 
   segments: 
   - 0
   - 12
-  - 1
-  version: 0.12.1
+  - 2
+  version: 0.12.2
 platform: ruby
 authors: 
 - Akira Matsuda
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-25 00:00:00 Z
+date: 2011-04-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -78,21 +78,22 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: mongo_mapper
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 25
         segments: 
         - 0
-        version: "0"
+        - 9
+        version: "0.9"
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: rspec-rails
+  name: rspec
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -106,7 +107,7 @@ dependencies:
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: rr
+  name: rspec-rails
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
@@ -120,7 +121,7 @@ dependencies:
   type: :development
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: steak
+  name: rr
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
@@ -134,7 +135,7 @@ dependencies:
   type: :development
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: capybara
+  name: steak
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
@@ -148,7 +149,7 @@ dependencies:
   type: :development
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: database_cleaner
+  name: capybara
   prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
@@ -161,6 +162,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id011
 description: Kaminari is a Scope & Engine based, clean, powerful, customizable and sophisticated paginator for Rails 3
 email: 
 - ronnie@dio.jp
@@ -216,9 +231,11 @@ files:
 - lib/kaminari/models/active_record_relation_methods.rb
 - lib/kaminari/models/array_extension.rb
 - lib/kaminari/models/configuration_methods.rb
+- lib/kaminari/models/mongo_mapper_extension.rb
 - lib/kaminari/models/mongoid_criteria_methods.rb
 - lib/kaminari/models/mongoid_extension.rb
 - lib/kaminari/models/page_scope_methods.rb
+- lib/kaminari/models/plucky_criteria_methods.rb
 - lib/kaminari/railtie.rb
 - lib/kaminari/version.rb
 - spec/acceptance/acceptance_helper.rb
@@ -227,11 +244,13 @@ files:
 - spec/acceptance/users_spec.rb
 - spec/config/config_spec.rb
 - spec/fake_app.rb
+- spec/helpers/action_view_extension_spec.rb
 - spec/helpers/helpers_spec.rb
 - spec/helpers/tags_spec.rb
 - spec/models/active_record_relation_methods_spec.rb
 - spec/models/array_spec.rb
 - spec/models/default_per_page_spec.rb
+- spec/models/mongo_mapper_spec.rb
 - spec/models/mongoid_spec.rb
 - spec/models/scopes_spec.rb
 - spec/spec_helper.rb
@@ -277,11 +296,13 @@ test_files:
 - spec/acceptance/users_spec.rb
 - spec/config/config_spec.rb
 - spec/fake_app.rb
+- spec/helpers/action_view_extension_spec.rb
 - spec/helpers/helpers_spec.rb
 - spec/helpers/tags_spec.rb
 - spec/models/active_record_relation_methods_spec.rb
 - spec/models/array_spec.rb
 - spec/models/default_per_page_spec.rb
+- spec/models/mongo_mapper_spec.rb
 - spec/models/mongoid_spec.rb
 - spec/models/scopes_spec.rb
 - spec/spec_helper.rb