activerecord 3.0.0.beta4 → 3.0.0.rc

data/lib/active_record/observer.rb

@@ -1,6 +1,8 @@
 require 'active_support/core_ext/class/attribute'
 
 module ActiveRecord
+  # = Active Record Observer
+  #
   # Observer classes respond to lifecycle callbacks to implement trigger-like
   # behavior outside the original class. This is a great way to reduce the
   # clutter that normally comes when the model class is burdened with
@@ -66,7 +68,7 @@ module ActiveRecord
   # == Configuration
   #
   # In order to activate an observer, list it in the <tt>config.active_record.observers</tt> configuration setting in your
-  # <tt>config/environment.rb</tt> file.
+  # <tt>config/application.rb</tt> file.
   #
   #   config.active_record.observers = :comment_observer, :signup_observer
   #
@@ -88,21 +90,26 @@ module ActiveRecord
   #
   class Observer < ActiveModel::Observer
     class_attribute :observed_methods
-    self.observed_methods = []
+    self.observed_methods = [].freeze
 
     def initialize
       super
-      observed_subclasses.each { |klass| add_observer!(klass) }
+      observed_descendants.each { |klass| add_observer!(klass) }
     end
 
     def self.method_added(method)
       method = method.to_sym
-      observed_methods << method if ActiveRecord::Callbacks::CALLBACKS.include?(method)
+
+      if ActiveRecord::Callbacks::CALLBACKS.include?(method)
+        self.observed_methods += [method]
+        self.observed_methods.freeze
+      end
     end
 
     protected
-      def observed_subclasses
-        observed_classes.sum([]) { |klass| klass.send(:subclasses) }
+
+      def observed_descendants
+        observed_classes.sum([]) { |klass| klass.descendants }
       end
 
       def observe_callbacks?

data/lib/active_record/persistence.rb

@@ -1,6 +1,8 @@
 module ActiveRecord
+  # = Active Record Persistence
   module Persistence
-    # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet; otherwise, returns false.
+    # Returns true if this object hasn't been saved yet -- that is, a record 
+    # for the object doesn't exist in the data store yet; otherwise, returns false.
     def new_record?
       @new_record
     end
@@ -10,7 +12,8 @@ module ActiveRecord
       @destroyed
     end
 
-    # Returns if the record is persisted, i.e. it's not a new record and it was not destroyed.
+    # Returns if the record is persisted, i.e. it's not a new record and it was
+    # not destroyed.
     def persisted?
       !(new_record? || destroyed?)
     end
@@ -69,8 +72,8 @@ module ActiveRecord
       freeze
     end
 
-    # Deletes the record in the database and freezes this instance to reflect that no changes should
-    # be made (since they can't be persisted).
+    # Deletes the record in the database and freezes this instance to reflect 
+    # that no changes should be made (since they can't be persisted).
     def destroy
       if persisted?
         self.class.unscoped.where(self.class.arel_table[self.class.primary_key].eq(id)).delete_all
@@ -80,10 +83,13 @@ module ActiveRecord
       freeze
     end
 
-    # Returns an instance of the specified +klass+ with the attributes of the current record. This is mostly useful in relation to
-    # single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record
-    # identification in Action Pack to allow, say, <tt>Client < Company</tt> to do something like render <tt>:partial => @client.becomes(Company)</tt>
-    # to render that instance using the companies/company partial instead of clients/client.
+    # Returns an instance of the specified +klass+ with the attributes of the 
+    # current record. This is mostly useful in relation to single-table 
+    # inheritance structures where you want a subclass to appear as the 
+    # superclass. This can be used along with record identification in 
+    # Action Pack to allow, say, <tt>Client < Company</tt> to do something 
+    # like render <tt>:partial => @client.becomes(Company)</tt> to render that
+    # instance using the companies/company partial instead of clients/client.
     #
     # Note: The new instance will share a link to the same attributes as the original class. So any change to the attributes in either
     # instance will affect the other.
@@ -96,25 +102,52 @@ module ActiveRecord
       became
     end
 
-    # Updates a single attribute and saves the record without going through the normal validation procedure.
-    # This is especially useful for boolean flags on existing records. The regular +update_attribute+ method
-    # in Base is replaced with this when the validations module is mixed in, which it is by default.
+    # Updates a single attribute and saves the record.  
+    # This is especially useful for boolean flags on existing records. Also note that
+    #
+    # * validation is skipped
+    # * No callbacks are invoked 
+    # * updated_at/updated_on column is updated if that column is available
+    # * does not work on associations
+    # * does not work on attr_accessor attributes. The attribute that is being updated must be column name.
+    #
     def update_attribute(name, value)
