activerecord 5.0.6 → 6.0.1

data/lib/active_record/relation/calculations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module Calculations
     # Count the records.
@@ -37,7 +39,15 @@ module ActiveRecord
     # Note: not all valid {Relation#select}[rdoc-ref:QueryMethods#select] expressions are valid #count expressions. The specifics differ
     # between databases. In invalid cases, an error from the database is thrown.
     def count(column_name = nil)
-      calculate(:count, column_name)
+      if block_given?
+        unless column_name.nil?
+          raise ArgumentError, "Column name argument is not supported when a block is passed."
+        end
+
+        super()
+      else
+        calculate(:count, column_name)
+      end
     end
 
     # Calculates the average value on a given column. Returns +nil+ if there's
@@ -71,9 +81,16 @@ module ActiveRecord
     # #calculate for examples with options.
     #
     #   Person.sum(:age) # => 4562
-    def sum(column_name = nil, &block)
-      return super(&block) if block_given?
-      calculate(:sum, column_name)
+    def sum(column_name = nil)
+      if block_given?
+        unless column_name.nil?
+          raise ArgumentError, "Column name argument is not supported when a block is passed."
+        end
+
+        super()
+      else
+        calculate(:sum, column_name)
+      end
     end
 
     # This calculates aggregate values in the given column. Methods for #count, #sum, #average,
@@ -108,13 +125,17 @@ module ActiveRecord
     #        ...
     #      end
     def calculate(operation, column_name)
-      if column_name.is_a?(Symbol) && attribute_alias?(column_name)
-        column_name = attribute_alias(column_name)
-      end
-
       if has_include?(column_name)
-        relation = construct_relation_for_association_calculations
-        relation = relation.distinct if operation.to_s.downcase == "count"
+        relation = apply_join_dependency
+
+        if operation.to_s.downcase == "count"
+          unless distinct_value || distinct_select?(column_name || select_for_count)
+            relation.distinct!
+            relation.select_values = [ klass.primary_key || table[Arel.star] ]
+          end
+          # PostgreSQL: ORDER BY expressions must appear in SELECT list when using DISTINCT
+          relation.order_values = []
+        end
 
         relation.calculate(operation, column_name)
       else
@@ -163,17 +184,35 @@ module ActiveRecord
       end
 
       if has_include?(column_names.first)
-        construct_relation_for_association_calculations.pluck(*column_names)
+        relation = apply_join_dependency
+        relation.pluck(*column_names)
       else
+        klass.disallow_raw_sql!(column_names)
         relation = spawn
-        relation.select_values = column_names.map { |cn|
-          @klass.has_attribute?(cn) || @klass.attribute_alias?(cn) ? arel_attribute(cn) : cn
-        }
-        result = klass.connection.select_all(relation.arel, nil, bound_attributes)
+        relation.select_values = column_names
+        result = skip_query_cache_if_necessary { klass.connection.select_all(relation.arel, nil) }
         result.cast_values(klass.attribute_types)
       end
     end
 
+    # Pick the value(s) from the named column(s) in the current relation.
+    # This is short-hand for <tt>relation.limit(1).pluck(*column_names).first</tt>, and is primarily useful
+    # when you have a relation that's already narrowed down to a single row.
+    #
+    # Just like #pluck, #pick will only load the actual value, not the entire record object, so it's also
+    # more efficient. The value is, again like with pluck, typecast by the column type.
+    #
+    #   Person.where(id: 1).pick(:name)
+    #   # SELECT people.name FROM people WHERE id = 1 LIMIT 1
+    #   # => 'David'
+    #
+    #   Person.where(id: 1).pick(:name, :email_address)
+    #   # SELECT people.name, people.email_address FROM people WHERE id = 1 LIMIT 1
+    #   # => [ 'David', 'david@loudthinking.com' ]
+    def pick(*column_names)
+      limit(1).pluck(*column_names).first
+    end
+
     # Pluck all the ID's for the relation using the table's primary key
     #
     #   Person.ids # SELECT people.id FROM people
@@ -183,203 +222,203 @@ module ActiveRecord
     end
 
     private
+      def has_include?(column_name)
+        eager_loading? || (includes_values.present? && column_name && column_name != :all)
+      end
 
-    def has_include?(column_name)
-      eager_loading? || (includes_values.present? && column_name && column_name != :all)
-    end
+      def perform_calculation(operation, column_name)
+        operation = operation.to_s.downcase
 
-    def perform_calculation(operation, column_name)
-      operation = operation.to_s.downcase
+        # If #count is used with #distinct (i.e. `relation.distinct.count`) it is
+        # considered distinct.
+        distinct = distinct_value
 
