activerecord 1.0.0 → 3.0.0

data/lib/active_record/associations/has_many_association.rb

@@ -1,104 +1,128 @@
 module ActiveRecord
+  # = Active Record Has Many Association
   module Associations
+    # This is the proxy that handles a has many association.
+    #
+    # If the association has a <tt>:through</tt> option further specialization
+    # is provided by its child HasManyThroughAssociation.
     class HasManyAssociation < AssociationCollection #:nodoc:
-      def initialize(owner, association_name, association_class_name, association_class_primary_key_name, options)
-        super(owner, association_name, association_class_name, association_class_primary_key_name, options)
-        @conditions = options[:conditions]
-        
-        if options[:finder_sql]
-          @counter_sql = options[:finder_sql].gsub(/SELECT (.*) FROM/, "SELECT COUNT(*) FROM")
-          @finder_sql = options[:finder_sql]
-        else
-          @counter_sql = "#{@association_class_primary_key_name} = '#{@owner.id}'#{@conditions ? " AND " + @conditions : ""}"
-          @finder_sql = "#{@association_class_primary_key_name} = '#{@owner.id}' #{@conditions ? " AND " + @conditions : ""}"   
-        end
-      end
-      
-      def <<(record)
-        raise ActiveRecord::AssociationTypeMismatch unless @association_class === record
-        record.send(@association_class_primary_key_name + "=", @owner.id)
-        record.save(false)
-        @collection_array << record unless @collection_array.nil?
-      end
- 
-      def delete(records)
-        duplicated_records_array(records).each do |record|
-          next if record.send(@association_class_primary_key_name) != @owner.id
-          record.send(@association_class_primary_key_name + "=", nil)
-          record.save(false)
-          @collection_array.delete(record) unless @collection_array.nil?
-        end
-      end
-      
-      def create(attributes = {})
-        # We can't use the regular Base.create method as the foreign key might be a protected attribute, hence the repetion
-        record = @association_class.new(attributes || {})
-        record.send(@association_class_primary_key_name + "=", @owner.id)
-        record.save
-
-        @collection_array << record unless @collection_array.nil?
-        
-        return record
+      def initialize(owner, reflection)
+        @finder_sql = nil
+        super
       end
-
-      def build(attributes = {})
-        association = @association_class.new
-        association.attributes = attributes.merge({ "#{@association_class_primary_key_name}" => @owner.id})
-        association
-      end
-      
-      def find_all(runtime_conditions = nil, orderings = nil, limit = nil, joins = nil, &block)
-        if block_given? || @options[:finder_sql]
-          load_collection_to_array
-          @collection_array.send(:find_all, &block)
-        else
-          @association_class.find_all(
-              "#{@association_class_primary_key_name} = '#{@owner.id}' " +
-              "#{@conditions ? " AND " + @conditions : ""} #{runtime_conditions ? " AND " + runtime_conditions : ""}",
-              orderings, 
-              limit, 
-              joins
-            )
-        end
-      end
-
-      def find(association_id = nil, &block)
-        if block_given? || @options[:finder_sql]
-          load_collection_to_array
-          return @collection_array.send(:find, &block)
-        else
-          @association_class.find_on_conditions(
-              association_id, "#{@association_class_primary_key_name} = '#{@owner.id}' #{@conditions ? " AND " + @conditions : ""}"
-            )
-        end
-      end
-      
       protected
-        def find_all_records
-          if @options[:finder_sql]
-            @association_class.find_by_sql(@finder_sql)
+        def owner_quoted_id
+          if @reflection.options[:primary_key]
+            quote_value(@owner.send(@reflection.options[:primary_key]))
           else
-            @association_class.find_all(@finder_sql, @options[:order] ? @options[:order] : nil)
+            @owner.quoted_id
           end
         end
