mislav-will_paginate 2.2.3 → 2.3.0

data/CHANGELOG

@@ -1,3 +1,18 @@
+== 2.3.0, released 2008-04-29
+
+* 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
+* LinkRenderer now has #page_link and #page_span methods for easier customization of output in
+  subclasses
+* Changed page_entries_info() method to adjust its output according to humanized class name of
+  collection items. Override this with :entry_name parameter (singular).
+    
+    page_entries_info(@posts)
+    #-> "Displaying all 12 posts"
+    page_entries_info(@posts, :entry_name => 'item')
+    #-> "Displaying all 12 items"
+    
 == 2.2.3, released 2008-04-26
 
 * will_paginate gem is no longer published on RubyForge, but on

data/README.rdoc

@@ -113,7 +113,7 @@ contributions or just simply awesome ideas:
 Chris Wanstrath, Dr. Nic Williams, K. Adam Christensen, Mike Garey, Bence
 Golda, Matt Aimonetti, Charles Brian Quinn, Desi McAdam, James Coglan, Matijs
 van Zuijlen, Maria, Brendan Ribera, Todd Willey, Bryan Helmkamp, Jan Berkel,
-Lourens Naudé, Rick Olson, Russell Norris.
+Lourens Naudé, Rick Olson, Russell Norris, Piotr Usewicz, Chris Eppstein.
 
 
 == Usable pagination in the UI

data/Rakefile

@@ -72,10 +72,13 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.options << '--webcvs=http://github.com/mislav/will_paginate/tree/master/'
 end
 
