activerecord 4.2.0

data/lib/active_record/associations/has_many_association.rb

@@ -0,0 +1,184 @@
+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 < CollectionAssociation #:nodoc:
+
+      def handle_dependency
+        case options[:dependent]
+        when :restrict_with_exception
+          raise ActiveRecord::DeleteRestrictionError.new(reflection.name) unless empty?
+
+        when :restrict_with_error
+          unless empty?
+            record = klass.human_attribute_name(reflection.name).downcase
+            owner.errors.add(:base, :"restrict_dependent_destroy.many", record: record)
+            false
+          end
+
+        else
+          if options[:dependent] == :destroy
+            # No point in executing the counter update since we're going to destroy the parent anyway
+            load_target.each { |t| t.destroyed_by_association = reflection }
+            destroy_all
+          else
+            delete_all
+          end
+        end
+      end
+
+      def insert_record(record, validate = true, raise = false)
+        set_owner_attributes(record)
+        set_inverse_instance(record)
+
+        if raise
+          record.save!(:validate => validate)
+        else
+          record.save(:validate => validate)
+        end
+      end
+
+      def empty?
+        if has_cached_counter?
+          size.zero?
+        else
+          super
+        end
+      end
+
+      private
+
+        # 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._read_attribute cached_counter_attribute_name
+          else
+            scope.count
+          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
+
+          [association_scope.limit_value, count].compact.min
+        end
+
+        def has_cached_counter?(reflection = reflection())
+          owner.attribute_present?(cached_counter_attribute_name(reflection))
+        end
+
+        def cached_counter_attribute_name(reflection = reflection())
+          options[:counter_cache] || "#{reflection.name}_count"
+        end
+
+        def update_counter(difference, reflection = reflection())
+          update_counter_in_database(difference, reflection)
+          update_counter_in_memory(difference, reflection)
+        end
+
+        def update_counter_in_database(difference, reflection = reflection())
+          if has_cached_counter?(reflection)
+            counter = cached_counter_attribute_name(reflection)
+            owner.class.update_counters(owner.id, counter => difference)
+          end
+        end
+
+        def update_counter_in_memory(difference, reflection = reflection())
+          if has_cached_counter?(reflection)
+            counter = cached_counter_attribute_name(reflection)
+            owner[counter] += difference
+            owner.send(:clear_attribute_changes, counter) # eww
+          end
+        end
+
+        # This shit is nasty. We need to avoid the following situation:
+        #
+        #   * An associated record is deleted via record.destroy
+        #   * Hence the callbacks run, and they find a belongs_to on the record with a
+        #     :counter_cache options which points back at our owner. So they update the
+        #     counter cache.
+        #   * In which case, we must make sure to *not* update the counter cache, or else
+        #     it will be decremented twice.
+        #
+        # Hence this method.
+        def inverse_updates_counter_cache?(reflection = reflection())
+          counter_name = cached_counter_attribute_name(reflection)
+          inverse_updates_counter_named?(counter_name, reflection)
+        end
+
+        def inverse_updates_counter_named?(counter_name, reflection = reflection())
+          reflection.klass._reflections.values.any? { |inverse_reflection|
+            inverse_reflection.belongs_to? &&
+            inverse_reflection.counter_cache_column == counter_name
+          }
+        end
+
+        def delete_count(method, scope)
+          if method == :delete_all
+            scope.delete_all
+          else
+            scope.update_all(reflection.foreign_key => nil)
+          end
+        end
+
+        def delete_or_nullify_all_records(method)
+          count = delete_count(method, self.scope)
+          update_counter(-count)
+        end
+
+        # Deletes the records according to the <tt>:dependent</tt> option.
+        def delete_records(records, method)
+          if method == :destroy
+            records.each(&:destroy!)
+            update_counter(-records.length) unless inverse_updates_counter_cache?
+          else
+            scope = self.scope.where(reflection.klass.primary_key => records)
+            update_counter(-delete_count(method, scope))
+          end
+        end
+
+        def foreign_key_present?
+          if reflection.klass.primary_key
+            owner.attribute_present?(reflection.association_primary_key)
+          else
+            false
+          end
+        end
+
+        def concat_records(records, *)
+          update_counter_if_success(super, records.length)
+        end
+
+        def _create_record(attributes, *)
+          if attributes.is_a?(Array)
+            super
+          else
+            update_counter_if_success(super, 1)
+          end
+        end
+
+        def update_counter_if_success(saved_successfully, difference)
+          if saved_successfully
+            update_counter_in_memory(difference)
+          end
+          saved_successfully
+        end
+    end
+  end
+end