-      send("#{name}=", value)
-      save(:validate => false)
+      raise ActiveRecordError, "#{name.to_s} is marked as readonly" if self.class.readonly_attributes.include? name.to_s
+
+      changes = record_update_timestamps || {}
+
+      if name
+        name = name.to_s
+        send("#{name}=", value)
+        changes[name] = read_attribute(name)
+      end
+
+      @changed_attributes.except!(*changes.keys)
+      primary_key = self.class.primary_key
+      self.class.update_all(changes, { primary_key => self[primary_key] }) == 1
     end
 
-    # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
-    # fail and false will be returned.
+    # Updates the attributes of the model from the passed-in hash and saves the
+    # record, all wrapped in a transaction. If the object is invalid, the saving
+    # will fail and false will be returned.
     def update_attributes(attributes)
-      self.attributes = attributes
-      save
+      # The following transaction covers any possible database side-effects of the
+      # attributes assignment. For example, setting the IDs of a child collection.
+      with_transaction_returning_status do
+        self.attributes = attributes
+        save
+      end
     end
 
-    # Updates an object just like Base.update_attributes but calls save! instead of save so an exception is raised if the record is invalid.
+    # Updates its receiver just like +update_attributes+ but calls <tt>save!</tt> instead
+    # of +save+, so an exception is raised if the record is invalid.
     def update_attributes!(attributes)
-      self.attributes = attributes
-      save!
+      # The following transaction covers any possible database side-effects of the
+      # attributes assignment. For example, setting the IDs of a child collection.
+      with_transaction_returning_status do
+        self.attributes = attributes
+        save!
+      end
     end
 
     # Initializes +attribute+ to zero if +nil+ and adds the value passed as +by+ (default is 1).
@@ -175,7 +208,7 @@ module ActiveRecord
     def reload(options = nil)
       clear_aggregation_cache
       clear_association_cache
-      @attributes.update(self.class.send(:with_exclusive_scope) { self.class.find(self.id, options) }.instance_variable_get('@attributes'))
+      @attributes.update(self.class.unscoped { self.class.find(self.id, options) }.instance_variable_get('@attributes'))
       @attributes_cache = {}
       self
     end
@@ -227,4 +260,4 @@ module ActiveRecord
       end
     end
   end
-end
+end

data/lib/active_record/query_cache.rb

@@ -1,6 +1,7 @@
 require 'active_support/core_ext/object/blank'
 
 module ActiveRecord
+  # = Active Record Query Cache
   class QueryCache
     module ClassMethods
       # Enable the query cache within the block if Active Record is configured.

data/lib/active_record/railtie.rb

@@ -9,24 +9,24 @@ require "active_model/railtie"
 require "action_controller/railtie"
 
 module ActiveRecord
+  # = Active Record Railtie
   class Railtie < Rails::Railtie
     config.active_record = ActiveSupport::OrderedOptions.new
 
     config.generators.orm :active_record, :migration => true,
                                           :timestamps => true
 
-    config.app_middleware.insert_after "::ActionDispatch::Callbacks",
-      "ActiveRecord::QueryCache"
-
-    config.app_middleware.insert_after "::ActionDispatch::Callbacks",
-      "ActiveRecord::ConnectionAdapters::ConnectionManagement"
+    config.app_middleware.insert_after "::ActionDispatch::Callbacks", "ActiveRecord::QueryCache"
 
     rake_tasks do
       load "active_record/railties/databases.rake"
     end
 
-    require "active_record/railties/log_subscriber"
-    log_subscriber :active_record, ActiveRecord::Railties::LogSubscriber.new
+    # When loading console, force ActiveRecord to be loaded to avoid cross
+    # references when loading a constant for the first time.
+    console do
+      ActiveRecord::Base
+    end
 
     initializer "active_record.initialize_timezone" do
       ActiveSupport.on_load(:active_record) do
@@ -68,13 +68,19 @@ module ActiveRecord
       unless app.config.cache_classes
         ActiveSupport.on_load(:active_record) do
           ActionDispatch::Callbacks.after do
-            ActiveRecord::Base.reset_subclasses
             ActiveRecord::Base.clear_reloadable_connections!
           end
         end
       end
     end
 
