square-activerecord 3.0.7

data/lib/active_record/associations/has_and_belongs_to_many_association.rb

@@ -0,0 +1,143 @@
+require 'active_support/deprecation'
+
+module ActiveRecord
+  # = Active Record Has And Belongs To Many Association
+  module Associations
+    class HasAndBelongsToManyAssociation < AssociationCollection #:nodoc:
+      def initialize(owner, reflection)
+        super
+        if columns.size > 2
+          ActiveSupport::Deprecation.warn "Having additional attributes on the join table of a has_and_belongs_to_many association is deprecated and will be removed in Rails 3.1. Please use a has_many :through association instead."
+        end
+      end
+
+      def create(attributes = {})
+        create_record(attributes) { |record| insert_record(record) }
+      end
+
+      def create!(attributes = {})
+        create_record(attributes) { |record| insert_record(record, true) }
+      end
+
+      def columns
+        @reflection.columns(@reflection.options[:join_table], "#{@reflection.options[:join_table]} Columns")
+      end
+
+      def reset_column_information
+        @reflection.reset_column_information
+      end
+
+      def has_primary_key?
+        @has_primary_key ||= @owner.connection.supports_primary_key? && @owner.connection.primary_key(@reflection.options[:join_table])
+      end
+
+      protected
+        def construct_find_options!(options)
+          options[:joins]      = Arel::SqlLiteral.new @join_sql
+          options[:readonly]   = finding_with_ambiguous_select?(options[:select] || @reflection.options[:select])
+          options[:select]   ||= (@reflection.options[:select] || Arel::SqlLiteral.new('*'))
+        end
+
+        def count_records
+          load_target.size
+        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
+
+          if @reflection.options[:insert_sql]
+            @owner.connection.insert(interpolate_and_sanitize_sql(@reflection.options[:insert_sql], record))
+          else
+            relation   = Arel::Table.new(@reflection.options[:join_table])
+            timestamps = record_timestamp_columns(record)
+            timezone   = record.send(:current_time_from_proper_timezone) if timestamps.any?
+
+            attributes = Hash[columns.map do |column|
+              name = column.name
+              value = case name.to_s
+                when @reflection.primary_key_name.to_s
+                  @owner.id
+                when @reflection.association_foreign_key.to_s
+                  record.id
+                when *timestamps
+                  timezone
+                else
+                  @owner.send(:quote_value, record[name], column) if record.has_attribute?(name)
+              end
+              [relation[name], value] unless value.nil?
+            end]
+
+            relation.insert(attributes)
+          end
+
+          return true
+        end
+
+        def delete_records(records)
+          if sql = @reflection.options[:delete_sql]
+            records.each { |record| @owner.connection.delete(interpolate_and_sanitize_sql(sql, record)) }
+          else
+            relation = Arel::Table.new(@reflection.options[:join_table])
+            relation.where(relation[@reflection.primary_key_name].eq(@owner.id).
+              and(relation[@reflection.association_foreign_key].in(records.map { |x| x.id }.compact))
+            ).delete
+          end
+        end
+
+        def construct_sql
+          if @reflection.options[:finder_sql]
+            @finder_sql = interpolate_and_sanitize_sql(@reflection.options[:finder_sql])
+          else
+            @finder_sql = "#{@owner.connection.quote_table_name @reflection.options[:join_table]}.#{@reflection.primary_key_name} = #{owner_quoted_id} "
+            @finder_sql << " AND (#{conditions})" if conditions
+          end
+
+          @join_sql = "INNER JOIN #{@owner.connection.quote_table_name @reflection.options[:join_table]} ON #{@reflection.quoted_table_name}.#{@reflection.klass.primary_key} = #{@owner.connection.quote_table_name @reflection.options[:join_table]}.#{@reflection.association_foreign_key}"
+
+          construct_counter_sql
+        end
+
+        def construct_scope
+          { :find => {  :conditions => @finder_sql,
+                        :joins => @join_sql,
+                        :readonly => false,
+                        :order => @reflection.options[:order],
+                        :include => @reflection.options[:include],
+                        :limit => @reflection.options[:limit] } }
+        end
+
+        # Join tables with additional columns on top of the two foreign keys must be considered
+        # ambiguous unless a select clause has been explicitly defined. Otherwise you can get
+        # broken records back, if, for example, the join column also has an id column. This will
+        # then overwrite the id column of the records coming back.
+        def finding_with_ambiguous_select?(select_clause)
+          !select_clause && columns.size != 2
+        end
+
+      private
+        def create_record(attributes, &block)
+          # Can't use Base.create because the foreign key may be a protected attribute.
+          ensure_owner_is_not_new
+          if attributes.is_a?(Array)
+            attributes.collect { |attr| create(attr) }
+          else
+            build_record(attributes, &block)
+          end
+        end
+
+        def record_timestamp_columns(record)
+          if record.record_timestamps
+            record.send(:all_timestamp_attributes).map { |x| x.to_s }
+          else
+            []
+          end
+        end
+    end
+  end
+end

data/lib/active_record/associations/has_many_association.rb

@@ -0,0 +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, reflection)
+        @finder_sql = nil
+        super
+      end
+      protected
+        def owner_quoted_id
+          if @reflection.options[:primary_key]
+            quote_value(@owner.send(@reflection.options[:primary_key]))
+          else
+            @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
+          count = if has_cached_counter?
+            @owner.send(:read_attribute, cached_counter_attribute_name)
+          elsif @reflection.options[:finder_sql] || @reflection.options[:counter_sql]
+            @reflection.klass.count_by_sql(@counter_sql)
+          else
+            @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
+          "#{@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_and_sanitize_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

data/lib/active_record/associations/has_many_through_association.rb

@@ -0,0 +1,115 @@
+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_association.create!(construct_join_attributes(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_and_sanitize_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