hobo_will_paginate 2.1.0

data/spec/fixtures/schema.rb

@@ -0,0 +1,38 @@
+ActiveRecord::Schema.define do
+
+  create_table "users", :force => true do |t|
+    t.column "name",       :text
+    t.column "salary",     :integer,  :default => 70000
+    t.column "created_at", :datetime
+    t.column "updated_at", :datetime
+    t.column "type",       :text
+  end
+
+  create_table "projects", :force => true do |t|
+    t.column "name", :text
+  end
+
+  create_table "developers_projects", :id => false, :force => true do |t|
+    t.column "developer_id", :integer, :null => false
+    t.column "project_id",   :integer, :null => false
+    t.column "joined_on",    :date
+    t.column "access_level", :integer, :default => 1
+  end
+
+  create_table "topics", :force => true do |t|
+    t.column "project_id", :integer
+    t.column "title",      :string
+    t.column "subtitle",   :string
+    t.column "content",    :text
+    t.column "created_at", :datetime
+    t.column "updated_at", :datetime
+  end
+
+  create_table "replies", :force => true do |t|
+    t.column "content",    :text
+    t.column "created_at", :datetime
+    t.column "updated_at", :datetime
+    t.column "topic_id",   :integer
+  end
+
+end

data/spec/fixtures/topic.rb

@@ -0,0 +1,7 @@
+class Topic < ActiveRecord::Base
+  has_many :replies, :dependent => :destroy, :order => 'replies.created_at DESC'
+  belongs_to :project
+
+  scope :mentions_activerecord, :conditions => ['topics.title LIKE ?', '%ActiveRecord%']
+  scope :distinct, :select => "DISTINCT #{table_name}.*"
+end

data/spec/fixtures/topics.yml

@@ -0,0 +1,30 @@
+futurama:
+  id: 1
+  title: Isnt futurama awesome?
+  subtitle: It really is, isnt it.
+  content: I like futurama
+  created_at: <%= 1.day.ago.utc.to_s(:db) %>
+  updated_at:
+  
+harvey_birdman:
+  id: 2
+  title: Harvey Birdman is the king of all men
+  subtitle: yup
+  content: He really is
+  created_at: <%= 2.hours.ago.utc.to_s(:db) %>
+  updated_at:
+
+rails:
+  id: 3
+  project_id: 1
+  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.utc.to_s(:db) %>
+
+ar:
+  id: 4
+  project_id: 1
+  title: ActiveRecord sometimes freaks me out
+  content: "I mean, what's the deal with eager loading?"
+  created_at: <%= 15.minutes.ago.utc.to_s(:db) %>

data/spec/fixtures/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/fixtures/users.yml

@@ -0,0 +1,35 @@
+david:
+  id: 1
+  name: David
+  salary: 80000
+  type: Developer
+
+jamis:
+  id: 2
+  name: Jamis
+  salary: 150000
+  type: Developer
+
+<% for digit in 3..10 %>
+dev_<%= digit %>:
+  id: <%= digit %>
+  name: fixture_<%= digit %>
+  salary: 100000
+  type: Developer
+<% end %>
+
+poor_jamis:
+  id: 11
+  name: Jamis
+  salary: 9000
+  type: Developer
+
+admin:
+  id: 12
+  name: admin
+  type: Admin
+
+goofy:
+  id: 13
+  name: Goofy
+  type: Admin

