activerecord 1.0.0 → 2.0.0

data/lib/active_record/observer.rb

@@ -1,38 +1,105 @@
 require 'singleton'
+require 'set'
 
 module ActiveRecord
-  # Observers can be programmed to react to lifecycle callbacks in another class 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 excess responsibility that doesn't pertain to
-  # the core and nature of the class. Example:
+  module Observing # :nodoc:
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Activates the observers assigned. Examples:
+      #
+      #   # Calls PersonObserver.instance
+      #   ActiveRecord::Base.observers = :person_observer
+      #
+      #   # Calls Cacher.instance and GarbageCollector.instance
+      #   ActiveRecord::Base.observers = :cacher, :garbage_collector
+      #
+      #   # Same as above, just using explicit class references
+      #   ActiveRecord::Base.observers = Cacher, GarbageCollector
+      #
+      # Note: Setting this does not instantiate the observers yet.  #instantiate_observers is
+      # called during startup, and before each development request.  
+      def observers=(*observers)
+        @observers = observers.flatten
+      end
+
+      # Gets the current observers.
+      def observers
+        @observers ||= []
+      end
+
+      # Instantiate the global ActiveRecord observers
+      def instantiate_observers
+        return if @observers.blank?
+        @observers.each do |observer|
+          if observer.respond_to?(:to_sym) # Symbol or String
+            observer.to_s.camelize.constantize.instance
+          elsif observer.respond_to?(:instance)
+            observer.instance
+          else
+            raise ArgumentError, "#{observer} must be a lowercase, underscored class name (or an instance of the class itself) responding to the instance method. Example: Person.observers = :big_brother # calls BigBrother.instance"
+          end
+        end
+      end
+
+      protected
+        # Notify observers when the observed class is subclassed.
+        def inherited(subclass)
+          super
+          changed
+          notify_observers :observed_class_inherited, subclass
+        end
+    end
+  end
+
+  # 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
+  # functionality that doesn't pertain to the core responsibility of the
+  # class. Example:
   #
   #   class CommentObserver < ActiveRecord::Observer
   #     def after_save(comment)
-  #       NotificationServer.send_email("admin@do.com", "New comment was posted", comment)
+  #       Notifications.deliver_comment("admin@do.com", "New comment was posted", comment)
   #     end
   #   end
   #
-  # This Observer is triggered when a Comment#save is finished and sends a notification about it to the administrator.
+  # This Observer sends an email when a Comment#save is finished.
   #
-  # == Observing a class that can't be infered
+  #   class ContactObserver < ActiveRecord::Observer
+  #     def after_create(contact)
+  #       contact.logger.info('New contact added!')
+  #     end
+  #
+  #     def after_destroy(contact)
+  #       contact.logger.warn("Contact with an id of #{contact.id} was destroyed!")
+  #     end
+  #   end
+  #
+  # This Observer uses logger to log when specific callbacks are triggered.
+  #
+  # == Observing a class that can't be inferred
   #
   # Observers will by default be mapped to the class with which they share a name. So CommentObserver will
   # be tied to observing Comment, ProductManagerObserver to ProductManager, and so on. If you want to name your observer
-  # something else than the class you're interested in observing, you can implement the observed_class class method. Like this:
+  # differently than the class you're interested in observing, you can use the Observer.observe class method which takes
+  # either the concrete class (Product) or a symbol for that class (:product):
   #
   #   class AuditObserver < ActiveRecord::Observer
-  #     def self.observed_class() Account end
+  #     observe :account
+  #
   #     def after_update(account)
   #       AuditTrail.new(account, "UPDATED")
   #     end
   #   end
   #
-  # == Observing multiple classes at once
-  #
-  # If the audit observer needs to watch more than one kind of object, this can be specified in an array, like this:
+  # If the audit observer needs to watch more than one kind of object, this can be specified with multiple arguments:
   #
   #   class AuditObserver < ActiveRecord::Observer
-  #     def self.observed_class() [ Account, Balance ] end
+  #     observe :account, :balance
+  #
   #     def after_update(record)
   #       AuditTrail.new(record, "UPDATED")
   #     end
