kaminari 0.9.12 → 0.9.13

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 0.9.13
+
+* Added Mongoid support #5 [juno, hibariya]
+  This means, Kaminari is now *ORM agnostic*  ☇3☇3☇3
+
 == 0.9.12
 
 * Moved the whole pagination logic to the paginator partial so that users can

data/Gemfile

@@ -20,4 +20,6 @@ group :development do
   gem 'rspec-rails', '>= 2.5.0'
   gem 'sqlite3', '>= 1.3.3'
   gem 'ruby-debug'
+  gem 'mongoid', '2.0.0.rc.7'
+  gem 'bson_ext', '~> 1.2'
 end

data/Gemfile.lock

@@ -61,6 +61,8 @@ GEM
   specs:
     abstract (1.0.0)
     bcrypt-ruby (2.1.4)
+    bson (1.2.2)
+    bson_ext (1.2.2)
     builder (3.0.0)
     capybara (0.4.1.2)
       celerity (>= 0.7.9)
@@ -96,6 +98,13 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.16)
+    mongo (1.2.2)
+      bson (>= 1.2.2)
+    mongoid (2.0.0.rc.7)
+      activemodel (~> 3.0)
+      mongo (~> 1.2)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
     nokogiri (1.4.4)
     polyglot (0.3.1)
     rack-cache (1.0)
@@ -138,6 +147,7 @@ GEM
     treetop (1.4.9)
       polyglot (>= 0.3.1)
     tzinfo (0.3.24)
+    will_paginate (3.0.pre2)
     xpath (0.1.3)
       nokogiri (~> 1.3)
 
@@ -146,9 +156,11 @@ PLATFORMS
 
 DEPENDENCIES
   arel!
+  bson_ext (~> 1.2)
   bundler (>= 1.0.0)
   capybara (>= 0.4.1.1)
   jeweler (>= 1.5.2)
+  mongoid (= 2.0.0.rc.7)
   rack!
   rails!
   rcov

data/README.rdoc

@@ -18,14 +18,22 @@ No special collection class or something for the paginated values but uses a gen
 * Engine based I18n aware customizable helper
 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 or style or whatever by overriding partial templates.
 
+* ORM, template engine agnostic
+Kaminari supports multiple ORMs (ActiveRecord, Mongoid) and multiple template engines (ERB, Haml).
+
 * Modern
 The pagination helper outputs the HTML5 <nav> tag by default. Plus, the helper supports the Rails 3 unobtrusive Ajax.
 
 
-== Rails versions
+== Supported versions
+
+* Ruby 1.8.7 and 1.9.2 and 1.9.3
+
+* Rails 3.0.x and 3.1
 
-3.0.x and 3.1
+* Haml 3
 
+* Mongoid 2 (beta)
 
 == Install
 

data/VERSION

@@ -1 +1 @@
-0.9.12
+0.9.13

data/kaminari.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kaminari}
-  s.version = "0.9.12"
+  s.version = "0.9.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Akira Matsuda"]
-  s.date = %q{2011-02-17}
+  s.date = %q{2011-02-18}
   s.description = %q{Kaminari is a Scope & Engine based clean and powerful and customizable and sophisticated paginator for Rails 3}
   s.email = %q{ronnie@dio.jp}
   s.extra_rdoc_files = [
@@ -51,9 +51,10 @@ Gem::Specification.new do |s|
     "kaminari.gemspec",
     "lib/generators/kaminari/views_generator.rb",
     "lib/kaminari.rb",
-    "lib/kaminari/active_record.rb",
+    "lib/kaminari/active_record_extension.rb",
     "lib/kaminari/engine.rb",
     "lib/kaminari/helpers.rb",
+    "lib/kaminari/mongoid_extension.rb",
     "lib/kaminari/railtie.rb",
     "lib/kaminari/tags.rb",
     "spec/acceptance/acceptance_helper.rb",
@@ -64,6 +65,7 @@ Gem::Specification.new do |s|
     "spec/helpers/helpers_spec.rb",
     "spec/helpers/tags_spec.rb",
     "spec/models/default_per_page_spec.rb",
+    "spec/models/mongoid_spec.rb",
     "spec/models/scopes_spec.rb",
     "spec/spec_helper.rb",
     "spec/support/matchers.rb"
@@ -82,6 +84,7 @@ Gem::Specification.new do |s|
     "spec/helpers/helpers_spec.rb",
     "spec/helpers/tags_spec.rb",
     "spec/models/default_per_page_spec.rb",
+    "spec/models/mongoid_spec.rb",
     "spec/models/scopes_spec.rb",
     "spec/spec_helper.rb",
     "spec/support/matchers.rb"
@@ -104,6 +107,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec-rails>, [">= 2.5.0"])
       s.add_development_dependency(%q<sqlite3>, [">= 1.3.3"])
       s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<mongoid>, ["= 2.0.0.rc.7"])