-        
+
+        # Returns the number of records in this collection.
+        #
+        # If the association has a counter cache it gets that value. Otherwise
+        # it will attempt to do a count via SQL, bounded to <tt>:limit</tt> if
+        # there's one.  Some configuration options like :group make it impossible
+        # to do an SQL count, in those cases the array count will be used.
+        #
+        # That does not depend on whether the collection has already been loaded
+        # or not. The +size+ method is the one that takes the loaded flag into
+        # account and delegates to +count_records+ if needed.
+        #
+        # If the collection is empty the target is set to an empty array and
+        # the loaded flag is set to true as well.
         def count_records
-          if has_cached_counter?
+          count = if has_cached_counter?
             @owner.send(:read_attribute, cached_counter_attribute_name)
-          elsif @options[:finder_sql]
-            @association_class.count_by_sql(@counter_sql)
+          elsif @reflection.options[:counter_sql]
+            @reflection.klass.count_by_sql(@counter_sql)
           else
-            @association_class.count(@counter_sql)
+            @reflection.klass.count(:conditions => @counter_sql, :include => @reflection.options[:include])
           end
+
+          # If there's nothing in the database and @target has no new records
+          # we are certain the current target is an empty array. This is a
+          # documented side-effect of the method that may avoid an extra SELECT.
+          @target ||= [] and loaded if count == 0
+
+          if @reflection.options[:limit]
+            count = [ @reflection.options[:limit], count ].min
+          end
+
+          return count
         end
-        
+
         def has_cached_counter?
           @owner.attribute_present?(cached_counter_attribute_name)
         end
-        
+
         def cached_counter_attribute_name
-          @association_name + "_count"
+          "#{@reflection.name}_count"
+        end
+
+        def insert_record(record, force = false, validate = true)
+          set_belongs_to_association_for(record)
+          force ? record.save! : record.save(:validate => validate)
+        end
+
+        # Deletes the records according to the <tt>:dependent</tt> option.
+        def delete_records(records)
+          case @reflection.options[:dependent]
+            when :destroy
+              records.each { |r| r.destroy }
+            when :delete_all
+              @reflection.klass.delete(records.map { |record| record.id })
+            else
+              relation = Arel::Table.new(@reflection.table_name)
+              relation.where(relation[@reflection.primary_key_name].eq(@owner.id).
+                  and(relation[@reflection.klass.primary_key].in(records.map { |r| r.id }))
+              ).update(relation[@reflection.primary_key_name] => nil)
+
+              @owner.class.update_counters(@owner.id, cached_counter_attribute_name => -records.size) if has_cached_counter?
+          end
+        end
+
+        def target_obsolete?
+          false
+        end
+
+        def construct_sql
+          case
+            when @reflection.options[:finder_sql]
+              @finder_sql = interpolate_sql(@reflection.options[:finder_sql])
+
+            when @reflection.options[:as]
+              @finder_sql =
+                "#{@reflection.quoted_table_name}.#{@reflection.options[:as]}_id = #{owner_quoted_id} AND " +
+                "#{@reflection.quoted_table_name}.#{@reflection.options[:as]}_type = #{@owner.class.quote_value(@owner.class.base_class.name.to_s)}"
+              @finder_sql << " AND (#{conditions})" if conditions
+
+            else
+              @finder_sql = "#{@reflection.quoted_table_name}.#{@reflection.primary_key_name} = #{owner_quoted_id}"
+              @finder_sql << " AND (#{conditions})" if conditions
+          end
+
+          construct_counter_sql
+        end
+
+        def construct_scope
+          create_scoping = {}
+          set_belongs_to_association_for(create_scoping)
+          {
+            :find => { :conditions => @finder_sql,
+                       :readonly => false,
+                       :order => @reflection.options[:order],
+                       :limit => @reflection.options[:limit],
+                       :include => @reflection.options[:include]},
+            :create => create_scoping
+          }
+        end
+
+        def we_can_set_the_inverse_on_this?(record)
+          inverse = @reflection.inverse_of
+          return !inverse.nil?
         end
     end
   end