@@ -40,32 +107,75 @@ module ActiveRecord
   #
   # The AuditObserver will now act on both updates to Account and Balance by treating them both as records.
   #
+  # == Available callback methods
+  #
   # The observer can implement callback methods for each of the methods described in the Callbacks module.
+  #
+  # == Storing Observers in Rails
+  #
+  # If you're using Active Record within Rails, observer classes are usually stored in app/models with the
+  # naming convention of app/models/audit_observer.rb.
+  #
+  # == 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.
+  #
+  #   config.active_record.observers = :comment_observer, :signup_observer
+  #
+  # Observers will not be invoked unless you define these in your application configuration.
+  #
   class Observer
     include Singleton
-  
-    def initialize
-      [ observed_class ].flatten.each do |klass| 
-        klass.add_observer(self)
-        klass.send(:define_method, :after_find) unless klass.respond_to?(:after_find)
+
+    class << self
+      # Attaches the observer to the supplied model classes.
+      def observe(*models)
+        models.flatten!
+        models.collect! { |model| model.is_a?(Symbol) ? model.to_s.camelize.constantize : model }
+        define_method(:observed_classes) { Set.new(models) }
       end
-    end
-  
-    def update(callback_method, object)
-      send(callback_method, object) if respond_to?(callback_method)
-    end
-    
-    private
+
+      # The class observed by default is inferred from the observer's class name:
+      #   assert_equal [Person], PersonObserver.observed_class
       def observed_class
-        if self.class.respond_to? "observed_class"
-          self.class.observed_class
+        if observed_class_name = name.scan(/(.*)Observer/)[0]
+          observed_class_name[0].constantize
         else
-          Object.const_get(infer_observed_class_name)
+          nil
         end
       end
-      
-      def infer_observed_class_name
-        self.class.name.scan(/(.*)Observer/)[0][0]
+    end
+
+    # Start observing the declared classes and their subclasses.
+    def initialize
+      Set.new(observed_classes + observed_subclasses).each { |klass| add_observer! klass }
+    end
+
+    # Send observed_method(object) if the method exists.
+    def update(observed_method, object) #:nodoc:
+      send(observed_method, object) if respond_to?(observed_method)
+    end
+
+    # Special method sent by the observed class when it is inherited.
+    # Passes the new subclass.
+    def observed_class_inherited(subclass) #:nodoc:
+      self.class.observe(observed_classes + [subclass])
+      add_observer!(subclass)
+    end
+
+    protected
+      def observed_classes
+        Set.new([self.class.observed_class].compact.flatten)
+      end
+
+      def observed_subclasses
+        observed_classes.collect(&:subclasses).flatten
+      end
+
+      def add_observer!(klass)
+        klass.add_observer(self)
+        klass.class_eval 'def after_find() end' unless klass.respond_to?(:after_find)
       end
   end
-end
+end

data/lib/active_record/query_cache.rb

@@ -0,0 +1,23 @@
+module ActiveRecord
+  module QueryCache
+    # Enable the query cache within the block if Active Record is configured.
+    def cache(&block)
+      if ActiveRecord::Base.configurations.blank?
+        yield
+      else
+        connection.cache(&block)
+      end
+    rescue
+      yield # if the database is not present, don't let the cache spoil the party
+    end
+
+    # Disable the query cache within the block if Active Record is configured.
+    def uncached(&block)
+      if ActiveRecord::Base.configurations.blank?
+        yield
+      else
+        connection.uncached(&block)
+      end
+    end
+  end
+end

data/lib/active_record/reflection.rb

@@ -1,126 +1,219 @@
 module ActiveRecord
   module Reflection # :nodoc:
-    def self.append_features(base)
-      super
+    def self.included(base)
       base.extend(ClassMethods)