data/spec/page_number_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+require 'will_paginate/page_number'
+
+describe WillPaginate::PageNumber do
+  describe "valid" do
+    subject { described_class.new('12', 'page') }
+
+    it { should eq(12) }
+    its(:inspect) { should eq('page 12') }
+    it { should be_a(WillPaginate::PageNumber) }
+    it { should be_instance_of(WillPaginate::PageNumber) }
+    it { should be_a(Numeric) }
+    it { should be_a(Fixnum) }
+    it { should_not be_instance_of(Fixnum) }
+
+    it "passes the PageNumber=== type check" do |variable|
+      (WillPaginate::PageNumber === subject).should be
+    end
+
+    it "passes the Numeric=== type check" do |variable|
+      (Numeric === subject).should be
+      (Fixnum === subject).should be
+    end
+  end
+
+  describe "invalid" do
+    def create(value, name = 'page')
+      described_class.new(value, name)
+    end
+
+    it "errors out on non-int values" do
+      lambda { create(nil) }.should raise_error(WillPaginate::InvalidPage)
+      lambda { create('') }.should raise_error(WillPaginate::InvalidPage)
+      lambda { create('Schnitzel') }.should raise_error(WillPaginate::InvalidPage)
+    end
+
+    it "errors out on zero or less" do
+      lambda { create(0) }.should raise_error(WillPaginate::InvalidPage)
+      lambda { create(-1) }.should raise_error(WillPaginate::InvalidPage)
+    end
+
+    it "doesn't error out on zero for 'offset'" do
+      lambda { create(0, 'offset') }.should_not raise_error
+      lambda { create(-1, 'offset') }.should raise_error(WillPaginate::InvalidPage)
+    end
+  end
+
+  describe "coercion method" do
+    it "defaults to 'page' name" do
+      num = WillPaginate::PageNumber(12)
+      num.inspect.should eq('page 12')
+    end
+
+    it "accepts a custom name" do
+      num = WillPaginate::PageNumber(12, 'monkeys')
+      num.inspect.should eq('monkeys 12')
+    end
+
+    it "doesn't affect PageNumber instances" do
+      num = WillPaginate::PageNumber(12)
+      num2 = WillPaginate::PageNumber(num)
+      num2.object_id.should eq(num.object_id)
+    end
+  end
+end

data/spec/per_page_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'will_paginate/per_page'
+
+describe WillPaginate::PerPage do
+
+  class MyModel
+    extend WillPaginate::PerPage
+  end
+
+  it "has the default value" do
+    MyModel.per_page.should == 30
+
+    WillPaginate.per_page = 10
+    begin
+      MyModel.per_page.should == 10
+    ensure
+      WillPaginate.per_page = 30
+    end
+  end
+
+  it "casts values to int" do
+    WillPaginate.per_page = '10'
+    begin
+      MyModel.per_page.should == 10
+    ensure
+      WillPaginate.per_page = 30
+    end
+  end
+
+  it "has an explicit value" do
+    MyModel.per_page = 12
+    begin
+      MyModel.per_page.should == 12
+      subclass = Class.new(MyModel)
+      subclass.per_page.should == 12
+    ensure
+      MyModel.send(:remove_instance_variable, '@per_page')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+require 'rspec'
+require File.expand_path('../view_helpers/view_example_group', __FILE__)
+begin
+  require 'ruby-debug'
+rescue LoadError
+  # no debugger available
+end
+
+RSpec.configure do |config|
+  config.include Module.new {
+    protected
+
+    def include_phrase(string)
+      PhraseMatcher.new(string)
+    end
+
+    def have_deprecation(msg)
+      DeprecationMatcher.new(msg)
+    end
+  }
+  
+  config.mock_with :mocha
+end
+
+class PhraseMatcher
+  def initialize(string)
+    @string = string
+    @pattern = /\b#{Regexp.escape string}\b/
+  end
+
+  def matches?(actual)
+    @actual = actual.to_s
+    @actual =~ @pattern
+  end
+
+  def failure_message
+    "expected #{@actual.inspect} to contain phrase #{@string.inspect}"
+  end
+
+  def negative_failure_message
+    "expected #{@actual.inspect} not to contain phrase #{@string.inspect}"
+  end
+end
+
+require 'stringio'
+
+class DeprecationMatcher
+  def initialize(message)
+    @message = message
+  end
+
+  def matches?(block)
+    @actual = hijack_stderr(&block)
+    PhraseMatcher.new("DEPRECATION WARNING: #{@message}").matches?(@actual)
+  end
+
+  def failure_message
+    "expected deprecation warning #{@message.inspect}, got #{@actual.inspect}"
+  end
+
+  private
+
+  def hijack_stderr
+    err = $stderr
+    $stderr = StringIO.new
+    yield
+    $stderr.string.rstrip
+  ensure
+    $stderr = err
+  end
+end

data/spec/view_helpers/action_view_spec.rb