data/lib/active_record/associations/has_many_through_association.rb

@@ -0,0 +1,238 @@
+require 'active_support/core_ext/string/filters'
+
+module ActiveRecord
+  # = Active Record Has Many Through Association
+  module Associations
+    class HasManyThroughAssociation < HasManyAssociation #:nodoc:
+      include ThroughAssociation
+
+      def initialize(owner, reflection)
+        super
+
+        @through_records     = {}
+        @through_association = nil
+      end
+
+      # Returns the size of the collection by executing a SELECT COUNT(*) query
+      # if the collection hasn't been loaded, and by calling collection.size if
+      # it has. If the collection will likely have a size greater than zero,
+      # and if fetching the collection will be needed afterwards, one less
+      # SELECT query will be generated by using #length instead.
+      def size
+        if has_cached_counter?
+          owner._read_attribute cached_counter_attribute_name(reflection)
+        elsif loaded?
+          target.size
+        else
+          super
+        end
+      end
+
+      def concat(*records)
+        unless owner.new_record?
+          records.flatten.each do |record|
+            raise_on_type_mismatch!(record)
+          end
+        end
+
+        super
+      end
+
+      def concat_records(records)
+        ensure_not_nested
+
+        records = super(records, true)
+
+        if owner.new_record? && records
+          records.flatten.each do |record|
+            build_through_record(record)
+          end
+        end
+
+        records
+      end
+
+      def insert_record(record, validate = true, raise = false)
+        ensure_not_nested
+
+        if record.new_record?
+          if raise
+            record.save!(:validate => validate)
+          else
+            return unless record.save(:validate => validate)
+          end
+        end
+
+        save_through_record(record)
+        if has_cached_counter? && !through_reflection_updates_counter_cache?
+          ActiveSupport::Deprecation.warn(<<-MSG.squish)
+            Automatic updating of counter caches on through associations has been
+            deprecated, and will be removed in Rails 5. Instead, please set the
+            appropriate `counter_cache` options on the `has_many` and `belongs_to`
+            for your associations to #{through_reflection.name}.
+          MSG
+
+          update_counter_in_database(1)
+        end
+        record
+      end
+
+      private
+
+        def through_association
+          @through_association ||= owner.association(through_reflection.name)
+        end
+
+        # The through record (built with build_record) is temporarily cached
+        # so that it may be reused if insert_record is subsequently called.
+        #
+        # However, after insert_record has been called, the cache is cleared in
+        # order to allow multiple instances of the same record in an association.
+        def build_through_record(record)
+          @through_records[record.object_id] ||= begin
+            ensure_mutable
+
+            through_record = through_association.build(*options_for_through_record)
+            through_record.send("#{source_reflection.name}=", record)
+            through_record
+          end
+        end
+
+        def options_for_through_record
+          [through_scope_attributes]
+        end
+
+        def through_scope_attributes
+          scope.where_values_hash(through_association.reflection.name.to_s).
+            except!(through_association.reflection.foreign_key,
+                    through_association.reflection.klass.inheritance_column)
+        end
+
+        def save_through_record(record)
+          build_through_record(record).save!
+        ensure
+          @through_records.delete(record.object_id)
+        end
+
+        def build_record(attributes)
+          ensure_not_nested
+
+          record = super(attributes)
+
+          inverse = source_reflection.inverse_of
+          if inverse
+            if inverse.collection?
+              record.send(inverse.name) << build_through_record(record)
+            elsif inverse.has_one?
+              record.send("#{inverse.name}=", build_through_record(record))
+            end
+          end
+
+          record
+        end
+
+        def target_reflection_has_associated_record?
+          !(through_reflection.belongs_to? && owner[through_reflection.foreign_key].blank?)
+        end
+
+        def update_through_counter?(method)
+          case method
+          when :destroy
+            !inverse_updates_counter_cache?(through_reflection)
+          when :nullify
+            false
+          else
+            true
+          end
+        end
+
+        def delete_or_nullify_all_records(method)
+          delete_records(load_target, method)
+        end
+
+        def delete_records(records, method)
+          ensure_not_nested
+
+          scope = through_association.scope
+          scope.where! construct_join_attributes(*records)
+
+          case method
+          when :destroy
+            if scope.klass.primary_key
+              count = scope.destroy_all.length
+            else
+              scope.each do |record|
+                record._run_destroy_callbacks
+              end
+
+              arel = scope.arel
+
+              stmt = Arel::DeleteManager.new arel.engine
+              stmt.from scope.klass.arel_table
+              stmt.wheres = arel.constraints
+
+              count = scope.klass.connection.delete(stmt, 'SQL', scope.bind_values)
+            end
+          when :nullify
+            count = scope.update_all(source_reflection.foreign_key => nil)
+          else
+            count = scope.delete_all
+          end
+
+          delete_through_records(records)
+
+          if source_reflection.options[:counter_cache] && method != :destroy
+            counter = source_reflection.counter_cache_column
+            klass.decrement_counter counter, records.map(&:id)
+          end
+
+          if through_reflection.collection? && update_through_counter?(method)
+            update_counter(-count, through_reflection)
+          end
+
+          update_counter(-count)
+        end
+
+        def through_records_for(record)
+          attributes = construct_join_attributes(record)
+          candidates = Array.wrap(through_association.target)
+          candidates.find_all do |c|
+            attributes.all? do |key, value|
+              c.public_send(key) == value
+            end
+          end
+        end
+
+        def delete_through_records(records)
+          records.each do |record|
+            through_records = through_records_for(record)
+
+            if through_reflection.collection?
+              through_records.each { |r| through_association.target.delete(r) }
+            else
+              if through_records.include?(through_association.target)
+                through_association.target = nil
+              end
+            end
+
+            @through_records.delete(record.object_id)
+          end
+        end
+
+        def find_target
+          return [] unless target_reflection_has_associated_record?
+          get_records
+        end
+
+        # NOTE - not sure that we can actually cope with inverses here
+        def invertible_for?(record)
+          false
+        end
+
+        def through_reflection_updates_counter_cache?
+          counter_name = cached_counter_attribute_name
+          inverse_updates_counter_named?(counter_name, through_reflection)
+        end
+    end
+  end
+end