-
-      base.class_eval do
-        class << self
-          alias_method :composed_of_without_reflection, :composed_of
-
-          def composed_of_with_reflection(part_id, options = {})
-            composed_of_without_reflection(part_id, options)
-            write_inheritable_array "aggregations", [ AggregateReflection.new(part_id, options, self) ]
-          end
-
-          alias_method :composed_of, :composed_of_with_reflection          
-        end
-      end
-      
-      for association_type in %w( belongs_to has_one has_many has_and_belongs_to_many )
-        base.module_eval <<-"end_eval"
-          class << self
-            alias_method :#{association_type}_without_reflection, :#{association_type}
-
-            def #{association_type}_with_reflection(association_id, options = {})
-              #{association_type}_without_reflection(association_id, options)
-              write_inheritable_array "associations", [ AssociationReflection.new(association_id, options, self) ]
-            end
-
-            alias_method :#{association_type}, :#{association_type}_with_reflection          
-          end
-        end_eval
-      end
     end
 
-    # Reflection allows you to interrogate Active Record classes and objects about their associations and aggregations. 
-    # This information can for example be used in a form builder that took an Active Record object and created input
+    # Reflection allows you to interrogate Active Record classes and objects about their associations and aggregations.
+    # This information can, for example, be used in a form builder that took an Active Record object and created input
     # fields for all of the attributes depending on their type and displayed the associations to other objects.
     #
     # You can find the interface for the AggregateReflection and AssociationReflection classes in the abstract MacroReflection class.
     module ClassMethods
+      def create_reflection(macro, name, options, active_record)
+        case macro
+          when :has_many, :belongs_to, :has_one, :has_and_belongs_to_many
+            reflection = AssociationReflection.new(macro, name, options, active_record)
+          when :composed_of
+            reflection = AggregateReflection.new(macro, name, options, active_record)
+        end
+        write_inheritable_hash :reflections, name => reflection
+        reflection
+      end
+      
+      # Returns a hash containing all AssociationReflection objects for the current class
+      # Example:
+      #
+      #   Invoice.reflections
+      #   Account.reflections
+      #
+      def reflections
+        read_inheritable_attribute(:reflections) || write_inheritable_attribute(:reflections, {})
+      end
+       
       # Returns an array of AggregateReflection objects for all the aggregations in the class.
       def reflect_on_all_aggregations
-        read_inheritable_attribute "aggregations"
+        reflections.values.select { |reflection| reflection.is_a?(AggregateReflection) }
       end
-      
+
       # Returns the AggregateReflection object for the named +aggregation+ (use the symbol). Example:
+      #
       #   Account.reflect_on_aggregation(:balance) # returns the balance AggregateReflection
+      #
       def reflect_on_aggregation(aggregation)
-        reflect_on_all_aggregations.find { |reflection| reflection.name == aggregation } unless reflect_on_all_aggregations.nil?
+        reflections[aggregation].is_a?(AggregateReflection) ? reflections[aggregation] : nil
       end
 
-      # Returns an array of AssociationReflection objects for all the aggregations in the class.
-      def reflect_on_all_associations
-        read_inheritable_attribute "associations"
+      # Returns an array of AssociationReflection objects for all the associations in the class. If you only want to reflect on a
+      # certain association type, pass in the symbol (:has_many, :has_one, :belongs_to) for that as the first parameter. 
+      # Example:
+      #
+      #   Account.reflect_on_all_associations             # returns an array of all associations
+      #   Account.reflect_on_all_associations(:has_many)  # returns an array of all has_many associations
+      #
+      def reflect_on_all_associations(macro = nil)
+        association_reflections = reflections.values.select { |reflection| reflection.is_a?(AssociationReflection) }
+        macro ? association_reflections.select { |reflection| reflection.macro == macro } : association_reflections
       end
-      
-      # Returns the AssociationReflection object for the named +aggregation+ (use the symbol). Example:
+
+      # Returns the AssociationReflection object for the named +association+ (use the symbol). Example:
+      #
       #   Account.reflect_on_association(:owner) # returns the owner AssociationReflection
+      #   Invoice.reflect_on_association(:line_items).macro  # returns :has_many
+      #
       def reflect_on_association(association)
-        reflect_on_all_associations.find { |reflection| reflection.name == association } unless reflect_on_all_associations.nil?
+        reflections[association].is_a?(AssociationReflection) ? reflections[association] : nil
       end
     end
-    
 
-    # Abstract base class for AggregateReflection and AssociationReflection that describes the interface available for both of 
+
+    # Abstract base class for AggregateReflection and AssociationReflection that describes the interface available for both of
     # those classes. Objects of AggregateReflection and AssociationReflection are returned by the Reflection::ClassMethods.
     class MacroReflection
       attr_reader :active_record
-      def initialize(name, options, active_record)
-        @name, @options, @active_record = name, options, active_record
+
+      def initialize(macro, name, options, active_record)
+        @macro, @name, @options, @active_record = macro, name, options, active_record
       end
-      
+
       # Returns the name of the macro, so it would return :balance for "composed_of :balance, :class_name => 'Money'" or
       # :clients for "has_many :clients".
       def name
         @name
       end
-      
-      # Returns the hash of options used for the macro, so it would return { :class_name => "Money" } for 
+
+      # Returns the type of the macro, so it would return :composed_of for
+      # "composed_of :balance, :class_name => 'Money'" or :has_many for "has_many :clients".
+      def macro
+        @macro
+      end
+
+      # Returns the hash of options used for the macro, so it would return { :class_name => "Money" } for
       # "composed_of :balance, :class_name => 'Money'" or {} for "has_many :clients".
       def options
         @options
       end
-      
-      # Returns the class for the macro, so "composed_of :balance, :class_name => 'Money'" would return the Money class and
-      # "has_many :clients" would return the Client class.
-      def klass() end
-      
+
+      # Returns the class for the macro, so "composed_of :balance, :class_name => 'Money'" returns the Money class and
+      # "has_many :clients" returns the Client class.
+      def klass
+        @klass ||= class_name.constantize
+      end
+
+      def class_name
+        @class_name ||= options[:class_name] || derive_class_name
+      end
+
       def ==(other_aggregation)
         name == other_aggregation.name && other_aggregation.options && active_record == other_aggregation.active_record
       end
+
+      private
+        def derive_class_name
+          name.to_s.camelize
+        end
     end
 
 
     # Holds all the meta-data about an aggregation as it was specified in the Active Record class.
     class AggregateReflection < MacroReflection #:nodoc:
-      def klass
-        Object.const_get(options[:class_name] || name_to_class_name(name.id2name)) 
-      end
-      
-      private
-        def name_to_class_name(name)
-          name.capitalize.gsub(/_(.)/) { |s| $1.capitalize }
-        end
     end
 
     # Holds all the meta-data about an association as it was specified in the Active Record class.
     class AssociationReflection < MacroReflection #:nodoc:
       def klass
