will_paginate 3.0.4 → 3.1.0

data/spec/finders/mongoid_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+begin
+  require 'will_paginate/mongoid'
+rescue LoadError => error
+  warn "Error running Mongoid specs: #{error.message}"
+  mongoid_loaded = false
+else
+  Mongoid.connect_to 'will_paginate_test'
+
+  class MongoidModel
+    include Mongoid::Document
+  end
+
+  mongoid_loaded = true
+end
+
+describe WillPaginate::Mongoid do
+  before(:all) do
+    MongoidModel.delete_all
+    4.times { MongoidModel.create! }
+  end
+
+  let(:criteria) { MongoidModel.criteria }
+
+  describe "#page" do
+    it "should forward to the paginate method" do
+      criteria.expects(:paginate).with(:page => 2).returns("itself")
+      criteria.page(2).should == "itself"
+    end
+
+    it "should not override per_page if set earlier in the chain" do
+      criteria.paginate(:per_page => 10).page(1).per_page.should == 10
+      criteria.paginate(:per_page => 20).page(1).per_page.should == 20
+    end
+  end
+
+  describe "#per_page" do
+    it "should set the limit if given an argument" do
+      criteria.per_page(10).options[:limit].should == 10
+    end
+
+    it "should return the current limit if no argument is given" do
+      criteria.per_page.should == nil
+      criteria.per_page(10).per_page.should == 10
+    end
+
+    it "should be interchangable with limit" do
+      criteria.limit(15).per_page.should == 15
+    end
+
+    it "should be nil'able" do
+      criteria.per_page(nil).per_page.should be_nil
+    end
+  end
+
+  describe "#paginate" do
+    it "should use criteria" do
+      criteria.paginate.should be_instance_of(::Mongoid::Criteria)
+    end
+
+    it "should not override page number if set earlier in the chain" do
+      criteria.page(3).paginate.current_page.should == 3
+    end
+
+    it "should limit according to per_page parameter" do
+      criteria.paginate(:per_page => 10).options.should include(:limit => 10)
+    end
+
+    it "should skip according to page and per_page parameters" do
+      criteria.paginate(:page => 2, :per_page => 5).options.should include(:skip => 5)
+    end
+
+    specify "first fallback value for per_page option is the current limit" do
+      criteria.limit(12).paginate.options.should include(:limit => 12)
+    end
+
+    specify "second fallback value for per_page option is WillPaginate.per_page" do
+      criteria.paginate.options.should include(:limit => WillPaginate.per_page)
+    end
+
+    specify "page should default to 1" do
+      criteria.paginate.options.should include(:skip => 0)
+    end
+
+    it "should convert strings to integers" do
+      criteria.paginate(:page => "2", :per_page => "3").options.should include(:limit => 3)
+    end
+
+    describe "collection compatibility" do
+      describe "#total_count" do
+        it "should be calculated correctly" do
+          criteria.paginate(:per_page => 1).total_entries.should == 4
+          criteria.paginate(:per_page => 3).total_entries.should == 4
+        end
+
+        it "should be cached" do
+          criteria.expects(:count).once.returns(123)
+          criteria.paginate
+          2.times { criteria.total_entries.should == 123 }
+        end
+      end
+
+      it "should calculate total_pages" do
+        criteria.paginate(:per_page => 1).total_pages.should == 4
+        criteria.paginate(:per_page => 3).total_pages.should == 2
+        criteria.paginate(:per_page => 10).total_pages.should == 1
+      end
+
+      it "should return per_page" do
+        criteria.paginate(:per_page => 1).per_page.should == 1
+        criteria.paginate(:per_page => 5).per_page.should == 5
+      end
+
+      describe "#current_page" do
+        it "should return current_page" do
+          criteria.paginate(:page => 1).current_page.should == 1
+          criteria.paginate(:page => 3).current_page.should == 3
+        end
+
+        it "should be casted to PageNumber" do
+          page = criteria.paginate(:page => 1).current_page
+          (page.instance_of? WillPaginate::PageNumber).should be
+        end
+      end
+
+      it "should return offset" do
+        criteria.paginate(:page => 1).offset.should == 0
+        criteria.paginate(:page => 2, :per_page => 5).offset.should == 5
+        criteria.paginate(:page => 3, :per_page => 10).offset.should == 20
+      end
+
+      it "should not pollute plain mongoid criterias" do
+        %w(total_entries total_pages current_page).each do |method|
+          criteria.should_not respond_to(method)
+        end
+      end
+    end
+  end
+end if mongoid_loaded

