1 files changed, 175 insertions, 47 deletions

diff --git a/activerecord/test/cases/batches_test.rb b/activerecord/test/cases/batches_test.rb
index 91ff5146fd..f7e21faf0f 100644
--- a/activerecord/test/cases/batches_test.rb
+++ b/activerecord/test/cases/batches_test.rb
@@ -1,6 +1,6 @@
-require 'cases/helper'
-require 'models/post'
-require 'models/subscriber'
+require "cases/helper"
+require "models/post"
+require "models/subscriber"
 
 class EachTest < ActiveRecord::TestCase
   fixtures :posts, :subscribers
@@ -8,12 +8,12 @@ class EachTest < ActiveRecord::TestCase
   def setup
     @posts = Post.order("id asc")
     @total = Post.count
-    Post.count('id') # preheat arel's table cache
+    Post.count("id") # preheat arel's table cache
   end
 
   def test_each_should_execute_one_query_per_batch
     assert_queries(@total + 1) do
-      Post.find_each(:batch_size => 1) do |post|
+      Post.find_each(batch_size: 1) do |post|
         assert_kind_of Post, post
       end
     end
@@ -21,14 +21,14 @@ class EachTest < ActiveRecord::TestCase
 
   def test_each_should_not_return_query_chain_and_execute_only_one_query
     assert_queries(1) do
-      result = Post.find_each(:batch_size => 100000){ }
+      result = Post.find_each(batch_size: 100000) {}
       assert_nil result
     end
   end
 
   def test_each_should_return_an_enumerator_if_no_block_is_present
     assert_queries(1) do
-      Post.find_each(:batch_size => 100000).with_index do |post, index|
+      Post.find_each(batch_size: 100000).with_index do |post, index|
         assert_kind_of Post, post
         assert_kind_of Integer, index
       end
@@ -45,7 +45,7 @@ class EachTest < ActiveRecord::TestCase
 
   def test_each_enumerator_should_execute_one_query_per_batch
     assert_queries(@total + 1) do
-      Post.find_each(:batch_size => 1).with_index do |post, index|
+      Post.find_each(batch_size: 1).with_index do |post, index|
         assert_kind_of Post, post
         assert_kind_of Integer, index
       end
@@ -62,16 +62,32 @@ class EachTest < ActiveRecord::TestCase
 
   def test_each_should_execute_if_id_is_in_select
     assert_queries(6) do
-      Post.select("id, title, type").find_each(:batch_size => 2) do |post|
+      Post.select("id, title, type").find_each(batch_size: 2) do |post|
         assert_kind_of Post, post
       end
     end
   end
 
-  def test_warn_if_limit_scope_is_set
-    assert_called(ActiveRecord::Base.logger, :warn) do
-      Post.limit(1).find_each { |post| post }
+  test "find_each should honor limit if passed a block" do
+    limit = @total - 1
+    total = 0
+
+    Post.limit(limit).find_each do |post|
+      total += 1
+    end
+
+    assert_equal limit, total
+  end
+
+  test "find_each should honor limit if no block is passed" do
+    limit = @total - 1
+    total = 0
+
+    Post.limit(limit).find_each.each do |post|
+      total += 1
     end
+
+    assert_equal limit, total
   end
 
   def test_warn_if_order_scope_is_set
@@ -84,7 +100,7 @@ class EachTest < ActiveRecord::TestCase
     previous_logger = ActiveRecord::Base.logger
     ActiveRecord::Base.logger = nil
     assert_nothing_raised do
-      Post.limit(1).find_each { |post| post }
+      Post.order("comments_count DESC").find_each { |post| post }
     end
   ensure
     ActiveRecord::Base.logger = previous_logger
@@ -92,7 +108,7 @@ class EachTest < ActiveRecord::TestCase
 
   def test_find_in_batches_should_return_batches
     assert_queries(@total + 1) do
-      Post.find_in_batches(:batch_size => 1) do |batch|
+      Post.find_in_batches(batch_size: 1) do |batch|
         assert_kind_of Array, batch
         assert_kind_of Post, batch.first
       end
