activerecord 5.0.7.2 → 6.0.6.1

data/lib/active_record/relation/finder_methods.rb

@@ -1,12 +1,14 @@
-require 'active_support/core_ext/string/filters'
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/filters"
 
 module ActiveRecord
   module FinderMethods
-    ONE_AS_ONE = '1 AS one'
+    ONE_AS_ONE = "1 AS one"
 
     # 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 one or more records can not be found for the requested ids, then RecordNotFound will be raised. If the primary key
-    # is an integer, find by id coerces its arguments using +to_i+.
+    # If one or more records cannot be found for the requested ids, then ActiveRecord::RecordNotFound will be raised.
+    # If the primary key is an integer, find by id coerces its arguments by using +to_i+.
     #
     #   Person.find(1)          # returns the object for ID = 1
     #   Person.find("1")        # returns the object for ID = 1
@@ -16,9 +18,10 @@ module ActiveRecord
     #   Person.find([1])        # returns an array for the object with ID = 1
     #   Person.where("administrator = 1").order("created_on DESC").find(1)
     #
-    # NOTE: The returned records may not be in the same order as the ids you
-    # provide since database rows are unordered. You will need to provide an explicit QueryMethods#order
-    # option if you want the results to be sorted.
+    # NOTE: The returned records are in the same order as the ids you provide.
+    # If you want the results to be sorted by database, you can use ActiveRecord::QueryMethods#where
+    # method and provide an explicit ActiveRecord::QueryMethods#order option.
+    # But ActiveRecord::QueryMethods#where method doesn't raise ActiveRecord::RecordNotFound.
     #
     # ==== Find with lock
     #
@@ -76,17 +79,12 @@ module ActiveRecord
     #   Post.find_by "published_at < ?", 2.weeks.ago
     def find_by(arg, *args)
       where(arg, *args).take
-    rescue RangeError
-      nil
     end
 
     # Like #find_by, except that if no record is found, raises
     # an ActiveRecord::RecordNotFound error.
     def find_by!(arg, *args)
       where(arg, *args).take!
-    rescue RangeError
-      raise RecordNotFound.new("Couldn't find #{@klass.name} with an out of range value",
-                               @klass.name)
     end
 
     # Gives a record (or N records if a parameter is supplied) without any implied
@@ -97,13 +95,13 @@ module ActiveRecord
     #   Person.take(5) # returns 5 objects fetched by SELECT * FROM people LIMIT 5
     #   Person.where(["name LIKE '%?'", name]).take
     def take(limit = nil)
-      limit ? limit(limit).to_a : find_take
+      limit ? find_take_with_limit(limit) : find_take
     end
 
     # Same as #take but raises ActiveRecord::RecordNotFound if no record
     # is found. Note that #take! accepts no arguments.
     def take!
-      take or raise RecordNotFound.new("Couldn't find #{@klass.name} with [#{arel.where_sql(@klass.arel_engine)}]")
+      take || raise_record_not_found_exception!
     end
 
     # Find the first record (or first N records if a parameter is supplied).
@@ -117,7 +115,7 @@ module ActiveRecord
     #
     def first(limit = nil)
       if limit
-        find_nth_with_limit_and_offset(0, limit, offset: offset_index)
+        find_nth_with_limit(0, limit)
       else
         find_nth 0
       end
@@ -126,7 +124,7 @@ module ActiveRecord
     # Same as #first but raises ActiveRecord::RecordNotFound if no record
     # is found. Note that #first! accepts no arguments.
     def first!
-      find_nth! 0
+      first || raise_record_not_found_exception!
     end
 
     # Find the last record (or last N records if a parameter is supplied).
@@ -145,27 +143,18 @@ module ActiveRecord
     #
     #   [#<Person id:4>, #<Person id:3>, #<Person id:2>]
     def last(limit = nil)
-      return find_last(limit) if loaded? || limit_value
+      return find_last(limit) if loaded? || has_limit_or_offset?
 