-      # If #count is used with #distinct (i.e. `relation.distinct.count`) it is
-      # considered distinct.
-      distinct = self.distinct_value
+        if operation == "count"
+          column_name ||= select_for_count
+          if column_name == :all
+            if !distinct
+              distinct = distinct_select?(select_for_count) if group_values.empty?
+            elsif group_values.any? || select_values.empty? && order_values.empty?
+              column_name = primary_key
+            end
+          elsif distinct_select?(column_name)
+            distinct = nil
+          end
+        end
 
-      if operation == "count"
-        column_name ||= select_for_count
-        column_name = primary_key if column_name == :all && distinct
-        distinct = nil if column_name =~ /\s*DISTINCT[\s(]+/i
+        if group_values.any?
+          execute_grouped_calculation(operation, column_name, distinct)
+        else
+          execute_simple_calculation(operation, column_name, distinct)
+        end
       end
 
-      if group_values.any?
-        execute_grouped_calculation(operation, column_name, distinct)
-      else
-        execute_simple_calculation(operation, column_name, distinct)
+      def distinct_select?(column_name)
+        column_name.is_a?(::String) && /\bDISTINCT[\s(]/i.match?(column_name)
       end
-    end
 
-    def aggregate_column(column_name)
-      return column_name if Arel::Expressions === column_name
+      def aggregate_column(column_name)
+        return column_name if Arel::Expressions === column_name
 
-      if @klass.column_names.include?(column_name.to_s)
-        Arel::Attribute.new(@klass.unscoped.table, column_name)
-      else
-        Arel.sql(column_name == :all ? "*" : column_name.to_s)
+        arel_column(column_name.to_s) do |name|
+          Arel.sql(column_name == :all ? "*" : name)
+        end
       end
-    end
 
-    def operation_over_aggregate_column(column, operation, distinct)
-      operation == 'count' ? column.count(distinct) : column.send(operation)
-    end
+      def operation_over_aggregate_column(column, operation, distinct)
+        operation == "count" ? column.count(distinct) : column.send(operation)
+      end
 
-    def execute_simple_calculation(operation, column_name, distinct) #:nodoc:
-      # PostgreSQL doesn't like ORDER BY when there are no GROUP BY
-      relation = unscope(:order)
+      def execute_simple_calculation(operation, column_name, distinct) #:nodoc:
+        column_alias = column_name
 
-      column_alias = column_name
+        if operation == "count" && (column_name == :all && distinct || has_limit_or_offset?)
+          # Shortcut when limit is zero.
+          return 0 if limit_value == 0
 
-      if operation == "count" && (relation.limit_value || relation.offset_value)
-        # Shortcut when limit is zero.
-        return 0 if relation.limit_value == 0
+          query_builder = build_count_subquery(spawn, column_name, distinct)
+        else
+          # PostgreSQL doesn't like ORDER BY when there are no GROUP BY
+          relation = unscope(:order).distinct!(false)
 
-        query_builder = build_count_subquery(relation, column_name, distinct)
-      else
-        column = aggregate_column(column_name)
+          column = aggregate_column(column_name)
 
-        select_value = operation_over_aggregate_column(column, operation, distinct)
+          select_value = operation_over_aggregate_column(column, operation, distinct)
+          if operation == "sum" && distinct
+            select_value.distinct = true
+          end
 
-        if operation == "sum" && distinct
-          select_value.distinct = true
-        end
+          column_alias = select_value.alias
+          column_alias ||= @klass.connection.column_name_for_operation(operation, select_value)
+          relation.select_values = [select_value]
 
-        column_alias = select_value.alias
-        column_alias ||= @klass.connection.column_name_for_operation(operation, select_value)
-        relation.select_values = [select_value]
+          query_builder = relation.arel
+        end
 
-        query_builder = relation.arel
-      end
+        result = skip_query_cache_if_necessary { @klass.connection.select_all(query_builder, nil) }
+        row    = result.first
+        value  = row && row.values.first
+        type   = result.column_types.fetch(column_alias) do
+          type_for(column_name)
+        end
 
-      result = @klass.connection.select_all(query_builder, nil, bound_attributes)
-      row    = result.first
-      value  = row && row.values.first
-      column = result.column_types.fetch(column_alias) do
-        type_for(column_name)
+        type_cast_calculated_value(value, type, operation)
       end
 
-      type_cast_calculated_value(value, column, operation)
-    end
+      def execute_grouped_calculation(operation, column_name, distinct) #:nodoc:
+        group_fields = group_values
 
-    def execute_grouped_calculation(operation, column_name, distinct) #:nodoc:
-      group_attrs = group_values
+        if group_fields.size == 1 && group_fields.first.respond_to?(:to_sym)
+          association  = klass._reflect_on_association(group_fields.first)
+          associated   = association && association.belongs_to? # only count belongs_to associations
+          group_fields = Array(association.foreign_key) if associated
+        end
+        group_fields = arel_columns(group_fields)
 
-      if group_attrs.first.respond_to?(:to_sym)
-        association  = @klass._reflect_on_association(group_attrs.first)
-        associated   = group_attrs.size == 1 && association && association.belongs_to? # only count belongs_to associations
-        group_fields = Array(associated ? association.foreign_key : group_attrs)
-      else
-        group_fields = group_attrs
-      end
-      group_fields = arel_columns(group_fields)
+        group_aliases = group_fields.map { |field|
+          field = connection.visitor.compile(field) if Arel.arel_node?(field)
+          column_alias_for(field.to_s.downcase)
+        }
+        group_columns = group_aliases.zip(group_fields)
+
+        aggregate_alias = column_alias_for("#{operation} #{column_name.to_s.downcase}")
+
+        select_values = [
+          operation_over_aggregate_column(
+            aggregate_column(column_name),
+            operation,
+            distinct).as(aggregate_alias)
+        ]
+        select_values += self.select_values unless having_clause.empty?
+
+        select_values.concat group_columns.map { |aliaz, field|
+          if field.respond_to?(:as)
+            field.as(aliaz)
+          else
+            "#{field} AS #{aliaz}"
+          end
+        }
 
-      group_aliases = group_fields.map { |field| column_alias_for(field) }
-      group_columns = group_aliases.zip(group_fields)
+        relation = except(:group).distinct!(false)
+        relation.group_values  = group_fields
+        relation.select_values = select_values
 
-      if operation == 'count' && column_name == :all
-        aggregate_alias = 'count_all'
-      else
-        aggregate_alias = column_alias_for([operation, column_name].join(' '))
-      end
+        calculated_data = skip_query_cache_if_necessary { @klass.connection.select_all(relation.arel, nil) }
 
-      select_values = [
-        operation_over_aggregate_column(
-          aggregate_column(column_name),
-          operation,
-          distinct).as(aggregate_alias)
-      ]
-      select_values += self.select_values unless having_clause.empty?
-
-      select_values.concat group_columns.map { |aliaz, field|
-        if field.respond_to?(:as)
-          field.as(aliaz)
-        else
-          "#{field} AS #{aliaz}"
+        if association
+          key_ids     = calculated_data.collect { |row| row[group_aliases.first] }
+          key_records = association.klass.base_class.where(association.klass.base_class.primary_key => key_ids)
+          key_records = Hash[key_records.map { |r| [r.id, r] }]
         end
-      }
-
-      relation = except(:group)
-      relation.group_values  = group_fields
-      relation.select_values = select_values
-
-      calculated_data = @klass.connection.select_all(relation, nil, relation.bound_attributes)
 
-      if association
-        key_ids     = calculated_data.collect { |row| row[group_aliases.first] }
-        key_records = association.klass.base_class.where(association.klass.base_class.primary_key => key_ids)
-        key_records = Hash[key_records.map { |r| [r.id, r] }]
-      end
-
-      Hash[calculated_data.map do |row|
-        key = group_columns.map { |aliaz, col_name|
-          column = type_for(col_name) do
-            calculated_data.column_types.fetch(aliaz) do
-              Type::Value.new
+        Hash[calculated_data.map do |row|
+          key = group_columns.map { |aliaz, col_name|
+            type = type_for(col_name) do
+              calculated_data.column_types.fetch(aliaz, Type.default_value)
             end
-          end
-          type_cast_calculated_value(row[aliaz], column)
-        }
-        key = key.first if key.size == 1
-        key = key_records[key] if associated
-
-        column_type = calculated_data.column_types.fetch(aggregate_alias) { type_for(column_name) }
-        [key, type_cast_calculated_value(row[aggregate_alias], column_type, operation)]
-      end]
-    end
-
-    # Converts the given keys to the value that the database adapter returns as
-    # a usable column name:
-    #
-    #   column_alias_for("users.id")                 # => "users_id"
-    #   column_alias_for("sum(id)")                  # => "sum_id"
-    #   column_alias_for("count(distinct users.id)") # => "count_distinct_users_id"
-    #   column_alias_for("count(*)")                 # => "count_all"
-    def column_alias_for(keys)
-      if keys.respond_to? :name
-        keys = "#{keys.relation.name}.#{keys.name}"
+            type_cast_calculated_value(row[aliaz], type)
+          }
+          key = key.first if key.size == 1
+          key = key_records[key] if associated
+
+          type = calculated_data.column_types.fetch(aggregate_alias) { type_for(column_name) }
+          [key, type_cast_calculated_value(row[aggregate_alias], type, operation)]
+        end]
       end
 
-      table_name = keys.to_s.downcase
-      table_name.gsub!(/\*/, 'all')
-      table_name.gsub!(/\W+/, ' ')
-      table_name.strip!
-      table_name.gsub!(/ +/, '_')
-
-      @klass.connection.table_alias_for(table_name)
-    end
+      # Converts the given field to the value that the database adapter returns as
+      # a usable column name:
+      #
+      #   column_alias_for("users.id")                 # => "users_id"
+      #   column_alias_for("sum(id)")                  # => "sum_id"
+      #   column_alias_for("count(distinct users.id)") # => "count_distinct_users_id"
+      #   column_alias_for("count(*)")                 # => "count_all"
+      def column_alias_for(field)
+        column_alias = +field
+        column_alias.gsub!(/\*/, "all")
+        column_alias.gsub!(/\W+/, " ")
+        column_alias.strip!
+        column_alias.gsub!(/ +/, "_")
+
+        connection.table_alias_for(column_alias)
+      end
 
-    def type_for(field, &block)
-      field_name = field.respond_to?(:name) ? field.name.to_s : field.to_s.split('.').last
-      @klass.type_for_attribute(field_name, &block)
-    end
+      def type_for(field, &block)
+        field_name = field.respond_to?(:name) ? field.name.to_s : field.to_s.split(".").last
+        @klass.type_for_attribute(field_name, &block)
+      end
 
-    def type_cast_calculated_value(value, type, operation = nil)
-      case operation
-        when 'count'   then value.to_i
-        when 'sum'     then type.deserialize(value || 0)
-        when 'average' then value.respond_to?(:to_d) ? value.to_d : value
+      def type_cast_calculated_value(value, type, operation = nil)
+        case operation
+        when "count"   then value.to_i
+        when "sum"     then type.deserialize(value || 0)
+        when "average" then value&.respond_to?(:to_d) ? value.to_d : value
         else type.deserialize(value)
+        end
       end
-    end
 
-    def select_for_count
-      if select_values.present?
-        return select_values.first if select_values.one?
-        select_values.join(", ")
-      else
-        :all
+      def select_for_count
+        if select_values.present?
+          return select_values.first if select_values.one?
+          select_values.join(", ")
+        else
+          :all
+        end
       end
-    end
 
-    def build_count_subquery(relation, column_name, distinct)
-      column_alias = Arel.sql('count_column')
-      subquery_alias = Arel.sql('subquery_for_count')
+      def build_count_subquery(relation, column_name, distinct)
+        if column_name == :all
+          column_alias = Arel.star
+          relation.select_values = [ Arel.sql(FinderMethods::ONE_AS_ONE) ] unless distinct
+        else
+          column_alias = Arel.sql("count_column")
+          relation.select_values = [ aggregate_column(column_name).as(column_alias) ]
+        end
 
-      aliased_column = aggregate_column(column_name == :all ? 1 : column_name).as(column_alias)
-      relation.select_values = [aliased_column]
-      subquery = relation.arel.as(subquery_alias)
+        subquery_alias = Arel.sql("subquery_for_count")
+        select_value = operation_over_aggregate_column(column_alias, "count", false)
 
-      sm = Arel::SelectManager.new relation.engine
-      select_value = operation_over_aggregate_column(column_alias, 'count', distinct)
-      sm.project(select_value).from(subquery)
-    end
+        relation.build_subquery(subquery_alias, select_value)
+      end
   end
 end

data/lib/active_record/relation/delegation.rb

@@ -1,4 +1,6 @@
-require 'active_support/concern'
+# frozen_string_literal: true
+
+require "mutex_m"
 
 module ActiveRecord
   module Delegation # :nodoc:
@@ -17,7 +19,11 @@ module ActiveRecord
           delegate = Class.new(klass) {
             include ClassSpecificRelation
           }
-          const_set klass.name.gsub('::'.freeze, '_'.freeze), delegate
+          include_relation_methods(delegate)
+          mangled_name = klass.name.gsub("::", "_")
+          const_set mangled_name, delegate
+          private_constant mangled_name
+
           cache[klass] = delegate
         end
       end
@@ -26,8 +32,49 @@ module ActiveRecord
         child_class.initialize_relation_delegate_cache
         super
       end
+
+      def generate_relation_method(method)
+        generated_relation_methods.generate_method(method)
+      end
+
+      protected
+        def include_relation_methods(delegate)
+          superclass.include_relation_methods(delegate) unless base_class?
+          delegate.include generated_relation_methods
+        end
+
+      private
+        def generated_relation_methods
+          @generated_relation_methods ||= GeneratedRelationMethods.new.tap do |mod|
+            const_set(:GeneratedRelationMethods, mod)
+            private_constant :GeneratedRelationMethods
+          end
+        end
     end
 
+    class GeneratedRelationMethods < Module # :nodoc:
+      include Mutex_m
+
+      def generate_method(method)
+        synchronize do
+          return if method_defined?(method)
+
+          if /\A[a-zA-Z_]\w*[!?]?\z/.match?(method)
+            module_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{method}(*args, &block)
+                scoping { klass.#{method}(*args, &block) }
+              end
+            RUBY
+          else
+            define_method(method) do |*args, &block|
+              scoping { klass.public_send(method, *args, &block) }
+            end
+          end
+        end
+      end
+    end
+    private_constant :GeneratedRelationMethods
+
     extend ActiveSupport::Concern
 
     # This module creates compiled delegation methods dynamically at runtime, which makes
@@ -35,65 +82,32 @@ module ActiveRecord
     # may vary depending on the klass of a relation, so we create a subclass of Relation
     # for each different klass, and the delegations are compiled into that subclass only.
 
-    delegate :to_xml, :encode_with, :length, :collect, :map, :each, :all?, :include?, :to_ary, :join,
-             :[], :&, :|, :+, :-, :sample, :reverse, :compact, :in_groups, :in_groups_of,
-             :to_sentence, :to_formatted_s,
-             :shuffle, :split, :index, to: :records
+    delegate :to_xml, :encode_with, :length, :each, :join,
+             :[], :&, :|, :+, :-, :sample, :reverse, :rotate, :compact, :in_groups, :in_groups_of,
+             :to_sentence, :to_formatted_s, :as_json,
+             :shuffle, :split, :slice, :index, :rindex, to: :records
 
-    delegate :table_name, :quoted_table_name, :primary_key, :quoted_primary_key,
-             :connection, :columns_hash, :to => :klass
+    delegate :primary_key, :connection, to: :klass
 
     module ClassSpecificRelation # :nodoc:
       extend ActiveSupport::Concern
 
-      included do
-        @delegation_mutex = Mutex.new
-      end
-
       module ClassMethods # :nodoc:
         def name
           superclass.name
         end
+      end
 
-        def delegate_to_scoped_klass(method)
-          @delegation_mutex.synchronize do
-            return if method_defined?(method)
-
-            if method.to_s =~ /\A[a-zA-Z_]\w*[!?]?\z/
-              module_eval <<-RUBY, __FILE__, __LINE__ + 1
-                def #{method}(*args, &block)
-                  scoping { @klass.#{method}(*args, &block) }
-                end
-              RUBY
-            else
-              define_method method do |*args, &block|
-                scoping { @klass.public_send(method, *args, &block) }
-              end
-            end
-          end
-        end
+      private
 
-        def delegate(method, opts = {})
-          @delegation_mutex.synchronize do
-            return if method_defined?(method)
+        def method_missing(method, *args, &block)
+          if @klass.respond_to?(method)
+            @klass.generate_relation_method(method)
+            scoping { @klass.public_send(method, *args, &block) }
+          else
             super
           end
         end
-      end
-
-      protected
-
-      def method_missing(method, *args, &block)
-        if @klass.respond_to?(method)
-          self.class.delegate_to_scoped_klass(method)
-          scoping { @klass.public_send(method, *args, &block) }
-        elsif arel.respond_to?(method)
-          self.class.delegate method, :to => :arel
-          arel.public_send(method, *args, &block)
-        else
-          super
-        end
-      end
     end
 
     module ClassMethods # :nodoc:
@@ -103,26 +117,14 @@ module ActiveRecord
 
       private
 
-      def relation_class_for(klass)
-        klass.relation_delegate_class(self)
-      end
-    end
-
-    def respond_to?(method, include_private = false)
-      super || @klass.respond_to?(method, include_private) ||
-        arel.respond_to?(method, include_private)
+        def relation_class_for(klass)
+          klass.relation_delegate_class(self)
+        end
     end
 
-    protected
-
-    def method_missing(method, *args, &block)
-      if @klass.respond_to?(method)
-        scoping { @klass.public_send(method, *args, &block) }
-      elsif arel.respond_to?(method)
-        arel.public_send(method, *args, &block)
-      else
-        super
+    private
+      def respond_to_missing?(method, _)
+        super || @klass.respond_to?(method)
       end
-    end
   end
 end