-end
+end

data/lib/active_record/associations/has_many_through_association.rb

@@ -0,0 +1,116 @@
+require "active_record/associations/through_association_scope"
+require 'active_support/core_ext/object/blank'
+
+module ActiveRecord
+  # = Active Record Has Many Through Association
+  module Associations
+    class HasManyThroughAssociation < HasManyAssociation #:nodoc:
+      include ThroughAssociationScope
+
+      alias_method :new, :build
+
+      def create!(attrs = nil)
+        create_record(attrs, true)
+      end
+
+      def create(attrs = nil)
+        create_record(attrs, false)
+      end
+
+      def destroy(*records)
+        transaction do
+          delete_records(flatten_deeper(records))
+          super
+        end
+      end
+
+      # Returns the size of the collection by executing a SELECT COUNT(*) query if the collection hasn't been
+      # loaded and calling collection.size if it has. If it's more likely than not that the collection does
+      # have a size larger than zero, and you need to fetch that collection afterwards, it'll take one fewer
+      # SELECT query if you use #length.
+      def size
+        return @owner.send(:read_attribute, cached_counter_attribute_name) if has_cached_counter?
+        return @target.size if loaded?
+        return count
+      end
+
+      protected
+        def create_record(attrs, force = true)
+          ensure_owner_is_not_new
+
+          transaction do
+            object = @reflection.klass.new(attrs)
+            add_record_to_target_with_callbacks(object) {|r| insert_record(object, force) }
+            object
+          end
+        end
+
+        def target_reflection_has_associated_record?
+          if @reflection.through_reflection.macro == :belongs_to && @owner[@reflection.through_reflection.primary_key_name].blank?
+            false
+          else
+            true
+          end
+        end
+
+        def construct_find_options!(options)
+          options[:joins]   = construct_joins(options[:joins])
+          options[:include] = @reflection.source_reflection.options[:include] if options[:include].nil? && @reflection.source_reflection.options[:include]
+        end
+
+        def insert_record(record, force = true, validate = true)
+          if record.new_record?
+            if force
+              record.save!
+            else
+              return false unless record.save(:validate => validate)
+            end
+          end
+
+          through_association = @owner.send(@reflection.through_reflection.name)
+          through_record = through_association.create!(construct_join_attributes(record))
+          through_association.proxy_target << through_record
+        end
+
+        # TODO - add dependent option support
+        def delete_records(records)
+          klass = @reflection.through_reflection.klass
+          records.each do |associate|
+            klass.delete_all(construct_join_attributes(associate))
+          end
+        end
+
+        def find_target
+          return [] unless target_reflection_has_associated_record?
+          with_scope(construct_scope) { @reflection.klass.find(:all) }
+        end
+
+        def construct_sql
+          case
+            when @reflection.options[:finder_sql]
+              @finder_sql = interpolate_sql(@reflection.options[:finder_sql])
+
+              @finder_sql = "#{@reflection.quoted_table_name}.#{@reflection.primary_key_name} = #{owner_quoted_id}"
+              @finder_sql << " AND (#{conditions})" if conditions
+            else
+              @finder_sql = construct_conditions
+          end
+
+          construct_counter_sql
+        end
+
+        def has_cached_counter?
+          @owner.attribute_present?(cached_counter_attribute_name)
+        end
+
+        def cached_counter_attribute_name
+          "#{@reflection.name}_count"
+        end
+
+        # NOTE - not sure that we can actually cope with inverses here
+        def we_can_set_the_inverse_on_this?(record)
+          false
+        end
+    end
+  end
+end

data/lib/active_record/associations/has_one_association.rb