-      result = limit(limit || 1)
-      result.order!(arel_attribute(primary_key)) if order_values.empty? && primary_key
+      result = ordered_relation.limit(limit)
       result = result.reverse_order!
 
       limit ? result.reverse : result.first
-    rescue ActiveRecord::IrreversibleOrderError
-      ActiveSupport::Deprecation.warn(<<-WARNING.squish)
-          Finding a last element by loading the relation when SQL ORDER
-          can not be reversed is deprecated.
-          Rails 5.1 will raise ActiveRecord::IrreversibleOrderError in this case.
-          Please call `to_a.last` if you still want to load the relation.
-      WARNING
-      find_last(limit)
     end
 
     # Same as #last but raises ActiveRecord::RecordNotFound if no record
     # is found. Note that #last! accepts no arguments.
     def last!
-      last or raise RecordNotFound.new("Couldn't find #{@klass.name} with [#{arel.where_sql(@klass.arel_engine)}]")
+      last || raise_record_not_found_exception!
     end
 
     # Find the second record.
@@ -181,7 +170,7 @@ module ActiveRecord
     # Same as #second but raises ActiveRecord::RecordNotFound if no record
     # is found.
     def second!
-      find_nth! 1
+      second || raise_record_not_found_exception!
     end
 
     # Find the third record.
@@ -197,7 +186,7 @@ module ActiveRecord
     # Same as #third but raises ActiveRecord::RecordNotFound if no record
     # is found.
     def third!
-      find_nth! 2
+      third || raise_record_not_found_exception!
     end
 
     # Find the fourth record.
@@ -213,7 +202,7 @@ module ActiveRecord
     # Same as #fourth but raises ActiveRecord::RecordNotFound if no record
     # is found.
     def fourth!
-      find_nth! 3
+      fourth || raise_record_not_found_exception!
     end
 
     # Find the fifth record.
@@ -229,7 +218,7 @@ module ActiveRecord
     # Same as #fifth but raises ActiveRecord::RecordNotFound if no record
     # is found.
     def fifth!
-      find_nth! 4
+      fifth || raise_record_not_found_exception!
     end
 
     # Find the forty-second record. Also known as accessing "the reddit".
@@ -245,7 +234,7 @@ module ActiveRecord
     # Same as #forty_two but raises ActiveRecord::RecordNotFound if no record
     # is found.
     def forty_two!
-      find_nth! 41
+      forty_two || raise_record_not_found_exception!
     end
 
     # Find the third-to-last record.
@@ -261,7 +250,7 @@ module ActiveRecord
     # Same as #third_to_last but raises ActiveRecord::RecordNotFound if no record
     # is found.
     def third_to_last!
-      find_nth_from_last 3 or raise RecordNotFound.new("Couldn't find #{@klass.name} with [#{arel.where_sql(@klass.arel_engine)}]")
+      third_to_last || raise_record_not_found_exception!
     end
 
     # Find the second-to-last record.
@@ -277,7 +266,7 @@ module ActiveRecord
     # Same as #second_to_last but raises ActiveRecord::RecordNotFound if no record
     # is found.
     def second_to_last!
-      find_nth_from_last 2 or raise RecordNotFound.new("Couldn't find #{@klass.name} with [#{arel.where_sql(@klass.arel_engine)}]")
+      second_to_last || raise_record_not_found_exception!
     end
 
     # Returns true if a record exists in the table that matches the +id+ or
@@ -291,7 +280,7 @@ module ActiveRecord
     # * Hash - Finds the record that matches these +find+-style conditions
     #   (such as <tt>{name: 'David'}</tt>).
     # * +false+ - Returns always +false+.
-    # * No args - Returns +false+ if the table is empty, +true+ otherwise.
+    # * No args - Returns +false+ if the relation is empty, +true+ otherwise.
     #
     # For more information about specifying conditions as a hash or array,
     # see the Conditions section in the introduction to ActiveRecord::Base.
