will_paginate 2.1.0 → 2.2.0

data/test/finder_test.rb

@@ -1,8 +1,9 @@
-require File.dirname(__FILE__) + '/helper'
-require File.dirname(__FILE__) + '/lib/activerecord_test_case'
+require 'helper'
+require 'lib/activerecord_test_case'
 
 require 'will_paginate'
 WillPaginate.enable_activerecord
+WillPaginate.enable_named_scope
 
 class FinderTest < ActiveRecordTestCase
   fixtures :topics, :replies, :users, :projects, :developers_projects
@@ -12,18 +13,18 @@ class FinderTest < ActiveRecordTestCase
   end
   
   def test_simple_paginate
-    entries = Topic.paginate :page => nil
-    assert_equal 1, entries.current_page
-    assert_nil entries.previous_page
-    assert_nil entries.next_page
-    assert_equal 1, entries.page_count
-    assert_equal 4, entries.size
+    assert_queries(1) do
+      entries = Topic.paginate :page => nil
+      assert_equal 1, entries.current_page
+      assert_equal 1, entries.total_pages
+      assert_equal 4, entries.size
+    end
     
-    entries = Topic.paginate :page => 2
-    assert_equal 2, entries.current_page
-    assert_equal 1, entries.previous_page
-    assert_equal 1, entries.page_count
-    assert entries.empty?
+    assert_queries(2) do
+      entries = Topic.paginate :page => 2
+      assert_equal 1, entries.total_pages
+      assert entries.empty?
+    end
   end
 
   def test_parameter_api
@@ -41,31 +42,31 @@ class FinderTest < ActiveRecordTestCase
   def test_paginate_with_per_page
     entries = Topic.paginate :page => 1, :per_page => 1
     assert_equal 1, entries.size
-    assert_equal 4, entries.page_count
+    assert_equal 4, entries.total_pages
 
     # Developer class has explicit per_page at 10
     entries = Developer.paginate :page => 1
     assert_equal 10, entries.size
-    assert_equal 2, entries.page_count
+    assert_equal 2, entries.total_pages
 
     entries = Developer.paginate :page => 1, :per_page => 5
     assert_equal 11, entries.total_entries
     assert_equal 5, entries.size
-    assert_equal 3, entries.page_count
+    assert_equal 3, entries.total_pages
   end
   
   def test_paginate_with_order
     entries = Topic.paginate :page => 1, :order => 'created_at desc'
     expected = [topics(:futurama), topics(:harvey_birdman), topics(:rails), topics(:ar)].reverse
     assert_equal expected, entries.to_a
-    assert_equal 1, entries.page_count
+    assert_equal 1, entries.total_pages
   end
   
   def test_paginate_with_conditions
     entries = Topic.paginate :page => 1, :conditions => ["created_at > ?", 30.minutes.ago]
     expected = [topics(:rails), topics(:ar)]
     assert_equal expected, entries.to_a
-    assert_equal 1, entries.page_count
+    assert_equal 1, entries.total_pages
   end
 
   def test_paginate_with_include_and_conditions
@@ -85,11 +86,14 @@ class FinderTest < ActiveRecordTestCase
   end
   
   def test_paginate_with_include_and_order
-    entries = Topic.paginate \
-      :page     => 1, 
-      :include  => :replies,  
-      :order    => 'replies.created_at asc, topics.created_at asc', 
-      :per_page => 10
+    entries = nil
+    assert_queries(2) do
+      entries = Topic.paginate \
+        :page     => 1, 
+        :include  => :replies,  
+        :order    => 'replies.created_at asc, topics.created_at asc', 
+        :per_page => 10
+    end
 
     expected = Topic.find :all, 
       :include => 'replies', 
@@ -104,7 +108,7 @@ class FinderTest < ActiveRecordTestCase
     entries, project = nil, projects(:active_record)
 
     assert_nothing_raised "THIS IS A BUG in Rails 1.2.3 that was fixed in [7326]. " +
-        "Please upgrade to the 1-2-stable branch or edge Rails." do
+        "Please upgrade to a newer version of Rails." do
       entries = project.topics.paginate \
         :page     => 1, 
         :include  => :replies,  
@@ -125,10 +129,12 @@ class FinderTest < ActiveRecordTestCase
     expected_name_ordered = [projects(:action_controller), projects(:active_record)]
     expected_id_ordered   = [projects(:active_record), projects(:action_controller)]
 
-    # with association-specified order
-    entries = dhh.projects.paginate(:page => 1)
-    assert_equal expected_name_ordered, entries
-    assert_equal 2, entries.total_entries
+    assert_queries(2) do
+      # with association-specified order
+      entries = dhh.projects.paginate(:page => 1)
+      assert_equal expected_name_ordered, entries
+      assert_equal 2, entries.total_entries
+    end
 
     # with explicit order
     entries = dhh.projects.paginate(:page => 1, :order => 'projects.id')
@@ -148,29 +154,43 @@ class FinderTest < ActiveRecordTestCase
 
   def test_paginate_association_extension
     project = Project.find(:first)
-    entries = project.replies.paginate_recent :page => 1
-    assert_equal [replies(:brave)], entries
+    
+    assert_queries(2) do
+      entries = project.replies.paginate_recent :page => 1
+      assert_equal [replies(:brave)], entries
+    end
   end
   
   def test_paginate_with_joins
-    entries = Developer.paginate :page => 1,
-                        :joins => 'LEFT JOIN developers_projects ON users.id = developers_projects.developer_id',
-                        :conditions => 'project_id = 1'        
-    assert_equal 2, entries.size
-    developer_names = entries.map { |d| d.name }
-    assert developer_names.include?('David')
-    assert developer_names.include?('Jamis')
-
-    expected = entries.to_a
-    entries = Developer.paginate :page => 1,
-                        :joins => 'LEFT JOIN developers_projects ON users.id = developers_projects.developer_id',
-                        :conditions => 'project_id = 1', :count => { :select => "users.id" }
-    assert_equal expected, entries.to_a
+    entries = nil
+    
+    assert_queries(1) do
+      entries = Developer.paginate :page => 1,
+                          :joins => 'LEFT JOIN developers_projects ON users.id = developers_projects.developer_id',
+                          :conditions => 'project_id = 1'        
+      assert_equal 2, entries.size
+      developer_names = entries.map &:name
+      assert developer_names.include?('David')
+      assert developer_names.include?('Jamis')
+    end
+
+    assert_queries(1) do
+      expected = entries.to_a
+      entries = Developer.paginate :page => 1,
+                          :joins => 'LEFT JOIN developers_projects ON users.id = developers_projects.developer_id',
+                          :conditions => 'project_id = 1', :count => { :select => "users.id" }
+      assert_equal expected, entries.to_a
+      assert_equal 2, entries.total_entries
+    end
   end
 
   def test_paginate_with_group
-    entries = Developer.paginate :page => 1, :per_page => 10,
-                                 :group => 'salary', :select => 'salary', :order => 'salary'
+    entries = nil
+    assert_queries(1) do
+      entries = Developer.paginate :page => 1, :per_page => 10,
+                                   :group => 'salary', :select => 'salary', :order => 'salary'
+    end
+    
     expected = [ users(:david), users(:jamis), users(:dev_10), users(:poor_jamis) ].map(&:salary).sort
     assert_equal expected, entries.map(&:salary)
   end
@@ -201,6 +221,56 @@ class FinderTest < ActiveRecordTestCase
     assert_equal 2, entries.total_entries
   end
 
+  ## named_scope ##
+  
+  def test_paginate_in_named_scope
+    entries = Developer.poor.paginate :page => 1, :per_page => 1
+
+    assert_equal 1, entries.size
+    assert_equal 2, entries.total_entries
+  end
+  
+  def test_paginate_in_named_scope_on_habtm_association
+    project = projects(:active_record)
+    assert_queries(2) do
+      entries = project.developers.poor.paginate :page => 1, :per_page => 1
+
+      assert_equal 1, entries.size, 'one developer should be found'
+      assert_equal 1, entries.total_entries, 'only one developer should be found'
+    end
+  end
+
+  def test_paginate_in_named_scope_on_hmt_association
+    project = projects(:active_record)
+    expected = [replies(:brave)]
+    
+    assert_queries(2) do
+      entries = project.replies.recent.paginate :page => 1, :per_page => 1
+      assert_equal expected, entries
+      assert_equal 1, entries.total_entries, 'only one reply should be found'
+    end
+  end
+
+  def test_paginate_in_named_scope_on_has_many_association
+    project = projects(:active_record)
+    expected = [topics(:ar)]
+    
+    assert_queries(2) do
+      entries = project.topics.mentions_activerecord.paginate :page => 1, :per_page => 1
+      assert_equal expected, entries
+      assert_equal 1, entries.total_entries, 'only one topic should be found'
+    end
+  end
+
+  ## misc ##
+
+  def test_count_and_total_entries_options_are_mutually_exclusive
+    e = assert_raise ArgumentError do
+      Developer.paginate :page => 1, :count => {}, :total_entries => 1
+    end
+    assert_match /exclusive/, e.to_s
+  end
+  
   def test_readonly
     assert_nothing_raised { Developer.paginate :readonly => true, :page => 1 }
   end
@@ -216,13 +286,15 @@ class FinderTest < ActiveRecordTestCase
   end
 
   # Is this Rails 2.0? Find out by testing find_all which was removed in [6998]
-  unless Developer.respond_to? :find_all
+  unless ActiveRecord::Base.respond_to? :find_all
     def test_paginate_array_of_ids
       # AR finders also accept arrays of IDs
       # (this was broken in Rails before [6912])
-      entries = Developer.paginate((1..8).to_a, :per_page => 3, :page => 2, :order => 'id')
-      assert_equal (4..6).to_a, entries.map(&:id)
-      assert_equal 8, entries.total_entries
+      assert_queries(1) do
+        entries = Developer.paginate((1..8).to_a, :per_page => 3, :page => 2, :order => 'id')
+        assert_equal (4..6).to_a, entries.map(&:id)
+        assert_equal 8, entries.total_entries
+      end
     end
   end
 
@@ -230,7 +302,7 @@ class FinderTest < ActiveRecordTestCase
     def test_implicit_all_with_dynamic_finders
       Topic.expects(:find_all_by_foo).returns([])
       Topic.expects(:count).returns(0)
-      Topic.paginate_by_foo :page => 1
+      Topic.paginate_by_foo :page => 2
     end
     
     def test_guessing_the_total_count
@@ -241,6 +313,14 @@ class FinderTest < ActiveRecordTestCase
       assert_equal 6, entries.total_entries
     end
     
+    def test_guessing_that_there_are_no_records
+      Topic.expects(:find).returns([])
+      Topic.expects(:count).never
+      
+      entries = Topic.paginate :page => 1, :per_page => 4
+      assert_equal 0, entries.total_entries
+    end
+    
     def test_extra_parameters_stay_untouched
       Topic.expects(:find).with(:all, {:foo => 'bar', :limit => 4, :offset => 0 }).returns(Array.new(5))
       Topic.expects(:count).with({:foo => 'bar'}).returns(1)
@@ -251,13 +331,13 @@ class FinderTest < ActiveRecordTestCase
     def test_count_skips_select
       Developer.stubs(:find).returns([])
       Developer.expects(:count).with({}).returns(0)
-      Developer.paginate :select => 'salary', :page => 1
+      Developer.paginate :select => 'salary', :page => 2
     end
 
     def test_count_select_when_distinct
       Developer.stubs(:find).returns([])
       Developer.expects(:count).with(:select => 'DISTINCT salary').returns(0)
-      Developer.paginate :select => 'DISTINCT salary', :page => 1
+      Developer.paginate :select => 'DISTINCT salary', :page => 2
     end
 
     def test_should_use_scoped_finders_if_present
@@ -288,16 +368,16 @@ class FinderTest < ActiveRecordTestCase
       Developer.expects(:find_by_sql).returns([])
       Developer.expects(:count_by_sql).with("SELECT COUNT(*) FROM (sql\n ) AS count_table").returns(0)
       
-      entries = Developer.paginate_by_sql "sql\n ORDER\nby foo, bar, `baz` ASC", :page => 1
+      Developer.paginate_by_sql "sql\n ORDER\nby foo, bar, `baz` ASC", :page => 2
     end
 
     # TODO: counts are still wrong
     def test_ability_to_use_with_custom_finders
       # acts_as_taggable defines find_tagged_with(tag, options)
-      Topic.expects(:find_tagged_with).with('will_paginate', :offset => 0, :limit => 5).returns([])
+      Topic.expects(:find_tagged_with).with('will_paginate', :offset => 5, :limit => 5).returns([])
       Topic.expects(:count).with({}).returns(0)
       
-      Topic.paginate_tagged_with 'will_paginate', :page => 1, :per_page => 5
+      Topic.paginate_tagged_with 'will_paginate', :page => 2, :per_page => 5
     end
     
     def test_array_argument_doesnt_eliminate_count
@@ -310,7 +390,6 @@ class FinderTest < ActiveRecordTestCase
 
     def test_paginating_finder_doesnt_mangle_options
       Developer.expects(:find).returns([])
-      Developer.expects(:count).returns(0)
       options = { :page => 1 }
       options.expects(:delete).never
       options_before = options.dup
@@ -318,5 +397,20 @@ class FinderTest < ActiveRecordTestCase
       Developer.paginate(options)
       assert_equal options, options_before
     end
+
+    def test_paginated_each
+      collection = stub('collection', :size => 5, :empty? => false, :per_page => 5)
+      collection.expects(:each).times(2).returns(collection)
+      last_collection = stub('collection', :size => 4, :empty? => false, :per_page => 5)
+      last_collection.expects(:each).returns(last_collection)
+      
+      params = { :order => 'id', :total_entries => 0 }
+      
+      Developer.expects(:paginate).with(params.merge(:page => 2)).returns(collection)
+      Developer.expects(:paginate).with(params.merge(:page => 3)).returns(collection)
+      Developer.expects(:paginate).with(params.merge(:page => 4)).returns(last_collection)
+      
+      assert_equal 14, Developer.paginated_each(:page => '2') { }
+    end
   end
 end

data/test/fixtures/developer.rb

@@ -7,5 +7,7 @@ class Developer < User
     end
   end
 
+  named_scope :poor, :conditions => ['salary <= ?', 80000], :order => 'salary'
+
   def self.per_page() 10 end
 end

data/test/fixtures/projects.yml

@@ -1,7 +1,6 @@
-action_controller:
-  id: 2
-  name: Active Controller
-
 active_record:
   id: 1
   name: Active Record
+action_controller:
+  id: 2
+  name: Active Controller

data/test/fixtures/reply.rb

@@ -1,5 +1,7 @@
 class Reply < ActiveRecord::Base
   belongs_to :topic, :include => [:replies]
+
+  named_scope :recent, :conditions => ['replies.created_at > ?', 15.minutes.ago]
   
   validates_presence_of :content
 end

data/test/fixtures/topic.rb

@@ -1,4 +1,6 @@
 class Topic < ActiveRecord::Base
   has_many :replies, :dependent => :destroy, :order => 'replies.created_at DESC'
   belongs_to :project
+
+  named_scope :mentions_activerecord, :conditions => ['topics.title LIKE ?', '%ActiveRecord%']
 end

data/test/helper.rb

@@ -4,7 +4,7 @@ require 'rubygems'
 # gem install redgreen for colored test output
 begin require 'redgreen'; rescue LoadError; end
 
-require File.join(File.dirname(__FILE__), 'boot') unless defined?(ActiveRecord)
+require 'boot' unless defined?(ActiveRecord)
 
 class Test::Unit::TestCase
   protected
