activerecord 1.13.2 → 1.14.0

data/lib/active_record/calculations.rb

@@ -0,0 +1,225 @@
+module ActiveRecord
+  module Calculations #:nodoc:
+    CALCULATIONS_OPTIONS = [:conditions, :joins, :order, :select, :group, :having, :distinct]
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Count operates using three different approaches. 
+      #
+      # * Count all: By not passing any parameters to count, it will return a count of all the rows for the model.
+      # * Count by conditions or joins: For backwards compatibility, you can pass in +conditions+ and +joins+ as individual parameters.
+      # * Count using options will find the row count matched by the options used.
+      #
+      # The last approach, count using options, accepts an option hash as the only parameter. The options are:
+      #
+      # * <tt>:conditions</tt>: An SQL fragment like "administrator = 1" or [ "user_name = ?", username ]. See conditions in the intro.
+      # * <tt>:joins</tt>: An SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id". (Rarely needed).
+      #   The records will be returned read-only since they will have attributes that do not correspond to the table's columns.
+      # * <tt>:include</tt>: Named associations that should be loaded alongside using LEFT OUTER JOINs. The symbols named refer
+      #   to already defined associations. When using named associations count returns the number DISTINCT items for the model you're counting.
+      #   See eager loading under Associations.
+      # * <tt>:order</tt>: An SQL fragment like "created_at DESC, name" (really only used with GROUP BY calculations).
+      # * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.
+      # * <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.
+      # * <tt>:distinct</tt>: Set this to true to make this a distinct calculation, such as SELECT COUNT(DISTINCT posts.id) ...
+      #
+      # Examples for counting all:
+      #   Person.count         # returns the total count of all people
+      #
+      # Examples for count by +conditions+ and +joins+ (for backwards compatibility):
+      #   Person.count("age > 26")  # returns the number of people older than 26
+      #   Person.find("age > 26 AND job.salary > 60000", "LEFT JOIN jobs on jobs.person_id = person.id") # returns the total number of rows matching the conditions and joins fetched by SELECT COUNT(*).
+      #
+      # Examples for count with options:
+      #   Person.count(:conditions => "age > 26")
+      #   Person.count(:conditions => "age > 26 AND job.salary > 60000", :include => :job) # because of the named association, it finds the DISTINCT count using LEFT OUTER JOIN.
+      #   Person.count(:conditions => "age > 26 AND job.salary > 60000", :joins => "LEFT JOIN jobs on jobs.person_id = person.id") # finds the number of rows matching the conditions and joins. 
+      #   Person.count('id', :conditions => "age > 26") # Performs a COUNT(id)
+      #   Person.count(:all, :conditions => "age > 26") # Performs a COUNT(*) (:all is an alias for '*')
+      #
+      # Note: Person.count(:all) will not work because it will use :all as the condition.  Use Person.count instead.
+      def count(*args)
+        options    = {}
+        
+        #For backwards compatibility, we need to handle both count(conditions=nil, joins=nil) or count(options={}).
+        if args.size >= 0 and args.size <= 2
+          if args.first.is_a?(Hash)
+            options = args.first
+            #should we verify the options hash???
+          elsif args[1].is_a?(Hash)
+            column_name = args.first
+            options    = args[1]
+          else
+            # Handle legacy paramter options: def count(conditions=nil, joins=nil) 
+            options.merge!(:conditions => args[0]) if args.length > 0
+            options.merge!(:joins => args[1]) if args.length > 1
+          end
+        else
+          raise(ArgumentError, "Unexpected parameters passed to count(*args): expected either count(conditions=nil, joins=nil) or count(options={})")
+        end
+
+        (scope(:find, :include) || options[:include]) ? count_with_associations(options) : calculate(:count, :all, options)
+      end
+
+      # Calculates average value on a given column.  The value is returned as a float.  See #calculate for examples with options.
+      #
+      #   Person.average('age')
+      def average(column_name, options = {})
+        calculate(:avg, column_name, options)
+      end
+
+      # Calculates the minimum value on a given column.  The value is returned with the same data type of the column..  See #calculate for examples with options.
+      #
+      #   Person.minimum('age')
+      def minimum(column_name, options = {})
+        calculate(:min, column_name, options)
+      end
+
+      # Calculates the maximum value on a given column.  The value is returned with the same data type of the column..  See #calculate for examples with options.
+      #
+      #   Person.maximum('age')
+      def maximum(column_name, options = {})
+        calculate(:max, column_name, options)
+      end
+
+      # Calculates the sum value on a given column.  The value is returned with the same data type of the column..  See #calculate for examples with options.
+      #
+      #   Person.sum('age')
+      def sum(column_name, options = {})
+        calculate(:sum, column_name, options)
+      end
+
+      # This calculates aggregate values in the given column:  Methods for count, sum, average, minimum, and maximum have been added as shortcuts.
+      # Options such as :conditions, :order, :group, :having, and :joins can be passed to customize the query.  
+      #
+      # 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 by the :group option.  It takes either a column name, or the name 
+      #     of a belongs_to association.
+      #
+      #       values = Person.maximum(:age, :group => 'last_name')
+      #       puts values["Drake"]
+      #       => 43
+      #
+      #       drake  = Family.find_by_last_name('Drake')
+      #       values = Person.maximum(:age, :group => :family) # Person belongs_to :family
+      #       puts values[drake]
+      #       => 43
+      #
+      #       values.each do |family, max_age|
+      #       ...
+      #       end
+      #
+      # Options:
+      # * <tt>:conditions</tt>: An SQL fragment like "administrator = 1" or [ "user_name = ?", username ]. See conditions in the intro.
+      # * <tt>:joins</tt>: An SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id". (Rarely needed).
+      #   The records will be returned read-only since they will have attributes that do not correspond to the table's columns.
+      # * <tt>:order</tt>: An SQL fragment like "created_at DESC, name" (really only used with GROUP BY calculations).
+      # * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.
+      # * <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.
+      # * <tt>:distinct</tt>: Set this to true to make this a distinct calculation, such as SELECT COUNT(DISTINCT posts.id) ...
+      #
+      # Examples:
+      #   Person.calculate(:count, :all) # The same as Person.count
+      #   Person.average(:age) # SELECT AVG(age) FROM people...
+      #   Person.minimum(:age, :conditions => ['last_name != ?', 'Drake']) # Selects the minimum age for everyone with a last name other than 'Drake'
+      #   Person.minimum(:age, :having => 'min(age) > 17', :group => :last_name) # Selects the minimum age for any family without any minors
+      def calculate(operation, column_name, options = {})
+        validate_calculation_options(operation, options)
+        column_name     = options[:select] if options[:select]
+        column_name     = '*' if column_name == :all
+        column          = column_for column_name
+        aggregate       = select_aggregate(operation, column_name, options)
+        aggregate_alias = column_alias_for(operation, column_name)
+        if options[:group]
+          execute_grouped_calculation(operation, column_name, column, aggregate, aggregate_alias, options)
+        else
+          execute_simple_calculation(operation, column_name, column, aggregate, aggregate_alias, options)
+        end
+      end
+
+      protected
+        def construct_calculation_sql(aggregate, aggregate_alias, options) #:nodoc:
+          scope = scope(:find)
+          sql  = ["SELECT #{aggregate} AS #{aggregate_alias}"]
+          sql << ", #{options[:group_field]} AS #{options[:group_alias]}" if options[:group]
+          sql << " FROM #{table_name} "
+          add_joins!(sql, options, scope)
+          add_conditions!(sql, options[:conditions], scope)
+          sql << " GROUP BY #{options[:group_field]}" if options[:group]
+          sql << " HAVING #{options[:having]}" if options[:group] && options[:having]
+          sql << " ORDER BY #{options[:order]}" if options[:order]
+          sql.join
+        end
+
+        def execute_simple_calculation(operation, column_name, column, aggregate, aggregate_alias, options) #:nodoc:
+          value     = connection.select_value(construct_calculation_sql(aggregate, aggregate_alias, options))
+          type_cast_calculated_value(value, column, operation)
+        end
+
+        def execute_grouped_calculation(operation, column_name, column, aggregate, aggregate_alias, options) #:nodoc:
+          group_attr      = options[:group].to_s
+          association     = reflect_on_association(group_attr.to_sym)
+          associated      = association && association.macro == :belongs_to # only count belongs_to associations
+          group_field     = (associated ? "#{options[:group]}_id" : options[:group]).to_s
+          group_alias     = column_alias_for(group_field)
+          group_column    = column_for group_field
+          sql             = construct_calculation_sql(aggregate, aggregate_alias, options.merge(:group_field => group_field, :group_alias => group_alias))
+          calculated_data = connection.select_all(sql)
+
+          if association
+            key_ids     = calculated_data.collect { |row| row[group_alias] }
+            key_records = association.klass.base_class.find(key_ids)
+            key_records = key_records.inject({}) { |hsh, r| hsh.merge(r.id => r) }
+          end
+
+          calculated_data.inject(OrderedHash.new) do |all, row|
+            key   = associated ? key_records[row[group_alias].to_i] : type_cast_calculated_value(row[group_alias], group_column)
+            value = row[aggregate_alias]
+            all << [key, type_cast_calculated_value(value, column, operation)]
+          end
+        end
+
+      private
+        def validate_calculation_options(operation, options = {})
+          if operation.to_s == 'count'
+            options.assert_valid_keys(CALCULATIONS_OPTIONS + [:include])
+          else
+            options.assert_valid_keys(CALCULATIONS_OPTIONS)
+          end
+        end
+
+        def select_aggregate(operation, column_name, options)
+          "#{operation}(#{'DISTINCT ' if options[:distinct]}#{column_name})"
+        end
+
+        # converts a given key to the value that the database adapter returns as
+        #
+        #   users.id #=> users_id
+        #   sum(id) #=> sum_id
+        #   count(distinct users.id) #=> count_distinct_users_id
+        #   count(*) #=> count_all
+        def column_alias_for(*keys)
+          keys.join(' ').downcase.gsub(/\*/, 'all').gsub(/\W+/, ' ').strip.gsub(/ +/, '_')
+        end
+
+        def column_for(field)
+          field_name = field.to_s.split('.').last
+          columns.detect { |c| c.name.to_s == field_name }
+        end
+
+        def type_cast_calculated_value(value, column, operation = nil)
+          operation = operation.to_s.downcase
+          case operation
+            when 'count' then value.to_i
+            when 'avg'   then value.to_f
+            else column ? column.type_cast(value) : value
+          end
+        end
+    end
+  end
+end

