activerecord 1.0.0 → 4.0.0

data/lib/active_record/relation/batches.rb

@@ -0,0 +1,93 @@
+
+module ActiveRecord
+  module Batches
+    # Looping through a collection of records from the database
+    # (using the +all+ method, for example) is very inefficient
+    # since it will try to instantiate all the objects at once.
+    #
+    # In that case, batch processing methods allow you to work
+    # with the records in batches, thereby greatly reducing memory consumption.
+    #
+    # The #find_each method uses #find_in_batches with a batch size of 1000 (or as
+    # specified by the +:batch_size+ option).
+    #
+    #   Person.all.find_each do |person|
+    #     person.do_awesome_stuff
+    #   end
+    #
+    #   Person.where("age > 21").find_each do |person|
+    #     person.party_all_night!
+    #   end
+    #
+    #  You can also pass the +:start+ option to specify
+    #  an offset to control the starting point.
+    def find_each(options = {})
+      find_in_batches(options) do |records|
+        records.each { |record| yield record }
+      end
+    end
+
+    # Yields each batch of records that was found by the find +options+ as
+    # an array. The size of each batch is set by the +:batch_size+
+    # option; the default is 1000.
+    #
+    # You can control the starting point for the batch processing by
+    # supplying the +:start+ option. This is especially useful if you
+    # want multiple workers dealing with the same processing queue. You can
+    # make worker 1 handle all the records between id 0 and 10,000 and
+    # worker 2 handle from 10,000 and beyond (by setting the +:start+
+    # option on that worker).
+    #
+    # It's not possible to set the order. That is automatically set to
+    # ascending on the primary key ("id ASC") to make the batch ordering
+    # work. This also means that this method only works with integer-based
+    # primary keys. You can't set the limit either, that's used to control
+    # the batch sizes.
+    #
+    #   Person.where("age > 21").find_in_batches do |group|
+    #     sleep(50) # Make sure it doesn't get too crowded in there!
+    #     group.each { |person| person.party_all_night! }
+    #   end
+    #
+    #   # Let's process the next 2000 records
+    #   Person.all.find_in_batches(start: 2000, batch_size: 2000) do |group|
+    #     group.each { |person| person.party_all_night! }
+    #   end
+    def find_in_batches(options = {})
+      options.assert_valid_keys(:start, :batch_size)
+
+      relation = self
+
+      unless arel.orders.blank? && arel.taken.blank?
+        ActiveRecord::Base.logger.warn("Scoped order and limit are ignored, it's forced to be batch order and batch size")
+      end
+
+      start = options.delete(:start)
+      batch_size = options.delete(:batch_size) || 1000
+
+      relation = relation.reorder(batch_order).limit(batch_size)
+      records = start ? relation.where(table[primary_key].gteq(start)).to_a : relation.to_a
+
+      while records.any?
+        records_size = records.size
+        primary_key_offset = records.last.id
+
+        yield records
+
+        break if records_size < batch_size
+
+        if primary_key_offset
+          records = relation.where(table[primary_key].gt(primary_key_offset)).to_a
+        else
+          raise "Primary key not included in the custom select clause"
+        end
+      end
+    end
+
+    private
+
+    def batch_order
+      "#{quoted_table_name}.#{quoted_primary_key} ASC"
+    end
+  end
+end

data/lib/active_record/relation/calculations.rb

@@ -0,0 +1,399 @@
+module ActiveRecord
+  module Calculations
+    # Count the records.
+    #
+    #   Person.count
+    #   # => the total count of all people
+    #
+    #   Person.count(:age)
+    #   # => returns the total count of all people whose age is present in database
+    #
+    #   Person.count(:all)
+    #   # => performs a COUNT(*) (:all is an alias for '*')
+    #
+    #   Person.distinct.count(:age)
+    #   # => counts the number of different age values
+    #
+    # If +count+ is used with +group+, it returns a Hash whose keys represent the aggregated column,
+    # and the values are the respective amounts:
+    #
+    #   Person.group(:city).count
+    #   # => { 'Rome' => 5, 'Paris' => 3 }
+    def count(column_name = nil, options = {})
+      column_name, options = nil, column_name if column_name.is_a?(Hash)
+      calculate(:count, column_name, options)
+    end
+
+    # Calculates the average value on a given column. Returns +nil+ if there's
+    # no row. See +calculate+ for examples with options.
+    #
+    #   Person.average('age') # => 35.8
+    def average(column_name, options = {})
+      calculate(:average, column_name, options)
+    end
+
+    # Calculates the minimum value on a given column. The value is returned
+    # with the same data type of the column, or +nil+ if there's no row. See
+    # +calculate+ for examples with options.
+    #
+    #   Person.minimum('age') # => 7
+    def minimum(column_name, options = {})
+      calculate(:minimum, column_name, options)
+    end
+
+    # Calculates the maximum value on a given column. The value is returned
+    # with the same data type of the column, or +nil+ if there's no row. See
+    # +calculate+ for examples with options.
+    #
+    #   Person.maximum('age') # => 93
+    def maximum(column_name, options = {})
+      calculate(:maximum, column_name, options)
+    end
+
+    # Calculates the sum of values on a given column. The value is returned
+    # with the same data type of the column, 0 if there's no row. See
+    # +calculate+ for examples with options.
+    #
+    #   Person.sum('age') # => 4562
+    def sum(*args)
+      if block_given?
+        ActiveSupport::Deprecation.warn(
+          "Calling #sum with a block is deprecated and will be removed in Rails 4.1. " \
+          "If you want to perform sum calculation over the array of elements, use `to_a.sum(&block)`."
+        )
+        self.to_a.sum(*args) {|*block_args| yield(*block_args)}
+      else
+        calculate(:sum, *args)
+      end
+    end
+
+    # This calculates aggregate values in the given column. Methods for count, sum, average,
+    # minimum, and maximum have been added as shortcuts.
+    #
+    # There are two basic forms of output:
+    #
+    #   * Single aggregate value: The single value is type cast to Fixnum for COUNT, Float
+    #     for AVG, and the given column's type for everything else.
+    #
+    #   * Grouped values: This returns an ordered hash of the values and groups them. It
+    #     takes either a column name, or the name of a belongs_to association.
+    #
+    #       values = Person.group('last_name').maximum(:age)
+    #       puts values["Drake"]
+    #       # => 43
+    #
+    #       drake  = Family.find_by(last_name: 'Drake')
+    #       values = Person.group(:family).maximum(:age) # Person belongs_to :family
+    #       puts values[drake]
+    #       # => 43
+    #
+    #       values.each do |family, max_age|
+    #       ...
+    #       end
+    #
+    #   Person.calculate(:count, :all) # The same as Person.count
+    #   Person.average(:age) # SELECT AVG(age) FROM people...
+    #
+    #   # Selects the minimum age for any family without any minors
+    #   Person.group(:last_name).having("min(age) > 17").minimum(:age)
+    #
+    #   Person.sum("2 * age")
+    def calculate(operation, column_name, options = {})
+      relation = with_default_scope
+
+      if relation.equal?(self)
+        if has_include?(column_name)
+          construct_relation_for_association_calculations.calculate(operation, column_name, options)
+        else
+          perform_calculation(operation, column_name, options)
+        end
+      else
+        relation.calculate(operation, column_name, options)
+      end
+    rescue ThrowResult
+      0
+    end
+
+    # Use <tt>pluck</tt> as a shortcut to select one or more attributes without
+    # loading a bunch of records just to grab the attributes you want.
+    #
+    #   Person.pluck(:name)
+    #
+    # instead of
+    #
+    #   Person.all.map(&:name)
+    #
+    # Pluck returns an <tt>Array</tt> of attribute values type-casted to match
+    # the plucked column names, if they can be deduced. Plucking an SQL fragment
+    # returns String values by default.
+    #
+    #   Person.pluck(:id)
+    #   # SELECT people.id FROM people
+    #   # => [1, 2, 3]
+    #
+    #   Person.pluck(:id, :name)
+    #   # SELECT people.id, people.name FROM people
+    #   # => [[1, 'David'], [2, 'Jeremy'], [3, 'Jose']]
+    #
+    #   Person.pluck('DISTINCT role')
+    #   # SELECT DISTINCT role FROM people
+    #   # => ['admin', 'member', 'guest']
+    #
+    #   Person.where(age: 21).limit(5).pluck(:id)
+    #   # SELECT people.id FROM people WHERE people.age = 21 LIMIT 5
+    #   # => [2, 3]
+    #
+    #   Person.pluck('DATEDIFF(updated_at, created_at)')
+    #   # SELECT DATEDIFF(updated_at, created_at) FROM people
+    #   # => ['0', '27761', '173']
+    #
+    def pluck(*column_names)
+      column_names.map! do |column_name|
+        if column_name.is_a?(Symbol) && self.column_names.include?(column_name.to_s)
+          "#{connection.quote_table_name(table_name)}.#{connection.quote_column_name(column_name)}"
+        else
+          column_name
+        end
+      end
+
+      if has_include?(column_names.first)
+        construct_relation_for_association_calculations.pluck(*column_names)
+      else
+        relation = spawn
+        relation.select_values = column_names
+        result = klass.connection.select_all(relation.arel, nil, bind_values)
+        columns = result.columns.map do |key|
+          klass.column_types.fetch(key) {
+            result.column_types.fetch(key) {
+              Class.new { def type_cast(v); v; end }.new
+            }
+          }
+        end
+
+        result = result.map do |attributes|
+          values = klass.initialize_attributes(attributes).values
+
+          columns.zip(values).map do |column, value|
+            column.type_cast(value)
+          end
+        end
+        columns.one? ? result.map!(&:first) : result
+      end
+    end
+
+    # Pluck all the ID's for the relation using the table's primary key
+    #
+    #   Person.ids # SELECT people.id FROM people
+    #   Person.joins(:companies).ids # SELECT people.id FROM people INNER JOIN companies ON companies.person_id = people.id
+    def ids
+      pluck primary_key
+    end
+
+    private
+
+    def has_include?(column_name)
+      eager_loading? || (includes_values.present? && (column_name || references_eager_loaded_tables?))
+    end
+
+    def perform_calculation(operation, column_name, options = {})
+      operation = operation.to_s.downcase
+
+      # If #count is used with #distinct / #uniq it is considered distinct. (eg. relation.distinct.count)
+      distinct = self.distinct_value
+      if options.has_key?(:distinct)
+        ActiveSupport::Deprecation.warn "The :distinct option for `Relation#count` is deprecated. " \
+          "Please use `Relation#distinct` instead. (eg. `relation.distinct.count`)"
+        distinct = options[:distinct]
+      end
+
+      if operation == "count"
+        column_name ||= (select_for_count || :all)
+
+        unless arel.ast.grep(Arel::Nodes::OuterJoin).empty?
+          distinct = true
+        end
+
+        column_name = primary_key if column_name == :all && distinct
+
+        distinct = nil if column_name =~ /\s*DISTINCT\s+/i
+      end
+
+      if group_values.any?
+        execute_grouped_calculation(operation, column_name, distinct)
+      else
+        execute_simple_calculation(operation, column_name, distinct)
+      end
+    end
+
+    def aggregate_column(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)
+      end
+    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 = reorder(nil)
+
+      column_alias = column_name
+
+      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(relation, column_name, distinct)
+      else
+        column = aggregate_column(column_name)
+
+        select_value = operation_over_aggregate_column(column, operation, distinct)
+
+        column_alias = select_value.alias
+        relation.select_values = [select_value]
+
+        query_builder = relation.arel
+      end
+
+      result = @klass.connection.select_all(query_builder, nil, relation.bind_values)
+      row    = result.first
+      value  = row && row.values.first
+      column = result.column_types.fetch(column_alias) do
+        column_for(column_name)
+      end
+
+      type_cast_calculated_value(value, column, operation)
+    end
+
+    def execute_grouped_calculation(operation, column_name, distinct) #:nodoc:
+      group_attrs = group_values
+
+      if group_attrs.first.respond_to?(:to_sym)
+        association  = @klass.reflect_on_association(group_attrs.first.to_sym)
+        associated   = group_attrs.size == 1 && association && association.macro == :belongs_to # only count belongs_to associations
+        group_fields = Array(associated ? association.foreign_key : group_attrs)
+      else
+        group_fields = group_attrs
+      end
+
+      group_aliases = group_fields.map { |field|
+        column_alias_for(field)
+      }
+      group_columns = group_aliases.zip(group_fields).map { |aliaz,field|
+        [aliaz, field]
+      }
+
+      group = group_fields
+
+      if operation == 'count' && column_name == :all
+        aggregate_alias = 'count_all'
+      else
+        aggregate_alias = column_alias_for([operation, column_name].join(' '))
+      end
+
+      select_values = [
+        operation_over_aggregate_column(
+          aggregate_column(column_name),
+          operation,
+          distinct).as(aggregate_alias)
+      ]
+      select_values += select_values unless having_values.empty?
+
+      select_values.concat group_fields.zip(group_aliases).map { |field,aliaz|
+        if field.respond_to?(:as)
+          field.as(aliaz)
+        else
+          "#{field} AS #{aliaz}"
+        end
+      }
+
+      relation = except(:group)
+      relation.group_values  = group
+      relation.select_values = select_values
+
+      calculated_data = @klass.connection.select_all(relation, nil, bind_values)
+
+      if association
+        key_ids     = calculated_data.collect { |row| row[group_aliases.first] }
+        key_records = association.klass.base_class.find(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 = calculated_data.column_types.fetch(aliaz) do
+            column_for(col_name)
+          end
+          type_cast_calculated_value(row[aliaz], column)
+        }
+        key = key.first if key.size == 1
+        key = key_records[key] if associated
+        [key, type_cast_calculated_value(row[aggregate_alias], column_for(column_name), 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"
+    #   column_alias_for("count", "id")              # => "count_id"
+    def column_alias_for(keys)
+      if keys.respond_to? :name
+        keys = "#{keys.relation.name}.#{keys.name}"
+      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
+
+    def column_for(field)
+      field_name = field.respond_to?(:name) ? field.name.to_s : field.to_s.split('.').last
+      @klass.columns_hash[field_name]
+    end
+
+    def type_cast_calculated_value(value, column, operation = nil)
+      case operation
+        when 'count'   then value.to_i
+        when 'sum'     then type_cast_using_column(value || 0, column)
+        when 'average' then value.respond_to?(:to_d) ? value.to_d : value
+        else type_cast_using_column(value, column)
+      end
+    end
+
+    def type_cast_using_column(value, column)
+      column ? column.type_cast(value) : value
+    end
+
+    def select_for_count
+      if select_values.present?
+        select = select_values.join(", ")
+        select if select !~ /[,*]/
+      end
+    end
+
+    def build_count_subquery(relation, column_name, distinct)
+      column_alias = Arel.sql('count_column')
+      subquery_alias = Arel.sql('subquery_for_count')
+
+      aliased_column = aggregate_column(column_name == :all ? 1 : column_name).as(column_alias)
+      relation.select_values = [aliased_column]
+      subquery = relation.arel.as(subquery_alias)
+
+      sm = Arel::SelectManager.new relation.engine
+      select_value = operation_over_aggregate_column(column_alias, 'count', distinct)
+      sm.project(select_value).from(subquery)
+    end
+  end
+end

data/lib/active_record/relation/delegation.rb

@@ -0,0 +1,125 @@
+require 'thread'
+require 'thread_safe'
+
+module ActiveRecord
+  module Delegation # :nodoc:
+    extend ActiveSupport::Concern
+
+    # This module creates compiled delegation methods dynamically at runtime, which makes
+    # subsequent calls to that method faster by avoiding method_missing. The delegations
+    # 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, :to_yaml, :length, :collect, :map, :each, :all?, :include?, :to_ary, :to => :to_a
+    delegate :table_name, :quoted_table_name, :primary_key, :quoted_primary_key,
+             :connection, :columns_hash, :to => :klass
+
+    module ClassSpecificRelation # :nodoc:
+      extend ActiveSupport::Concern
+
+      included do
+        @delegation_mutex = Mutex.new
+      end
+
+      module ClassMethods # :nodoc:
+        def name
+          superclass.name
+        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.send(method, *args, &block) }
+              end
+            end
+          end
+        end
+
+        def delegate(method, opts = {})
+          @delegation_mutex.synchronize do
+            return if method_defined?(method)
+            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.send(method, *args, &block) }
+        elsif Array.method_defined?(method)
+          self.class.delegate method, :to => :to_a
+          to_a.send(method, *args, &block)
+        elsif arel.respond_to?(method)
+          self.class.delegate method, :to => :arel
+          arel.send(method, *args, &block)
+        else
+          super
+        end
+      end
+    end
+
+    module ClassMethods # :nodoc:
+      @@subclasses = ThreadSafe::Cache.new(:initial_capacity => 2)
+
+      def new(klass, *args)
+        relation = relation_class_for(klass).allocate
+        relation.__send__(:initialize, klass, *args)
+        relation
+      end
+
+      # This doesn't have to be thread-safe. relation_class_for guarantees that this will only be
+      # called exactly once for a given const name.
+      def const_missing(name)
+        const_set(name, Class.new(self) { include ClassSpecificRelation })
+      end
+
+      private
+      # Cache the constants in @@subclasses because looking them up via const_get
+      # make instantiation significantly slower.
+      def relation_class_for(klass)
+        if klass && (klass_name = klass.name)
+          my_cache = @@subclasses.compute_if_absent(self) { ThreadSafe::Cache.new }
+          # This hash is keyed by klass.name to avoid memory leaks in development mode
+          my_cache.compute_if_absent(klass_name) do
+            # Cache#compute_if_absent guarantees that the block will only executed once for the given klass_name
+            const_get("#{name.gsub('::', '_')}_#{klass_name.gsub('::', '_')}", false)
+          end
+        else
+          ActiveRecord::Relation
+        end
+      end
+    end
+
+    def respond_to?(method, include_private = false)
+      super || Array.method_defined?(method) ||
+        @klass.respond_to?(method, include_private) ||
+        arel.respond_to?(method, include_private)
+    end
+
+    protected
+
+    def method_missing(method, *args, &block)
+      if @klass.respond_to?(method)
+        scoping { @klass.send(method, *args, &block) }
+      elsif Array.method_defined?(method)
+        to_a.send(method, *args, &block)
+      elsif arel.respond_to?(method)
+        arel.send(method, *args, &block)
+      else
+        super
+      end
+    end
+  end
+end