+      s.add_development_dependency(%q<bson_ext>, ["~> 1.2"])
       s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
     else
       s.add_dependency(%q<rspec>, [">= 2.5.0"])
@@ -119,6 +124,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec-rails>, [">= 2.5.0"])
       s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
       s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<mongoid>, ["= 2.0.0.rc.7"])
+      s.add_dependency(%q<bson_ext>, ["~> 1.2"])
       s.add_dependency(%q<rails>, [">= 3.0.0"])
     end
   else
@@ -135,6 +142,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec-rails>, [">= 2.5.0"])
     s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
     s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<mongoid>, ["= 2.0.0.rc.7"])
+    s.add_dependency(%q<bson_ext>, ["~> 1.2"])
     s.add_dependency(%q<rails>, [">= 3.0.0"])
   end
 end

data/lib/kaminari/{active_record.rb → active_record_extension.rb}

@@ -1,7 +1,8 @@
 module Kaminari
-  module ActiveRecord
+  DEFAULT_PER_PAGE = 25 unless defined? ::Kaminari::DEFAULT_PER_PAGE
+
+  module ActiveRecordExtension
     extend ActiveSupport::Concern
-    DEFAULT_PER_PAGE = 25
 
     included do
       def self.inherited(kls) #:nodoc:
@@ -51,7 +52,7 @@ module Kaminari
           # This model's default per_page value
           # returns 25 unless explicitly overridden via <tt>paginates_per</tt>
           def self.default_per_page
-            @_default_per_page || Kaminari::ActiveRecord::DEFAULT_PER_PAGE
+            @_default_per_page || Kaminari::DEFAULT_PER_PAGE
           end
         end
       end

data/lib/kaminari/mongoid_extension.rb

@@ -0,0 +1,63 @@
+module Kaminari
+  DEFAULT_PER_PAGE = 25 unless defined? ::Kaminari::DEFAULT_PER_PAGE
+
+  module MongoidExtension
+    module Criteria
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :page, :per, :num_pages, :current_page, :limit_value, :to => '@klass'
+      end
+    end
+
+    module Document
+      extend ActiveSupport::Concern
+
+      included do
+        # Fetch the values at the specified page number
+        #   Model.page(5)
+        scope :page, lambda {|num|
+          limit(default_per_page).offset(default_per_page * ([num.to_i, 1].max - 1))
+        } do
+          # 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(options[:skip] / options[:limit] * n)
+            end
+          end
+
+          # Total number of pages
+          def num_pages
+            (count.to_f / options[:limit]).ceil
+          end
+
+          # Current page number
+          def current_page
+            (options[:skip] / options[:limit]) + 1
+          end
+
+          def limit_value
+            options[:limit]
+          end
+        end
+
+        # Overrides the default per_page value per model
+        #   class Article < ActiveRecord::Base
+        #     paginates_per 10
+        #   end
+        def self.paginates_per(val)
+          @_default_per_page = val
+        end
+
+        # This model's default per_page value
+        # returns 25 unless explicitly overridden via <tt>paginates_per</tt>
+        def self.default_per_page
+          @_default_per_page || Kaminari::DEFAULT_PER_PAGE
+        end
+      end
+    end
+  end
+end

data/lib/kaminari/railtie.rb

@@ -1,13 +1,23 @@
 require 'rails'
-require 'active_record'
 require 'action_view'
-require File.join(File.dirname(__FILE__), 'active_record')
+# ensure ORMs are loaded *before* initializing Kaminari
+begin; require 'active_record'; rescue LoadError; end
+begin; require 'mongoid'; rescue LoadError; end
+
 require File.join(File.dirname(__FILE__), 'helpers')
 
 module Kaminari
   class Railtie < ::Rails::Railtie #:nodoc:
     initializer 'paginatablize' do |app|
