kaminari 0.11.0 → 0.12.0

data/lib/kaminari/helpers/paginator.rb

@@ -6,10 +6,12 @@ module Kaminari
     class Paginator < Tag
       def initialize(template, options) #:nodoc:
         @window_options = {}.tap do |h|
-          h[:window] = options.delete(:window) || options.delete(:inner_window) || 4
-          outer_window = options.delete(:outer_window)
-          h[:left] = options.delete(:left) || outer_window || 0
-          h[:right] = options.delete(:right) || outer_window || 0
+          h[:window] = options.delete(:window) || options.delete(:inner_window) || Kaminari.config.window
+          outer_window = options.delete(:outer_window) || Kaminari.config.outer_window
+          h[:left] = options.delete(:left) || Kaminari.config.left
+          h[:left] = outer_window if h[:left] == 0
+          h[:right] = options.delete(:right) || Kaminari.config.right
+          h[:right] = outer_window if h[:right] == 0
         end
         @template, @options = template, options
         @options[:current_page] = PageProxy.new @window_options.merge(@options), @options[:current_page], nil

data/lib/kaminari/helpers/tags.rb

@@ -25,7 +25,7 @@ module Kaminari
       end
 
       def page_url_for(page)
-        @template.url_for @template.params.merge(@param_name => (page <= 1 ? nil : page))
+        @template.url_for @params.merge(@param_name => (page <= 1 ? nil : page))
       end
     end
 

data/lib/kaminari/models/active_record_relation_methods.rb

@@ -2,9 +2,11 @@ module Kaminari
   module ActiveRecordRelationMethods
     extend ActiveSupport::Concern
     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'
         def count #:nodoc:
-          limit_value == 0 ? 0 : length
+          limit_value ? length : super
         end
       end
 

data/lib/kaminari/models/array_extension.rb

@@ -0,0 +1,42 @@
+module Kaminari
+  # Kind of Array that can paginate
+  class PaginatableArray < Array
+    include Kaminari::ConfigurationMethods::ClassMethods
+
+    attr_internal_accessor :limit_value, :offset_value
+
+    def initialize(original_array, limit_val = default_per_page, offset_val = 0) #:nodoc:
+      @_original_array, @_limit_value, @_offset_value = original_array, limit_val, offset_val
+      super (original_array[offset_val, limit_val] || [])
+    end
+
+    # items at the specified "page"
+    def page(num = 1)
+      offset(limit_value * ([num.to_i, 1].max - 1))
+    end
+
+    # returns another chunk of the original array
+    def limit(num)
+      self.class.new @_original_array, num, offset_value
+    end
+
+    # total item numbers of the original array
+    def total_count
+      @_original_array.count
+    end
+
+    # returns another chunk of the original array
+    def offset(num)
+      arr = self.class.new @_original_array, limit_value, num
+      class << arr
+        include Kaminari::PageScopeMethods
+      end
+      arr
+    end
+  end
+
+  # Wrap an Array object to make it paginatable
+  def self.paginate_array(array)
+    PaginatableArray.new array
+  end
+end

data/lib/kaminari/models/configuration_methods.rb

@@ -2,7 +2,7 @@ module Kaminari
   module ConfigurationMethods
     extend ActiveSupport::Concern
     module ClassMethods
-      # Overrides the default per_page value per model
+      # Overrides the default +per_page+ value per model
       #   class Article < ActiveRecord::Base
       #     paginates_per 10
       #   end
@@ -10,10 +10,10 @@ module Kaminari
         @_default_per_page = val
       end
 
-      # This model's default per_page value
-      # returns 25 unless explicitly overridden via <tt>paginates_per</tt>
+      # This model's default +per_page+ value
+      # returns +default_per_page+ value unless explicitly overridden via <tt>paginates_per</tt>
       def default_per_page
-        @_default_per_page || Kaminari::DEFAULT_PER_PAGE
+        @_default_per_page || Kaminari.config.default_per_page
       end
     end
   end

