will_paginate 2.3.16 → 3.0.pre

data/spec/view_helpers/action_view_spec.rb

@@ -0,0 +1,345 @@
+require 'spec_helper'
+require 'active_support/rescuable' # needed for Ruby 1.9.1
+require 'action_controller'
+require 'view_helpers/view_example_group'
+require 'will_paginate/view_helpers/action_view'
+require 'will_paginate/collection'
+
+ActionController::Routing::Routes.draw do |map|
+  map.connect 'dummy/page/:page', :controller => 'dummy'
+  map.connect 'dummy/dots/page.:page', :controller => 'dummy', :action => 'dots'
+  map.connect 'ibocorp/:page', :controller => 'ibocorp',
+                               :requirements => { :page => /\d+/ },
+                               :defaults => { :page => 1 }
+                               
+  map.connect ':controller/:action/:id'
+end
+
+describe WillPaginate::ViewHelpers::ActionView do
+  before(:each) do
+    @assigns = {}
+    @controller = DummyController.new
+    @request = @controller.request
+    @template = '<%= will_paginate collection, options %>'
+  end
+  
+  attr_reader :assigns, :controller, :request
+  
+  def render(locals)
+    @view = ActionView::Base.new([], @assigns, @controller)
+    @view.request = @request
+    @view.render(:inline => @template, :locals => locals)
+  end
+  
+  ## basic pagination ##
+  
+  it "should render" do
+    paginate do |pagination|
+      assert_select 'a[href]', 3 do |elements|
+        validate_page_numbers [2,3,2], elements
+        assert_select elements.last, ':last-child', "Next &#8594;"
+      end
+      assert_select 'span', 1
+      assert_select 'span.disabled:first-child', '&#8592; Previous'
+      assert_select 'em', '1'
+      pagination.first.inner_text.should == '&#8592; Previous 1 2 3 Next &#8594;'
+    end
+  end
+
+  it "should render nothing when there is only 1 page" do
+    paginate(:per_page => 30).should be_empty
+  end
+
+  it "should paginate with options" do
+    paginate({ :page => 2 }, :class => 'will_paginate', :previous_label => 'Prev', :next_label => 'Next') do
+      assert_select 'a[href]', 4 do |elements|
+        validate_page_numbers [1,1,3,3], elements
+        # test rel attribute values:
+        assert_select elements[1], 'a', '1' do |link|
+          link.first['rel'].should == 'prev start'
+        end
+        assert_select elements.first, 'a', "Prev" do |link|
+          link.first['rel'].should == 'prev start'
+        end
+        assert_select elements.last, 'a', "Next" do |link|
+          link.first['rel'].should == 'next'
+        end
+      end
+      assert_select 'em', '2'
+    end
+  end
+
+  it "should paginate using a custom renderer class" do
+    paginate({}, :renderer => AdditionalLinkAttributesRenderer) do
+      assert_select 'a[default=true]', 3
+    end
+  end
+
+  it "should paginate using a custom renderer instance" do
+    renderer = WillPaginate::ViewHelpers::LinkRenderer.new
+    def renderer.gap() '<span class="my-gap">~~</span>' end
+    
+    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
+
+  it "should have classnames on previous/next links" do
+    paginate do |pagination|
+      assert_select 'span.disabled.previous_page:first-child'
+      assert_select 'a.next_page[href]:last-child'
+    end
+  end
+  
+  it "should warn about :prev_label being deprecated" do
+    lambda {
+      paginate({ :page => 2 }, :prev_label => 'Deprecated') do
+        assert_select 'a[href]:first-child', 'Deprecated'
+      end
+    }.should have_deprecation
+  end
+
+  it "should match expected markup" do
+    paginate
+    expected = <<-HTML
+      <div class="pagination"><span class="previous_page disabled">&#8592; Previous</span>
+      <em>1</em>
+      <a href="/foo/bar?page=2" rel="next">2</a>
+      <a href="/foo/bar?page=3">3</a>
+      <a href="/foo/bar?page=2" class="next_page" rel="next">Next &#8594;</a></div>
+    HTML
+    expected.strip!.gsub!(/\s{2,}/, ' ')
+    expected_dom = HTML::Document.new(expected).root
+    
+    html_document.root.should == expected_dom
+  end
+  
+  it "should output escaped URLs" do
+    paginate({:page => 1, :per_page => 1, :total_entries => 2},
+             :page_links => false, :params => { :tag => '<br>' })
+    
+    assert_select 'a[href]', 1 do |links|
+      query = links.first['href'].split('?', 2)[1]
+      query.split('&amp;').sort.should == %w(page=2 tag=%3Cbr%3E)
+    end
+  end
+  
+  ## advanced options for pagination ##
+
+  it "should be able to render without container" do
+    paginate({}, :container => false)
+    assert_select 'div.pagination', 0, 'main DIV present when it shouldn\'t'
+    assert_select 'a[href]', 3
+  end
+
+  it "should be able to render without page links" do
+    paginate({ :page => 2 }, :page_links => false) do
+      assert_select 'a[href]', 2 do |elements|
+        validate_page_numbers [1,3], elements
+      end
+    end
+  end
+
+  it "should have magic HTML ID for the container" do
+    paginate do |div|
+      div.first['id'].should be_nil
+    end
+    
+    # magic ID
+    paginate({}, :id => true) do |div|
+      div.first['id'].should == 'fixnums_pagination'
+    end
+    
+    # explicit ID
+    paginate({}, :id => 'custom_id') do |div|
+      div.first['id'].should == 'custom_id'
+    end
+  end
+
+  ## other helpers ##
+  
+  it "should render a paginated section" do
+    @template = <<-ERB
+      <% paginated_section collection, options do %>
+        <%= content_tag :div, '', :id => "developers" %>
+      <% end %>
+    ERB
+    
+    paginate
+    assert_select 'div.pagination', 2
+    assert_select 'div.pagination + div#developers', 1
+  end
+  
+  ## parameter handling in page links ##
+  
+  it "should preserve parameters on GET" do
+    request.params :foo => { :bar => 'baz' }
+    paginate
+    assert_links_match /foo\[bar\]=baz/
+  end
+  
+  it "should not preserve parameters on POST" do
+    request.post
+    request.params :foo => 'bar'
+    paginate
+    assert_no_links_match /foo=bar/
+  end
+  
+  it "should add additional parameters to links" do
+    paginate({}, :params => { :foo => 'bar' })
+    assert_links_match /foo=bar/
+  end
+  
+  it "should add anchor parameter" do
+    paginate({}, :params => { :anchor => 'anchor' })
+    assert_links_match /#anchor$/
+  end
+  
+  it "should remove arbitrary parameters" do
+    request.params :foo => 'bar'
+    paginate({}, :params => { :foo => nil })
+    assert_no_links_match /foo=bar/
+  end
+    
+  it "should override default route parameters" do
+    paginate({}, :params => { :controller => 'baz', :action => 'list' })
+    assert_links_match %r{\Wbaz/list\W}
+  end
+  
+  it "should paginate with custom page parameter" do
+    paginate({ :page => 2 }, :param_name => :developers_page) do
+      assert_select 'a[href]', 4 do |elements|
+        validate_page_numbers [1,1,3,3], elements, :developers_page
+      end
+    end    
+  end
+  
+  it "should paginate with complex custom page parameter" do
+    request.params :developers => { :page => 2 }
+    
+    paginate({ :page => 2 }, :param_name => 'developers[page]') do
+      assert_select 'a[href]', 4 do |links|
+        assert_links_match /\?developers\[page\]=\d+$/, links
+        validate_page_numbers [1,1,3,3], links, 'developers[page]'
+      end
+    end
+  end
+
+  it "should paginate with custom route page parameter" do
+    request.symbolized_path_parameters.update :controller => 'dummy', :action => nil
+    paginate :per_page => 2 do
+      assert_select 'a[href]', 6 do |links|
+        assert_links_match %r{/page/(\d+)$}, links, [2, 3, 4, 5, 6, 2]
+      end
+    end
+  end
+
+  it "should paginate with custom route with dot separator page parameter" do
+    request.symbolized_path_parameters.update :controller => 'dummy', :action => 'dots'
+    paginate :per_page => 2 do
+      assert_select 'a[href]', 6 do |links|
+        assert_links_match %r{/page\.(\d+)$}, links, [2, 3, 4, 5, 6, 2]
+      end
+    end
+  end
+
+  it "should paginate with custom route and first page number implicit" do
+    request.symbolized_path_parameters.update :controller => 'ibocorp', :action => nil
+    paginate :page => 2, :per_page => 2 do
+      assert_select 'a[href]', 7 do |links|
+        assert_links_match %r{/ibocorp(?:/(\d+))?$}, links, [nil, nil, 3, 4, 5, 6, 3]
+      end
+    end
+  end
+
+  ## internal hardcore stuff ##
+
+  it "should be able to guess the collection name" do
+    collection = mock
+    collection.expects(:total_pages).returns(1)
+    
+    @template = '<%= will_paginate options %>'
+    controller.controller_name = 'developers'
+    assigns['developers'] = collection
+    
+    paginate(nil)
+  end
+  
+  it "should fail if the inferred collection is nil" do
+    @template = '<%= will_paginate options %>'
+    controller.controller_name = 'developers'
+    
+    lambda {
+      paginate(nil)
+    }.should raise_error(ActionView::TemplateError, /@developers/)
+  end
+end
+
+class AdditionalLinkAttributesRenderer < WillPaginate::ViewHelpers::LinkRenderer
+  def initialize(link_attributes = nil)
+    super()
+    @additional_link_attributes = link_attributes || { :default => 'true' }
+  end
+
+  def link(text, target, attributes = {})
+    super(text, target, attributes.merge(@additional_link_attributes))
+  end
+end
+
+class DummyController
+  attr_reader :request
+  attr_accessor :controller_name
+  
+  def initialize
+    @request = DummyRequest.new
+    @url = ActionController::UrlRewriter.new(@request, @request.params)
+  end
+
+  def params
+    @request.params
+  end
+  
+  def url_for(params)
+    @url.rewrite(params)
+  end
+end
+
+class DummyRequest
+  attr_accessor :symbolized_path_parameters
+  
+  def initialize
+    @get = true
+    @params = {}
+    @symbolized_path_parameters = { :controller => 'foo', :action => 'bar' }
+  end
+  
+  def get?
+    @get
+  end
+
+  def post
+    @get = false
+  end
+
+  def relative_url_root
+    ''
+  end
+
+  def params(more = nil)
+    @params.update(more) if more
+    @params
+  end
+  
+  def host_with_port
+    'example.com'
+  end
+  
+  def protocol
+    'http:'
+  end
+end