@@ -307,32 +296,25 @@ module ActiveRecord
     #   Person.exists?(name: 'David')
     #   Person.exists?(false)
     #   Person.exists?
+    #   Person.where(name: 'Spartacus', rating: 4).exists?
     def exists?(conditions = :none)
       if Base === conditions
-        conditions = conditions.id
-        ActiveSupport::Deprecation.warn(<<-MSG.squish)
+        raise ArgumentError, <<-MSG.squish
           You are passing an instance of ActiveRecord::Base to `exists?`.
           Please pass the id of the object by calling `.id`.
         MSG
       end
 
-      return false if !conditions
-
-      relation = apply_join_dependency(self, construct_join_dependency)
-      return false if ActiveRecord::NullRelation === relation
-
-      relation = relation.except(:select, :order).select(ONE_AS_ONE).limit(1)
+      return false if !conditions || limit_value == 0
 
-      case conditions
-      when Array, Hash
-        relation = relation.where(conditions)
-      else
-        unless conditions == :none
-          relation = relation.where(primary_key => conditions)
-        end
+      if eager_loading?
+        relation = apply_join_dependency(eager_loading: false)
+        return relation.exists?(conditions)
       end
 
-      connection.select_value(relation, "#{name} Exists", relation.bound_attributes) ? true : false
+      relation = construct_relation_for_exists(conditions)
+
+      skip_query_cache_if_necessary { connection.select_one(relation.arel, "#{name} Exists?") } ? true : false
     end
 
     # This method is called whenever no records are found with either a single
@@ -343,258 +325,236 @@ module ActiveRecord
     # of results obtained should be provided in the +result_size+ argument and
     # the expected number of results should be provided in the +expected_size+
     # argument.
-    def raise_record_not_found_exception!(ids, result_size, expected_size, key = primary_key) #:nodoc:
-      conditions = arel.where_sql(@klass.arel_engine)
+    def raise_record_not_found_exception!(ids = nil, result_size = nil, expected_size = nil, key = primary_key, not_found_ids = nil) # :nodoc:
+      conditions = arel.where_sql(@klass)
       conditions = " [#{conditions}]" if conditions
       name = @klass.name
 
-      if Array(ids).size == 1
+      if ids.nil?
+        error = +"Couldn't find #{name}"
+        error << " with#{conditions}" if conditions
+        raise RecordNotFound.new(error, name, key)
+      elsif Array(ids).size == 1
         error = "Couldn't find #{name} with '#{key}'=#{ids}#{conditions}"
         raise RecordNotFound.new(error, name, key, ids)
       else
-        error = "Couldn't find all #{name.pluralize} with '#{key}': "
-        error << "(#{ids.join(", ")})#{conditions} (found #{result_size} results, but was looking for #{expected_size})"
-
-        raise RecordNotFound, error
+        error = +"Couldn't find all #{name.pluralize} with '#{key}': "
+        error << "(#{ids.join(", ")})#{conditions} (found #{result_size} results, but was looking for #{expected_size})."
+        error << " Couldn't find #{name.pluralize(not_found_ids.size)} with #{key.to_s.pluralize(not_found_ids.size)} #{not_found_ids.join(', ')}." if not_found_ids
+        raise RecordNotFound.new(error, name, key, ids)
       end
     end
 
     private
+      def offset_index
+        offset_value || 0
+      end
 
-    def offset_index
-      offset_value || 0
-    end
+      def construct_relation_for_exists(conditions)
+        conditions = sanitize_forbidden_attributes(conditions)
 
-    def find_with_associations
-      # NOTE: the JoinDependency constructed here needs to know about
-      #       any joins already present in `self`, so pass them in
-      #
-      # failing to do so means that in cases like activerecord/test/cases/associations/inner_join_association_test.rb:136
-      # incorrect SQL is generated. In that case, the join dependency for
-      # SpecialCategorizations is constructed without knowledge of the
-      # preexisting join in joins_values to categorizations (by way of
-      # the `has_many :through` for categories).
-      #
-      join_dependency = construct_join_dependency(joins_values)
-
-      aliases  = join_dependency.aliases
-      relation = select aliases.columns
-      relation = apply_join_dependency(relation, join_dependency)
-
-      if block_given?
-        yield relation
-      else
-        if ActiveRecord::NullRelation === relation
-          []
+        if distinct_value && offset_value
+          relation = except(:order).limit!(1)
         else
-          arel = relation.arel
-          rows = connection.select_all(arel, 'SQL', relation.bound_attributes)
-          join_dependency.instantiate(rows, aliases)
+          relation = except(:select, :distinct, :order)._select!(ONE_AS_ONE).limit!(1)
         end
-      end
-    end
 
-    def construct_join_dependency(joins = [])
-      including = eager_load_values + includes_values
-      ActiveRecord::Associations::JoinDependency.new(@klass, including, joins)
-    end
+        case conditions
+        when Array, Hash
+          relation.where!(conditions) unless conditions.empty?
+        else
+          relation.where!(primary_key => conditions) unless conditions == :none
+        end
 
-    def construct_relation_for_association_calculations
-      from = arel.froms.first
-      if Arel::Table === from
-        apply_join_dependency(self, construct_join_dependency(joins_values))
-      else
-        # FIXME: as far as I can tell, `from` will always be an Arel::Table.
-        # There are no tests that test this branch, but presumably it's
-        # possible for `from` to be a list?
-        apply_join_dependency(self, construct_join_dependency(from))
+        relation
       end
-    end
 
-    def apply_join_dependency(relation, join_dependency)
-      relation = relation.except(:includes, :eager_load, :preload)
-      relation = relation.joins join_dependency
+      def apply_join_dependency(eager_loading: group_values.empty?)
+        join_dependency = construct_join_dependency(
+          eager_load_values | includes_values, Arel::Nodes::OuterJoin
+        )
+        relation = except(:includes, :eager_load, :preload).joins!(join_dependency)
+
+        if eager_loading && !(
+            using_limitable_reflections?(join_dependency.reflections) &&
+            using_limitable_reflections?(
+              construct_join_dependency(
+                select_association_list(joins_values).concat(
+                  select_association_list(left_outer_joins_values)
+                ), nil
+              ).reflections
+            )
+        )
+          if has_limit_or_offset?
+            limited_ids = limited_ids_for(relation)
+            limited_ids.empty? ? relation.none! : relation.where!(primary_key => limited_ids)
+          end
+          relation.limit_value = relation.offset_value = nil
+        end
 
-      if using_limitable_reflections?(join_dependency.reflections)
-        relation
-      else
-        if relation.limit_value
-          limited_ids = limited_ids_for(relation)
-          limited_ids.empty? ? relation.none! : relation.where!(primary_key => limited_ids)
+        if block_given?
+          yield relation, join_dependency
+        else
+          relation
         end
-        relation.except(:limit, :offset)
       end
-    end
 
-    def limited_ids_for(relation)
-      values = @klass.connection.columns_for_distinct(
-        "#{quoted_table_name}.#{quoted_primary_key}", relation.order_values)
+      def limited_ids_for(relation)
+        values = @klass.connection.columns_for_distinct(
+          connection.visitor.compile(arel_attribute(primary_key)),
+          relation.order_values
+        )
 
-      relation = relation.except(:select).select(values).distinct!
-      arel = relation.arel
+        relation = relation.except(:select).select(values).distinct!
 
-      id_rows = @klass.connection.select_all(arel, 'SQL', relation.bound_attributes)
-      id_rows.map {|row| row[primary_key]}
-    end
+        id_rows = skip_query_cache_if_necessary { @klass.connection.select_all(relation.arel, "SQL") }
+        id_rows.map { |row| row[primary_key] }
+      end
 
-    def using_limitable_reflections?(reflections)
-      reflections.none?(&:collection?)
-    end
+      def using_limitable_reflections?(reflections)
+        reflections.none?(&:collection?)
+      end
 