data/lib/kaminari/railtie.rb

@@ -2,13 +2,13 @@ require 'rails'
 # ensure ORMs are loaded *before* initializing Kaminari
 begin; require 'mongoid'; rescue LoadError; end
 
+require File.join(File.dirname(__FILE__), 'config')
 require File.join(File.dirname(__FILE__), 'helpers/action_view_extension')
 require File.join(File.dirname(__FILE__), 'helpers/paginator')
 require File.join(File.dirname(__FILE__), 'models/page_scope_methods')
 require File.join(File.dirname(__FILE__), 'models/configuration_methods')
 
 module Kaminari
-  DEFAULT_PER_PAGE = 25 unless defined? ::Kaminari::DEFAULT_PER_PAGE
   class Railtie < ::Rails::Railtie #:nodoc:
     initializer 'kaminari' do |app|
       ActiveSupport.on_load(:active_record) do
@@ -20,6 +20,7 @@ module Kaminari
         ::Mongoid::Document.send :include, Kaminari::MongoidExtension::Document
         ::Mongoid::Criteria.send :include, Kaminari::MongoidExtension::Criteria
       end
+      require File.join(File.dirname(__FILE__), 'models/array_extension')
       ActiveSupport.on_load(:action_view) do
         ::ActionView::Base.send :include, Kaminari::ActionViewExtension
       end

data/lib/kaminari/version.rb

@@ -1,3 +1,3 @@
 module Kaminari
-  VERSION = File.read File.join(File.dirname(__FILE__), '../../VERSION')
+  VERSION = '0.12.0'
 end

data/spec/config/config_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe Kaminari::Configuration do
+  subject { Kaminari.config }
+  describe 'default_per_page' do
+    context 'by default' do
+      its(:default_per_page) { should == 25 }
+    end
+    context 'configured via config block' do
+      before do
+        Kaminari.configure {|c| c.default_per_page = 17}
+      end
+      its(:default_per_page) { should == 17 }
+      after do
+        Kaminari.configure {|c| c.default_per_page = 25}
+      end
+    end
+  end
+
+  describe 'window' do
+    context 'by default' do
+      its(:window) { should == 4 }
+    end
+  end
+
+  describe 'outer_window' do
+    context 'by default' do
+      its(:outer_window) { should == 0 }
+    end
+  end
+
+  describe 'left' do
+    context 'by default' do
+      its(:left) { should == 0 }
+    end
+  end
+
+  describe 'right' do
+    context 'by default' do
+      its(:right) { should == 0 }
+    end
+  end
+end