@@ -0,0 +1,423 @@
+require 'spec_helper'
+require 'active_support/rescuable' # needed for Ruby 1.9.1
+require 'action_controller'
+require 'will_paginate/view_helpers/action_view'
+require 'will_paginate/collection'
+
+Routes = ActionDispatch::Routing::RouteSet.new
+
+Routes.draw do
+  match 'dummy/page/:page' => 'dummy#index'
+  match 'dummy/dots/page.:page' => 'dummy#dots'
+  match 'ibocorp(/:page)' => 'ibocorp#index',
+        :constraints => { :page => /\d+/ }, :defaults => { :page => 1 }
+
+  match ':controller(/:action(/:id(.:format)))'
+end
+
+describe WillPaginate::ActionView do
+
+  before(:all) do
+    I18n.load_path.concat WillPaginate::I18n.load_path
+  end
+
+  before(:each) do
+    I18n.reload!
+  end
+
+  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.singleton_class.send(:include, @controller._routes.url_helpers)
+    @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.current', '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 '.current', '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::ActionView::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 match expected markup" do
+    paginate
+    expected = <<-HTML
+      <div class="pagination"><span class="previous_page disabled">&#8592; Previous</span>
+      <em class="current">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
+
+  ## 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
+
+  it "should not render a paginated section with a single page" do
+    @template = <<-ERB
+      <%= paginated_section collection, options do %>
+        <%= content_tag :div, '', :id => "developers" %>
+      <% end %>
+    ERB
+
+    paginate(:total_entries => 1)
+    assert_select 'div.pagination', 0
+    assert_select '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
+    # Routes.recognize_path('/ibocorp/2').should == {:page=>'2', :action=>'index', :controller=>'ibocorp'}
+    # Routes.recognize_path('/ibocorp/foo').should == {:action=>'foo', :controller=>'ibocorp'}
+  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
+
+  ## i18n
+
+  it "is able to translate previous/next labels" do
+    translation :will_paginate => {
+      :previous_label => 'Go back',
+      :next_label => 'Load more'
+    }
+
+    paginate do |pagination|
+      assert_select 'span.disabled:first-child', 'Go back'
+      assert_select 'a[rel=next]', 'Load more'
+    end
+  end
+
+  it "renders using ActionView helpers on a custom object" do
+    helper = Object.new
+    class << helper
+      attr_reader :controller
+      include ActionView::Helpers::UrlHelper
+      include Routes.url_helpers
+      include WillPaginate::ActionView
+    end
+    helper.default_url_options[:controller] = 'dummy'
+
+    collection = WillPaginate::Collection.new(2, 1, 3)
+    @render_output = helper.will_paginate(collection)
+
+    assert_select 'a[href]', 4 do |links|
+      urls = links.map {|l| l['href'] }.uniq
+      urls.should == ['/dummy/page/1', '/dummy/page/3']
+    end
+  end
+
+  it "renders using ActionDispatch helper on a custom object" do
+    helper = Object.new
+    class << helper
+      include ActionDispatch::Routing::UrlFor
+      include Routes.url_helpers
+      include WillPaginate::ActionView
+    end
+    helper.default_url_options[:host] = 'example.com'
+    helper.default_url_options[:controller] = 'dummy'
+    # helper.default_url_options[:only_path] = true
+
+    collection = WillPaginate::Collection.new(2, 1, 3)
+    @render_output = helper.will_paginate(collection)
+
+    assert_select 'a[href]', 4 do |links|
+      urls = links.map {|l| l['href'] }.uniq
+      urls.should == ['http://example.com/dummy/page/1', 'http://example.com/dummy/page/3']
+    end
+  end
+
+  private
+
+  def translation(data)
+    I18n.available_locales # triggers loading existing translations
+    I18n.backend.store_translations(:en, data)
+  end
+end
+
+class AdditionalLinkAttributesRenderer < WillPaginate::ActionView::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
+  
+  include ActionController::UrlFor
+  include Routes.url_helpers
+  
+  def initialize
+    @request = DummyRequest.new
+  end
+
+  def params
+    @request.params
+  end
+
+  def env
+    {}
+  end
+
+  def _prefixes
+    []
+  end
+end
+
+class IbocorpController < DummyController
+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 script_name
+    ''
+  end
+
+  def params(more = nil)
+    @params.update(more) if more
+    @params
+  end
+  
+  def host_with_port
+    'example.com'
+  end
+  alias host host_with_port
+
+  def optional_port
+    ''
+  end
+  
+  def protocol
+    'http:'
+  end
+end