-    protected
+      def find_with_ids(*ids)
+        raise UnknownPrimaryKey.new(@klass) if primary_key.nil?
 
-    def find_with_ids(*ids)
-      raise UnknownPrimaryKey.new(@klass) if primary_key.nil?
+        expects_array = ids.first.kind_of?(Array)
+        return [] if expects_array && ids.first.empty?
 
-      expects_array = ids.first.kind_of?(Array)
-      return ids.first if expects_array && ids.first.empty?
+        ids = ids.flatten.compact.uniq
 
-      ids = ids.flatten.compact.uniq
+        model_name = @klass.name
 
-      case ids.size
-      when 0
-        raise RecordNotFound, "Couldn't find #{@klass.name} without an ID"
-      when 1
-        result = find_one(ids.first)
-        expects_array ? [ result ] : result
-      else
-        find_some(ids)
+        case ids.size
+        when 0
+          error_message = "Couldn't find #{model_name} without an ID"
+          raise RecordNotFound.new(error_message, model_name, primary_key)
+        when 1
+          result = find_one(ids.first)
+          expects_array ? [ result ] : result
+        else
+          find_some(ids)
+        end
       end
-    rescue RangeError
-      raise RecordNotFound, "Couldn't find #{@klass.name} with an out of range ID"
-    end
 
-    def find_one(id)
-      if ActiveRecord::Base === id
-        id = id.id
-        ActiveSupport::Deprecation.warn(<<-MSG.squish)
-          You are passing an instance of ActiveRecord::Base to `find`.
-          Please pass the id of the object by calling `.id`.
-        MSG
-      end
+      def find_one(id)
+        if ActiveRecord::Base === id
+          raise ArgumentError, <<-MSG.squish
+            You are passing an instance of ActiveRecord::Base to `find`.
+            Please pass the id of the object by calling `.id`.
+          MSG
+        end
 
-      relation = where(primary_key => id)
-      record = relation.take
+        relation = where(primary_key => id)
+        record = relation.take
 
-      raise_record_not_found_exception!(id, 0, 1) unless record
+        raise_record_not_found_exception!(id, 0, 1) unless record
 
-      record
-    end
+        record
+      end
 
-    def find_some(ids)
-      return find_some_ordered(ids) unless order_values.present?
+      def find_some(ids)
+        return find_some_ordered(ids) unless order_values.present?
 
-      result = where(primary_key => ids).to_a
+        result = where(primary_key => ids).to_a
 
-      expected_size =
-        if limit_value && ids.size > limit_value
-          limit_value
-        else
-          ids.size
-        end
+        expected_size =
+          if limit_value && ids.size > limit_value
+            limit_value
+          else
+            ids.size
+          end
 
-      # 11 ids with limit 3, offset 9 should give 2 results.
-      if offset_value && (ids.size - offset_value < expected_size)
-        expected_size = ids.size - offset_value
-      end
+        # 11 ids with limit 3, offset 9 should give 2 results.
+        if offset_value && (ids.size - offset_value < expected_size)
+          expected_size = ids.size - offset_value
+        end
 
-      if result.size == expected_size
-        result
-      else
-        raise_record_not_found_exception!(ids, result.size, expected_size)
+        if result.size == expected_size
+          result
+        else
+          raise_record_not_found_exception!(ids, result.size, expected_size)
+        end
       end
-    end
 
-    def find_some_ordered(ids)
-      ids = ids.slice(offset_value || 0, limit_value || ids.size) || []
+      def find_some_ordered(ids)
+        ids = ids.slice(offset_value || 0, limit_value || ids.size) || []
 
-      result = except(:limit, :offset).where(primary_key => ids).records
+        result = except(:limit, :offset).where(primary_key => ids).records
 
-      if result.size == ids.size
-        pk_type = @klass.type_for_attribute(primary_key)
+        if result.size == ids.size
+          pk_type = @klass.type_for_attribute(primary_key)
 
