kaminari 0.11.0 → 0.12.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+doc
+log

data/CHANGELOG

@@ -1,3 +1,24 @@
+== 0.12.0
+
+* General configuration options #41 #62 [javierv, iain]
+  You can now globally override some default values such as default_per_page,
+  window, etc. via configuration file.
+  Also, here comes a generator command that generates the default
+  configuration file into your app's config/initilizers directory.
+
+* Generic pagination support for Array object #47 #68 #74 [lda ened jianlin]
+  You can now paginate through any kind of Arrayish object in this way:
+    Kaminari.paginate_array(my_array_object).page(params[:page]).per(10)
+
+* Fixed a serious performance regression in 0.11.0 [ankane]
+  There was a critical performance issue on #count method in 0.11.0 gem.
+
+* Bugfix: Pass the real @params to url_for #90 [utkarshkukreti]
+
+* Fixed a gem packaging problem (circular dependency)
+  There was a packaging problem with Kaminari 0.11.0 that the gem depends on
+  Kaminari gem. Maybe Jeweler + "gemspec" method didn't work well...
+
 == 0.11.0
 
 This release contains several backward incompatibilities on template API.

data/Gemfile

@@ -1 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in kaminari.gemspec
 gemspec

data/README.rdoc

@@ -43,6 +43,7 @@ Put this line in your Gemfile:
 Then bundle:
   % bundle
 
+
 == Usage
 
 === Query Basics
@@ -58,6 +59,19 @@ Then bundle:
     User.page(7).per(50)
   Note that the +per+ scope is not directly defined on the models but is just a method defined on the page scope. This is absolutely reasonable because you will never actually use +per_page+ without specifying the +page+ number.
 
+=== General configuration options
+
+You can configure the following default values by overriding these values using <tt>Kaminari.configure</tt> method.
+  default_per_page  # 25 by default
+  window            # 4 by default
+  outer_window      # 0 by default
+  left              # 0 by default
+  right             # 0 by default
+
+There's a handy generator that generates the default configuration file into config/initilizers directory.
+Run the following generator command, then edit the generated file.
+  % rails g kaminari:config
+
 === Configuring default +per_page+ value for each model
 
 * +paginates_per+
@@ -90,24 +104,24 @@ Then bundle:
     <%= paginate @users, :window => 2 %>
   This would output something like <tt>... 5 6 7 8 9 ...</tt> when 7 is the current page.
 
-* specifing the "outer window" size (1 by default)
+* specifing the "outer window" size (0 by default)
 
     <%= paginate @users, :outer_window => 3 %>
   This would output something like <tt>1 2 3 4 ...(snip)... 17 18 19 20</tt> while having 20 pages in total.
 
-* outer window can be separetely specified by +left+, +right+ (1 by default)
+* outer window can be separetely specified by +left+, +right+ (0 by default)
 
-    <%= paginate @users, :left => 0, :right => 2 %>
+    <%= paginate @users, :left => 1, :right => 3 %>
   This would output something like <tt>1 ...(snip)... 18 19 20</tt> while having 20 pages in total.
 
 * changing the parameter name (:+param_name+) for the links
 
-    <%= paginate @users, :param_name => :pagina
+    <%= paginate @users, :param_name => :pagina %>
   This would modify the query parameter name on each links.
 
 * extra parameters (:+params+) for the links
 
-    <%= paginate @users, :params => {:controller => 'foo', :action => 'bar'}
+    <%= paginate @users, :params => {:controller => 'foo', :action => 'bar'} %>
   This would modify each link's +url_option+. :+controller+ and :+action+ might be the keys in common.
 
 * Ajax links (crazy simple, but works perfectly!)
@@ -159,25 +173,33 @@ Kaminari includes a handy template generator.
 * multiple themes
 
   To utilize multiple themes from within a single application, create a directory within the app/views/kaminari/ and move your custom template files into that directory.
-    rails g kaminari:views default (skip if you have existing kaminari views)
-    cd app/views/kaminari
-    mkdir my_custom_theme
-    cp _*.html.* my_custom_theme/
-	
+    % rails g kaminari:views default (skip if you have existing kaminari views)
+    % cd app/views/kaminari
+    % mkdir my_custom_theme
+    % cp _*.html.* my_custom_theme/
+
   Next reference that directory when calling the paginate method:
 
-    % paginate @users, :theme => 'my_custom_theme'
+    <%= paginate @users, :theme => 'my_custom_theme' %>
 
   Customize away!
 
   Note: if the theme isn't present or none is specified, kaminari will default back to the views included within the gem.
 
+=== Paginating a generic Array object
+
+Kaminari provides an Array wrapper class that adapts a generic Array object to the <tt>paginate</tt> view helper.
+However, the <tt>paginate</tt> helper doesn't automatically handle your Array object (this is an intensional design).
+<tt>Kaminari::paginate_array</tt> method converts your Array object into a paginatable Array that accepts <tt>page</tt> method.
+  Kaminari.paginate_array(my_array_object).page(params[:page]).per(10)
+
 
 == For more information
 
 Check out Kaminari recipes on the GitHub Wiki for more advanced tips and techniques.
 https://github.com/amatsuda/kaminari/wiki/Kaminari-recipes
 