-        active_record.send(:compute_type, (name_to_class_name(name.id2name)))
+        @klass ||= active_record.send(:compute_type, class_name)
+      end
+
+      def table_name
+        @table_name ||= klass.table_name
+      end
+
+      def primary_key_name
+        @primary_key_name ||= options[:foreign_key] || derive_primary_key_name
+      end
+
+      def association_foreign_key
+        @association_foreign_key ||= @options[:association_foreign_key] || class_name.foreign_key
+      end
+
+      def counter_cache_column
+        if options[:counter_cache] == true
+          "#{active_record.name.underscore.pluralize}_count"
+        elsif options[:counter_cache]
+          options[:counter_cache]
+        end
+      end
+
+      def through_reflection
+        @through_reflection ||= options[:through] ? active_record.reflect_on_association(options[:through]) : false
+      end
+
+      # Gets an array of possible :through source reflection names
+      #
+      #   [singularized, pluralized]
+      #
+      def source_reflection_names
+        @source_reflection_names ||= (options[:source] ? [options[:source]] : [name.to_s.singularize, name]).collect { |n| n.to_sym }
+      end
+
+      # Gets the source of the through reflection.  It checks both a singularized and pluralized form for :belongs_to or :has_many.
+      # (The :tags association on Tagging below)
+      # 
+      #   class Post
+      #     has_many :tags, :through => :taggings
+      #   end
+      #
+      def source_reflection
+        return nil unless through_reflection
+        @source_reflection ||= source_reflection_names.collect { |name| through_reflection.klass.reflect_on_association(name) }.compact.first
+      end
+
+      def check_validity!
+        if options[:through]
+          if through_reflection.nil?
+            raise HasManyThroughAssociationNotFoundError.new(active_record.name, self)
+          end
+          
+          if source_reflection.nil?
+            raise HasManyThroughSourceAssociationNotFoundError.new(self)
+          end
+
+          if options[:source_type] && source_reflection.options[:polymorphic].nil?
+            raise HasManyThroughAssociationPointlessSourceTypeError.new(active_record.name, self, source_reflection)
+          end
+          
+          if source_reflection.options[:polymorphic] && options[:source_type].nil?
+            raise HasManyThroughAssociationPolymorphicError.new(active_record.name, self, source_reflection)
+          end
+          
+          unless [:belongs_to, :has_many].include?(source_reflection.macro) && source_reflection.options[:through].nil?
+            raise HasManyThroughSourceAssociationMacroError.new(self)
+          end
+        end
       end
 
       private
-        def name_to_class_name(name)
-          if name !~ /::/
-            class_name = active_record.send(
-              :type_name_with_module, 
-              (options[:class_name] || active_record.class_name(active_record.table_name_prefix + name + active_record.table_name_suffix))
-            )
+        def derive_class_name
+          # get the class_name of the belongs_to association of the through reflection
+          if through_reflection
+            options[:source_type] || source_reflection.class_name
+          else
+            class_name = name.to_s.camelize
+            class_name = class_name.singularize if [ :has_many, :has_and_belongs_to_many ].include?(macro)
+            class_name
+          end
+        end
+
+        def derive_primary_key_name
+          if macro == :belongs_to
+            "#{name}_id"
+          elsif options[:as]
+            "#{options[:as]}_id"
+          else
+            active_record.name.foreign_key
           end
-          return class_name || name
         end
     end
   end
-end
+end

data/lib/active_record/schema.rb

@@ -0,0 +1,58 @@
+module ActiveRecord
+  # Allows programmers to programmatically define a schema in a portable
+  # DSL. This means you can define tables, indexes, etc. without using SQL
+  # directly, so your applications can more easily support multiple
+  # databases.
+  #
+  # Usage:
+  #
+  #   ActiveRecord::Schema.define do
+  #     create_table :authors do |t|
+  #       t.string :name, :null => false
+  #     end
+  #
+  #     add_index :authors, :name, :unique
+  #
+  #     create_table :posts do |t|
+  #       t.integer :author_id, :null => false
+  #       t.string :subject
+  #       t.text :body
+  #       t.boolean :private, :default => false
+  #     end
+  #
+  #     add_index :posts, :author_id
+  #   end
+  #
+  # ActiveRecord::Schema is only supported by database adapters that also
+  # support migrations, the two features being very similar.
+  class Schema < Migration
+    private_class_method :new
+
+    # Eval the given block. All methods available to the current connection
+    # adapter are available within the block, so you can easily use the
+    # database definition DSL to build up your schema (#create_table,
+    # #add_index, etc.).
+    #
+    # The +info+ hash is optional, and if given is used to define metadata
+    # about the current schema (like the schema's version):
+    #
+    #   ActiveRecord::Schema.define(:version => 15) do
+    #     ...
+    #   end
+    def self.define(info={}, &block)
+      instance_eval(&block)
+
+      unless info.empty?
+        initialize_schema_information
+        cols = columns('schema_info')
+
+        info = info.map do |k,v|
+          v = Base.connection.quote(v, cols.detect { |c| c.name == k.to_s })
+          "#{k} = #{v}"
+        end
+
+        Base.connection.update "UPDATE #{Migrator.schema_info_table_name} SET #{info.join(", ")}"
+      end
+    end
+  end
+end