@@ -0,0 +1,143 @@
+module ActiveRecord
+  # = Active Record Belongs To Has One Association
+  module Associations
+    class HasOneAssociation < AssociationProxy #:nodoc:
+      def initialize(owner, reflection)
+        super
+        construct_sql
+      end
+
+      def create(attrs = {}, replace_existing = true)
+        new_record(replace_existing) do |reflection|
+          attrs = merge_with_conditions(attrs)
+          reflection.create_association(attrs)
+        end
+      end
+
+      def create!(attrs = {}, replace_existing = true)
+        new_record(replace_existing) do |reflection|
+          attrs = merge_with_conditions(attrs)
+          reflection.create_association!(attrs)
+        end
+      end
+
+      def build(attrs = {}, replace_existing = true)
+        new_record(replace_existing) do |reflection|
+          attrs = merge_with_conditions(attrs)
+          reflection.build_association(attrs)
+        end
+      end
+
+      def replace(obj, dont_save = false)
+        load_target
+
+        unless @target.nil? || @target == obj
+          if dependent? && !dont_save
+            case @reflection.options[:dependent]
+            when :delete
+              @target.delete unless @target.new_record?
+              @owner.clear_association_cache
+            when :destroy
+              @target.destroy unless @target.new_record?
+              @owner.clear_association_cache
+            when :nullify
+              @target[@reflection.primary_key_name] = nil
+              @target.save unless @owner.new_record? || @target.new_record?
+            end
+          else
+            @target[@reflection.primary_key_name] = nil
+            @target.save unless @owner.new_record? || @target.new_record?
+          end
+        end
+
+        if obj.nil?
+          @target = nil
+        else
+          raise_on_type_mismatch(obj)
+          set_belongs_to_association_for(obj)
+          @target = (AssociationProxy === obj ? obj.target : obj)
+        end
+
+        set_inverse_instance(obj, @owner)
+        @loaded = true
+
+        unless @owner.new_record? or obj.nil? or dont_save
+          return (obj.save ? self : false)
+        else
+          return (obj.nil? ? nil : self)
+        end
+      end
+
+      protected
+        def owner_quoted_id
+          if @reflection.options[:primary_key]
+            @owner.class.quote_value(@owner.send(@reflection.options[:primary_key]))
+          else
+            @owner.quoted_id
+          end
+        end
+
+      private
+        def find_target
+          options = @reflection.options.dup
+          (options.keys - [:select, :order, :include, :readonly]).each do |key|
+            options.delete key
+          end
+          options[:conditions] = @finder_sql
+
+          the_target = @reflection.klass.find(:first, options)
+          set_inverse_instance(the_target, @owner)
+          the_target
+        end
+
+        def construct_sql
+          case
+            when @reflection.options[:as]
+              @finder_sql =
+                "#{@reflection.quoted_table_name}.#{@reflection.options[:as]}_id = #{owner_quoted_id} AND " +
+                "#{@reflection.quoted_table_name}.#{@reflection.options[:as]}_type = #{@owner.class.quote_value(@owner.class.base_class.name.to_s)}"
+            else
+              @finder_sql = "#{@reflection.quoted_table_name}.#{@reflection.primary_key_name} = #{owner_quoted_id}"
+          end
+          @finder_sql << " AND (#{conditions})" if conditions
+        end
+
+        def construct_scope
+          create_scoping = {}
+          set_belongs_to_association_for(create_scoping)
+          { :create => create_scoping }
+        end
+
+        def new_record(replace_existing)
+          # Make sure we load the target first, if we plan on replacing the existing
+          # instance. Otherwise, if the target has not previously been loaded
+          # elsewhere, the instance we create will get orphaned.
+          load_target if replace_existing
+          record = @reflection.klass.send(:with_scope, :create => construct_scope[:create]) do
+            yield @reflection
+          end
+
+          if replace_existing
+            replace(record, true)
+          else
+            record[@reflection.primary_key_name] = @owner.id unless @owner.new_record?
+            self.target = record
+            set_inverse_instance(record, @owner)
+          end
+
+          record
+        end
+
+        def we_can_set_the_inverse_on_this?(record)
+          inverse = @reflection.inverse_of
+          return !inverse.nil?
+        end
+
+        def merge_with_conditions(attrs={})
+          attrs ||= {}
+          attrs.update(@reflection.options[:conditions]) if @reflection.options[:conditions].is_a?(Hash)
+          attrs
+        end
+    end
+  end
+end