-        records_by_id = result.index_by(&:id)
-        ids.map { |id| records_by_id.fetch(pk_type.cast(id)) }
-      else
-        raise_record_not_found_exception!(ids, result.size, ids.size)
+          records_by_id = result.index_by(&:id)
+          ids.map { |id| records_by_id.fetch(pk_type.cast(id)) }
+        else
+          raise_record_not_found_exception!(ids, result.size, ids.size)
+        end
       end
-    end
 
-    def find_take
-      if loaded?
-        records.first
-      else
-        @take ||= limit(1).records.first
+      def find_take
+        if loaded?
+          records.first
+        else
+          @take ||= limit(1).records.first
+        end
       end
-    end
 
-    def find_nth(index, offset = nil)
-      # TODO: once the offset argument is removed we rely on offset_index
-      # within find_nth_with_limit, rather than pass it in via
-      # find_nth_with_limit_and_offset
-      if offset
-        ActiveSupport::Deprecation.warn(<<-MSG.squish)
-          Passing an offset argument to find_nth is deprecated,
-          please use Relation#offset instead.
-        MSG
+      def find_take_with_limit(limit)
+        if loaded?
+          records.take(limit)
+        else
+          limit(limit).to_a
+        end
       end
-      if loaded?
-        records[index]
-      else
-        offset ||= offset_index
-        @offsets[offset + index] ||= find_nth_with_limit_and_offset(index, 1, offset: offset).first
+
+      def find_nth(index)
+        @offsets[offset_index + index] ||= find_nth_with_limit(index, 1).first
       end
-    end
 
-    def find_nth!(index)
-      find_nth(index) or raise RecordNotFound.new("Couldn't find #{@klass.name} with [#{arel.where_sql(@klass.arel_engine)}]")
-    end
+      def find_nth_with_limit(index, limit)
+        if loaded?
+          records[index, limit] || []
+        else
+          relation = ordered_relation
+
+          if limit_value
+            limit = [limit_value - index, limit].min
+          end
+
+          if limit > 0
+            relation = relation.offset(offset_index + index) unless index.zero?
+            relation.limit(limit).to_a
+          else
+            []
+          end
+        end
+      end
 
-    def find_nth_with_limit(index, limit)
-      # TODO: once the offset argument is removed from find_nth,
-      # find_nth_with_limit_and_offset can be merged into this method
-      relation = if order_values.empty? && primary_key
-                   order(arel_attribute(primary_key).asc)
-                 else
-                   self
-                 end
-
-      relation = relation.offset(index) unless index.zero?
-      relation.limit(limit).to_a
-    end
+      def find_nth_from_last(index)
+        if loaded?
+          records[-index]
+        else
+          relation = ordered_relation
 
-    def find_nth_from_last(index)
-      if loaded?
-        records[-index]
-      else
-        relation = if order_values.empty? && primary_key
-                     order(arel_attribute(primary_key).asc)
-                   else
-                     self
-                   end
-
-        relation.to_a[-index]
-        # TODO: can be made more performant on large result sets by
-        # for instance, last(index)[-index] (which would require
-        # refactoring the last(n) finder method to make test suite pass),
-        # or by using a combination of reverse_order, limit, and offset,
-        # e.g., reverse_order.offset(index-1).first
+          if equal?(relation) || has_limit_or_offset?
+            relation.records[-index]
+          else
+            relation.last(index)[-index]
+          end
+        end
       end
-    end
-    
-    private
 
-    def find_nth_with_limit_and_offset(index, limit, offset:) # :nodoc:
-      if loaded?
-        records[index, limit]
-      else
-        index += offset
-        find_nth_with_limit(index, limit)
+      def find_last(limit)
+        limit ? records.last(limit) : records.last
       end
-    end
 
-    def find_last(limit)
-      limit ? records.last(limit) : records.last
-    end
+      def ordered_relation
+        if order_values.empty? && (implicit_order_column || primary_key)
+          order(arel_attribute(implicit_order_column || primary_key).asc)
+        else
+          self
+        end
+      end
   end
 end