+    initializer "active_record.add_concurrency_middleware" do |app|
+      if app.config.allow_concurrency
+        app.config.middleware.insert_after "::ActionDispatch::Callbacks",
+          "ActiveRecord::ConnectionAdapters::ConnectionManagement"
+      end
+    end
+
     config.after_initialize do
       ActiveSupport.on_load(:active_record) do
         instantiate_observers

data/lib/active_record/railties/controller_runtime.rb

@@ -11,9 +11,9 @@ module ActiveRecord
 
       def cleanup_view_runtime
         if ActiveRecord::Base.connected?
-          db_rt_before_render = ActiveRecord::Base.connection.reset_runtime
+          db_rt_before_render = ActiveRecord::LogSubscriber.reset_runtime
           runtime = super
-          db_rt_after_render = ActiveRecord::Base.connection.reset_runtime
+          db_rt_after_render = ActiveRecord::LogSubscriber.reset_runtime
           self.db_runtime = db_rt_before_render + db_rt_after_render
           runtime - db_rt_after_render
         else

data/lib/active_record/railties/databases.rake

@@ -1,11 +1,11 @@
 namespace :db do
   task :load_config => :rails_env do
     require 'active_record'
-    ActiveRecord::Base.configurations = Rails::Application.config.database_configuration
+    ActiveRecord::Base.configurations = Rails.application.config.database_configuration
   end
 
   namespace :create do
-    desc 'Create all the local databases defined in config/database.yml'
+    # desc 'Create all the local databases defined in config/database.yml'
     task :all => :load_config do
       ActiveRecord::Base.configurations.each_value do |config|
         # Skip entries that don't have a database key, such as the first entry here:
@@ -26,7 +26,7 @@ namespace :db do
     end
   end
 
-  desc 'Create the database defined in config/database.yml for the current Rails.env - also makes test database if in development mode'
+  desc 'Create the database from config/database.yml for the current Rails.env (use db:create:all to create all dbs in the config)'
   task :create => :load_config do
     # Make the test database at the same time as the development one, if it exists
     if Rails.env.development? && ActiveRecord::Base.configurations['test']
@@ -57,7 +57,7 @@ namespace :db do
       end
     rescue
       case config['adapter']
-      when 'mysql'
+      when /mysql/
         @charset   = ENV['CHARSET']   || 'utf8'
         @collation = ENV['COLLATION'] || 'utf8_unicode_ci'
         creation_options = {:charset => (config['charset'] || @charset), :collation => (config['collation'] || @collation)}
@@ -100,7 +100,7 @@ namespace :db do
   end
 
   namespace :drop do
-    desc 'Drops all the local databases defined in config/database.yml'
+    # desc 'Drops all the local databases defined in config/database.yml'
     task :all => :load_config do
       ActiveRecord::Base.configurations.each_value do |config|
         # Skip entries that don't have a database key
@@ -115,7 +115,7 @@ namespace :db do
     end
   end
 
-  desc 'Drops the database for the current Rails.env'
+  desc 'Drops the database for the current Rails.env (use db:drop:all to drop all databases)'
   task :drop => :load_config do
     config = ActiveRecord::Base.configurations[Rails.env || 'development']
     begin
@@ -134,7 +134,7 @@ namespace :db do
   end
 
 
