@@ -49,12 +49,13 @@ module WillPaginate
# * <tt>:param_name</tt> -- parameter name for page number in URLs (default: <tt>:page</tt>)
# * <tt>:params</tt> -- additional parameters when generating pagination links
# (eg. <tt>:controller => "foo", :action => nil</tt>)
- # * <tt>:renderer</tt> -- class name of the link renderer (default: WillPaginate::LinkRenderer)
+ # * <tt>:renderer</tt> -- class name, class or instance of a link renderer (default:
+ # <tt>WillPaginate::LinkRenderer</tt>)
# * <tt>:page_links</tt> -- when false, only previous/next links are rendered (default: true)
# * <tt>:container</tt> -- toggles rendering of the DIV container for pagination links, set to
# false only when you are rendering your own pagination markup (default: true)
- # * <tt>:id</tt> -- HTML ID for the container (default: nil). Pass +true+ to have the ID automatically
- # generated from the class name of objects in collection: for example, paginating
+ # * <tt>:id</tt> -- HTML ID for the container (default: nil). Pass +true+ to have the ID
+ # automatically generated from the class name of objects in collection: for example, paginating
# ArticleComment models would yield an ID of "article_comments_pagination".
#
# All options beside listed ones are passed as HTML attributes to the container
@@ -91,19 +92,18 @@ module WillPaginate
return nil unless WillPaginate::ViewHelpers.total_pages_for_collection(collection) > 1
options = options.symbolize_keys.reverse_merge WillPaginate::ViewHelpers.pagination_options
- # create the renderer instance
+
+ # get the renderer instance
renderer = case options[:renderer]
- when String, Class
- renderer_class = options[:renderer].to_s.constantize
- renderer_class.new collection, options, self
+ when String
+ options[:renderer].to_s.constantize.new
+ when Class
+ options[:renderer].new
else
- returning(options[:renderer]) do |r|
- r.collection = collection
- r.options = options
- r.template = self
- end
+ options[:renderer]
end
# render HTML for pagination
+ renderer.prepare collection, options, self
renderer.to_html
end
@@ -179,16 +179,26 @@ module WillPaginate
# links. It is used by +will_paginate+ helper internally.
class LinkRenderer
- attr_accessor :collection, :options, :template
-
+ # The gap in page links is represented by:
+ #
+ # <span class="gap">…</span>
+ attr_accessor :gap_marker
+
+ def initialize
+ @gap_marker = '<span class="gap">…</span>'
+ end
+
# * +collection+ is a WillPaginate::Collection instance or any other object
# that conforms to that API
# * +options+ are forwarded from +will_paginate+ view helper
# * +template+ is the reference to the template being rendered
- def initialize(collection, options, template)
+ def prepare(collection, options, template)
@collection = collection
@options = options
@template = template
+
+ # reset values in case we're re-using this instance
+ @total_pages = @param_name = @url_string = nil
end
# Process it! This method returns the complete HTML string which contains
@@ -197,8 +207,8 @@ module WillPaginate
def to_html
links = @options[:page_links] ? windowed_links : []
# previous/next buttons
- links.unshift page_link_or_span(@collection.previous_page, %w(disabled prev_page), @options[:prev_label])
- links.push page_link_or_span(@collection.next_page, %w(disabled next_page), @options[:next_label])
+ links.unshift page_link_or_span(@collection.previous_page, 'disabled prev_page', @options[:prev_label])
+ links.push page_link_or_span(@collection.next_page, 'disabled next_page', @options[:next_label])
html = links.join(@options[:separator])
@options[:container] ? @template.content_tag(:div, html, html_attributes) : html
@@ -218,13 +228,6 @@ module WillPaginate
protected
- # The gap in page links is represented by:
- #
- # <span class="gap">…</span>
- def gap_marker
- '<span class="gap">…</span>'
- end
-
# Collects link items for visible page numbers.
def windowed_links
prev = nil
@@ -267,12 +270,12 @@ module WillPaginate
def page_link_or_span(page, span_class, text = nil)
text ||= page.to_s
- classnames = Array[*span_class]
if page and page != current_page
- page_link page, text, :rel => rel_value(page), :class => classnames[1]
+ classnames = span_class && span_class.index(' ') && span_class.split(' ', 2).last
+ page_link page, text, :rel => rel_value(page), :class => classnames
else
- page_span page, text, :class => classnames.join(' ')
+ page_span page, text, :class => span_class
end
end
@@ -284,7 +287,6 @@ module WillPaginate
@template.content_tag :span, text, attributes
end
-
# Returns URL params for +page_link_or_span+, taking the current GET params
# and <tt>:params</tt> option into account.
def url_for(page)
lib/will_paginate/view_helpers.rb
@@ -2,13 +2,9 @@ require 'helper'
require 'lib/view_test_process'
class AdditionalLinkAttributesRenderer < WillPaginate::LinkRenderer
- def initialize(*arguments)
- if arguments.size == 3
- super(*arguments)
- @additional_link_attributes = {:default => 'true'}
- else
- @additional_link_attributes = arguments.extract_options!
- end
+ def initialize(link_attributes = nil)
+ super()
+ @additional_link_attributes = link_attributes || { :default => 'true' }
end
def page_link(page, text, attributes = {})
@@ -16,7 +12,6 @@ class AdditionalLinkAttributesRenderer < WillPaginate::LinkRenderer
end
end
-
class ViewTest < WillPaginate::ViewTestCase
## basic pagination ##
@@ -60,14 +55,22 @@ class ViewTest < WillPaginate::ViewTestCase
end
def test_will_paginate_using_renderer_class
- paginate({},:renderer => AdditionalLinkAttributesRenderer) do
- assert_select 'a[default~=true]'
+ paginate({}, :renderer => AdditionalLinkAttributesRenderer) do
+ assert_select 'a[default=true]', 3
end
end
def test_will_paginate_using_renderer_instance
- paginate({},:renderer => AdditionalLinkAttributesRenderer.new(:title => 'rendered')) do
- assert_select 'a[title=rendered]'
+ renderer = WillPaginate::LinkRenderer.new
+ renderer.gap_marker = '<span class="my-gap">~~</span>'
+
+ paginate({ :per_page => 2 }, :inner_window => 0, :outer_window => 0, :renderer => renderer) do
+ assert_select 'span.my-gap', '~~'
+ end
+
+ renderer = AdditionalLinkAttributesRenderer.new(:title => 'rendered')
+ paginate({}, :renderer => renderer) do
+ assert_select 'a[title=rendered]', 3
end
end
test/view_test.rb
5586e8ea4b99394baa4a60539e766aa9d2a8a8b6
Mislav Marohnić
mislav.marohnic@gmail.com
http://github.com/mislav/will_paginate/commit/2e45f01bd13fae007412896335d266983e11ec03
2e45f01bd13fae007412896335d266983e11ec03
2008-04-29T12:59:28-07:00
2008-04-29T12:59:28-07:00
CHANGED LinkRenderer to receive collection, options and reference to view template NOT in constructor, but with the #prepare method.
This is a step towards supporting passing of LinkRenderer (or subclass) instances that may be preconfigured in some way.
a5d917a1ff32f6f5e558bf0480d2f696f14e4e9b
Mislav Marohnić
mislav.marohnic@gmail.com