extract deprecated code for #find, #first, #last, #all

1 files changed, 36 insertions, 105 deletions

diff --git a/activerecord/lib/active_record/relation/finder_methods.rb b/activerecord/lib/active_record/relation/finder_methods.rb
index 87f6822a3d..416b55f5c5 100644
--- a/activerecord/lib/active_record/relation/finder_methods.rb
+++ b/activerecord/lib/active_record/relation/finder_methods.rb
@@ -3,54 +3,12 @@ require 'active_support/core_ext/hash/indifferent_access'
 
 module ActiveRecord
   module FinderMethods
-    # Find operates with four different retrieval approaches:
-    #
-    # * Find by id - This can either be a specific id (1), a list of ids (1, 5, 6), or an array of ids ([5, 6, 10]).
-    #   If no record can be found for all of the listed ids, then RecordNotFound will be raised. If the primary key
-    #   is an integer, find by id coerces its arguments using +to_i+.
-    # * Find first - This will return the first record matched by the options used. These options can either be specific
-    #   conditions or merely an order. If no record can be matched, +nil+ is returned. Use
-    #   <tt>Model.find(:first, *args)</tt> or its shortcut <tt>Model.first(*args)</tt>.
-    # * Find last - This will return the last record matched by the options used. These options can either be specific
-    #   conditions or merely an order. If no record can be matched, +nil+ is returned. Use
-    #   <tt>Model.find(:last, *args)</tt> or its shortcut <tt>Model.last(*args)</tt>.
-    # * Find all - This will return all the records matched by the options used.
-    #   If no records are found, an empty array is returned. Use
-    #   <tt>Model.find(:all, *args)</tt> or its shortcut <tt>Model.all(*args)</tt>.
-    #
-    # All approaches accept an options hash as their last parameter.
-    #
-    # ==== Options
-    #
-    # * <tt>:conditions</tt> - An SQL fragment like "administrator = 1", <tt>["user_name = ?", username]</tt>,
-    #   or <tt>["user_name = :user_name", { :user_name => user_name }]</tt>. See conditions in the intro.
-    # * <tt>:order</tt> - An SQL fragment like "created_at DESC, name".
-    # * <tt>:group</tt> - An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
-    # * <tt>:having</tt> - Combined with +:group+ this can be used to filter the records that a
-    #   <tt>GROUP BY</tt> returns. Uses the <tt>HAVING</tt> SQL-clause.
-    # * <tt>:limit</tt> - An integer determining the limit on the number of rows that should be returned.
-    # * <tt>:offset</tt> - An integer determining the offset from where the rows should be fetched. So at 5,
-    #   it would skip rows 0 through 4.
-    # * <tt>:joins</tt> - Either an SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id" (rarely needed),
-    #   named associations in the same form used for the <tt>:include</tt> option, which will perform an
-    #   <tt>INNER JOIN</tt> on the associated table(s),
-    #   or an array containing a mixture of both strings and named associations.
-    #   If the value is a string, then the records will be returned read-only since they will
-    #   have attributes that do not correspond to the table's columns.
-    #   Pass <tt>:readonly => false</tt> to override.
-    # * <tt>:include</tt> - Names associations that should be loaded alongside. The symbols named refer
-    #   to already defined associations. See eager loading under Associations.
-    # * <tt>:select</tt> - By default, this is "*" as in "SELECT * FROM", but can be changed if you,
-    #   for example, want to do a join but not include the joined columns. Takes a string with the SELECT SQL fragment (e.g. "id, name").
-    # * <tt>:from</tt> - By default, this is the table name of the class, but can be changed
-    #   to an alternate table name (or even the name of a database view).
-    # * <tt>:readonly</tt> - Mark the returned records read-only so they cannot be saved or updated.
-    # * <tt>:lock</tt> - An SQL fragment like "FOR UPDATE" or "LOCK IN SHARE MODE".
-    #   <tt>:lock => true</tt> gives connection's default exclusive lock, usually "FOR UPDATE".
+    # Find by id - This can either be a specific id (1), a list of ids (1, 5, 6), or an array of ids ([5, 6, 10]).
+    # If no record can be found for all of the listed ids, then RecordNotFound will be raised. If the primary key
+    # is an integer, find by id coerces its arguments using +to_i+.
     #
     # ==== Examples
     #
-    #   # find by id
     #   Person.find(1)       # returns the object for ID = 1
     #   Person.find("1")     # returns the object for ID = 1
     #   Person.find(1, 2, 6) # returns an array for objects with IDs in (1, 2, 6)
@@ -59,29 +17,10 @@ module ActiveRecord
     #   Person.where("administrator = 1").order("created_on DESC").find(1)
     #
     # Note that returned records may not be in the same order as the ids you