data/lib/active_record/associations/has_one_through_association.rb

@@ -0,0 +1,40 @@
+require "active_record/associations/through_association_scope"
+
+module ActiveRecord
+  # = Active Record Has One Through Association
+  module Associations
+    class HasOneThroughAssociation < HasOneAssociation
+      include ThroughAssociationScope
+
+      def replace(new_value)
+        create_through_record(new_value)
+        @target = new_value
+      end
+
+      private
+
+      def create_through_record(new_value) #nodoc:
+        klass = @reflection.through_reflection.klass
+
+        current_object = @owner.send(@reflection.through_reflection.name)
+
+        if current_object
+           new_value ? current_object.update_attributes(construct_join_attributes(new_value)) : current_object.destroy
+        elsif new_value
+          if @owner.new_record?
+            self.target = new_value
+            through_association = @owner.send(:association_instance_get, @reflection.through_reflection.name)
+            through_association.build(construct_join_attributes(new_value))
+          else
+            @owner.send(@reflection.through_reflection.name, klass.create(construct_join_attributes(new_value)))
+          end
+        end
+      end
+
+    private
+      def find_target
+        with_scope(construct_scope) { @reflection.klass.find(:first) }
+      end
+    end
+  end
+end

data/lib/active_record/associations/through_association_scope.rb