data/spec/fixtures/admin.rb

@@ -1,3 +1,3 @@
 class Admin < User
-  has_many :companies, :finder_sql => 'SELECT * FROM companies'
+  has_many :companies
 end

data/spec/fixtures/developer.rb

@@ -1,13 +1,9 @@
 class Developer < User
-  has_and_belongs_to_many :projects, :include => :topics, :order => 'projects.name', :join_table => 'developers_projects'
+  has_and_belongs_to_many :projects, :join_table => 'developers_projects'
 
-  def self.with_poor_ones(&block)
-    with_scope :find => { :conditions => ['salary <= ?', 80000], :order => 'salary' } do
-      yield
-    end
-  end
-
-  scope :poor, :conditions => ['salary <= ?', 80000], :order => 'salary'
+  scope :poor, lambda {
+    where(['salary <= ?', 80000]).order('salary')
+  }
 
   def self.per_page() 10 end
 end

data/spec/fixtures/project.rb

@@ -1,5 +1,5 @@
 class Project < ActiveRecord::Base
-  has_and_belongs_to_many :developers, :uniq => true, :join_table => 'developers_projects'
+  has_and_belongs_to_many :developers, :join_table => 'developers_projects'
   
   has_many :topics
     # :finder_sql  => 'SELECT * FROM topics WHERE (topics.project_id = #{id})',
@@ -7,9 +7,7 @@ class Project < ActiveRecord::Base
   
   has_many :replies, :through => :topics do
     def only_recent(params = {})
-      scoped.where(['replies.created_at > ?', 15.minutes.ago])
+      where(['replies.created_at > ?', 15.minutes.ago])
     end
   end
-
-  has_many :unique_replies, :through => :topics, :source => :replies, :uniq => true
 end

data/spec/fixtures/reply.rb

@@ -1,9 +1,8 @@
 class Reply < ActiveRecord::Base
-  belongs_to :topic, :include => [:replies]
-
-  scope :recent,
-    :conditions => ['replies.created_at > ?', 15.minutes.ago],
-    :order => 'replies.created_at DESC'
+  scope :recent, lambda {
+    where(['replies.created_at > ?', 15.minutes.ago]).
+      order('replies.created_at DESC')
+  }
 
   validates_presence_of :content
 end

data/spec/fixtures/topic.rb

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

data/spec/matchers/deprecation_matcher.rb

@@ -0,0 +1,27 @@
+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/matchers/phrase_matcher.rb

@@ -0,0 +1,19 @@
+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

data/spec/matchers/query_count_matcher.rb

@@ -0,0 +1,36 @@
+class QueryCountMatcher
+  def initialize(num)
+    @expected_count = num
+  end
+
+  def matches?(block)
+    run(block)
+
+    if @expected_count.respond_to? :include?
+      @expected_count.include? @count
+    else
+      @count == @expected_count
+    end
+  end
+
+  def run(block)
+    $query_count = 0
+    $query_sql = []
+    block.call
+  ensure
+    @queries = $query_sql.dup
+    @count = $query_count
+  end
+
+  def performed_queries
+    @queries
+  end
+
+  def failure_message
+    "expected #{@expected_count} queries, got #{@count}\n#{@queries.join("\n")}"
+  end
+
+  def negative_failure_message
+    "expected query count not to be #{@expected_count}"
+  end
+end

data/spec/page_number_spec.rb

@@ -3,23 +3,41 @@ require 'will_paginate/page_number'
 
 describe WillPaginate::PageNumber do
   describe "valid" do
-    subject { described_class.new('12', 'page') }
+    def num
+      WillPaginate::PageNumber.new('12', 'page')
+    end
+
+    it "== 12" do
+      num.should eq(12)
+    end
 
-    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 "inspects to 'page 12'" do
+      num.inspect.should eq('page 12')
+    end
+
+    it "is a PageNumber" do
+      (num.instance_of? WillPaginate::PageNumber).should be
+    end
+
+    it "is a kind of Numeric" do
+      (num.is_a? Numeric).should be
+    end
+
+    it "is a kind of Fixnum" do
+      (num.is_a? Fixnum).should be
+    end
+
+    it "isn't directly a Fixnum" do
+      (num.instance_of? Fixnum).should_not be
+    end
 
     it "passes the PageNumber=== type check" do |variable|
-      (WillPaginate::PageNumber === subject).should be
+      (WillPaginate::PageNumber === num).should be
     end
 
     it "passes the Numeric=== type check" do |variable|
-      (Numeric === subject).should be
-      (Fixnum === subject).should be
+      (Numeric === num).should be
+      (Fixnum === num).should be
     end
   end
 

data/spec/spec_helper.rb

@@ -1,11 +1,13 @@
 require 'rspec'
-require File.expand_path('../view_helpers/view_example_group', __FILE__)
+require 'view_helpers/view_example_group'
 begin
   require 'ruby-debug'
 rescue LoadError
   # no debugger available
 end
 
+Dir[File.expand_path('../matchers/*_matcher.rb', __FILE__)].each { |matcher| require matcher }
+
 RSpec.configure do |config|
   config.include Module.new {
     protected
@@ -17,55 +19,28 @@ RSpec.configure do |config|
     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 run_queries(num)
+      QueryCountMatcher.new(num)
+    end
 
-  def failure_message
-    "expected deprecation warning #{@message.inspect}, got #{@actual.inspect}"
-  end
+    def ignore_deprecation
+      ActiveSupport::Deprecation.silence { yield }
+    end
 
-  private
+    def show_queries(&block)
+      counter = QueryCountMatcher.new(nil)
+      counter.run block
+    ensure
+      queries = counter.performed_queries
+      if queries.any?
+        puts queries
+      else
+        puts "no queries"
+      end
+    end
+  }
 
-  def hijack_stderr
-    err = $stderr
-    $stderr = StringIO.new
-    yield
-    $stderr.string.rstrip
-  ensure
-    $stderr = err
-  end
+  config.mock_with :mocha
+  config.backtrace_clean_patterns << /view_example_group/
 end

data/spec/view_helpers/action_view_spec.rb

@@ -1,6 +1,8 @@
+# encoding: utf-8
 require 'spec_helper'
 require 'active_support/rescuable' # needed for Ruby 1.9.1
 require 'action_controller'
+require 'action_view'
 require 'will_paginate/view_helpers/action_view'
 require 'will_paginate/collection'
 
@@ -19,6 +21,7 @@ describe WillPaginate::ActionView do
 
   before(:all) do
     I18n.load_path.concat WillPaginate::I18n.load_path
+    I18n.enforce_available_locales = false
   end
 
   before(:each) do
@@ -47,12 +50,23 @@ describe WillPaginate::ActionView 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 →"
+        text(elements[2]).should == 'Next →'
+      end
+      assert_select 'span', 1 do |spans|
+        spans[0]['class'].should == 'previous_page disabled'
+        text(spans[0]).should == '← Previous'
       end
-      assert_select 'span', 1
-      assert_select 'span.disabled:first-child', '← Previous'
       assert_select 'em.current', '1'
-      pagination.first.inner_text.should == '← Previous 1 2 3 Next →'
+      text(pagination[0]).should == '← Previous 1 2 3 Next →'
+    end
+  end
+
+  it "should override existing page param value" do
+    request.params :page => 1
+    paginate do |pagination|
+      assert_select 'a[href]', 3 do |elements|
+        validate_page_numbers [2,3,2], elements
+      end
     end
   end
 
@@ -65,15 +79,12 @@ describe WillPaginate::ActionView 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
+        text(elements[0]).should == 'Prev'
+        elements[0]['rel'].should == 'prev start'
+        text(elements[1]).should == '1'
+        elements[1]['rel'].should == 'prev start'
+        text(elements[3]).should == 'Next'
+        elements[3]['rel'].should == 'next'
       end
       assert_select '.current', '2'
     end
@@ -116,8 +127,8 @@ describe WillPaginate::ActionView do
       <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
-    
+    expected_dom = parse_html_document(expected).root
+
     html_document.root.should == expected_dom
   end
   
@@ -127,7 +138,8 @@ describe WillPaginate::ActionView do
     
     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)
+      parts = query.gsub('&amp;', '&').split('&').sort
+      parts.should == %w(page=2 tag=%3Cbr%3E)
     end
   end
   
@@ -180,6 +192,15 @@ describe WillPaginate::ActionView do
     paginate
     assert_links_match /foo\[bar\]=baz/
   end
+
+  it "doesn't allow tampering with host, port, protocol" do
+    request.params :host => 'disney.com', :port => '99', :protocol => 'ftp'
+    paginate
+    assert_links_match %r{^/foo/bar}
+    assert_no_links_match /disney/
+    assert_no_links_match /99/
+    assert_no_links_match /ftp/
+  end
   
   it "should not preserve parameters on POST" do
     request.post
@@ -294,13 +315,12 @@ describe WillPaginate::ActionView do
   end
 
   it "renders using ActionView helpers on a custom object" do
-    helper = Object.new
-    class << helper
+    helper = Class.new {
       attr_reader :controller
       include ActionView::Helpers::UrlHelper
       include Routes.url_helpers
       include WillPaginate::ActionView
-    end
+    }.new
     helper.default_url_options[:controller] = 'dummy'
 
     collection = WillPaginate::Collection.new(2, 1, 3)
@@ -313,22 +333,21 @@ describe WillPaginate::ActionView do
   end
 
   it "renders using ActionDispatch helper on a custom object" do
-    helper = Object.new
-    class << helper
+    helper = Class.new {
       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
+    }.new
+    helper.default_url_options.update \
+      :only_path => true,
+      :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 == ['http://example.com/dummy/page/1', 'http://example.com/dummy/page/3']
+      urls.should == ['/dummy/page/1', '/dummy/page/3']
     end
   end
 
@@ -338,6 +357,11 @@ describe WillPaginate::ActionView do
     I18n.available_locales # triggers loading existing translations
     I18n.backend.store_translations(:en, data)
   end
+
+  # Normalizes differences between HTML::Document and Nokogiri::HTML
+  def text(node)
+    node.inner_text.gsub('&#8594;', '→').gsub('&#8592;', '←')
+  end
 end
 
 class AdditionalLinkAttributesRenderer < WillPaginate::ActionView::LinkRenderer
@@ -359,7 +383,7 @@ class DummyController
   include Routes.url_helpers
   
   def initialize
-    @request = DummyRequest.new
+    @request = DummyRequest.new(self)
   end
 
   def params
@@ -380,13 +404,19 @@ end
 
 class DummyRequest
   attr_accessor :symbolized_path_parameters
+  alias :path_parameters :symbolized_path_parameters
   
-  def initialize
+  def initialize(controller)
+    @controller = controller
     @get = true
     @params = {}
     @symbolized_path_parameters = { :controller => 'foo', :action => 'bar' }
   end
-  
+
+  def routes
+    @controller._routes
+  end
+
   def get?
     @get
   end

data/spec/view_helpers/base_spec.rb

@@ -10,6 +10,7 @@ describe WillPaginate::ViewHelpers do
   before(:all) do
     # make sure default translations aren't loaded
     I18n.load_path.clear
+    I18n.enforce_available_locales = false
   end
 
   before(:each) do
@@ -32,6 +33,18 @@ describe WillPaginate::ViewHelpers do
       collection = mock 'Collection', :total_pages => 1
       will_paginate(collection).should be_nil
     end
+
+    it "should call html_safe on result" do
+      collection = WillPaginate::Collection.new(1, 2, 4)
+
+      html = mock 'HTML'
+      html.expects(:html_safe).returns(html)
+      renderer = mock 'Renderer'
+      renderer.stubs(:prepare)
+      renderer.expects(:to_html).returns(html)
+
+      will_paginate(collection, :renderer => renderer).should eql(html)
+    end
   end
 
   describe "pagination_options" do