data/spec/view_helpers/base_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'will_paginate/view_helpers/base'
+require 'will_paginate/array'
+
+describe WillPaginate::ViewHelpers::Base do
+
+  include WillPaginate::ViewHelpers::Base
+  
+  describe "will_paginate" do
+    it "should render" do
+      collection = WillPaginate::Collection.new(1, 2, 4)
+      renderer   = mock 'Renderer'
+      renderer.expects(:prepare).with(collection, instance_of(Hash), self)
+      renderer.expects(:to_html).returns('<PAGES>')
+      
+      will_paginate(collection, :renderer => renderer).should == '<PAGES>'
+    end
+    
+    it "should return nil for single-page collections" do
+      collection = mock 'Collection', :total_pages => 1
+      will_paginate(collection).should be_nil
+    end
+  end
+  
+  describe "page_entries_info" do
+    before :all do
+      @array = ('a'..'z').to_a
+    end
+
+    def info(params, options = {})
+      options[:html] ||= false unless options.key?(:html) and options[:html].nil?
+      collection = Hash === params ? @array.paginate(params) : params
+      page_entries_info collection, options
+    end
+
+    it "should display middle results and total count" do
+      info(:page => 2, :per_page => 5).should == "Displaying strings 6 - 10 of 26 in total"
+    end
+
+    it "should output HTML by default" do
+      info({ :page => 2, :per_page => 5 }, :html => nil).should ==
+        "Displaying strings <b>6&nbsp;-&nbsp;10</b> of <b>26</b> in total"
+    end
+
+    it "should display shortened end results" do
+      info(:page => 7, :per_page => 4).should include_phrase('strings 25 - 26')
+    end
+
+    it "should handle longer class names" do
+      collection = @array.paginate(:page => 2, :per_page => 5)
+      collection.first.stubs(:class).returns(mock('Class', :name => 'ProjectType'))
+      info(collection).should include_phrase('project types')
+    end
+
+    it "should adjust output for single-page collections" do
+      info(('a'..'d').to_a.paginate(:page => 1, :per_page => 5)).should == "Displaying all 4 strings"
+      info(['a'].paginate(:page => 1, :per_page => 5)).should == "Displaying 1 string"
+    end
+  
+    it "should display 'no entries found' for empty collections" do
+      info([].paginate(:page => 1, :per_page => 5)).should == "No entries found"
+    end
+  end
+end