-    # provide since database rows are unordered. Give an explicit <tt>:order</tt>
+    # provide since database rows are unordered. Give an explicit <tt>order</tt>
     # to ensure the results are sorted.
     #
-    # ==== Examples
-    #
-    #   # find first
-    #   Person.first # returns the first object fetched by SELECT * FROM people
-    #   Person.where(["user_name = ?", user_name]).first
-    #   Person.where(["user_name = :u", { :u => user_name }]).first
-    #   Person.order("created_on DESC").offset(5).first
-    #
-    #   # find last
-    #   Person.last # returns the last object fetched by SELECT * FROM people
-    #   Person.where(["user_name = ?", user_name]).last
-    #   Person.order("created_on DESC").offset(5).last
-    #
-    #   # find all
-    #   Person.all # returns an array of objects for all the rows fetched by SELECT * FROM people
-    #   Person.where(["category IN (?)", categories]).limit(50).all
-    #   Person.where({ :friends => ["Bob", "Steve", "Fred"] }).all
-    #   Person.offset(10).limit(10).all
-    #   Person.includes([:account, :friends]).all
-    #   Person.group("category").all
+    # ==== Find with lock
     #
     # Example for find with a lock: Imagine two concurrent transactions:
     # each will read <tt>person.visits == 2</tt>, add 1 to it, and save, resulting
@@ -95,19 +34,10 @@ module ActiveRecord
     #     person.save!
     #   end
     def find(*args)
-      return to_a.find { |*block_args| yield(*block_args) } if block_given?
-
-      options = args.extract_options!
-
-      if options.present?
-        apply_finder_options(options).find(*args)
+      if block_given?
+        to_a.find { |*block_args| yield(*block_args) }
       else
-        case args.first
-        when :first, :last, :all
-          send(args.first)
-        else
-          find_with_ids(*args)
-        end
+        find_with_ids(*args)
       end
     end
 
@@ -130,18 +60,14 @@ module ActiveRecord
       where(*args).first!
     end
 
-    # A convenience wrapper for <tt>find(:first, *args)</tt>. You can pass in all the
-    # same arguments to this method as you can to <tt>find(:first)</tt>.
-    def first(*args)
-      if args.any?
-        if args.first.kind_of?(Integer) || (loaded? && !args.first.kind_of?(Hash))
-          limit(*args).to_a
-        else
-          apply_finder_options(args.first).first
-        end
-      else
-        find_first
-      end
+    # Examples:
+    #
+    #   Person.first # returns the first object fetched by SELECT * FROM people
+    #   Person.where(["user_name = ?", user_name]).first
+    #   Person.where(["user_name = :u", { :u => user_name }]).first
+    #   Person.order("created_on DESC").offset(5).first
+    def first(limit = nil)
+      limit ? limit(limit).to_a : find_first
     end
 
     # Same as +first+ but raises <tt>ActiveRecord::RecordNotFound</tt> if no record
@@ -150,18 +76,17 @@ module ActiveRecord
       first or raise RecordNotFound
     end
 
-    # A convenience wrapper for <tt>find(:last, *args)</tt>. You can pass in all the
-    # same arguments to this method as you can to <tt>find(:last)</tt>.
-    def last(*args)
-      if args.any?
-        if args.first.kind_of?(Integer) || (loaded? && !args.first.kind_of?(Hash))
-          if order_values.empty?
-            order("#{primary_key} DESC").limit(*args).reverse
-          else
-            to_a.last(*args)
-          end
+    # Examples:
+    #
+    #   Person.last # returns the last object fetched by SELECT * FROM people
+    #   Person.where(["user_name = ?", user_name]).last
+    #   Person.order("created_on DESC").offset(5).last
+    def last(limit = nil)
+      if limit
+        if order_values.empty?
+          order("#{primary_key} DESC").limit(limit).reverse
         else
-          apply_finder_options(args.first).last
+          to_a.last(limit)
         end
       else
         find_last
@@ -174,10 +99,16 @@ module ActiveRecord
       last or raise RecordNotFound
     end
 
-    # A convenience wrapper for <tt>find(:all, *args)</tt>. You can pass in all the
-    # same arguments to this method as you can to <tt>find(:all)</tt>.
-    def all(*args)
-      args.any? ? apply_finder_options(args.first).to_a : to_a
+    # Examples:
+    #
+    #   Person.all # returns an array of objects for all the rows fetched by SELECT * FROM people
+    #   Person.where(["category IN (?)", categories]).limit(50).all
+    #   Person.where({ :friends => ["Bob", "Steve", "Fred"] }).all
+    #   Person.offset(10).limit(10).all
+    #   Person.includes([:account, :friends]).all
+    #   Person.group("category").all
+    def all
+      to_a
     end
 
     # Returns true if a record exists in the table that matches the +id+ or