data/lib/active_record/associations/has_one_association.rb

@@ -0,0 +1,105 @@
+module ActiveRecord
+  # = Active Record Belongs To Has One Association
+  module Associations
+    class HasOneAssociation < SingularAssociation #:nodoc:
+
+      def handle_dependency
+        case options[:dependent]
+        when :restrict_with_exception
+          raise ActiveRecord::DeleteRestrictionError.new(reflection.name) if load_target
+
+        when :restrict_with_error
+          if load_target
+            record = klass.human_attribute_name(reflection.name).downcase
+            owner.errors.add(:base, :"restrict_dependent_destroy.one", record: record)
+            false
+          end
+
+        else
+          delete
+        end
+      end
+
+      def replace(record, save = true)
+        raise_on_type_mismatch!(record) if record
+        load_target
+
+        return self.target if !(target || record)
+
+        assigning_another_record = target != record
+        if assigning_another_record || record.changed?
+          save &&= owner.persisted?
+
+          transaction_if(save) do
+            remove_target!(options[:dependent]) if target && !target.destroyed? && assigning_another_record
+
+            if record
+              set_owner_attributes(record)
+              set_inverse_instance(record)
+
+              if save && !record.save
+                nullify_owner_attributes(record)
+                set_owner_attributes(target) if target
+                raise RecordNotSaved, "Failed to save the new associated #{reflection.name}."
+              end
+            end
+          end
+        end
+
+        self.target = record
+      end
+
+      def delete(method = options[:dependent])
+        if load_target
+          case method
+            when :delete
+              target.delete
+            when :destroy
+              target.destroy
+            when :nullify
+              target.update_columns(reflection.foreign_key => nil)
+          end
+        end
+      end
+
+      private
+
+        # The reason that the save param for replace is false, if for create (not just build),
+        # is because the setting of the foreign keys is actually handled by the scoping when
+        # the record is instantiated, and so they are set straight away and do not need to be
+        # updated within replace.
+        def set_new_record(record)
+          replace(record, false)
+        end
+
+        def remove_target!(method)
+          case method
+            when :delete
+              target.delete
+            when :destroy
+              target.destroy
+            else
+              nullify_owner_attributes(target)
+
+              if target.persisted? && owner.persisted? && !target.save
+                set_owner_attributes(target)
+                raise RecordNotSaved, "Failed to remove the existing associated #{reflection.name}. " +
+                                      "The record failed to save after its foreign key was set to nil."
+              end
+          end
+        end
+
+        def nullify_owner_attributes(record)
+          record[reflection.foreign_key] = nil
+        end
+
+        def transaction_if(value)
+          if value
+            reflection.klass.transaction { yield }
+          else
+            yield
+          end
+        end
+    end
+  end
+end