@@ -13,6 +13,18 @@ class Test::Unit::TestCase
       [method.to_s, method.to_sym].each { |m| assert_respond_to object, m }
     end
   end
+  
+  def collect_deprecations
+    old_behavior = WillPaginate::Deprecation.behavior
+    deprecations = []
+    WillPaginate::Deprecation.behavior = Proc.new do |message, callstack|
+      deprecations << message
+    end
+    result = yield
+    [result, deprecations]
+  ensure
+    WillPaginate::Deprecation.behavior = old_behavior
+  end
 end
 
 # Wrap tests that use Mocha and skip if unavailable.

data/test/lib/activerecord_test_case.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'activerecord_test_connector')
+require 'lib/activerecord_test_connector'
 
 class ActiveRecordTestCase < Test::Unit::TestCase
   # Set our fixture path
@@ -18,6 +18,19 @@ class ActiveRecordTestCase < Test::Unit::TestCase
   # Default so Test::Unit::TestCase doesn't complain
   def test_truth
   end
+
+  protected
+
+    def assert_queries(num = 1)
+      $query_count = 0
+      yield
+    ensure
+      assert_equal num, $query_count, "#{$query_count} instead of #{num} queries were executed."
+    end
+
+    def assert_no_queries(&block)
+      assert_queries(0, &block)
+    end
 end
 
 ActiveRecordTestConnector.setup

data/test/lib/activerecord_test_connector.rb

@@ -6,6 +6,8 @@ class ActiveRecordTestConnector
   cattr_accessor :able_to_connect
   cattr_accessor :connected
 
+  FIXTURES_PATH = File.join(File.dirname(__FILE__), '..', 'fixtures')
+
   # Set our defaults
   self.connected = false
   self.able_to_connect = true
@@ -14,13 +16,12 @@ class ActiveRecordTestConnector
     unless self.connected || !self.able_to_connect
       setup_connection
       load_schema
-      # require_fixture_models
-      Dependencies.load_paths.unshift(File.dirname(__FILE__) + "/../fixtures")
+      Dependencies.load_paths.unshift FIXTURES_PATH
       self.connected = true
     end
   rescue Exception => e  # errors from ActiveRecord setup
-    $stderr.puts "\nSkipping ActiveRecord assertion tests: #{e}"
-    #$stderr.puts "  #{e.backtrace.join("\n  ")}\n"
+    $stderr.puts "\nSkipping ActiveRecord tests: #{e}"
+    $stderr.puts "Install SQLite3 to run the full test suite for will_paginate.\n\n"
     self.able_to_connect = false
   end
 
@@ -38,7 +39,7 @@ class ActiveRecordTestConnector
     
     ActiveRecord::Base.establish_connection(configuration)
     ActiveRecord::Base.configurations = { db => configuration }
-    ActiveRecord::Base.connection
+    prepare ActiveRecord::Base.connection
 
     unless Object.const_defined?(:QUOTED_TYPE)
       Object.send :const_set, :QUOTED_TYPE, ActiveRecord::Base.connection.quote_column_name('type')
@@ -48,13 +49,21 @@ class ActiveRecordTestConnector
   def self.load_schema
     ActiveRecord::Base.silence do
       ActiveRecord::Migration.verbose = false
-      load File.dirname(__FILE__) + "/../fixtures/schema.rb"
+      load File.join(FIXTURES_PATH, 'schema.rb')
     end
   end
 
-  def self.require_fixture_models
-    models = Dir.glob(File.dirname(__FILE__) + "/../fixtures/*.rb")
-    models = (models.grep(/user.rb/) + models).uniq
-    models.each { |f| require f }
+  def self.prepare(conn)
+    class << conn
+      IGNORED_SQL = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SHOW FIELDS /]
+
+      def execute_with_counting(sql, name = nil, &block)
+        $query_count ||= 0
+        $query_count  += 1 unless IGNORED_SQL.any? { |r| sql =~ r }
+        execute_without_counting(sql, name, &block)
+      end
+
+      alias_method_chain :execute, :counting
+    end
   end
 end