-  desc "Migrate the database through scripts in db/migrate and update db/schema.rb by invoking db:schema:dump. Target specific version with VERSION=x. Turn off output with VERBOSE=false."
+  desc "Migrate the database (options: VERSION=x, VERBOSE=false)."
   task :migrate => :environment do
     ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
     ActiveRecord::Migrator.migrate("db/migrate/", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
@@ -142,7 +142,7 @@ namespace :db do
   end
 
   namespace :migrate do
-    desc  'Rollbacks the database one migration and re migrate up. If you want to rollback more than one step, define STEP=x. Target specific version with VERSION=x.'
+    # desc  'Rollbacks the database one migration and re migrate up (options: STEP=x, VERSION=x).'
     task :redo => :environment do
       if ENV["VERSION"]
         Rake::Task["db:migrate:down"].invoke
@@ -153,10 +153,10 @@ namespace :db do
       end
     end
 
-    desc 'Resets your database using your migrations for the current environment'
+    # desc 'Resets your database using your migrations for the current environment'
     task :reset => ["db:drop", "db:create", "db:migrate"]
 
-    desc 'Runs the "up" for a given migration VERSION.'
+    # desc 'Runs the "up" for a given migration VERSION.'
     task :up => :environment do
       version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
       raise "VERSION is required" unless version
@@ -164,37 +164,67 @@ namespace :db do
       Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
     end
 
-    desc 'Runs the "down" for a given migration VERSION.'
+    # desc 'Runs the "down" for a given migration VERSION.'
     task :down => :environment do
       version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
       raise "VERSION is required" unless version
       ActiveRecord::Migrator.run(:down, "db/migrate/", version)
       Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
     end
+
+    desc "Display status of migrations"
+    task :status => :environment do
+      config = ActiveRecord::Base.configurations[Rails.env || 'development']
+      ActiveRecord::Base.establish_connection(config)
+      unless ActiveRecord::Base.connection.table_exists?(ActiveRecord::Migrator.schema_migrations_table_name)
+        puts 'Schema migrations table does not exist yet.'
+        next  # means "return" for rake task
+      end
+      db_list = ActiveRecord::Base.connection.select_values("SELECT version FROM #{ActiveRecord::Migrator.schema_migrations_table_name}")
+      file_list = []
+      Dir.foreach(File.join(Rails.root, 'db', 'migrate')) do |file|
+        # only files matching "20091231235959_some_name.rb" pattern
+        if match_data = /(\d{14})_(.+)\.rb/.match(file)
+          status = db_list.delete(match_data[1]) ? 'up' : 'down'
+          file_list << [status, match_data[1], match_data[2]]
+        end
+      end
+      # output
+      puts "\ndatabase: #{config['database']}\n\n"
+      puts "#{"Status".center(8)}  #{"Migration ID".ljust(14)}  Migration Name"
+      puts "-" * 50
+      file_list.each do |file|
+        puts "#{file[0].center(8)}  #{file[1].ljust(14)}  #{file[2].humanize}"
+      end
+      db_list.each do |version|
+        puts "#{'up'.center(8)}  #{version.ljust(14)}  *** NO FILE ***"
+      end
+      puts
+    end
   end
 
-  desc 'Rolls the schema back to the previous version. Specify the number of steps with STEP=n'
+  desc 'Rolls the schema back to the previous version (specify steps w/ STEP=n).'
   task :rollback => :environment do
     step = ENV['STEP'] ? ENV['STEP'].to_i : 1
     ActiveRecord::Migrator.rollback('db/migrate/', step)
     Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
   end
 
-  desc 'Pushes the schema to the next version. Specify the number of steps with STEP=n'
+  # desc 'Pushes the schema to the next version (specify steps w/ STEP=n).'
   task :forward => :environment do
     step = ENV['STEP'] ? ENV['STEP'].to_i : 1
     ActiveRecord::Migrator.forward('db/migrate/', step)
     Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
   end
 
-  desc 'Drops and recreates the database from db/schema.rb for the current environment and loads the seeds.'
+  # desc 'Drops and recreates the database from db/schema.rb for the current environment and loads the seeds.'
   task :reset => [ 'db:drop', 'db:setup' ]
 
-  desc "Retrieves the charset for the current environment's database"
+  # desc "Retrieves the charset for the current environment's database"
   task :charset => :environment do
     config = ActiveRecord::Base.configurations[Rails.env || 'development']
     case config['adapter']
-    when 'mysql'
+    when /mysql/
       ActiveRecord::Base.establish_connection(config)
       puts ActiveRecord::Base.connection.charset
     when 'postgresql'
@@ -208,11 +238,11 @@ namespace :db do
     end
   end
 
-  desc "Retrieves the collation for the current environment's database"
+  # desc "Retrieves the collation for the current environment's database"
   task :collation => :environment do
     config = ActiveRecord::Base.configurations[Rails.env || 'development']
     case config['adapter']
-    when 'mysql'
+    when /mysql/
       ActiveRecord::Base.establish_connection(config)
       puts ActiveRecord::Base.connection.collation
     else
@@ -225,7 +255,7 @@ namespace :db do
     puts "Current version: #{ActiveRecord::Migrator.current_version}"
   end
 
-  desc "Raises an error if there are pending migrations"
+  # desc "Raises an error if there are pending migrations"
   task :abort_if_pending_migrations => :environment do
     if defined? ActiveRecord
       pending_migrations = ActiveRecord::Migrator.new(:up, 'db/migrate').pending_migrations
@@ -240,11 +270,11 @@ namespace :db do
     end
   end
 
-  desc 'Create the database, load the schema, and initialize with the seed data'
+  desc 'Create the database, load the schema, and initialize with the seed data (use db:reset to also drop the db first)'
   task :setup => [ 'db:create', 'db:schema:load', 'db:seed' ]
 
   desc 'Load the seed data from db/seeds.rb'
-  task :seed => :environment do
+  task :seed => 'db:abort_if_pending_migrations' do
     seed_file = File.join(Rails.root, 'db', 'seeds.rb')
     load(seed_file) if File.exist?(seed_file)
   end
@@ -263,7 +293,7 @@ namespace :db do
       end
     end
 
-    desc "Search for a fixture given a LABEL or ID. Specify an alternative path (eg. spec/fixtures) using FIXTURES_PATH=spec/fixtures."
+    # desc "Search for a fixture given a LABEL or ID. Specify an alternative path (eg. spec/fixtures) using FIXTURES_PATH=spec/fixtures."
     task :identify => :environment do
       require 'active_record/fixtures'
 
@@ -313,7 +343,7 @@ namespace :db do
     task :dump => :environment do
       abcs = ActiveRecord::Base.configurations
       case abcs[Rails.env]["adapter"]
-      when "mysql", "oci", "oracle"
+      when /mysql/, "oci", "oracle"
         ActiveRecord::Base.establish_connection(abcs[Rails.env])
         File.open("#{Rails.root}/db/#{Rails.env}_structure.sql", "w+") { |f| f << ActiveRecord::Base.connection.structure_dump }
       when "postgresql"
@@ -347,21 +377,21 @@ namespace :db do
   end
 
   namespace :test do
-    desc "Recreate the test database from the current schema.rb"
+    # desc "Recreate the test database from the current schema.rb"
     task :load => 'db:test:purge' do
       ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
       ActiveRecord::Schema.verbose = false
       Rake::Task["db:schema:load"].invoke
     end
 
-    desc "Recreate the test database from the current environment's database schema"
+    # desc "Recreate the test database from the current environment's database schema"
     task :clone => %w(db:schema:dump db:test:load)
 
-    desc "Recreate the test databases from the development structure"
+    # desc "Recreate the test databases from the development structure"
     task :clone_structure => [ "db:structure:dump", "db:test:purge" ] do
       abcs = ActiveRecord::Base.configurations
       case abcs["test"]["adapter"]
-      when "mysql"
+      when /mysql/
         ActiveRecord::Base.establish_connection(:test)
         ActiveRecord::Base.connection.execute('SET foreign_key_checks = 0')
         IO.readlines("#{Rails.root}/db/#{Rails.env}_structure.sql").join.split("\n\n").each do |table|
@@ -391,11 +421,11 @@ namespace :db do
       end
     end
 
-    desc "Empty the test database"
+    # desc "Empty the test database"
     task :purge => :environment do
       abcs = ActiveRecord::Base.configurations
       case abcs["test"]["adapter"]
-      when "mysql"
+      when /mysql/
         ActiveRecord::Base.establish_connection(:test)
         ActiveRecord::Base.connection.recreate_database(abcs["test"]["database"], abcs["test"])
       when "postgresql"
@@ -422,7 +452,7 @@ namespace :db do
       end
     end
 
-    desc 'Check for pending migrations and load the test schema'
+    # desc 'Check for pending migrations and load the test schema'
     task :prepare => 'db:abort_if_pending_migrations' do
       if defined?(ActiveRecord) && !ActiveRecord::Base.configurations.blank?
         Rake::Task[{ :sql  => "db:test:clone_structure", :ruby => "db:test:load" }[ActiveRecord::Base.schema_format]].invoke
@@ -431,7 +461,7 @@ namespace :db do
   end
 
   namespace :sessions do
-    desc "Creates a sessions migration for use with ActiveRecord::SessionStore"
+    # desc "Creates a sessions migration for use with ActiveRecord::SessionStore"
     task :create => :environment do
       raise "Task unavailable to this database (no migration support)" unless ActiveRecord::Base.connection.supports_migrations?
       require 'rails/generators'
@@ -440,7 +470,7 @@ namespace :db do
       Rails::Generators::SessionMigrationGenerator.start [ ENV["MIGRATION"] || "add_sessions_table" ]
     end
 
-    desc "Clear the sessions table"
+    # desc "Clear the sessions table"
     task :clear => :environment do
       ActiveRecord::Base.connection.execute "DELETE FROM #{session_table_name}"
     end
@@ -451,7 +481,7 @@ task 'test:prepare' => 'db:test:prepare'
 
 def drop_database(config)
   case config['adapter']
-  when 'mysql'
+  when /mysql/
     ActiveRecord::Base.establish_connection(config)
     ActiveRecord::Base.connection.drop_database config['database']
   when /^sqlite/