+
 == Questions, Feedback
 
 Feel free to message me on Github (amatsuda) or Twitter (@a_matsuda)  ☇☇☇  :)

data/Rakefile

@@ -1,42 +1,7 @@
 # encoding: utf-8
 
-require 'rubygems'
 require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "kaminari"
-  gem.homepage = "http://github.com/amatsuda/kaminari"
-  gem.license = "MIT"
-  gem.summary = 'A pagination engine plugin for Rails 3'
-  gem.description = 'Kaminari is a Scope & Engine based, clean, powerful, customizable and sophisticated paginator for Rails 3'
-  gem.email = "ronnie@dio.jp"
-  gem.authors = ["Akira Matsuda"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-   gem.add_development_dependency 'rails', '>= 3.0.0'
-   gem.add_development_dependency 'bundler', '>= 1.0.0'
-   gem.add_development_dependency 'sqlite3'
-   gem.add_development_dependency 'mongoid', '>= 2'
-   gem.add_development_dependency 'rspec'
-   gem.add_development_dependency 'rspec-rails'
-   gem.add_development_dependency 'rr'
-   gem.add_development_dependency 'steak'
-   gem.add_development_dependency 'capybara'
-   gem.add_development_dependency 'database_cleaner'
-   gem.add_development_dependency 'rcov'
-   gem.add_development_dependency 'jeweler'
-end
-Jeweler::RubygemsDotOrgTasks.new
+Bundler::GemHelper.install_tasks
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
@@ -44,23 +9,14 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
 task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  require 'kaminari/version'
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "kaminari #{version}"
+  rdoc.title = "kaminari #{Kaminari::VERSION}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
-task :test do
-	Rake::Task[:spec].invoke
-end

data/kaminari.gemspec

@@ -1,181 +1,34 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kaminari/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{kaminari}
-  s.version = "0.11.0"
+  s.name        = 'kaminari'
+  s.version     = Kaminari::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Akira Matsuda']
+  s.email       = ['ronnie@dio.jp']
+  s.homepage    = 'https://github.com/amatsuda/kaminari'
+  s.summary     = 'A pagination engine plugin for Rails 3'
+  s.description = 'Kaminari is a Scope & Engine based, clean, powerful, customizable and sophisticated paginator for Rails 3'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Akira Matsuda"]
-  s.date = %q{2011-04-19}
-  s.description = %q{Kaminari is a Scope & Engine based, clean, powerful, customizable and sophisticated paginator for Rails 3}
-  s.email = %q{ronnie@dio.jp}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    ".gemtest",
-    ".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",
-    "app/views/kaminari/_gap.html.haml",
-    "app/views/kaminari/_last_page.html.erb",
-    "app/views/kaminari/_last_page.html.haml",
-    "app/views/kaminari/_next_page.html.erb",
-    "app/views/kaminari/_next_page.html.haml",
-    "app/views/kaminari/_page.html.erb",
-    "app/views/kaminari/_page.html.haml",
-    "app/views/kaminari/_paginator.html.erb",
-    "app/views/kaminari/_paginator.html.haml",
-    "app/views/kaminari/_prev_page.html.erb",
-    "app/views/kaminari/_prev_page.html.haml",
-    "config/locales/kaminari.yml",
-    "kaminari.gemspec",
-    "lib/generators/kaminari/views_generator.rb",
-    "lib/kaminari.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/configuration_methods.rb",
-    "lib/kaminari/models/mongoid_criteria_methods.rb",
-    "lib/kaminari/models/mongoid_extension.rb",
-    "lib/kaminari/models/page_scope_methods.rb",
-    "lib/kaminari/railtie.rb",
-    "lib/kaminari/version.rb",
-    "spec/acceptance/acceptance_helper.rb",
-    "spec/acceptance/support/helpers.rb",
-    "spec/acceptance/support/paths.rb",
-    "spec/acceptance/users_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/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"
-  ]
-  s.homepage = %q{http://github.com/amatsuda/kaminari}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.2}
-  s.summary = %q{A pagination engine plugin for Rails 3}
-  s.test_files = [
-    "spec/acceptance/acceptance_helper.rb",
-    "spec/acceptance/support/helpers.rb",
-    "spec/acceptance/support/paths.rb",
-    "spec/acceptance/users_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/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"
-  ]
+  s.rubyforge_project = 'kaminari'
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.extra_rdoc_files = ['README.rdoc']
+  s.require_paths = ['lib']
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<kaminari>, [">= 0"])
-      s.add_development_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_development_dependency(%q<sqlite3>, [">= 0"])
-      s.add_development_dependency(%q<mongoid>, [">= 2"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
-      s.add_development_dependency(%q<rr>, [">= 0"])
-      s.add_development_dependency(%q<steak>, [">= 0"])
-      s.add_development_dependency(%q<capybara>, [">= 0"])
-      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_development_dependency(%q<sqlite3>, [">= 0"])
-      s.add_development_dependency(%q<mongoid>, [">= 2"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
-      s.add_development_dependency(%q<rr>, [">= 0"])
-      s.add_development_dependency(%q<steak>, [">= 0"])
-      s.add_development_dependency(%q<capybara>, [">= 0"])
-      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-    else
-      s.add_dependency(%q<kaminari>, [">= 0"])
-      s.add_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_dependency(%q<sqlite3>, [">= 0"])
-      s.add_dependency(%q<mongoid>, [">= 2"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<rspec-rails>, [">= 0"])
-      s.add_dependency(%q<rr>, [">= 0"])
-      s.add_dependency(%q<steak>, [">= 0"])
-      s.add_dependency(%q<capybara>, [">= 0"])
-      s.add_dependency(%q<database_cleaner>, [">= 0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_dependency(%q<sqlite3>, [">= 0"])
-      s.add_dependency(%q<mongoid>, [">= 2"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<rspec-rails>, [">= 0"])
-      s.add_dependency(%q<rr>, [">= 0"])
-      s.add_dependency(%q<steak>, [">= 0"])
-      s.add_dependency(%q<capybara>, [">= 0"])
-      s.add_dependency(%q<database_cleaner>, [">= 0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<kaminari>, [">= 0"])
-    s.add_dependency(%q<rails>, [">= 3.0.0"])
-    s.add_dependency(%q<bundler>, [">= 1.0.0"])
-    s.add_dependency(%q<sqlite3>, [">= 0"])
-    s.add_dependency(%q<mongoid>, [">= 2"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<rspec-rails>, [">= 0"])
-    s.add_dependency(%q<rr>, [">= 0"])
-    s.add_dependency(%q<steak>, [">= 0"])
-    s.add_dependency(%q<capybara>, [">= 0"])
-    s.add_dependency(%q<database_cleaner>, [">= 0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<rails>, [">= 3.0.0"])
-    s.add_dependency(%q<bundler>, [">= 1.0.0"])
-    s.add_dependency(%q<sqlite3>, [">= 0"])
-    s.add_dependency(%q<mongoid>, [">= 2"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<rspec-rails>, [">= 0"])
-    s.add_dependency(%q<rr>, [">= 0"])
-    s.add_dependency(%q<steak>, [">= 0"])
-    s.add_dependency(%q<capybara>, [">= 0"])
-    s.add_dependency(%q<database_cleaner>, [">= 0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-  end
-end
+  s.licenses = ['MIT']
 
+  s.add_dependency 'rails', ['>= 3.0.0']
+  s.add_development_dependency 'bundler', ['>= 1.0.0']
+  s.add_development_dependency 'sqlite3', ['>= 0']
+  s.add_development_dependency 'mongoid', ['>= 2']
+  s.add_development_dependency 'rspec', ['>= 0']
+  s.add_development_dependency 'rspec-rails', ['>= 0']
+  s.add_development_dependency 'rr', ['>= 0']
+  s.add_development_dependency 'steak', ['>= 0']
+  s.add_development_dependency 'capybara', ['>= 0']
+  s.add_development_dependency 'database_cleaner', ['>= 0']
+end

data/lib/generators/kaminari/config_generator.rb

@@ -0,0 +1,16 @@
+module Kaminari
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      desc <<DESC
+Description:
+    Copies Kaminari configuration file to your application's initializer directory.
+DESC
+
+      def copy_config_file
+        template 'kaminari_config.rb', 'config/initializers/kaminari_config.rb'
+      end
+    end
+  end
+end

data/lib/generators/kaminari/templates/kaminari_config.rb

@@ -0,0 +1,7 @@
+Kaminari.configure do |config|
+  # config.default_per_page = 25
+  # config.window = 4
+  # config.outer_window = 0
+  # config.left = 0
+  # config.right = 0
+end

data/lib/kaminari.rb

@@ -1,3 +1,2 @@
-require File.join(File.dirname(__FILE__), 'kaminari/version')
 require File.join(File.dirname(__FILE__), 'kaminari/railtie')
 require File.join(File.dirname(__FILE__), 'kaminari/engine')

data/lib/kaminari/config.rb

@@ -0,0 +1,35 @@
+require 'active_support/configurable'
+
+module Kaminari
+  # Configures global settings for Kaminari
+  #   Kaminari.configure do |config|
+  #     config.default_per_page = 10
+  #   end
+  def self.configure(&block)
+    yield @config ||= Kaminari::Configuration.new
+  end
+
+  # Global settings for Kaminari
+  def self.config
+    @config
+  end
+
+  # need a Class for 3.0
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor :default_per_page
+    config_accessor :window
+    config_accessor :outer_window
+    config_accessor :left
+    config_accessor :right
+  end
+
+  # this is ugly. why can't we pass the default value to config_accessor...?
+  configure do |config|
+    config.default_per_page = 25
+    config.window = 4
+    config.outer_window = 0
+    config.left = 0
+    config.right = 0
+  end
+end