data/spec/models/array_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe Kaminari::PaginatableArray do
+  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(: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(: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 '#num_pages' do
+    context 'per 25 (default)' do
+      subject { array.page }
+      its(:num_pages) { should == 4 }
+    end
+
+    context 'per 7' do
+      subject { array.page(2).per(7) }
+      its(:num_pages) { should == 15 }
+    end
+
+    context 'per 65536' do
+      subject { array.page(50).per(65536) }
+      its(:num_pages) { should == 1 }
+    end
+
+    context 'per 0 (using default)' do
+      subject { array.page(50).per(0) }
+      its(:num_pages) { should == 4 }
+    end
+
+    context 'per -1 (using default)' do
+      subject { array.page(5).per(-1) }
+      its(:num_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(:num_pages) { should == 4 }
+    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 '#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
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kaminari
 version: !ruby/object:Gem::Version 
-  hash: 51
+  hash: 47
   prerelease: 
   segments: 
   - 0
-  - 11
+  - 12
   - 0
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors: 
 - Akira Matsuda
@@ -15,25 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-19 00:00:00 Z
+date: 2011-04-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id001
-  name: kaminari
+  name: rails
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,12 +31,12 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
-  version_requirements: *id002
-  name: rails
-  prerelease: false
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,12 +47,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id003
-  name: bundler
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -74,12 +61,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id004
-  name: sqlite3
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -88,26 +75,12 @@ dependencies:
         segments: 
         - 2
         version: "2"
-  version_requirements: *id005
-  name: mongoid
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id006
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -116,40 +89,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id007
-  name: rspec-rails
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id008
-  name: rr
-  prerelease: false
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id009
-  name: steak
+  name: rspec-rails
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -158,40 +103,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id010
-  name: capybara
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id011 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id011
-  name: database_cleaner
-  prerelease: false
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id012 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id012
-  name: rcov
+  name: rr
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -200,72 +117,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id013
-  name: jeweler
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id014 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
-  version_requirements: *id014
-  name: rails
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id015 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id015
-  name: bundler
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id016 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id016
-  name: sqlite3
-  prerelease: false
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id017 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        version: "2"
-  version_requirements: *id017
-  name: mongoid
+  name: steak
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id018 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -274,40 +131,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id018
-  name: rspec
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id019 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id019
-  name: rspec-rails
-  prerelease: false
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id020 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id020
-  name: rr
+  name: capybara
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id021 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -316,40 +145,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id021
-  name: steak
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id022 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id022
-  name: capybara
-  prerelease: false
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id023 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id023
   name: database_cleaner
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id024 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -358,43 +159,27 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id024
-  name: rcov
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id025 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id025
-  name: jeweler
-  prerelease: false
+  version_requirements: *id010
 description: Kaminari is a Scope & Engine based, clean, powerful, customizable and sophisticated paginator for Rails 3
-email: ronnie@dio.jp
+email: 
+- ronnie@dio.jp
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE.txt
 - README.rdoc
 files: 
 - .document
 - .gemtest
+- .gitignore
 - .rspec
 - CHANGELOG
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
-- VERSION
 - app/views/kaminari/_first_page.html.erb
 - app/views/kaminari/_first_page.html.haml
 - app/views/kaminari/_gap.html.erb
@@ -411,14 +196,18 @@ files:
 - app/views/kaminari/_prev_page.html.haml
 - config/locales/kaminari.yml
 - kaminari.gemspec
+- lib/generators/kaminari/config_generator.rb
+- lib/generators/kaminari/templates/kaminari_config.rb
 - lib/generators/kaminari/views_generator.rb
 - lib/kaminari.rb
+- lib/kaminari/config.rb
 - lib/kaminari/engine.rb
 - lib/kaminari/helpers/action_view_extension.rb
 - lib/kaminari/helpers/paginator.rb
 - lib/kaminari/helpers/tags.rb
 - lib/kaminari/models/active_record_extension.rb
 - lib/kaminari/models/active_record_relation_methods.rb
+- lib/kaminari/models/array_extension.rb
 - lib/kaminari/models/configuration_methods.rb
 - lib/kaminari/models/mongoid_criteria_methods.rb
 - lib/kaminari/models/mongoid_extension.rb
@@ -429,17 +218,19 @@ files:
 - spec/acceptance/support/helpers.rb
 - spec/acceptance/support/paths.rb
 - spec/acceptance/users_spec.rb
+- spec/config/config_spec.rb
 - spec/fake_app.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/mongoid_spec.rb
 - spec/models/scopes_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_cleaner.rb
 - spec/support/matchers.rb
-homepage: http://github.com/amatsuda/kaminari
+homepage: https://github.com/amatsuda/kaminari
 licenses: 
 - MIT
 post_install_message: 
@@ -467,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: kaminari
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
@@ -477,13 +268,16 @@ test_files:
 - spec/acceptance/support/helpers.rb
 - spec/acceptance/support/paths.rb
 - spec/acceptance/users_spec.rb
+- spec/config/config_spec.rb
 - spec/fake_app.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/mongoid_spec.rb
 - spec/models/scopes_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_cleaner.rb
 - spec/support/matchers.rb
+has_rdoc: