classic_pagination plugin

master-old
Eugene Korbut 2009-01-08 06:22:44 +10:00
parent ab8bf72949
commit 53fd7ad6ee
23 changed files with 1267 additions and 487 deletions

View File

@ -1,487 +0,0 @@
# == Pagination Helper
#
# === Action Pack pagination for Active Record collections
#
# <em>Sam Stephenson <sstephenson at gmail dot com></em>
#
# Pagination Helper aids in the process of paging large collections of Active
# Record objects. It offers macro-style automatic fetching of your model for
# multiple views, or explicit fetching for single actions. And if the magic
# isn't flexible enough for your needs, you can create your own paginators
# with a minimal amount of code.
#
# Unlike most helpers, Pagination Helper is available to all of Action Pack:
# it helps you query your models with Action Controller and render links in
# Action View.
#
# ----
#
# === Controller examples
#
# Pagination Helper can handle as much or as little as you wish. In the
# controller, have it automatically query your model for pagination; or,
# if you prefer, create Paginator objects yourself.
#
# ==== Automatic pagination for every action in a controller
#
# class PersonController < ApplicationController
# helper :pagination
# model :person
#
# paginate :people, :order_by => 'last_name, first_name',
# :per_page => 20
#
# # ...
# end
#
# Each action in this controller now has access to a <tt>@people</tt> instance
# variable, which is an ordered collection of model objects for the current
# page (at most 20, sorted by last name and first name), and a
# <tt>@person_pages</tt> Paginator instance. The current page is determined by
# the <tt>@params['page']</tt> variable.
#
# ==== Pagination for a single action
#
# def list
# @person_pages, @people =
# paginate :people, :order_by => 'last_name, first_name'
# end
#
# Like the previous example, but explicitly creates <tt>@person_pages</tt> and
# <tt>@people</tt> for a single action, and uses the default of 10 items per
# page.
#
# ==== Custom/"classic" pagination
#
# def list
# @person_pages = Paginator.new self, Person.count, 10, @params['page']
# @people = Person.find_all nil, 'last_name, first_name',
# @person_pages.current.to_sql
# end
#
# Explicitly creates the paginator from the previous example and uses
# Paginator#to_sql to retrieve <tt>@people</tt> from the model.
#
# === View examples
#
# Paginator Helper includes various methods to help you display pagination
# links in your views. (For information on displaying the paginated
# collections you retrieve in the controller, see the documentation for
# ActionView::Partials#render_collection_of_partials.)
#
# ==== Using Paginator#basic_html
#
# Use the +basic_html+ method to get a simple list of pages (always including
# the first and last page) with a window around the current page. In your
# view, using one of the controller examples above,
#
# <%= @person_pages.basic_html(self) %>
#
# will render a list of links. For a list of parameters, see the documentation
# for Page#basic_html.
#
# ==== Using a paginator partial
#
# If you need more advanced control over pagination links and need to paginate
# multiple actions and controllers, consider using a shared paginator partial.
# For instance, _why suggests this partial, which you might place in
# <tt>app/views/partial/_paginator.rhtml</tt>:
#
# <div class="counter">
# Displaying <%= paginator.current.first_item %>
# - <%= paginator.current.last_item %>
# of <%= paginator.item_count %> &nbsp; &nbsp;
#
# <%= link_to(h('< Previous'), paginator.current.previous.to_link) +
# " | " if paginator.current.previous %>
# <%= paginator.basic_html(self, 4) %>
# <%= " | " + link_to(h('Next >'), paginator.current.next.to_link) if
# paginator.current.next %>
# </div>
#
# Then in your views, simply call
#
# <%= render_partial "partial/paginator", @person_pages %>
#
# wherever you want your pagination links to appear.
#
# ----
#
# ==== Thanks
#
# Thanks to the following people for their contributions to Pagination Helper:
# * Marcel Molina Jr (noradio), who provided the idea for and original
# implementation of Paginator::Window, as well as endless mental support.
# * evl, who pointed out that Page#link_to should take and merge in a hash of
# additional parameters.
# * why the lucky stiff, who wrote a lovely article on the original Pagination
# Helper alongside the first implementation of Paginator#base_html, created
# Page#first_item and Page#last_item, and who provided inspiration for
# revising Pagination Helper to make it more "Rails-ish."
# * xal, who saw the limitations of having only the macro-style paginate
# method and suggested the single-action version, and who also suggested the
# automatic inclusion into ActionController::Base.
# * jbd for feedback and debugging help.
# * ##rubyonrails on Freenode and the Rails mailing list.
#
module PaginationHelper
# A hash holding options for controllers using macro-style pagination
OPTIONS = Hash.new
# The default options for pagination
DEFAULT_OPTIONS = {
:class_name => nil,
:per_page => 10,
:parameter => 'page',
:conditions => nil,
:order_by => nil
}
def self.included(base) #:nodoc:
super
base.extend(ClassMethods)
end
def self.validate_options!(collection_id, options, in_action) #:nodoc:
options.merge!(DEFAULT_OPTIONS) {|key, old, new| old}
valid_options = [:class_name, :per_page,
:parameter, :conditions, :order_by]
valid_options << :actions unless in_action
unknown_option_keys = options.keys - valid_options
raise ActionController::ActionControllerError,
"Unknown options: #{unknown_option_keys.join(', ')}" unless
unknown_option_keys.empty?
options[:singular_name] = Inflector.singularize(collection_id.to_s)
options[:class_name] ||= Inflector.camelize(options[:singular_name])
end
# Returns a paginator and a collection of Active Record model instances for
# the paginator's current page. This is designed to be used in a single
# action; to automatically paginate multiple actions, consider
# ClassMethods#paginate.
#
# +options+ are:
# <tt>:class_name</tt>:: the class name to use, if it can't be inferred by
# singularizing the collection name.
# <tt>:per_page</tt>:: the maximum number of items to include in a
# single page. Defaults to 10.
# <tt>:parameter</tt>:: the CGI parameter from which the current page is
# determined. Defaults to 'page'; i.e., the current
# page is specified by <tt>@params['page']</tt>.
# <tt>:conditions</tt>:: optional conditions passed to Model.find_all.
# <tt>:order_by</tt>:: optional order parameter passed to Model.find_all
# and Model.count.
def paginate(collection_id, options={})
PaginationHelper.validate_options!(collection_id, options, true)
paginator_and_collection_for(collection_id, options)
end
# These methods become class methods on any controller which includes
# PaginationHelper.
module ClassMethods
# Creates a +before_filter+ which automatically paginates an Active Record
# model for all actions in a controller (or certain actions if specified
# with the <tt>:actions</tt> option).
#
# +options+ are the same as PaginationHelper#paginate, with the addition
# of:
# <tt>:actions</tt>:: an array of actions for which the pagination is
# active. Defaults to +nil+ (i.e., every action).
def paginate(collection_id, options={})
PaginationHelper.validate_options!(collection_id, options, false)
module_eval do
before_filter :create_paginators_and_retrieve_collections
OPTIONS[self] ||= Hash.new
OPTIONS[self][collection_id] = options
end
end
end
def create_paginators_and_retrieve_collections #:nodoc:
PaginationHelper::OPTIONS[self.class].each do |collection_id, options|
next unless options[:actions].include? action_name if options[:actions]
paginator, collection =
paginator_and_collection_for(collection_id, options)
paginator_name = "@#{options[:singular_name]}_pages"
self.instance_variable_set(paginator_name, paginator)
collection_name = "@#{collection_id.to_s}"
self.instance_variable_set(collection_name, collection)
end
end
# Returns the total number of items in the collection to be paginated for
# the +model+ and given +conditions+. Override this method to implement a
# custom counter.
def count_collection_for_pagination(model, conditions)
model.count(conditions)
end
# Returns a collection of items for the given +model+ and +conditions+,
# ordered by +order_by+, for the current page in the given +paginator+.
# Override this method to implement a custom finder.
def find_collection_for_pagination(model, conditions, order_by, paginator)
model.find_all(conditions, order_by, paginator.current.to_sql)
end
protected :create_paginators_and_retrieve_collections,
:count_collection_for_pagination, :find_collection_for_pagination
def paginator_and_collection_for(collection_id, options) #:nodoc:
klass = eval options[:class_name]
page = @params[options[:parameter]]
count = count_collection_for_pagination(klass, options[:conditions])
paginator = Paginator.new(self, count,
options[:per_page], page, options[:parameter])
collection = find_collection_for_pagination(klass,
options[:conditions], options[:order_by], paginator)
return paginator, collection
end
private :paginator_and_collection_for
# A class representing a paginator for an Active Record collection.
class Paginator
include Enumerable
# Creates a new Paginator on the given +controller+ for a set of items of
# size +item_count+ and having +items_per_page+ items per page. Raises
# ArgumentError if items_per_page is out of bounds (i.e., less than or
# equal to zero). The page CGI parameter for links defaults to "page" and
# can be overridden with +page_parameter+.
def initialize(controller, item_count, items_per_page, current_page=1,
page_parameter='page')
raise ArgumentError, 'must have at least one item per page' if
items_per_page <= 0
@controller = controller
@item_count = item_count || 0
@items_per_page = items_per_page
@page_parameter = page_parameter
self.current_page = current_page
end
attr_reader :controller, :item_count, :items_per_page, :page_parameter
# Sets the current page number of this paginator. If +page+ is a Page
# object, its +number+ attribute is used as the value; if the page does
# not belong to this Paginator, an ArgumentError is raised.
def current_page=(page)
if page.is_a? Page
raise ArgumentError, 'Page/Paginator mismatch' unless
page.paginator == self
end
page = page.to_i
@current_page = has_page_number?(page) ? page : 1
end
# Returns a Page object representing this paginator's current page.
def current_page
self[@current_page]
end
alias current :current_page
# Returns a new Page representing the first page in this paginator.
def first_page
self[1]
end
alias first :first_page
# Returns a new Page representing the last page in this paginator.
def last_page
self[page_count]
end
alias last :last_page
# Returns the number of pages in this paginator.
def page_count
return 1 if @item_count.zero?
(@item_count / @items_per_page.to_f).ceil
end
alias length :page_count
# Returns true if this paginator contains the page of index +number+.
def has_page_number?(number)
return false unless number.is_a? Fixnum
number >= 1 and number <= page_count
end
# Returns a new Page representing the page with the given index +number+.
def [](number)
Page.new(self, number)
end
# Successively yields all the paginator's pages to the given block.
def each(&block)
page_count.times do |n|
yield self[n+1]
end
end
# Creates a basic HTML link bar for the given +view+. The first and last
# pages of the paginator are always shown, along with +window_size+ pages
# around the current page. By default, the current page is displayed, but
# not linked; to change this behavior, pass true to the
# +link_to_current_page+ argument. Specify additional link_to parameters
# with +params+.
def basic_html(view, window_size=2, link_to_current_page=false, params={})
window_pages = current.window(window_size).pages
return if window_pages.length <= 1 unless link_to_current_page
html = ''
unless window_pages[0].first?
html << view.link_to(first.number, first.to_link(params))
html << ' ... ' if window_pages[0].number - first.number > 1
html << ' '
end
window_pages.each do |page|
if current == page and not link_to_current_page
html << page.number.to_s
else
html << view.link_to(page.number, page.to_link(params))
end
html << ' '
end
unless window_pages.last.last?
html << ' ... ' if last.number - window_pages[-1].number > 1
html << view.link_to(last.number, last.to_link(params))
end
html
end
# A class representing a single page in a paginator.
class Page
include Comparable
# Creates a new Page for the given +paginator+ with the index +number+.
# If +number+ is not in the range of valid page numbers or is not a
# number at all, it defaults to 1.
def initialize(paginator, number)
@paginator = paginator
@number = number.to_i
@number = 1 unless @paginator.has_page_number? @number
end
attr_reader :paginator, :number
alias to_i :number
# Compares two Page objects and returns true when they represent the
# same page (i.e., their paginators are the same and they have the same
# page number).
def ==(page)
@paginator == page.paginator and
@number == page.number
end
# Compares two Page objects and returns -1 if the left-hand page comes
# before the right-hand page, 0 if the pages are equal, and 1 if the
# left-hand page comes after the right-hand page. Raises ArgumentError
# if the pages do not belong to the same Paginator object.
def <=>(page)
raise ArgumentError unless @paginator == page.paginator
@number <=> page.number
end
# Returns the item offset for the first item in this page.
def offset
@paginator.items_per_page * (@number - 1)
end
# Returns the number of the first item displayed.
def first_item
offset + 1
end
# Returns the number of the last item displayed.
def last_item
[@paginator.items_per_page * @number, @paginator.item_count].min
end
# Returns true if this page is the first page in the paginator.
def first?
self == @paginator.first
end
# Returns true if this page is the last page in the paginator.
def last?
self == @paginator.last
end
# Returns a new Page object representing the page just before this page,
# or nil if this is the first page.
def previous
if first? then nil else Page.new(@paginator, @number - 1) end
end
# Returns a new Page object representing the page just after this page,
# or nil if this is the last page.
def next
if last? then nil else Page.new(@paginator, @number + 1) end
end
# Returns a new Window object for this page with the specified
# +padding+.
def window(padding=2)
Window.new(self, padding)
end
# Returns a hash appropriate for using with link_to or url_for. Takes an
# optional +params+ hash for specifying additional link parameters.
def to_link(params={})
{:params => {@paginator.page_parameter => @number.to_s}.merge(params)}
end
# Returns the SQL "LIMIT ... OFFSET" clause for this page.
def to_sql
['? OFFSET ?', @paginator.items_per_page, offset]
end
end
# A class for representing ranges around a given page.
class Window
# Creates a new Window object for the given +page+ with the specified
# +padding+.
def initialize(page, padding=2)
@paginator = page.paginator
@page = page
self.padding = padding
end
attr_reader :paginator, :page
# Sets the window's padding (the number of pages on either side of the
# window page).
def padding=(padding)
@padding = padding < 0 ? 0 : padding
# Find the beginning and end pages of the window
@first = @paginator.has_page_number?(@page.number - @padding) ?
@paginator[@page.number - @padding] : @paginator.first
@last = @paginator.has_page_number?(@page.number + @padding) ?
@paginator[@page.number + @padding] : @paginator.last
end
attr_reader :padding, :first, :last
# Returns an array of Page objects in the current window.
def pages
(@first.number..@last.number).to_a.map {|n| @paginator[n]}
end
alias to_a :pages
end
end
end
module ActionController #:nodoc:
class Base #:nodoc:
# Automatically include PaginationHelper.
include PaginationHelper
end
end

View File

@ -0,0 +1,152 @@
* Exported the changelog of Pagination code for historical reference.
* Imported some patches from Rails Trac (others closed as "wontfix"):
#8176, #7325, #7028, #4113. Documentation is much cleaner now and there
are some new unobtrusive features!
* Extracted Pagination from Rails trunk (r6795)
#
# ChangeLog for /trunk/actionpack/lib/action_controller/pagination.rb
#
# Generated by Trac 0.10.3
# 05/20/07 23:48:02
#
09/03/06 23:28:54 david [4953]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
Docs and deprecation
08/07/06 12:40:14 bitsweat [4715]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
Deprecate direct usage of @params. Update ActionView::Base for
instance var deprecation.
06/21/06 02:16:11 rick [4476]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
Fix indent in pagination documentation. Closes #4990. [Kevin Clark]
04/25/06 17:42:48 marcel [4268]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
Remove all remaining references to @params in the documentation.
03/16/06 06:38:08 rick [3899]
* trunk/actionpack/lib/action_view/helpers/pagination_helper.rb (modified)
trivial documentation patch for #pagination_links [Francois
Beausoleil] closes #4258
02/20/06 03:15:22 david [3620]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
* trunk/actionpack/test/activerecord/pagination_test.rb (modified)
* trunk/activerecord/CHANGELOG (modified)
* trunk/activerecord/lib/active_record/base.rb (modified)
* trunk/activerecord/test/base_test.rb (modified)
Added :count option to pagination that'll make it possible for the
ActiveRecord::Base.count call to using something else than * for the
count. Especially important for count queries using DISTINCT #3839
[skaes]. Added :select option to Base.count that'll allow you to
select something else than * to be counted on. Especially important
for count queries using DISTINCT (closes #3839) [skaes].
02/09/06 09:17:40 nzkoz [3553]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
* trunk/actionpack/test/active_record_unit.rb (added)
* trunk/actionpack/test/activerecord (added)
* trunk/actionpack/test/activerecord/active_record_assertions_test.rb (added)
* trunk/actionpack/test/activerecord/pagination_test.rb (added)
* trunk/actionpack/test/controller/active_record_assertions_test.rb (deleted)
* trunk/actionpack/test/fixtures/companies.yml (added)
* trunk/actionpack/test/fixtures/company.rb (added)
* trunk/actionpack/test/fixtures/db_definitions (added)
* trunk/actionpack/test/fixtures/db_definitions/sqlite.sql (added)
* trunk/actionpack/test/fixtures/developer.rb (added)
* trunk/actionpack/test/fixtures/developers_projects.yml (added)
* trunk/actionpack/test/fixtures/developers.yml (added)
* trunk/actionpack/test/fixtures/project.rb (added)
* trunk/actionpack/test/fixtures/projects.yml (added)
* trunk/actionpack/test/fixtures/replies.yml (added)
* trunk/actionpack/test/fixtures/reply.rb (added)
* trunk/actionpack/test/fixtures/topic.rb (added)
* trunk/actionpack/test/fixtures/topics.yml (added)
* Fix pagination problems when using include
* Introduce Unit Tests for pagination
* Allow count to work with :include by using count distinct.
[Kevin Clark &amp; Jeremy Hopple]
11/05/05 02:10:29 bitsweat [2878]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
Update paginator docs. Closes #2744.
10/16/05 15:42:03 minam [2649]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
Update/clean up AP documentation (rdoc)
08/31/05 00:13:10 ulysses [2078]
* trunk/actionpack/CHANGELOG (modified)
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
Add option to specify the singular name used by pagination. Closes
#1960
08/23/05 14:24:15 minam [2041]
* trunk/actionpack/CHANGELOG (modified)
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
Add support for :include with pagination (subject to existing
constraints for :include with :limit and :offset) #1478
[michael@schubert.cx]
07/15/05 20:27:38 david [1839]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
* trunk/actionpack/lib/action_view/helpers/pagination_helper.rb (modified)
More pagination speed #1334 [Stefan Kaes]
07/14/05 08:02:01 david [1832]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
* trunk/actionpack/lib/action_view/helpers/pagination_helper.rb (modified)
* trunk/actionpack/test/controller/addresses_render_test.rb (modified)
Made pagination faster #1334 [Stefan Kaes]
04/13/05 05:40:22 david [1159]
* trunk/actionpack/CHANGELOG (modified)
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
* trunk/activerecord/lib/active_record/base.rb (modified)
Fixed pagination to work with joins #1034 [scott@sigkill.org]
04/02/05 09:11:17 david [1067]
* trunk/actionpack/CHANGELOG (modified)
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
* trunk/actionpack/lib/action_controller/scaffolding.rb (modified)
* trunk/actionpack/lib/action_controller/templates/scaffolds/list.rhtml (modified)
* trunk/railties/lib/rails_generator/generators/components/scaffold/templates/controller.rb (modified)
* trunk/railties/lib/rails_generator/generators/components/scaffold/templates/view_list.rhtml (modified)
Added pagination for scaffolding (10 items per page) #964
[mortonda@dgrmm.net]
03/31/05 14:46:11 david [1048]
* trunk/actionpack/lib/action_view/helpers/pagination_helper.rb (modified)
Improved the message display on the exception handler pages #963
[Johan Sorensen]
03/27/05 00:04:07 david [1017]
* trunk/actionpack/CHANGELOG (modified)
* trunk/actionpack/lib/action_view/helpers/pagination_helper.rb (modified)
Fixed that pagination_helper would ignore :params #947 [Sebastian
Kanthak]
03/22/05 13:09:44 david [976]
* trunk/actionpack/lib/action_view/helpers/pagination_helper.rb (modified)
Fixed documentation and prepared for 0.11.0 release
03/21/05 14:35:36 david [967]
* trunk/actionpack/lib/action_controller/pagination.rb (modified)
* trunk/actionpack/lib/action_view/helpers/pagination_helper.rb (modified)
Tweaked the documentation
03/20/05 23:12:05 david [949]
* trunk/actionpack/CHANGELOG (modified)
* trunk/actionpack/lib/action_controller.rb (modified)
* trunk/actionpack/lib/action_controller/pagination.rb (added)
* trunk/actionpack/lib/action_view/helpers/pagination_helper.rb (added)
* trunk/activesupport/lib/active_support/core_ext/kernel.rb (added)
Added pagination support through both a controller and helper add-on
#817 [Sam Stephenson]

View File

@ -0,0 +1,18 @@
Pagination
==========
To install:
script/plugin install svn://errtheblog.com/svn/plugins/classic_pagination
This code was extracted from Rails trunk after the release 1.2.3.
WARNING: this code is dead. It is unmaintained, untested and full of cruft.
There is a much better pagination plugin called will_paginate.
Install it like this and glance through the README:
script/plugin install svn://errtheblog.com/svn/plugins/will_paginate
It doesn't have the same API, but is in fact much nicer. You can
have both plugins installed until you change your controller/view code that
handles pagination. Then, simply uninstall classic_pagination.

View File

@ -0,0 +1,22 @@
require 'rake'
require 'rake/testtask'
require 'rake/rdoctask'
desc 'Default: run unit tests.'
task :default => :test
desc 'Test the classic_pagination plugin.'
Rake::TestTask.new(:test) do |t|
t.libs << 'lib'
t.pattern = 'test/**/*_test.rb'
t.verbose = true
end
desc 'Generate documentation for the classic_pagination plugin.'
Rake::RDocTask.new(:rdoc) do |rdoc|
rdoc.rdoc_dir = 'rdoc'
rdoc.title = 'Pagination'
rdoc.options << '--line-numbers' << '--inline-source'
rdoc.rdoc_files.include('README')
rdoc.rdoc_files.include('lib/**/*.rb')
end

View File

@ -0,0 +1,33 @@
#--
# Copyright (c) 2004-2006 David Heinemeier Hansson
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#++
require 'pagination'
require 'pagination_helper'
ActionController::Base.class_eval do
include ActionController::Pagination
end
ActionView::Base.class_eval do
include ActionView::Helpers::PaginationHelper
end

View File

@ -0,0 +1 @@
puts "\n\n" + File.read(File.dirname(__FILE__) + '/README')

View File

@ -0,0 +1,405 @@
module ActionController
# === Action Pack pagination for Active Record collections
#
# The Pagination module aids in the process of paging large collections of
# Active Record objects. It offers macro-style automatic fetching of your
# model for multiple views, or explicit fetching for single actions. And if
# the magic isn't flexible enough for your needs, you can create your own
# paginators with a minimal amount of code.
#
# The Pagination module can handle as much or as little as you wish. In the
# controller, have it automatically query your model for pagination; or,
# if you prefer, create Paginator objects yourself.
#
# Pagination is included automatically for all controllers.
#
# For help rendering pagination links, see
# ActionView::Helpers::PaginationHelper.
#
# ==== Automatic pagination for every action in a controller
#
# class PersonController < ApplicationController
# model :person
#
# paginate :people, :order => 'last_name, first_name',
# :per_page => 20
#
# # ...
# end
#
# Each action in this controller now has access to a <tt>@people</tt>
# instance variable, which is an ordered collection of model objects for the
# current page (at most 20, sorted by last name and first name), and a
# <tt>@person_pages</tt> Paginator instance. The current page is determined
# by the <tt>params[:page]</tt> variable.
#
# ==== Pagination for a single action
#
# def list
# @person_pages, @people =
# paginate :people, :order => 'last_name, first_name'
# end
#
# Like the previous example, but explicitly creates <tt>@person_pages</tt>
# and <tt>@people</tt> for a single action, and uses the default of 10 items
# per page.
#
# ==== Custom/"classic" pagination
#
# def list
# @person_pages = Paginator.new self, Person.count, 10, params[:page]
# @people = Person.find :all, :order => 'last_name, first_name',
# :limit => @person_pages.items_per_page,
# :offset => @person_pages.current.offset
# end
#
# Explicitly creates the paginator from the previous example and uses
# Paginator#to_sql to retrieve <tt>@people</tt> from the model.
#
module Pagination
unless const_defined?(:OPTIONS)
# A hash holding options for controllers using macro-style pagination
OPTIONS = Hash.new
# The default options for pagination
DEFAULT_OPTIONS = {
:class_name => nil,
:singular_name => nil,
:per_page => 10,
:conditions => nil,
:order_by => nil,
:order => nil,
:join => nil,
:joins => nil,
:count => nil,
:include => nil,
:select => nil,
:group => nil,
:parameter => 'page'
}
else
DEFAULT_OPTIONS[:group] = nil
end
def self.included(base) #:nodoc:
super
base.extend(ClassMethods)
end
def self.validate_options!(collection_id, options, in_action) #:nodoc:
options.merge!(DEFAULT_OPTIONS) {|key, old, new| old}
valid_options = DEFAULT_OPTIONS.keys
valid_options << :actions unless in_action
unknown_option_keys = options.keys - valid_options
raise ActionController::ActionControllerError,
"Unknown options: #{unknown_option_keys.join(', ')}" unless
unknown_option_keys.empty?
options[:singular_name] ||= Inflector.singularize(collection_id.to_s)
options[:class_name] ||= Inflector.camelize(options[:singular_name])
end
# Returns a paginator and a collection of Active Record model instances
# for the paginator's current page. This is designed to be used in a
# single action; to automatically paginate multiple actions, consider
# ClassMethods#paginate.
#
# +options+ are:
# <tt>:singular_name</tt>:: the singular name to use, if it can't be inferred by singularizing the collection name
# <tt>:class_name</tt>:: the class name to use, if it can't be inferred by
# camelizing the singular name
# <tt>:per_page</tt>:: the maximum number of items to include in a
# single page. Defaults to 10
# <tt>:conditions</tt>:: optional conditions passed to Model.find(:all, *params) and
# Model.count
# <tt>:order</tt>:: optional order parameter passed to Model.find(:all, *params)
# <tt>:order_by</tt>:: (deprecated, used :order) optional order parameter passed to Model.find(:all, *params)
# <tt>:joins</tt>:: optional joins parameter passed to Model.find(:all, *params)
# and Model.count
# <tt>:join</tt>:: (deprecated, used :joins or :include) optional join parameter passed to Model.find(:all, *params)
# and Model.count
# <tt>:include</tt>:: optional eager loading parameter passed to Model.find(:all, *params)
# and Model.count
# <tt>:select</tt>:: :select parameter passed to Model.find(:all, *params)
#
# <tt>:count</tt>:: parameter passed as :select option to Model.count(*params)
#
# <tt>:group</tt>:: :group parameter passed to Model.find(:all, *params). It forces the use of DISTINCT instead of plain COUNT to come up with the total number of records
#
def paginate(collection_id, options={})
Pagination.validate_options!(collection_id, options, true)
paginator_and_collection_for(collection_id, options)
end
# These methods become class methods on any controller
module ClassMethods
# Creates a +before_filter+ which automatically paginates an Active
# Record model for all actions in a controller (or certain actions if
# specified with the <tt>:actions</tt> option).
#
# +options+ are the same as PaginationHelper#paginate, with the addition
# of:
# <tt>:actions</tt>:: an array of actions for which the pagination is
# active. Defaults to +nil+ (i.e., every action)
def paginate(collection_id, options={})
Pagination.validate_options!(collection_id, options, false)
module_eval do
before_filter :create_paginators_and_retrieve_collections
OPTIONS[self] ||= Hash.new
OPTIONS[self][collection_id] = options
end
end
end
def create_paginators_and_retrieve_collections #:nodoc:
Pagination::OPTIONS[self.class].each do |collection_id, options|
next unless options[:actions].include? action_name if
options[:actions]
paginator, collection =
paginator_and_collection_for(collection_id, options)
paginator_name = "@#{options[:singular_name]}_pages"
self.instance_variable_set(paginator_name, paginator)
collection_name = "@#{collection_id.to_s}"
self.instance_variable_set(collection_name, collection)
end
end
# Returns the total number of items in the collection to be paginated for
# the +model+ and given +conditions+. Override this method to implement a
# custom counter.
def count_collection_for_pagination(model, options)
model.count(:conditions => options[:conditions],
:joins => options[:join] || options[:joins],
:include => options[:include],
:select => (options[:group] ? "DISTINCT #{options[:group]}" : options[:count]))
end
# Returns a collection of items for the given +model+ and +options[conditions]+,
# ordered by +options[order]+, for the current page in the given +paginator+.
# Override this method to implement a custom finder.
def find_collection_for_pagination(model, options, paginator)
model.find(:all, :conditions => options[:conditions],
:order => options[:order_by] || options[:order],
:joins => options[:join] || options[:joins], :include => options[:include],
:select => options[:select], :limit => options[:per_page],
:group => options[:group], :offset => paginator.current.offset)
end
protected :create_paginators_and_retrieve_collections,
:count_collection_for_pagination,
:find_collection_for_pagination
def paginator_and_collection_for(collection_id, options) #:nodoc:
klass = options[:class_name].constantize
page = params[options[:parameter]]
count = count_collection_for_pagination(klass, options)
paginator = Paginator.new(self, count, options[:per_page], page)
collection = find_collection_for_pagination(klass, options, paginator)
return paginator, collection
end
private :paginator_and_collection_for
# A class representing a paginator for an Active Record collection.
class Paginator
include Enumerable
# Creates a new Paginator on the given +controller+ for a set of items
# of size +item_count+ and having +items_per_page+ items per page.
# Raises ArgumentError if items_per_page is out of bounds (i.e., less
# than or equal to zero). The page CGI parameter for links defaults to
# "page" and can be overridden with +page_parameter+.
def initialize(controller, item_count, items_per_page, current_page=1)
raise ArgumentError, 'must have at least one item per page' if
items_per_page <= 0
@controller = controller
@item_count = item_count || 0
@items_per_page = items_per_page
@pages = {}
self.current_page = current_page
end
attr_reader :controller, :item_count, :items_per_page
# Sets the current page number of this paginator. If +page+ is a Page
# object, its +number+ attribute is used as the value; if the page does
# not belong to this Paginator, an ArgumentError is raised.
def current_page=(page)
if page.is_a? Page
raise ArgumentError, 'Page/Paginator mismatch' unless
page.paginator == self
end
page = page.to_i
@current_page_number = has_page_number?(page) ? page : 1
end
# Returns a Page object representing this paginator's current page.
def current_page
@current_page ||= self[@current_page_number]
end
alias current :current_page
# Returns a new Page representing the first page in this paginator.
def first_page
@first_page ||= self[1]
end
alias first :first_page
# Returns a new Page representing the last page in this paginator.
def last_page
@last_page ||= self[page_count]
end
alias last :last_page
# Returns the number of pages in this paginator.
def page_count
@page_count ||= @item_count.zero? ? 1 :
(q,r=@item_count.divmod(@items_per_page); r==0? q : q+1)
end
alias length :page_count
# Returns true if this paginator contains the page of index +number+.
def has_page_number?(number)
number >= 1 and number <= page_count
end
# Returns a new Page representing the page with the given index
# +number+.
def [](number)
@pages[number] ||= Page.new(self, number)
end
# Successively yields all the paginator's pages to the given block.
def each(&block)
page_count.times do |n|
yield self[n+1]
end
end
# A class representing a single page in a paginator.
class Page
include Comparable
# Creates a new Page for the given +paginator+ with the index
# +number+. If +number+ is not in the range of valid page numbers or
# is not a number at all, it defaults to 1.
def initialize(paginator, number)
@paginator = paginator
@number = number.to_i
@number = 1 unless @paginator.has_page_number? @number
end
attr_reader :paginator, :number
alias to_i :number
# Compares two Page objects and returns true when they represent the
# same page (i.e., their paginators are the same and they have the
# same page number).
def ==(page)
return false if page.nil?
@paginator == page.paginator and
@number == page.number
end
# Compares two Page objects and returns -1 if the left-hand page comes
# before the right-hand page, 0 if the pages are equal, and 1 if the
# left-hand page comes after the right-hand page. Raises ArgumentError
# if the pages do not belong to the same Paginator object.
def <=>(page)
raise ArgumentError unless @paginator == page.paginator
@number <=> page.number
end
# Returns the item offset for the first item in this page.
def offset
@paginator.items_per_page * (@number - 1)
end
# Returns the number of the first item displayed.
def first_item
offset + 1
end
# Returns the number of the last item displayed.
def last_item
[@paginator.items_per_page * @number, @paginator.item_count].min
end
# Returns true if this page is the first page in the paginator.
def first?
self == @paginator.first
end
# Returns true if this page is the last page in the paginator.
def last?
self == @paginator.last
end
# Returns a new Page object representing the page just before this
# page, or nil if this is the first page.
def previous
if first? then nil else @paginator[@number - 1] end
end
# Returns a new Page object representing the page just after this
# page, or nil if this is the last page.
def next
if last? then nil else @paginator[@number + 1] end
end
# Returns a new Window object for this page with the specified
# +padding+.
def window(padding=2)
Window.new(self, padding)
end
# Returns the limit/offset array for this page.
def to_sql
[@paginator.items_per_page, offset]
end
def to_param #:nodoc:
@number.to_s
end
end
# A class for representing ranges around a given page.
class Window
# Creates a new Window object for the given +page+ with the specified
# +padding+.
def initialize(page, padding=2)
@paginator = page.paginator
@page = page
self.padding = padding
end
attr_reader :paginator, :page
# Sets the window's padding (the number of pages on either side of the
# window page).
def padding=(padding)
@padding = padding < 0 ? 0 : padding
# Find the beginning and end pages of the window
@first = @paginator.has_page_number?(@page.number - @padding) ?
@paginator[@page.number - @padding] : @paginator.first
@last = @paginator.has_page_number?(@page.number + @padding) ?
@paginator[@page.number + @padding] : @paginator.last
end
attr_reader :padding, :first, :last
# Returns an array of Page objects in the current window.
def pages
(@first.number..@last.number).to_a.collect! {|n| @paginator[n]}
end
alias to_a :pages
end
end
end
end

View File

@ -0,0 +1,135 @@
module ActionView
module Helpers
# Provides methods for linking to ActionController::Pagination objects using a simple generator API. You can optionally
# also build your links manually using ActionView::Helpers::AssetHelper#link_to like so:
#
# <%= link_to "Previous page", { :page => paginator.current.previous } if paginator.current.previous %>
# <%= link_to "Next page", { :page => paginator.current.next } if paginator.current.next %>
module PaginationHelper
unless const_defined?(:DEFAULT_OPTIONS)
DEFAULT_OPTIONS = {
:name => :page,
:window_size => 2,
:always_show_anchors => true,
:link_to_current_page => false,
:params => {}
}
end
# Creates a basic HTML link bar for the given +paginator+. Links will be created
# for the next and/or previous page and for a number of other pages around the current
# pages position. The +html_options+ hash is passed to +link_to+ when the links are created.
#
# ==== Options
# <tt>:name</tt>:: the routing name for this paginator
# (defaults to +page+)
# <tt>:prefix</tt>:: prefix for pagination links
# (i.e. Older Pages: 1 2 3 4)
# <tt>:suffix</tt>:: suffix for pagination links
# (i.e. 1 2 3 4 <- Older Pages)
# <tt>:window_size</tt>:: the number of pages to show around
# the current page (defaults to <tt>2</tt>)
# <tt>:always_show_anchors</tt>:: whether or not the first and last
# pages should always be shown
# (defaults to +true+)
# <tt>:link_to_current_page</tt>:: whether or not the current page
# should be linked to (defaults to
# +false+)
# <tt>:params</tt>:: any additional routing parameters
# for page URLs
#
# ==== Examples
# # We'll assume we have a paginator setup in @person_pages...
#
# pagination_links(@person_pages)
# # => 1 <a href="/?page=2/">2</a> <a href="/?page=3/">3</a> ... <a href="/?page=10/">10</a>
#
# pagination_links(@person_pages, :link_to_current_page => true)
# # => <a href="/?page=1/">1</a> <a href="/?page=2/">2</a> <a href="/?page=3/">3</a> ... <a href="/?page=10/">10</a>
#
# pagination_links(@person_pages, :always_show_anchors => false)
# # => 1 <a href="/?page=2/">2</a> <a href="/?page=3/">3</a>
#
# pagination_links(@person_pages, :window_size => 1)
# # => 1 <a href="/?page=2/">2</a> ... <a href="/?page=10/">10</a>
#
# pagination_links(@person_pages, :params => { :viewer => "flash" })
# # => 1 <a href="/?page=2&amp;viewer=flash/">2</a> <a href="/?page=3&amp;viewer=flash/">3</a> ...
# # <a href="/?page=10&amp;viewer=flash/">10</a>
def pagination_links(paginator, options={}, html_options={})
name = options[:name] || DEFAULT_OPTIONS[:name]
params = (options[:params] || DEFAULT_OPTIONS[:params]).clone
prefix = options[:prefix] || ''
suffix = options[:suffix] || ''
pagination_links_each(paginator, options, prefix, suffix) do |n|
params[name] = n
link_to(n.to_s, params, html_options)
end
end
# Iterate through the pages of a given +paginator+, invoking a
# block for each page number that needs to be rendered as a link.
#
# ==== Options
# <tt>:window_size</tt>:: the number of pages to show around
# the current page (defaults to +2+)
# <tt>:always_show_anchors</tt>:: whether or not the first and last
# pages should always be shown
# (defaults to +true+)
# <tt>:link_to_current_page</tt>:: whether or not the current page
# should be linked to (defaults to
# +false+)
#
# ==== Example
# # Turn paginated links into an Ajax call
# pagination_links_each(paginator, page_options) do |link|
# options = { :url => {:action => 'list'}, :update => 'results' }
# html_options = { :href => url_for(:action => 'list') }
#
# link_to_remote(link.to_s, options, html_options)
# end
def pagination_links_each(paginator, options, prefix = nil, suffix = nil)
options = DEFAULT_OPTIONS.merge(options)
link_to_current_page = options[:link_to_current_page]
always_show_anchors = options[:always_show_anchors]
current_page = paginator.current_page
window_pages = current_page.window(options[:window_size]).pages
return if window_pages.length <= 1 unless link_to_current_page
first, last = paginator.first, paginator.last
html = ''
html << prefix if prefix
if always_show_anchors and not (wp_first = window_pages[0]).first?
html << yield(first.number)
html << ' ... ' if wp_first.number - first.number > 1
html << ' '
end
window_pages.each do |page|
if current_page == page && !link_to_current_page
html << page.number.to_s
else
html << yield(page.number)
end
html << ' '
end
if always_show_anchors and not (wp_last = window_pages[-1]).last?
html << ' ... ' if last.number - wp_last.number > 1
html << yield(last.number)
end
html << suffix if suffix
html
end
end # PaginationHelper
end # Helpers
end # ActionView

View File

@ -0,0 +1,24 @@
thirty_seven_signals:
id: 1
name: 37Signals
rating: 4
TextDrive:
id: 2
name: TextDrive
rating: 4
PlanetArgon:
id: 3
name: Planet Argon
rating: 4
Google:
id: 4
name: Google
rating: 4
Ionist:
id: 5
name: Ioni.st
rating: 4

View File

@ -0,0 +1,9 @@
class Company < ActiveRecord::Base
attr_protected :rating
set_sequence_name :companies_nonstd_seq
validates_presence_of :name
def validate
errors.add('rating', 'rating should not be 2') if rating == 2
end
end

View File

@ -0,0 +1,7 @@
class Developer < ActiveRecord::Base
has_and_belongs_to_many :projects
end
class DeVeLoPeR < ActiveRecord::Base
set_table_name "developers"
end

View File

@ -0,0 +1,21 @@
david:
id: 1
name: David
salary: 80000
jamis:
id: 2
name: Jamis
salary: 150000
<% for digit in 3..10 %>
dev_<%= digit %>:
id: <%= digit %>
name: fixture_<%= digit %>
salary: 100000
<% end %>
poor_jamis:
id: 11
name: Jamis
salary: 9000

View File

@ -0,0 +1,13 @@
david_action_controller:
developer_id: 1
project_id: 2
joined_on: 2004-10-10
david_active_record:
developer_id: 1
project_id: 1
joined_on: 2004-10-10
jamis_active_record:
developer_id: 2
project_id: 1

View File

@ -0,0 +1,3 @@
class Project < ActiveRecord::Base
has_and_belongs_to_many :developers, :uniq => true
end

View File

@ -0,0 +1,7 @@
action_controller:
id: 2
name: Active Controller
active_record:
id: 1
name: Active Record

View File

@ -0,0 +1,13 @@
witty_retort:
id: 1
topic_id: 1
content: Birdman is better!
created_at: <%= 6.hours.ago.to_s(:db) %>
updated_at: nil
another:
id: 2
topic_id: 2
content: Nuh uh!
created_at: <%= 1.hour.ago.to_s(:db) %>
updated_at: nil

View File

@ -0,0 +1,5 @@
class Reply < ActiveRecord::Base
belongs_to :topic, :include => [:replies]
validates_presence_of :content
end

View File

@ -0,0 +1,42 @@
CREATE TABLE 'companies' (
'id' INTEGER PRIMARY KEY NOT NULL,
'name' TEXT DEFAULT NULL,
'rating' INTEGER DEFAULT 1
);
CREATE TABLE 'replies' (
'id' INTEGER PRIMARY KEY NOT NULL,
'content' text,
'created_at' datetime,
'updated_at' datetime,
'topic_id' integer
);
CREATE TABLE 'topics' (
'id' INTEGER PRIMARY KEY NOT NULL,
'title' varchar(255),
'subtitle' varchar(255),
'content' text,
'created_at' datetime,
'updated_at' datetime
);
CREATE TABLE 'developers' (
'id' INTEGER PRIMARY KEY NOT NULL,
'name' TEXT DEFAULT NULL,
'salary' INTEGER DEFAULT 70000,
'created_at' DATETIME DEFAULT NULL,
'updated_at' DATETIME DEFAULT NULL
);
CREATE TABLE 'projects' (
'id' INTEGER PRIMARY KEY NOT NULL,
'name' TEXT DEFAULT NULL
);
CREATE TABLE 'developers_projects' (
'developer_id' INTEGER NOT NULL,
'project_id' INTEGER NOT NULL,
'joined_on' DATE DEFAULT NULL,
'access_level' INTEGER DEFAULT 1
);

View File

@ -0,0 +1,3 @@
class Topic < ActiveRecord::Base
has_many :replies, :include => [:user], :dependent => :destroy
end

View File

@ -0,0 +1,22 @@
futurama:
id: 1
title: Isnt futurama awesome?
subtitle: It really is, isnt it.
content: I like futurama
created_at: <%= 1.day.ago.to_s(:db) %>
updated_at:
harvey_birdman:
id: 2
title: Harvey Birdman is the king of all men
subtitle: yup
content: It really is
created_at: <%= 2.hours.ago.to_s(:db) %>
updated_at:
rails:
id: 3
title: Rails is nice
subtitle: It makes me happy
content: except when I have to hack internals to fix pagination. even then really.
created_at: <%= 20.minutes.ago.to_s(:db) %>

View File

@ -0,0 +1,117 @@
require 'test/unit'
unless defined?(ActiveRecord)
plugin_root = File.join(File.dirname(__FILE__), '..')
# first look for a symlink to a copy of the framework
if framework_root = ["#{plugin_root}/rails", "#{plugin_root}/../../rails"].find { |p| File.directory? p }
puts "found framework root: #{framework_root}"
# this allows for a plugin to be tested outside an app
$:.unshift "#{framework_root}/activesupport/lib", "#{framework_root}/activerecord/lib", "#{framework_root}/actionpack/lib"
else
# is the plugin installed in an application?
app_root = plugin_root + '/../../..'
if File.directory? app_root + '/config'
puts 'using config/boot.rb'
ENV['RAILS_ENV'] = 'test'
require File.expand_path(app_root + '/config/boot')
else
# simply use installed gems if available
puts 'using rubygems'
require 'rubygems'
gem 'actionpack'; gem 'activerecord'
end
end
%w(action_pack active_record action_controller active_record/fixtures action_controller/test_process).each {|f| require f}
Dependencies.load_paths.unshift "#{plugin_root}/lib"
end
# Define the connector
class ActiveRecordTestConnector
cattr_accessor :able_to_connect
cattr_accessor :connected
# Set our defaults
self.connected = false
self.able_to_connect = true
class << self
def setup
unless self.connected || !self.able_to_connect
setup_connection
load_schema
require_fixture_models
self.connected = true
end
rescue Exception => e # errors from ActiveRecord setup
$stderr.puts "\nSkipping ActiveRecord assertion tests: #{e}"
#$stderr.puts " #{e.backtrace.join("\n ")}\n"
self.able_to_connect = false
end
private
def setup_connection
if Object.const_defined?(:ActiveRecord)
defaults = { :database => ':memory:' }
begin
options = defaults.merge :adapter => 'sqlite3', :timeout => 500
ActiveRecord::Base.establish_connection(options)
ActiveRecord::Base.configurations = { 'sqlite3_ar_integration' => options }
ActiveRecord::Base.connection
rescue Exception # errors from establishing a connection
$stderr.puts 'SQLite 3 unavailable; trying SQLite 2.'
options = defaults.merge :adapter => 'sqlite'
ActiveRecord::Base.establish_connection(options)
ActiveRecord::Base.configurations = { 'sqlite2_ar_integration' => options }
ActiveRecord::Base.connection
end
Object.send(:const_set, :QUOTED_TYPE, ActiveRecord::Base.connection.quote_column_name('type')) unless Object.const_defined?(:QUOTED_TYPE)
else
raise "Can't setup connection since ActiveRecord isn't loaded."
end
end
# Load actionpack sqlite tables
def load_schema
File.read(File.dirname(__FILE__) + "/fixtures/schema.sql").split(';').each do |sql|
ActiveRecord::Base.connection.execute(sql) unless sql.blank?
end
end
def require_fixture_models
Dir.glob(File.dirname(__FILE__) + "/fixtures/*.rb").each {|f| require f}
end
end
end
# Test case for inheritance
class ActiveRecordTestCase < Test::Unit::TestCase
# Set our fixture path
if ActiveRecordTestConnector.able_to_connect
self.fixture_path = "#{File.dirname(__FILE__)}/fixtures/"
self.use_transactional_fixtures = false
end
def self.fixtures(*args)
super if ActiveRecordTestConnector.connected
end
def run(*args)
super if ActiveRecordTestConnector.connected
end
# Default so Test::Unit::TestCase doesn't complain
def test_truth
end
end
ActiveRecordTestConnector.setup
ActionController::Routing::Routes.reload rescue nil
ActionController::Routing::Routes.draw do |map|
map.connect ':controller/:action/:id'
end

View File

@ -0,0 +1,38 @@
require File.dirname(__FILE__) + '/helper'
require File.dirname(__FILE__) + '/../init'
class PaginationHelperTest < Test::Unit::TestCase
include ActionController::Pagination
include ActionView::Helpers::PaginationHelper
include ActionView::Helpers::UrlHelper
include ActionView::Helpers::TagHelper
def setup
@controller = Class.new do
attr_accessor :url, :request
def url_for(options, *parameters_for_method_reference)
url
end
end
@controller = @controller.new
@controller.url = "http://www.example.com"
end
def test_pagination_links
total, per_page, page = 30, 10, 1
output = pagination_links Paginator.new(@controller, total, per_page, page)
assert_equal "1 <a href=\"http://www.example.com\">2</a> <a href=\"http://www.example.com\">3</a> ", output
end
def test_pagination_links_with_prefix
total, per_page, page = 30, 10, 1
output = pagination_links Paginator.new(@controller, total, per_page, page), :prefix => 'Newer '
assert_equal "Newer 1 <a href=\"http://www.example.com\">2</a> <a href=\"http://www.example.com\">3</a> ", output
end
def test_pagination_links_with_suffix
total, per_page, page = 30, 10, 1
output = pagination_links Paginator.new(@controller, total, per_page, page), :suffix => 'Older'
assert_equal "1 <a href=\"http://www.example.com\">2</a> <a href=\"http://www.example.com\">3</a> Older", output
end
end

View File

@ -0,0 +1,177 @@
require File.dirname(__FILE__) + '/helper'
require File.dirname(__FILE__) + '/../init'
class PaginationTest < ActiveRecordTestCase
fixtures :topics, :replies, :developers, :projects, :developers_projects
class PaginationController < ActionController::Base
if respond_to? :view_paths=
self.view_paths = [ "#{File.dirname(__FILE__)}/../fixtures/" ]
else
self.template_root = [ "#{File.dirname(__FILE__)}/../fixtures/" ]
end
def simple_paginate
@topic_pages, @topics = paginate(:topics)
render :nothing => true
end
def paginate_with_per_page
@topic_pages, @topics = paginate(:topics, :per_page => 1)
render :nothing => true
end
def paginate_with_order
@topic_pages, @topics = paginate(:topics, :order => 'created_at asc')
render :nothing => true
end
def paginate_with_order_by
@topic_pages, @topics = paginate(:topics, :order_by => 'created_at asc')
render :nothing => true
end
def paginate_with_include_and_order
@topic_pages, @topics = paginate(:topics, :include => :replies, :order => 'replies.created_at asc, topics.created_at asc')
render :nothing => true
end
def paginate_with_conditions
@topic_pages, @topics = paginate(:topics, :conditions => ["created_at > ?", 30.minutes.ago])
render :nothing => true
end
def paginate_with_class_name
@developer_pages, @developers = paginate(:developers, :class_name => "DeVeLoPeR")
render :nothing => true
end
def paginate_with_singular_name
@developer_pages, @developers = paginate()
render :nothing => true
end
def paginate_with_joins
@developer_pages, @developers = paginate(:developers,
:joins => 'LEFT JOIN developers_projects ON developers.id = developers_projects.developer_id',
:conditions => 'project_id=1')
render :nothing => true
end
def paginate_with_join
@developer_pages, @developers = paginate(:developers,
:join => 'LEFT JOIN developers_projects ON developers.id = developers_projects.developer_id',
:conditions => 'project_id=1')
render :nothing => true
end
def paginate_with_join_and_count
@developer_pages, @developers = paginate(:developers,
:join => 'd LEFT JOIN developers_projects ON d.id = developers_projects.developer_id',
:conditions => 'project_id=1',
:count => "d.id")
render :nothing => true
end
def paginate_with_join_and_group
@developer_pages, @developers = paginate(:developers,
:join => 'INNER JOIN developers_projects ON developers.id = developers_projects.developer_id',
:group => 'developers.id')
render :nothing => true
end
def rescue_errors(e) raise e end
def rescue_action(e) raise end
end
def setup
@controller = PaginationController.new
@request = ActionController::TestRequest.new
@response = ActionController::TestResponse.new
super
end
# Single Action Pagination Tests
def test_simple_paginate
get :simple_paginate
assert_equal 1, assigns(:topic_pages).page_count
assert_equal 3, assigns(:topics).size
end
def test_paginate_with_per_page
get :paginate_with_per_page
assert_equal 1, assigns(:topics).size
assert_equal 3, assigns(:topic_pages).page_count
end
def test_paginate_with_order
get :paginate_with_order
expected = [topics(:futurama),
topics(:harvey_birdman),
topics(:rails)]
assert_equal expected, assigns(:topics)
assert_equal 1, assigns(:topic_pages).page_count
end
def test_paginate_with_order_by
get :paginate_with_order
expected = assigns(:topics)
get :paginate_with_order_by
assert_equal expected, assigns(:topics)
assert_equal 1, assigns(:topic_pages).page_count
end
def test_paginate_with_conditions
get :paginate_with_conditions
expected = [topics(:rails)]
assert_equal expected, assigns(:topics)
assert_equal 1, assigns(:topic_pages).page_count
end
def test_paginate_with_class_name
get :paginate_with_class_name
assert assigns(:developers).size > 0
assert_equal DeVeLoPeR, assigns(:developers).first.class
end
def test_paginate_with_joins
get :paginate_with_joins
assert_equal 2, assigns(:developers).size
developer_names = assigns(:developers).map { |d| d.name }
assert developer_names.include?('David')
assert developer_names.include?('Jamis')
end
def test_paginate_with_join_and_conditions
get :paginate_with_joins
expected = assigns(:developers)
get :paginate_with_join
assert_equal expected, assigns(:developers)
end
def test_paginate_with_join_and_count
get :paginate_with_joins
expected = assigns(:developers)
get :paginate_with_join_and_count
assert_equal expected, assigns(:developers)
end
def test_paginate_with_include_and_order
get :paginate_with_include_and_order
expected = Topic.find(:all, :include => 'replies', :order => 'replies.created_at asc, topics.created_at asc', :limit => 10)
assert_equal expected, assigns(:topics)
end
def test_paginate_with_join_and_group
get :paginate_with_join_and_group
assert_equal 2, assigns(:developers).size
assert_equal 2, assigns(:developer_pages).item_count
developer_names = assigns(:developers).map { |d| d.name }
assert developer_names.include?('David')
assert developer_names.include?('Jamis')
end
end