@@ -119,18 +135,18 @@ class EachTest < ActiveRecord::TestCase
 
   def test_find_in_batches_shouldnt_execute_query_unless_needed
     assert_queries(2) do
-      Post.find_in_batches(:batch_size => @total) {|batch| assert_kind_of Array, batch }
+      Post.find_in_batches(batch_size: @total) { |batch| assert_kind_of Array, batch }
     end
 
     assert_queries(1) do
-      Post.find_in_batches(:batch_size => @total + 1) {|batch| assert_kind_of Array, batch }
+      Post.find_in_batches(batch_size: @total + 1) { |batch| assert_kind_of Array, batch }
     end
   end
 
   def test_find_in_batches_should_quote_batch_order
     c = Post.connection
     assert_sql(/ORDER BY #{c.quote_table_name('posts')}.#{c.quote_column_name('id')}/) do
-      Post.find_in_batches(:batch_size => 1) do |batch|
+      Post.find_in_batches(batch_size: 1) do |batch|
         assert_kind_of Array, batch
         assert_kind_of Post, batch.first
       end
@@ -140,9 +156,9 @@ class EachTest < ActiveRecord::TestCase
   def test_find_in_batches_should_not_use_records_after_yielding_them_in_case_original_array_is_modified
     not_a_post = "not a post"
     def not_a_post.id; end
-    not_a_post.stub(:id, ->{ raise StandardError.new("not_a_post had #id called on it") }) do
+    not_a_post.stub(:id, -> { raise StandardError.new("not_a_post had #id called on it") }) do
       assert_nothing_raised do
-        Post.find_in_batches(:batch_size => 1) do |batch|
+        Post.find_in_batches(batch_size: 1) do |batch|
           assert_kind_of Array, batch
           assert_kind_of Post, batch.first
 
@@ -166,37 +182,37 @@ class EachTest < ActiveRecord::TestCase
 
   def test_find_in_batches_should_error_on_ignore_the_order
     assert_raise(ArgumentError) do
-      PostWithDefaultScope.find_in_batches(error_on_ignore: true){}
+      PostWithDefaultScope.find_in_batches(error_on_ignore: true) {}
     end
   end
 
-  def test_find_in_batches_should_not_error_if_config_overriden
-    # Set the config option which will be overriden
-    prev = ActiveRecord::Base.error_on_ignored_order_or_limit
-    ActiveRecord::Base.error_on_ignored_order_or_limit = true
+  def test_find_in_batches_should_not_error_if_config_overridden
+    # Set the config option which will be overridden
+    prev = ActiveRecord::Base.error_on_ignored_order
+    ActiveRecord::Base.error_on_ignored_order = true
     assert_nothing_raised do
-      PostWithDefaultScope.find_in_batches(error_on_ignore: false){}
+      PostWithDefaultScope.find_in_batches(error_on_ignore: false) {}
     end
   ensure
     # Set back to default
-    ActiveRecord::Base.error_on_ignored_order_or_limit = prev
+    ActiveRecord::Base.error_on_ignored_order = prev
   end
 
   def test_find_in_batches_should_error_on_config_specified_to_error
     # Set the config option
-    prev = ActiveRecord::Base.error_on_ignored_order_or_limit
-    ActiveRecord::Base.error_on_ignored_order_or_limit = true
+    prev = ActiveRecord::Base.error_on_ignored_order
+    ActiveRecord::Base.error_on_ignored_order = true
     assert_raise(ArgumentError) do
-      PostWithDefaultScope.find_in_batches(){}
+      PostWithDefaultScope.find_in_batches() {}
     end
   ensure
     # Set back to default
-    ActiveRecord::Base.error_on_ignored_order_or_limit = prev
+    ActiveRecord::Base.error_on_ignored_order = prev
   end
 
   def test_find_in_batches_should_not_error_by_default
     assert_nothing_raised do
-      PostWithDefaultScope.find_in_batches(){}
+      PostWithDefaultScope.find_in_batches() {}
     end
   end
 
@@ -211,12 +227,12 @@ class EachTest < ActiveRecord::TestCase
 
   def test_find_in_batches_should_not_modify_passed_options
     assert_nothing_raised do
-      Post.find_in_batches({ batch_size: 42, start: 1 }.freeze){}
+      Post.find_in_batches({ batch_size: 42, start: 1 }.freeze) {}
     end
   end
 
   def test_find_in_batches_should_use_any_column_as_primary_key
-    nick_order_subscribers = Subscriber.order('nick asc')
+    nick_order_subscribers = Subscriber.order("nick asc")
     start_nick = nick_order_subscribers.second.nick
 
     subscribers = []
@@ -239,7 +255,7 @@ class EachTest < ActiveRecord::TestCase
   def test_find_in_batches_should_return_an_enumerator
     enum = nil
     assert_no_queries do
-      enum = Post.find_in_batches(:batch_size => 1)
+      enum = Post.find_in_batches(batch_size: 1)
     end
     assert_queries(4) do
       enum.first(4) do |batch|
@@ -249,6 +265,28 @@ class EachTest < ActiveRecord::TestCase
     end
   end
 
+  test "find_in_batches should honor limit if passed a block" do
+    limit = @total - 1
+    total = 0
+
+    Post.limit(limit).find_in_batches do |batch|
+      total += batch.size
+    end
+
+    assert_equal limit, total
+  end
+
+  test "find_in_batches should honor limit if no block is passed" do
+    limit = @total - 1
+    total = 0
+
+    Post.limit(limit).find_in_batches.each do |batch|
+      total += batch.size
+    end
+
+    assert_equal limit, total
+  end
+
   def test_in_batches_should_not_execute_any_query
     assert_no_queries do
       assert_kind_of ActiveRecord::Batches::BatchEnumerator, Post.in_batches(of: 2)
@@ -290,7 +328,7 @@ class EachTest < ActiveRecord::TestCase
   end
 
   def test_in_batches_each_record_should_be_ordered_by_id
-    ids = Post.order('id ASC').pluck(:id)
+    ids = Post.order("id ASC").pluck(:id)
     assert_queries(6) do
       Post.in_batches(of: 2).each_record.with_index do |post, i|
         assert_equal ids[i], post.id
@@ -306,9 +344,9 @@ class EachTest < ActiveRecord::TestCase
   end
 
   def test_in_batches_delete_all_should_not_delete_records_in_other_batches
-    not_deleted_count = Post.where('id <= 2').count
-    Post.where('id > 2').in_batches(of: 2).delete_all
-    assert_equal 0, Post.where('id > 2').count
+    not_deleted_count = Post.where("id <= 2").count
+    Post.where("id > 2").in_batches(of: 2).delete_all
+    assert_equal 0, Post.where("id > 2").count
     assert_equal not_deleted_count, Post.count
   end
 
@@ -345,7 +383,7 @@ class EachTest < ActiveRecord::TestCase
   end
 
   def test_in_batches_should_start_from_the_start_option
-    post = Post.order('id ASC').where('id >= ?', 2).first
+    post = Post.order("id ASC").where("id >= ?", 2).first
     assert_queries(2) do
       relation = Post.in_batches(of: 1, start: 2).first
       assert_equal post, relation.first
@@ -353,7 +391,7 @@ class EachTest < ActiveRecord::TestCase
   end
 
   def test_in_batches_should_end_at_the_finish_option
-    post = Post.order('id DESC').where('id <= ?', 5).first
+    post = Post.order("id DESC").where("id <= ?", 5).first
     assert_queries(7) do
       relation = Post.in_batches(of: 1, finish: 5, load: true).reverse_each.first
       assert_equal post, relation.last
@@ -407,12 +445,12 @@ class EachTest < ActiveRecord::TestCase
 
   def test_in_batches_should_not_modify_passed_options
     assert_nothing_raised do
-      Post.in_batches({ of: 42, start: 1 }.freeze){}
+      Post.in_batches({ of: 42, start: 1 }.freeze) {}
     end
   end
 
   def test_in_batches_should_use_any_column_as_primary_key
-    nick_order_subscribers = Subscriber.order('nick asc')
+    nick_order_subscribers = Subscriber.order("nick asc")
     start_nick = nick_order_subscribers.second.nick
 
     subscribers = []
@@ -472,18 +510,108 @@ class EachTest < ActiveRecord::TestCase
     person.update_attributes(author_id: 1)
 
     Post.in_batches(of: 2) do |batch|
-      batch.where('author_id >= 1').update_all('author_id = author_id + 1')
+      batch.where("author_id >= 1").update_all("author_id = author_id + 1")
     end
     assert_equal 2, person.reload.author_id # incremented only once
   end
 
   if Enumerator.method_defined? :size
     def test_find_in_batches_should_return_a_sized_enumerator
-      assert_equal 11, Post.find_in_batches(:batch_size => 1).size
-      assert_equal 6, Post.find_in_batches(:batch_size => 2).size
+      assert_equal 11, Post.find_in_batches(batch_size: 1).size
+      assert_equal 6, Post.find_in_batches(batch_size: 2).size
       assert_equal 4, Post.find_in_batches(batch_size: 2, start: 4).size
-      assert_equal 4, Post.find_in_batches(:batch_size => 3).size
-      assert_equal 1, Post.find_in_batches(:batch_size => 10_000).size
+      assert_equal 4, Post.find_in_batches(batch_size: 3).size
+      assert_equal 1, Post.find_in_batches(batch_size: 10_000).size
+    end
+  end
+
+  [true, false].each do |load|
+    test "in_batches should return limit records when limit is less than batch size and load is #{load}" do
+      limit      = 3
+      batch_size = 5
+      total      = 0
+
+      Post.limit(limit).in_batches(of: batch_size, load: load) do |batch|
+        total += batch.count
+      end
+
+      assert_equal limit, total
+    end
+
+    test "in_batches should return limit records when limit is greater than batch size and load is #{load}" do
+      limit      = 5
+      batch_size = 3
+      total      = 0
+
+      Post.limit(limit).in_batches(of: batch_size, load: load) do |batch|
+        total += batch.count
+      end
+
+      assert_equal limit, total
+    end
+
+    test "in_batches should return limit records when limit is a multiple of the batch size and load is #{load}" do
+      limit      = 6
+      batch_size = 3
+      total      = 0
+
+      Post.limit(limit).in_batches(of: batch_size, load: load) do |batch|
+        total += batch.count
+      end
+
+      assert_equal limit, total
+    end
+
+    test "in_batches should return no records if the limit is 0 and load is #{load}" do
+      limit      = 0
+      batch_size = 1
+      total      = 0
+
+      Post.limit(limit).in_batches(of: batch_size, load: load) do |batch|
+        total += batch.count
+      end
+
+      assert_equal limit, total
+    end
+
+    test "in_batches should return all if the limit is greater than the number of records when load is #{load}" do
+      limit      = @total + 1
+      batch_size = 1
+      total      = 0
+
+      Post.limit(limit).in_batches(of: batch_size, load: load) do |batch|
+        total += batch.count
+      end
+
+      assert_equal @total, total
+    end
+  end
+
+  test ".error_on_ignored_order_or_limit= is deprecated" do
+    begin
+      prev = ActiveRecord::Base.error_on_ignored_order
+      assert_deprecated "Please use error_on_ignored_order= instead." do
+        ActiveRecord::Base.error_on_ignored_order_or_limit = true
+      end
+      assert ActiveRecord::Base.error_on_ignored_order
+    ensure
+      ActiveRecord::Base.error_on_ignored_order = prev
+    end
+  end
+
+  test ".error_on_ignored_order_or_limit is deprecated" do
+    expected = ActiveRecord::Base.error_on_ignored_order
+    actual = assert_deprecated "Please use error_on_ignored_order instead." do
+      ActiveRecord::Base.error_on_ignored_order_or_limit
+    end
+    assert_equal expected, actual
+  end
+
+  test "#error_on_ignored_order_or_limit is deprecated" do
+    expected = ActiveRecord::Base.error_on_ignored_order
+    actual = assert_deprecated "Please use error_on_ignored_order instead." do
+      Post.new.error_on_ignored_order_or_limit
     end
+    assert_equal expected, actual
   end
 end