data/lib/active_record/callbacks.rb

@@ -13,15 +13,15 @@ module ActiveRecord
   # * (2) before_validation_on_create
   # * (-) validate
   # * (-) validate_on_create
-  # * (4) after_validation
-  # * (5) after_validation_on_create
-  # * (6) before_save
-  # * (7) before_create
+  # * (3) after_validation
+  # * (4) after_validation_on_create
+  # * (5) before_save
+  # * (6) before_create
   # * (-) create
-  # * (8) after_create
-  # * (9) after_save
+  # * (7) after_create
+  # * (8) after_save
   #
-  # That's a total of nine callbacks, which gives you immense power to react and prepare for each state in the
+  # That's a total of eight callbacks, which gives you immense power to react and prepare for each state in the
   # Active Record lifecycle.
   #
   # Examples:

data/lib/active_record/connection_adapters/abstract/connection_specification.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module ActiveRecord
   class Base
     class ConnectionSpecification #:nodoc:
@@ -7,22 +9,139 @@ module ActiveRecord
       end
     end
 
+    # Check for activity after at least +verification_timeout+ seconds.
+    # Defaults to 0 (always check.)
+    cattr_accessor :verification_timeout
+    @@verification_timeout = 0
+
     # The class -> [adapter_method, config] map
     @@defined_connections = {}
 
-    # The class -> thread id -> adapter cache.
-    @@connection_cache = Hash.new { |h, k| h[k] = Hash.new }
+    # The class -> thread id -> adapter cache. (class -> adapter if not allow_concurrency)
+    @@active_connections = {}
 
-    # Returns the connection currently associated with the class. This can
-    # also be used to "borrow" the connection to do database work unrelated
-    # to any of the specific Active Records.
-    def self.connection
-      @@connection_cache[Thread.current.object_id][name] ||= retrieve_connection
-    end
+    class << self
+      # Retrieve the connection cache.
+      def thread_safe_active_connections #:nodoc:
+        @@active_connections[Thread.current.object_id] ||= {}
+      end
+     
+      def single_threaded_active_connections #:nodoc:
+        @@active_connections
+      end
+     
+      # pick up the right active_connection method from @@allow_concurrency
+      if @@allow_concurrency
+        alias_method :active_connections, :thread_safe_active_connections
+      else
+        alias_method :active_connections, :single_threaded_active_connections
+      end
+     
+      # set concurrency support flag (not thread safe, like most of the methods in this file)
+      def allow_concurrency=(threaded) #:nodoc:
+        logger.debug "allow_concurrency=#{threaded}" if logger
+        return if @@allow_concurrency == threaded
+        clear_all_cached_connections!
+        @@allow_concurrency = threaded
+        method_prefix = threaded ? "thread_safe" : "single_threaded"
+        sing = (class << self; self; end)
+        [:active_connections, :scoped_methods].each do |method|
+          sing.send(:alias_method, method, "#{method_prefix}_#{method}")
+        end
+        log_connections if logger
+      end
+      
+      def active_connection_name #:nodoc:
+        @active_connection_name ||=
+           if active_connections[name] || @@defined_connections[name]
+             name
+           elsif self == ActiveRecord::Base
+             nil
+           else
+             superclass.active_connection_name
+           end
+      end
+
+      def clear_active_connection_name #:nodoc:
+        @active_connection_name = nil
+        subclasses.each { |klass| klass.clear_active_connection_name }
+      end
+
+      # Returns the connection currently associated with the class. This can
+      # also be used to "borrow" the connection to do database work unrelated
+      # to any of the specific Active Records.
+      def connection
+        if @active_connection_name && (conn = active_connections[@active_connection_name])
+          conn
+        else
+          # retrieve_connection sets the cache key.
+          conn = retrieve_connection
+          active_connections[@active_connection_name] = conn
+        end
+      end
+
+      # Clears the cache which maps classes to connections.
+      def clear_active_connections!
+        clear_cache!(@@active_connections) do |name, conn|
+          conn.disconnect!
+        end
+      end
+
+      # Verify active connections.
+      def verify_active_connections! #:nodoc:
+        if @@allow_concurrency
+          remove_stale_cached_threads!(@@active_connections) do |name, conn|
+            conn.disconnect!
+          end
+        end
+        
+        active_connections.each_value do |connection|
+          connection.verify!(@@verification_timeout)
+        end
+      end
 
-    # Clears the cache which maps classes to connections.
-    def self.clear_connection_cache!
-      @@connection_cache.clear
+      private
+        def clear_cache!(cache, thread_id = nil, &block)
+          if cache
+            if @@allow_concurrency
+              thread_id ||= Thread.current.object_id
+              thread_cache, cache = cache, cache[thread_id]
+              return unless cache
+            end
+
+            cache.each(&block) if block_given?
+            cache.clear
+          end
+        ensure
+          if thread_cache && @@allow_concurrency
+            thread_cache.delete(thread_id)
+          end
+        end
+
+        # Remove stale threads from the cache.
+        def remove_stale_cached_threads!(cache, &block)
+          stale = Set.new(cache.keys)
+
+          Thread.list.each do |thread|
+            stale.delete(thread.object_id) if thread.alive?
+          end
+
+          stale.each do |thread_id|
+            clear_cache!(cache, thread_id, &block)
+          end
+        end
+        
+        def clear_all_cached_connections!
+          if @@allow_concurrency
+            @@active_connections.each_value do |connection_hash_for_thread|
+              connection_hash_for_thread.each_value {|conn| conn.disconnect! }
+              connection_hash_for_thread.clear
+            end
+          else
+            @@active_connections.each_value {|conn| conn.disconnect! }
+          end
+          @@active_connections.clear          
+        end
     end
 
     # Returns the connection currently associated with the class. This can