+desc %{Update ".manifest" with the latest list of project filenames. Respect\
+.gitignore by excluding everything that git ignores. Update `files` and\
+`test_files` arrays in "*.gemspec" file if it's present.}
 task :manifest do
   list = Dir['**/*'].sort
   spec_file = Dir['*.gemspec'].first
-  list -= [spec_file]
+  list -= [spec_file] if spec_file
   
   File.read('.gitignore').each_line do |glob|
     glob = glob.chomp.sub(/^\//, '')
@@ -84,14 +87,16 @@ task :manifest do
     puts "excluding #{glob}"
   end
 
-  spec = File.read spec_file
-  spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
-    assignment = $1
-    bunch = $2 ? list.grep(/^test\//) : list
-    '%s%%w(%s)' % [assignment, bunch.join(' ')]
+  if spec_file
+    spec = File.read spec_file
+    spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+      assignment = $1
+      bunch = $2 ? list.grep(/^test\//) : list
+      '%s%%w(%s)' % [assignment, bunch.join(' ')]
+    end
+      
+    File.open(spec_file,   'w') {|f| f << spec }
   end
-    
-  File.open(spec_file,   'w') {|f| f << spec }
   File.open('.manifest', 'w') {|f| f << list.join("\n") }
 end
 

data/lib/will_paginate/version.rb

@@ -1,8 +1,8 @@
 module WillPaginate #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 2
-    MINOR = 2
-    TINY  = 3
+    MINOR = 3
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/will_paginate/view_helpers.rb

@@ -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,10 +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
-      renderer_class = options[:renderer].to_s.constantize
-      renderer = renderer_class.new collection, options, self
+      
+      # get the renderer instance
+      renderer = case options[:renderer]
+      when String
+        options[:renderer].to_s.constantize.new
+      when Class
+        options[:renderer].new
+      else
+        options[:renderer]
+      end
       # render HTML for pagination
+      renderer.prepare collection, options, self
       renderer.to_html
     end
     
@@ -130,16 +139,26 @@ module WillPaginate
     # You can use this as a blueprint for your own, similar helpers.
     #
     #   <%= page_entries_info @posts %>
-    #   #-> Displaying entries 6 - 10 of 26 in total
-    def page_entries_info(collection)
+    #   #-> Displaying posts 6 - 10 of 26 in total
+    #
+    # By default, the message will use the humanized class name of objects
+    # in collection: for instance, "project types" for ProjectType models.
+    # Override this to your liking with the <tt>:entry_name</tt> parameter:
+    #
+    #   <%= page_entries_info @posts, :entry_name => 'item' %>
+    #   #-> Displaying items 6 - 10 of 26 in total
+    def page_entries_info(collection, options = {})
+      entry_name = options[:entry_name] ||
+        (collection.empty?? 'entry' : collection.first.class.name.underscore.sub('_', ' '))
+      
       if collection.total_pages < 2
         case collection.size
-        when 0; 'No entries found'
-        when 1; 'Displaying <b>1</b> entry'
-        else;   "Displaying <b>all #{collection.size}</b> entries"
+        when 0; "No #{entry_name.pluralize} found"
+        when 1; "Displaying <b>1</b> #{entry_name}"
+        else;   "Displaying <b>all #{collection.size}</b> #{entry_name.pluralize}"
         end
       else
-        %{Displaying entries <b>%d&nbsp;-&nbsp;%d</b> of <b>%d</b> in total} % [
+        %{Displaying #{entry_name.pluralize} <b>%d&nbsp;-&nbsp;%d</b> of <b>%d</b> in total} % [
           collection.offset + 1,
           collection.offset + collection.length,
           collection.total_entries
@@ -166,14 +185,27 @@ module WillPaginate
   # This class does the heavy lifting of actually building the pagination
   # links. It is used by +will_paginate+ helper internally.
   class LinkRenderer
+
+    # The gap in page links is represented by:
+    #
+    #   <span class="gap">&hellip;</span>
+    attr_accessor :gap_marker
+    
+    def initialize
+      @gap_marker = '<span class="gap">&hellip;</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
@@ -182,8 +214,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
@@ -203,13 +235,6 @@ module WillPaginate
     
   protected
 
-    # The gap in page links is represented by:
-    #
-    #   <span class="gap">&hellip;</span>
-    def gap_marker
-      '<span class="gap">&hellip;</span>'
-    end
-    
     # Collects link items for visible page numbers.
     def windowed_links
       prev = nil
@@ -252,15 +277,23 @@ 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
-        @template.link_to text, url_for(page), :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
-        @template.content_tag :span, text, :class => classnames.join(' ')
+        page_span page, text, :class => span_class
       end
     end
 
+    def page_link(page, text, attributes = {})
+      @template.link_to text, url_for(page), attributes
+    end
+
+    def page_span(page, text, attributes = {})
+      @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)

data/test/lib/view_test_process.rb

@@ -38,9 +38,9 @@ class WillPaginate::ViewTestCase < Test::Unit::TestCase
 
       locals = { :collection => collection, :options => options }
 
-      if defined? ActionView::Template
+      if defined? ActionView::InlineTemplate
         # Rails 2.1
-        args = [ ActionView::Template.new(@view, @template, false, locals, true, nil) ]
+        args = [ ActionView::InlineTemplate.new(@view, @template, locals) ]
       else
         # older Rails versions
         args = [nil, @template, nil, locals]
@@ -130,6 +130,10 @@ class DummyController
     @request = DummyRequest.new
     @url = ActionController::UrlRewriter.new(@request, @request.params)
   end
+
+  def params
+    @request.params
+  end
   
   def url_for(params)
     @url.rewrite(params)

data/test/view_test.rb

@@ -1,6 +1,17 @@
 require 'helper'
 require 'lib/view_test_process'
 
+class AdditionalLinkAttributesRenderer < WillPaginate::LinkRenderer
+  def initialize(link_attributes = nil)
+    super()
+    @additional_link_attributes = link_attributes || { :default => 'true' }
+  end
+
+  def page_link(page, text, attributes = {})
+    @template.link_to text, url_for(page), attributes.merge(@additional_link_attributes)
+  end
+end
+
 class ViewTest < WillPaginate::ViewTestCase
   
   ## basic pagination ##
@@ -43,6 +54,26 @@ class ViewTest < WillPaginate::ViewTestCase
     end
   end
 
+  def test_will_paginate_using_renderer_class
+    paginate({}, :renderer => AdditionalLinkAttributesRenderer) do
+      assert_select 'a[default=true]', 3
+    end
+  end
+
+  def test_will_paginate_using_renderer_instance
+    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
+
   def test_prev_next_links_have_classnames
     paginate do |pagination|
       assert_select 'span.disabled.prev_page:first-child'
@@ -135,27 +166,54 @@ class ViewTest < WillPaginate::ViewTestCase
     array = ('a'..'z').to_a
     
     paginate array.paginate(:page => 2, :per_page => 5)
-    assert_equal %{Displaying entries <b>6&nbsp;-&nbsp;10</b> of <b>26</b> in total},
+    assert_equal %{Displaying strings <b>6&nbsp;-&nbsp;10</b> of <b>26</b> in total},
       @html_result
     
     paginate array.paginate(:page => 7, :per_page => 4)
-    assert_equal %{Displaying entries <b>25&nbsp;-&nbsp;26</b> of <b>26</b> in total},
+    assert_equal %{Displaying strings <b>25&nbsp;-&nbsp;26</b> of <b>26</b> in total},
       @html_result
   end
 
+  def test_page_entries_info_with_longer_class_name
+    @template = '<%= page_entries_info collection %>'
+    collection = ('a'..'z').to_a.paginate
+    collection.first.stubs(:class).returns(mock('class', :name => 'ProjectType'))
+    
+    paginate collection
+    assert @html_result.index('project types'), "expected <#{@html_result.inspect}> to mention 'project types'"
+  end
+
   def test_page_entries_info_with_single_page_collection
     @template = '<%= page_entries_info collection %>'
     
     paginate(('a'..'d').to_a.paginate(:page => 1, :per_page => 5))
-    assert_equal %{Displaying <b>all 4</b> entries}, @html_result
+    assert_equal %{Displaying <b>all 4</b> strings}, @html_result
     
     paginate(['a'].paginate(:page => 1, :per_page => 5))
-    assert_equal %{Displaying <b>1</b> entry}, @html_result
+    assert_equal %{Displaying <b>1</b> string}, @html_result
     
     paginate([].paginate(:page => 1, :per_page => 5))
     assert_equal %{No entries found}, @html_result
   end
   
+  def test_page_entries_info_with_custom_entry_name
+    @template = '<%= page_entries_info collection, :entry_name => "author" %>'
+    
+    entries = (1..20).to_a
+    
+    paginate(entries.paginate(:page => 1, :per_page => 5))
+    assert_equal %{Displaying authors <b>1&nbsp;-&nbsp;5</b> of <b>20</b> in total}, @html_result
+    
+    paginate(entries.paginate(:page => 1, :per_page => 20))
+    assert_equal %{Displaying <b>all 20</b> authors}, @html_result
+    
+    paginate(['a'].paginate(:page => 1, :per_page => 5))
+    assert_equal %{Displaying <b>1</b> author}, @html_result
+    
+    paginate([].paginate(:page => 1, :per_page => 5))
+    assert_equal %{No authors found}, @html_result
+  end
+  
   ## parameter handling in page links ##
   
   def test_will_paginate_preserves_parameters_on_get

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mislav-will_paginate
 version: !ruby/object:Gem::Version 
-  version: 2.2.3
+  version: 2.3.0
 platform: ruby
 authors: 
 - "Mislav Marohni\xC4\x87"