data/spec/view_helpers/link_renderer_base_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'will_paginate/view_helpers/link_renderer_base'
+require 'will_paginate/collection'
+
+describe WillPaginate::ViewHelpers::LinkRendererBase do
+  
+  before do
+    @renderer = WillPaginate::ViewHelpers::LinkRendererBase.new
+  end
+  
+  it "should raise error when unprepared" do
+    lambda {
+      @renderer.send :param_name
+    }.should raise_error
+  end
+  
+  it "should prepare with collection and options" do
+    prepare({}, :param_name => 'mypage')
+    @renderer.send(:current_page).should == 1
+    @renderer.send(:param_name).should == 'mypage'
+  end
+  
+  it "should have total_pages accessor" do
+    prepare :total_pages => 42
+    lambda {
+      @renderer.send(:total_pages).should == 42
+    }.should_not have_deprecation
+  end
+  
+  it "should clear old cached values when prepared" do
+    prepare({ :total_pages => 1 }, :param_name => 'foo')
+    @renderer.send(:total_pages).should == 1
+    @renderer.send(:param_name).should == 'foo'
+    # prepare with different object and options:
+    prepare({ :total_pages => 2 }, :param_name => 'bar')
+    @renderer.send(:total_pages).should == 2
+    @renderer.send(:param_name).should == 'bar'
+  end
+  
+  it "should have pagination definition" do
+    prepare({ :total_pages => 1 }, :page_links => true)
+    @renderer.pagination.should == [:previous_page, 1, :next_page]
+  end
+  
+  describe "visible page numbers" do
+    it "should calculate windowed visible links" do
+      prepare({ :page => 6, :total_pages => 11 }, :inner_window => 1, :outer_window => 1)
+      showing_pages 1, 2, :gap, 5, 6, 7, :gap, 10, 11
+    end
+  
+    it "should eliminate small gaps" do
+      prepare({ :page => 6, :total_pages => 11 }, :inner_window => 2, :outer_window => 1)
+      # pages 4 and 8 appear instead of the gap
+      showing_pages 1..11
+    end
+    
+    it "should support having no windows at all" do
+      prepare({ :page => 4, :total_pages => 7 }, :inner_window => 0, :outer_window => 0)
+      showing_pages 1, :gap, 4, :gap, 7
+    end
+    
+    it "should adjust upper limit if lower is out of bounds" do
+      prepare({ :page => 1, :total_pages => 10 }, :inner_window => 2, :outer_window => 1)
+      showing_pages 1, 2, 3, 4, 5, :gap, 9, 10
+    end
+    
+    it "should adjust lower limit if upper is out of bounds" do
+      prepare({ :page => 10, :total_pages => 10 }, :inner_window => 2, :outer_window => 1)
+      showing_pages 1, 2, :gap, 6, 7, 8, 9, 10
+    end
+    
+    def showing_pages(*pages)
+      pages = pages.first.to_a if Array === pages.first or Range === pages.first
+      @renderer.send(:windowed_page_numbers).should == pages
+    end
+  end
+  
+  protected
+  
+    def prepare(collection_options, options = {})
+      @renderer.prepare(collection(collection_options), options)
+    end
+  
+end