@@ -0,0 +1,154 @@
+module ActiveRecord
+  # = Active Record Through Association Scope
+  module Associations
+    module ThroughAssociationScope
+
+      protected
+
+      def construct_scope
+        { :create => construct_owner_attributes(@reflection),
+          :find   => { :conditions  => construct_conditions,
+                       :joins       => construct_joins,
+                       :include     => @reflection.options[:include] || @reflection.source_reflection.options[:include],
+                       :select      => construct_select,
+                       :order       => @reflection.options[:order],
+                       :limit       => @reflection.options[:limit],
+                       :readonly    => @reflection.options[:readonly],
+           } }
+      end
+
+      # Build SQL conditions from attributes, qualified by table name.
+      def construct_conditions
+        table_name = @reflection.through_reflection.quoted_table_name
+        conditions = construct_quoted_owner_attributes(@reflection.through_reflection).map do |attr, value|
+          "#{table_name}.#{attr} = #{value}"
+        end
+        conditions << sql_conditions if sql_conditions
+        "(" + conditions.join(') AND (') + ")"
+      end
+
+      # Associate attributes pointing to owner, quoted.
+      def construct_quoted_owner_attributes(reflection)
+        if as = reflection.options[:as]
+          { "#{as}_id" => owner_quoted_id,
+            "#{as}_type" => reflection.klass.quote_value(
+              @owner.class.base_class.name.to_s,
+              reflection.klass.columns_hash["#{as}_type"]) }
+        elsif reflection.macro == :belongs_to
+          { reflection.klass.primary_key => @owner.class.quote_value(@owner[reflection.primary_key_name]) }
+        else
+          { reflection.primary_key_name => owner_quoted_id }
+        end
+      end
+
+      def construct_from
+        @reflection.table_name
+      end
+
+      def construct_select(custom_select = nil)
+        distinct = "DISTINCT " if @reflection.options[:uniq]
+        selected = custom_select || @reflection.options[:select] || "#{distinct}#{@reflection.quoted_table_name}.*"
+      end
+
+      def construct_joins(custom_joins = nil)
+        polymorphic_join = nil
+        if @reflection.source_reflection.macro == :belongs_to
+          reflection_primary_key = @reflection.klass.primary_key
+          source_primary_key     = @reflection.source_reflection.primary_key_name
+          if @reflection.options[:source_type]
+            polymorphic_join = "AND %s.%s = %s" % [
+              @reflection.through_reflection.quoted_table_name, "#{@reflection.source_reflection.options[:foreign_type]}",
+              @owner.class.quote_value(@reflection.options[:source_type])
+            ]
+          end
+        else
+          reflection_primary_key = @reflection.source_reflection.primary_key_name
+          source_primary_key     = @reflection.through_reflection.klass.primary_key
+          if @reflection.source_reflection.options[:as]
+            polymorphic_join = "AND %s.%s = %s" % [
+              @reflection.quoted_table_name, "#{@reflection.source_reflection.options[:as]}_type",
+              @owner.class.quote_value(@reflection.through_reflection.klass.name)
+            ]
+          end
+        end
+
+        "INNER JOIN %s ON %s.%s = %s.%s %s #{@reflection.options[:joins]} #{custom_joins}" % [
+          @reflection.through_reflection.quoted_table_name,
+          @reflection.quoted_table_name, reflection_primary_key,
+          @reflection.through_reflection.quoted_table_name, source_primary_key,
+          polymorphic_join
+        ]
+      end
+
+      # Construct attributes for associate pointing to owner.
+      def construct_owner_attributes(reflection)
+        if as = reflection.options[:as]
+          { "#{as}_id" => @owner.id,
+            "#{as}_type" => @owner.class.base_class.name.to_s }
+        else
+          { reflection.primary_key_name => @owner.id }
+        end
+      end
+
+      # Construct attributes for :through pointing to owner and associate.
+      def construct_join_attributes(associate)
+        # TODO: revisit this to allow it for deletion, supposing dependent option is supported
+        raise ActiveRecord::HasManyThroughCantAssociateThroughHasOneOrManyReflection.new(@owner, @reflection) if [:has_one, :has_many].include?(@reflection.source_reflection.macro)
+
+        join_attributes = construct_owner_attributes(@reflection.through_reflection).merge(@reflection.source_reflection.primary_key_name => associate.id)
+
+        if @reflection.options[:source_type]
+          join_attributes.merge!(@reflection.source_reflection.options[:foreign_type] => associate.class.base_class.name.to_s)
+        end
+
+        if @reflection.through_reflection.options[:conditions].is_a?(Hash)
+          join_attributes.merge!(@reflection.through_reflection.options[:conditions])
+        end
+
+        join_attributes
+      end
+
+      def conditions
+        @conditions = build_conditions unless defined?(@conditions)
+        @conditions
+      end
+
+      def build_conditions
+        association_conditions = @reflection.options[:conditions]
+        through_conditions = build_through_conditions
+        source_conditions = @reflection.source_reflection.options[:conditions]
+        uses_sti = !@reflection.through_reflection.klass.descends_from_active_record?
+
+        if association_conditions || through_conditions || source_conditions || uses_sti
+          all = []
+
+          [association_conditions, source_conditions].each do |conditions|
+            all << interpolate_sql(sanitize_sql(conditions)) if conditions
+          end
+
+          all << through_conditions  if through_conditions
+          all << build_sti_condition if uses_sti
+
+          all.map { |sql| "(#{sql})" } * ' AND '
+        end
+      end
+
+      def build_through_conditions
+        conditions = @reflection.through_reflection.options[:conditions]
+        if conditions.is_a?(Hash)
+          interpolate_sql(@reflection.through_reflection.klass.send(:sanitize_sql, conditions)).gsub(
+            @reflection.quoted_table_name,
+            @reflection.through_reflection.quoted_table_name)
+        elsif conditions
+          interpolate_sql(sanitize_sql(conditions))
+        end
+      end
+
+      def build_sti_condition
+        @reflection.through_reflection.klass.send(:type_condition).to_sql
+      end
+
+      alias_method :sql_conditions, :conditions
+    end
+  end
+end