@@ -65,6 +184,8 @@ module ActiveRecord
           raise AdapterNotSpecified unless defined? RAILS_ENV
           establish_connection(RAILS_ENV)
         when ConnectionSpecification
+          clear_active_connection_name
+          @active_connection_name = name
           @@defined_connections[name] = spec
         when Symbol, String
           if configuration = configurations[spec.to_s]
@@ -82,46 +203,31 @@ module ActiveRecord
       end
     end
 
-    def self.active_connections #:nodoc:
-      if allow_concurrency
-        Thread.current['active_connections'] ||= {}
-      else
-        @@active_connections ||= {}
-      end
-    end
-
     # Locate the connection of the nearest super class. This can be an
     # active or defined connections: if it is the latter, it will be
     # opened and set as the active connection for the class it was defined
     # for (not necessarily the current class).
     def self.retrieve_connection #:nodoc:
-      klass = self
-      ar_super = ActiveRecord::Base.superclass
-      until klass == ar_super
-        if conn = active_connections[klass.name]
-          # Reconnect if the connection is inactive.
-          conn.reconnect! unless conn.active?
-          return conn
-        elsif conn = @@defined_connections[klass.name]
-          klass.connection = conn
-          return self.connection
+      # Name is nil if establish_connection hasn't been called for
+      # some class along the inheritance chain up to AR::Base yet.
+      if name = active_connection_name
+        if conn = active_connections[name]
+          # Verify the connection.
+          conn.verify!(@@verification_timeout)
+        elsif spec = @@defined_connections[name]
+          # Activate this connection specification.
+          klass = name.constantize
+          klass.connection = spec
+          conn = active_connections[name]
         end
-        klass = klass.superclass
       end
-      raise ConnectionNotEstablished
+
+      conn or raise ConnectionNotEstablished
     end
 
     # Returns true if a connection that's accessible to this class have already been opened.
     def self.connected?
-      klass = self
-      until klass == ActiveRecord::Base.superclass
-        if active_connections[klass.name]
-          return true
-        else
-          klass = klass.superclass
-        end
-      end
-      return false
+      active_connections[active_connection_name] ? true : false
     end
 
     # Remove the connection for this class. This will close the active
@@ -129,16 +235,16 @@ module ActiveRecord
     # can be used as argument for establish_connection, for easy
     # re-establishing of the connection.
     def self.remove_connection(klass=self)
-      conn = @@defined_connections[klass.name]
-      @@defined_connections.delete(klass.name)
-      @@connection_cache[Thread.current.object_id].delete(klass.name)
-      active_connections.delete(klass.name)
-      @connection = nil
-      conn.config if conn
+      spec = @@defined_connections[klass.name]
+      konn = active_connections[klass.name]
+      @@defined_connections.delete_if { |key, value| value == spec }
+      active_connections.delete_if { |key, value| value == konn }
+      konn.disconnect! if konn
+      spec.config if spec
     end
 
     # Set the connection for the class.
-    def self.connection=(spec)
+    def self.connection=(spec) #:nodoc:
       if spec.kind_of?(ActiveRecord::ConnectionAdapters::AbstractAdapter)
         active_connections[name] = spec
       elsif spec.kind_of?(ConnectionSpecification)
@@ -149,5 +255,14 @@ module ActiveRecord
         establish_connection spec
       end
     end
+
+    # connection state logging
+    def self.log_connections #:nodoc:
+      if logger
+        logger.info "Defined connections: #{@@defined_connections.inspect}"
+        logger.info "Active connections: #{active_connections.inspect}"
+        logger.info "Active connection name: #{@active_connection_name}"
+      end
+    end
   end
 end