-      ::ActiveRecord::Base.send :include, Kaminari::ActiveRecord
+      if defined? ::ActiveRecord
+        require File.join(File.dirname(__FILE__), 'active_record_extension')
+        ::ActiveRecord::Base.send :include, Kaminari::ActiveRecordExtension
+      end
+      if defined? ::Mongoid
+        require File.join(File.dirname(__FILE__), 'mongoid_extension')
+        ::Mongoid::Document.send :include, Kaminari::MongoidExtension::Document
+        ::Mongoid::Criteria.send :include, Kaminari::MongoidExtension::Criteria
+      end
       ::ActionView::Base.send :include, Kaminari::Helpers
     end
   end

data/spec/models/mongoid_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+require 'mongoid'
+require File.expand_path('../../lib/kaminari/mongoid_extension', File.dirname(__FILE__))
+
+describe Kaminari::MongoidExtension do
+  before :all do
+    class Developer
+      include ::Mongoid::Document
+    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 Mongoid::Criteria }
+      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 Mongoid::Criteria }
+      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 Mongoid::Criteria }
+      its(:current_page) { should == 1 }
+      its(:limit_value) { should == 25 }
+      its(:num_pages) { should == 12 }
+      it { should skip 0 }
+    end
+  end
+
+  describe '#per' do
+    subject { Developer.page(2).per(10) }
+    it { should be_a Mongoid::Criteria }
+    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

@@ -1,6 +1,6 @@
 require File.expand_path('../spec_helper', File.dirname(__FILE__))
 
-describe Kaminari::ActiveRecord do
+describe Kaminari::ActiveRecordExtension do
   before :all do
     User.delete_all
     1.upto(100) {|i| User.create! :name => "user#{'%03d' % i}" }

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rails'
+require 'mongoid'
 require 'kaminari'
 
 require File.join(File.dirname(__FILE__), 'fake_app')

data/spec/support/matchers.rb

@@ -38,3 +38,9 @@ RSpec::Matchers.define :contain_tag_old do |count|
     "expected #{count || 'any'} instance(s) of #{@klass.name} but was #{@count}"
   end
 end
+
+RSpec::Matchers.define :skip do |num|
+  match do |criteria|
+    criteria.instance_variable_get('@options')[:skip] == num
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kaminari
 version: !ruby/object:Gem::Version 
-  hash: 35
+  hash: 33
   prerelease: 
   segments: 
   - 0
   - 9
-  - 12
-  version: 0.9.12
+  - 13
+  version: 0.9.13
 platform: ruby
 authors: 
 - Akira Matsuda
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-17 00:00:00 +09:00
+date: 2011-02-18 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -218,8 +218,41 @@ dependencies:
   type: :development
   requirement: *id013
 - !ruby/object:Gem::Dependency 
-  name: rails
+  name: mongoid
   version_requirements: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15424091
+        segments: 
+        - 2
+        - 0
+        - 0
+        - rc
+        - 7
+        version: 2.0.0.rc.7
+  prerelease: false
+  type: :development
+  requirement: *id014
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  prerelease: false
+  type: :development
+  requirement: *id015
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirements: &id016 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -232,7 +265,7 @@ dependencies:
         version: 3.0.0
   prerelease: false
   type: :runtime
-  requirement: *id014
+  requirement: *id016
 description: Kaminari is a Scope & Engine based clean and powerful and customizable and sophisticated paginator for Rails 3
 email: ronnie@dio.jp
 executables: []
@@ -277,9 +310,10 @@ files:
 - kaminari.gemspec
 - lib/generators/kaminari/views_generator.rb
 - lib/kaminari.rb
-- lib/kaminari/active_record.rb
+- lib/kaminari/active_record_extension.rb
 - lib/kaminari/engine.rb
 - lib/kaminari/helpers.rb
+- lib/kaminari/mongoid_extension.rb
 - lib/kaminari/railtie.rb
 - lib/kaminari/tags.rb
 - spec/acceptance/acceptance_helper.rb
@@ -290,6 +324,7 @@ files:
 - spec/helpers/helpers_spec.rb
 - spec/helpers/tags_spec.rb
 - spec/models/default_per_page_spec.rb
+- spec/models/mongoid_spec.rb
 - spec/models/scopes_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
@@ -336,6 +371,7 @@ test_files:
 - spec/helpers/helpers_spec.rb
 - spec/helpers/tags_spec.rb
 - spec/models/default_per_page_spec.rb
+- spec/models/mongoid_spec.rb
 - spec/models/scopes_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb