activerecord 4.0.4 → 4.1.16

data/lib/active_record/associations/builder/association.rb

@@ -1,50 +1,72 @@
+require 'active_support/core_ext/module/attribute_accessors'
+
+# This is the parent Association class which defines the variables
+# used by all associations.
+#
+# The hierarchy is defined as follows:
+#  Association
+#    - SingularAssociation
+#      - BelongsToAssociation
+#      - HasOneAssociation
+#    - CollectionAssociation
+#      - HasManyAssociation
+
 module ActiveRecord::Associations::Builder
   class Association #:nodoc:
     class << self
+      attr_accessor :extensions
+      # TODO: This class accessor is needed to make activerecord-deprecated_finders work.
+      # We can move it to a constant in 5.0.
       attr_accessor :valid_options
     end
+    self.extensions = []
+
+    self.valid_options = [:class_name, :anonymous_class, :foreign_key, :validate]
 
-    self.valid_options = [:class_name, :foreign_key, :validate]
+    attr_reader :name, :scope, :options
 
-    attr_reader :model, :name, :scope, :options, :reflection
+    def self.build(model, name, scope, options, &block)
+      if model.dangerous_attribute_method?(name)
+        raise ArgumentError, "You tried to define an association named #{name} on the model #{model.name}, but " \
+                             "this will conflict with a method #{name} already defined by Active Record. " \
+                             "Please choose a different association name."
+      end
 
-    def self.build(*args, &block)
-      new(*args, &block).build
+      builder = create_builder model, name, scope, options, &block
+      reflection = builder.build(model)
+      define_accessors model, reflection
+      define_callbacks model, reflection
+      builder.define_extensions model
+      reflection
     end
 
-    def initialize(model, name, scope, options)
+    def self.create_builder(model, name, scope, options, &block)
       raise ArgumentError, "association names must be a Symbol" unless name.kind_of?(Symbol)
 
-      @model   = model
-      @name    = name
+      new(model, name, scope, options, &block)
+    end
 
+    def initialize(model, name, scope, options)
+      # TODO: Move this to create_builder as soon we drop support to activerecord-deprecated_finders.
       if scope.is_a?(Hash)
-        @scope   = nil
-        @options = scope
-      else
-        @scope   = scope
-        @options = options
+        options = scope
+        scope   = nil
       end
 
-      if @scope && @scope.arity == 0
-        prev_scope = @scope
-        @scope = proc { instance_exec(&prev_scope) }
-      end
-    end
+      # TODO: Remove this model argument as soon we drop support to activerecord-deprecated_finders.
+      @name    = name
+      @scope   = scope
+      @options = options
 
-    def mixin
-      @model.generated_feature_methods
-    end
+      validate_options
 
-    include Module.new { def build; end }
+      if scope && scope.arity == 0
+        @scope = proc { instance_exec(&scope) }
+      end
+    end
 
-    def build
-      validate_options
-      define_accessors
-      configure_dependency if options[:dependent]
-      @reflection = model.create_reflection(macro, name, scope, options, model)
-      super # provides an extension point
-      @reflection
+    def build(model)
+      ActiveRecord::Reflection.create(macro, name, scope, options, model)
     end
 
     def macro
@@ -52,19 +74,37 @@ module ActiveRecord::Associations::Builder
     end
 
     def valid_options
-      Association.valid_options
+      Association.valid_options + Association.extensions.flat_map(&:valid_options)
     end
 
     def validate_options
       options.assert_valid_keys(valid_options)
     end
 
-    def define_accessors
-      define_readers
-      define_writers
+    def define_extensions(model)
     end
 
-    def define_readers
+    def self.define_callbacks(model, reflection)
+      add_before_destroy_callbacks(model, reflection) if reflection.options[:dependent]
+      Association.extensions.each do |extension|
+        extension.build model, reflection
+      end
+    end
+
+    # Defines the setter and getter methods for the association
+    # class Post < ActiveRecord::Base
+    #   has_many :comments
+    # end
+    #
+    # Post.first.comments and Post.first.comments= methods are defined by this method...
+    def self.define_accessors(model, reflection)
+      mixin = model.generated_association_methods
+      name = reflection.name
+      define_readers(mixin, name)
+      define_writers(mixin, name)
+    end
+
+    def self.define_readers(mixin, name)
       mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
         def #{name}(*args)
           association(:#{name}).reader(*args)
@@ -72,7 +112,7 @@ module ActiveRecord::Associations::Builder
       CODE
     end
 
-    def define_writers
+    def self.define_writers(mixin, name)
       mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
         def #{name}=(value)
           association(:#{name}).writer(value)
@@ -80,29 +120,19 @@ module ActiveRecord::Associations::Builder
       CODE
     end
 
-    def configure_dependency
-      unless valid_dependent_options.include? options[:dependent]
-        raise ArgumentError, "The :dependent option must be one of #{valid_dependent_options}, but is :#{options[:dependent]}"
-      end
-
-      if options[:dependent] == :restrict
-        ActiveSupport::Deprecation.warn(
-          "The :restrict option is deprecated. Please use :restrict_with_exception instead, which " \
-          "provides the same functionality."
-        )
-      end
+    def self.valid_dependent_options
+      raise NotImplementedError
+    end
 
-      mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
-        def #{macro}_dependent_for_#{name}
-          association(:#{name}).handle_dependency
-        end
-      CODE
+    private
 
-      model.before_destroy "#{macro}_dependent_for_#{name}"
-    end
+    def self.add_before_destroy_callbacks(model, reflection)
+      unless valid_dependent_options.include? reflection.options[:dependent]
+        raise ArgumentError, "The :dependent option must be one of #{valid_dependent_options}, but is :#{reflection.options[:dependent]}"
+      end
 
-    def valid_dependent_options
-      raise NotImplementedError
+      name = reflection.name
+      model.before_destroy lambda { |o| o.association(name).handle_dependency }
     end
   end
 end

data/lib/active_record/associations/builder/belongs_to.rb

@@ -8,99 +8,131 @@ module ActiveRecord::Associations::Builder
       super + [:foreign_type, :polymorphic, :touch, :counter_cache]
     end
 
-    def constructable?
-      !options[:polymorphic]
+    def self.valid_dependent_options
+      [:destroy, :delete]
     end
 
-    def build
-      reflection = super
-      add_counter_cache_callbacks(reflection) if options[:counter_cache]
-      add_touch_callbacks(reflection)         if options[:touch]
-      reflection
+    def self.define_callbacks(model, reflection)
+      super
+      add_counter_cache_callbacks(model, reflection) if reflection.options[:counter_cache]
+      add_touch_callbacks(model, reflection)         if reflection.options[:touch]
     end
 
-    def add_counter_cache_callbacks(reflection)
-      cache_column = reflection.counter_cache_column
-      foreign_key = reflection.foreign_key
+    def self.define_accessors(mixin, reflection)
+      super
+      add_counter_cache_methods mixin
+    end
+
+    private
+
+    def self.add_counter_cache_methods(mixin)
+      return if mixin.method_defined? :belongs_to_counter_cache_after_create
 
-      mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
-        def belongs_to_counter_cache_after_create_for_#{name}
-          if record = #{name}
-            record.class.increment_counter(:#{cache_column}, record.id)
+      mixin.class_eval do
+        def belongs_to_counter_cache_after_create(reflection)
+          if record = send(reflection.name)
+            cache_column = reflection.counter_cache_column
+            record.class.increment_counter(cache_column, record.id)
             @_after_create_counter_called = true
           end
         end
 
-        def belongs_to_counter_cache_before_destroy_for_#{name}
-          unless destroyed_by_association && destroyed_by_association.foreign_key.to_sym == #{foreign_key.to_sym.inspect}
-            record = #{name}
+        def belongs_to_counter_cache_before_destroy(reflection)
+          foreign_key = reflection.foreign_key.to_sym
+          unless destroyed_by_association && destroyed_by_association.foreign_key.to_sym == foreign_key
+            record = send reflection.name
             if record && !self.destroyed?
-              record.class.decrement_counter(:#{cache_column}, record.id)
+              cache_column = reflection.counter_cache_column
+              record.class.decrement_counter(cache_column, record.id)
             end
           end
         end
 
-        def belongs_to_counter_cache_after_update_for_#{name}
+        def belongs_to_counter_cache_after_update(reflection)
+          foreign_key  = reflection.foreign_key
+          cache_column = reflection.counter_cache_column
+
           if (@_after_create_counter_called ||= false)
             @_after_create_counter_called = false
-          elsif self.#{foreign_key}_changed? && !new_record? && defined?(#{name.to_s.camelize})
-            model = #{name.to_s.camelize}
-            foreign_key_was = self.#{foreign_key}_was
-            foreign_key = self.#{foreign_key}
+          elsif attribute_changed?(foreign_key) && !new_record? && reflection.constructable?
+            model           = reflection.klass
+            foreign_key_was = attribute_was foreign_key
+            foreign_key     = attribute foreign_key
 
             if foreign_key && model.respond_to?(:increment_counter)
-              model.increment_counter(:#{cache_column}, foreign_key)
+              model.increment_counter(cache_column, foreign_key)
             end
             if foreign_key_was && model.respond_to?(:decrement_counter)
-              model.decrement_counter(:#{cache_column}, foreign_key_was)
+              model.decrement_counter(cache_column, foreign_key_was)
             end
           end
         end
-      CODE
+      end
+    end
+
+    def self.add_counter_cache_callbacks(model, reflection)
+      cache_column = reflection.counter_cache_column
+
+      model.after_create lambda { |record|
+        record.belongs_to_counter_cache_after_create(reflection)
+      }
 
-      model.after_create   "belongs_to_counter_cache_after_create_for_#{name}"
-      model.before_destroy "belongs_to_counter_cache_before_destroy_for_#{name}"
-      model.after_update   "belongs_to_counter_cache_after_update_for_#{name}"
+      model.before_destroy lambda { |record|
+        record.belongs_to_counter_cache_before_destroy(reflection)
+      }
+
+      model.after_update lambda { |record|
+        record.belongs_to_counter_cache_after_update(reflection)
+      }
 
       klass = reflection.class_name.safe_constantize
       klass.attr_readonly cache_column if klass && klass.respond_to?(:attr_readonly)
     end
 
-    def add_touch_callbacks(reflection)
-      mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
-        def belongs_to_touch_after_save_or_destroy_for_#{name}
-          foreign_key_field = #{reflection.foreign_key.inspect}
-          old_foreign_id    = changed_attributes[foreign_key_field]
-
-          if old_foreign_id
-            association = association(:#{name})
-            reflection = association.reflection
-            if reflection.polymorphic?
-              klass = send("#{reflection.foreign_type}_was").constantize
-            else
-              klass = association.klass
-            end
-            old_record = klass.find_by(klass.primary_key => old_foreign_id)
+    def self.touch_record(o, foreign_key, name, touch) # :nodoc:
+      old_foreign_id = o.changed_attributes[foreign_key]
 
-            if old_record
-              old_record.touch #{options[:touch].inspect if options[:touch] != true}
-            end
-          end
+      if old_foreign_id
+        association = o.association(name)
+        reflection = association.reflection
+        if reflection.polymorphic?
+          klass = o.public_send("#{reflection.foreign_type}_was").constantize
+        else
+          klass = association.klass
+        end
+        old_record = klass.find_by(klass.primary_key => old_foreign_id)
 
-          record = #{name}
-          if record && record.persisted?
-            record.touch #{options[:touch].inspect if options[:touch] != true}
+        if old_record
+          if touch != true
+            old_record.touch touch
+          else
+            old_record.touch
           end
         end
-      CODE
-
-      model.after_save    "belongs_to_touch_after_save_or_destroy_for_#{name}"
-      model.after_touch   "belongs_to_touch_after_save_or_destroy_for_#{name}"
-      model.after_destroy "belongs_to_touch_after_save_or_destroy_for_#{name}"
+      end
+
+      record = o.send name
+      if record && record.persisted?
+        if touch != true
+          record.touch touch
+        else
+          record.touch
+        end
+      end
     end
 
-    def valid_dependent_options
-      [:destroy, :delete]
+    def self.add_touch_callbacks(model, reflection)
+      foreign_key = reflection.foreign_key
+      n           = reflection.name
+      touch       = reflection.options[:touch]
+
+      callback = lambda { |record|
+        BelongsTo.touch_record(record, foreign_key, n, touch)
+      }
+
+      model.after_save    callback
+      model.after_touch   callback
+      model.after_destroy callback
     end
   end
 end

data/lib/active_record/associations/builder/collection_association.rb

@@ -1,3 +1,5 @@
+# This class is inherited by the has_many and has_many_and_belongs_to_many association classes
+
 require 'active_record/associations'
 
 module ActiveRecord::Associations::Builder
@@ -6,67 +8,57 @@ module ActiveRecord::Associations::Builder
     CALLBACKS = [:before_add, :after_add, :before_remove, :after_remove]
 
     def valid_options
-      super + [:table_name, :finder_sql, :counter_sql, :before_add,
+      super + [:table_name, :before_add,
                :after_add, :before_remove, :after_remove, :extend]
     end
 
-    attr_reader :block_extension, :extension_module
-
-    def initialize(*args, &extension)
-      super(*args)
-      @block_extension = extension
-    end
+    attr_reader :block_extension
 
-    def build
-      show_deprecation_warnings
-      wrap_block_extension
-      reflection = super
-      CALLBACKS.each { |callback_name| define_callback(callback_name) }
-      reflection
+    def initialize(model, name, scope, options)
+      super
+      @mod = nil
+      if block_given?
+        @mod = Module.new(&Proc.new)
+        @scope = wrap_scope @scope, @mod
+      end
     end
 
-    def writable?
-      true
+    def self.define_callbacks(model, reflection)
+      super
+      name    = reflection.name
+      options = reflection.options
+      CALLBACKS.each { |callback_name|
+        define_callback(model, callback_name, name, options)
+      }
     end
 
-    def show_deprecation_warnings
-      [:finder_sql, :counter_sql].each do |name|
-        if options.include? name
-          ActiveSupport::Deprecation.warn("The :#{name} association option is deprecated. Please find an alternative (such as using scopes).")
-        end
+    def define_extensions(model)
+      if @mod
+        extension_module_name = "#{model.name.demodulize}#{name.to_s.camelize}AssociationExtension"
+        model.parent.const_set(extension_module_name, @mod)
       end
     end
 
-    def wrap_block_extension
-      if block_extension
-        @extension_module = mod = Module.new(&block_extension)
-        silence_warnings do
-          model.parent.const_set(extension_module_name, mod)
-        end
-
-        prev_scope = @scope
+    def self.define_callback(model, callback_name, name, options)
+      full_callback_name = "#{callback_name}_for_#{name}"
 
-        if prev_scope
-          @scope = proc { |owner| instance_exec(owner, &prev_scope).extending(mod) }
+      # TODO : why do i need method_defined? I think its because of the inheritance chain
+      model.class_attribute full_callback_name unless model.method_defined?(full_callback_name)
+      callbacks = Array(options[callback_name.to_sym]).map do |callback|
+        case callback
+        when Symbol
+          ->(method, owner, record) { owner.send(callback, record) }
+        when Proc
+          ->(method, owner, record) { callback.call(owner, record) }
         else
-          @scope = proc { extending(mod) }
+          ->(method, owner, record) { callback.send(method, owner, record) }
         end
       end
+      model.send "#{full_callback_name}=", callbacks
     end
 
-    def extension_module_name
-      @extension_module_name ||= "#{model.name.demodulize}#{name.to_s.camelize}AssociationExtension"
-    end
-
-    def define_callback(callback_name)
-      full_callback_name = "#{callback_name}_for_#{name}"
-
-      # TODO : why do i need method_defined? I think its because of the inheritance chain
-      model.class_attribute full_callback_name.to_sym unless model.method_defined?(full_callback_name)
-      model.send("#{full_callback_name}=", Array(options[callback_name.to_sym]))
-    end
-
-    def define_readers
+    # Defines the setter and getter methods for the collection_singular_ids.
+    def self.define_readers(mixin, name)
       super
 
       mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
@@ -76,7 +68,7 @@ module ActiveRecord::Associations::Builder
       CODE
     end
 
-    def define_writers
+    def self.define_writers(mixin, name)
       super
 
       mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
@@ -85,5 +77,15 @@ module ActiveRecord::Associations::Builder
         end
       CODE
     end
+
+    private
+
+    def wrap_scope(scope, mod)
+      if scope
+        proc { |owner| instance_exec(owner, &scope).extending(mod) }
+      else
+        proc { extending(mod) }
+      end
+    end
   end
 end

data/lib/active_record/associations/builder/has_and_belongs_to_many.rb

@@ -1,39 +1,133 @@
 module ActiveRecord::Associations::Builder
-  class HasAndBelongsToMany < CollectionAssociation #:nodoc:
-    def macro
-      :has_and_belongs_to_many
-    end
+  class HasAndBelongsToMany # :nodoc:
+    class JoinTableResolver
+      KnownTable = Struct.new :join_table
+
+      class KnownClass
+        def initialize(lhs_class, rhs_class_name)
+          @lhs_class      = lhs_class
+          @rhs_class_name = rhs_class_name
+          @join_table     = nil
+        end
+
+        def join_table
+          @join_table ||= [@lhs_class.table_name, klass.table_name].sort.join("\0").gsub(/^(.*[._])(.+)\0\1(.+)/, '\1\2_\3').gsub("\0", "_")
+        end
 
-    def valid_options
-      super + [:join_table, :association_foreign_key, :delete_sql, :insert_sql]
+        private
+
+        def klass
+          @lhs_class.send(:compute_type, @rhs_class_name)
+        end
+      end
+
+      def self.build(lhs_class, name, options)
+        if options[:join_table]
+          KnownTable.new options[:join_table].to_s
+        else
+          class_name = options.fetch(:class_name) {
+            name.to_s.camelize.singularize
+          }
+          KnownClass.new lhs_class, class_name
+        end
+      end
     end
 
-    def build
-      reflection = super
-      define_destroy_hook
-      reflection
+    attr_reader :lhs_model, :association_name, :options
+
+    def initialize(association_name, lhs_model, options)
+      @association_name = association_name
+      @lhs_model = lhs_model
+      @options = options
     end
 
-    def show_deprecation_warnings
-      super
+    def through_model
+      habtm = JoinTableResolver.build lhs_model, association_name, options
 
-      [:delete_sql, :insert_sql].each do |name|
-        if options.include? name
-          ActiveSupport::Deprecation.warn("The :#{name} association option is deprecated. Please find an alternative (such as using has_many :through).")
+      join_model = Class.new(ActiveRecord::Base) {
+        class << self;
+          attr_accessor :class_resolver
+          attr_accessor :name
+          attr_accessor :table_name_resolver
+          attr_accessor :left_reflection
+          attr_accessor :right_reflection
         end
+
+        def self.table_name
+          table_name_resolver.join_table
+        end
+
+        def self.compute_type(class_name)
+          class_resolver.compute_type class_name
+        end
+
+        def self.add_left_association(name, options)
+          belongs_to name, options
+          self.left_reflection = _reflect_on_association(name)
+        end
+
+        def self.add_right_association(name, options)
+          rhs_name = name.to_s.singularize.to_sym
+          belongs_to rhs_name, options
+          self.right_reflection = _reflect_on_association(rhs_name)
+        end
+
+        def hash
+          object_id.hash
+        end
+
+        def ==(other)
+          equal?(other)
+        end
+        alias :eql? :==
+
+      }
+
+      join_model.name                = "HABTM_#{association_name.to_s.camelize}"
+      join_model.table_name_resolver = habtm
+      join_model.class_resolver      = lhs_model
+
+      join_model.add_left_association :left_side, anonymous_class: lhs_model
+      join_model.add_right_association association_name, belongs_to_options(options)
+      join_model
+    end
+
+    def middle_reflection(join_model)
+      middle_name = [lhs_model.name.downcase.pluralize,
+                     association_name].join('_').gsub(/::/, '_').to_sym
+      middle_options = middle_options join_model
+      hm_builder = HasMany.create_builder(lhs_model,
+                                          middle_name,
+                                          nil,
+                                          middle_options)
+      hm_builder.build lhs_model
+    end
+
+    private
+
+    def middle_options(join_model)
+      middle_options = {}
+      middle_options[:anonymous_class] = join_model
+      middle_options[:source] = join_model.left_reflection.name
+      if options.key? :foreign_key
+        middle_options[:foreign_key] = options[:foreign_key]
       end
+      middle_options
     end
 
-    def define_destroy_hook
-      name = self.name
-      model.send(:include, Module.new {
-        class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def destroy_associations
-            association(:#{name}).delete_all
-            super
-          end
-        RUBY
-      })
+    def belongs_to_options(options)
+      rhs_options = {}
+
+      if options.key? :class_name
+        rhs_options[:foreign_key] = options[:class_name].foreign_key
+        rhs_options[:class_name] = options[:class_name]
+      end
+
+      if options.key? :association_foreign_key
+        rhs_options[:foreign_key] = options[:association_foreign_key]
+      end
+
+      rhs_options
     end
   end
 end