data/spec/view_helpers/view_example_group.rb

@@ -0,0 +1,103 @@
+require 'action_dispatch/testing/assertions'
+
+class ViewExampleGroup < Spec::Example::ExampleGroup
+  
+  include ActionDispatch::Assertions::SelectorAssertions
+  
+  def assert(value, message)
+    raise message unless value
+  end
+  
+  def paginate(collection = {}, options = {}, &block)
+    if collection.instance_of? Hash
+      page_options = { :page => 1, :total_entries => 11, :per_page => 4 }.merge(collection)
+      collection = [1].paginate(page_options)
+    end
+
+    locals = { :collection => collection, :options => options }
+
+    @render_output = render(locals)
+    @html_document = nil
+    
+    if block_given?
+      classname = options[:class] || WillPaginate::ViewHelpers.pagination_options[:class]
+      assert_select("div.#{classname}", 1, 'no main DIV', &block)
+    end
+    
+    @render_output
+  end
+  
+  def html_document
+    @html_document ||= HTML::Document.new(@render_output, true, false)
+  end
+  
+  def response_from_page_or_rjs
+    html_document.root
+  end
+  
+  def validate_page_numbers(expected, links, param_name = :page)
+    param_pattern = /\W#{Regexp.escape(param_name.to_s)}=([^&]*)/
+    
+    links.map { |e|
+      e['href'] =~ param_pattern
+      $1 ? $1.to_i : $1
+    }.should == expected
+  end
+
+  def assert_links_match(pattern, links = nil, numbers = nil)
+    links ||= assert_select 'div.pagination a[href]' do |elements|
+      elements
+    end
+
+    pages = [] if numbers
+    
+    links.each do |el|
+      el['href'].should =~ pattern
+      if numbers
+        el['href'] =~ pattern
+        pages << ($1.nil?? nil : $1.to_i)
+      end
+    end
+
+    pages.should == numbers if numbers
+  end
+
+  def assert_no_links_match(pattern)
+    assert_select 'div.pagination a[href]' do |elements|
+      elements.each do |el|
+        el['href'] !~ pattern
+      end
+    end
+  end
+  
+  def build_message(message, pattern, *args)
+    built_message = pattern.dup
+    for value in args
+      built_message.sub! '?', value.inspect
+    end
+    built_message
+  end
+  
+end
+
+Spec::Example::ExampleGroupFactory.register(:view_helpers, ViewExampleGroup)
+
+module HTML
+  Node.class_eval do
+    def inner_text
+      children.map(&:inner_text).join('')
+    end
+  end
+  
+  Text.class_eval do
+    def inner_text
+      self.to_s
+    end
+  end
+
+  Tag.class_eval do
+    def inner_text
+      childless?? '' : super
+    end
+  end
+end