123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::Associations::Builder::BelongsTo

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: ActiveRecord::Associations::Builder::SingularAssociation
Defined in: activerecord/lib/active_record/associations/builder/belongs_to.rb

Constant Summary

Association - Inherited

VALID_OPTIONS

Class Attribute Summary

Association - Inherited

Class Method Summary

Class Method Details

.add_counter_cache_callbacks(model, reflection) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 28

def self.add_counter_cache_callbacks(model, reflection)
  cache_column = reflection.counter_cache_column

  model.after_update lambda { |record|
    association = association(reflection.name)

    if association.saved_change_to_target?
      association.increment_counters
      association.decrement_counters_before_last_save
    end
  }

  klass = reflection.class_name.safe_constantize
  klass._counter_cache_columns = (klass._counter_cache_columns | [cache_column]).freeze if klass && klass.respond_to?(:_counter_cache_columns)
  model.counter_cached_association_names = (model.counter_cached_association_names | [reflection.name]).freeze
end

.add_default_callbacks(model, reflection) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 112

def self.add_default_callbacks(model, reflection)
  model.before_validation lambda { |o|
    o.association(reflection.name).default(&reflection.options[:default])
  }
end

.add_destroy_callbacks(model, reflection) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 118

def self.add_destroy_callbacks(model, reflection)
  if reflection.deprecated?
    # If :dependent is set, destroying the record has some side effect that
    # would no longer happen if the association is removed.
    model.before_destroy do
      report_deprecated_association(reflection, context: ":dependent has a side effect here")
    end
  end

  model.after_destroy lambda { |o| o.association(reflection.name).handle_dependency }
end

.add_touch_callbacks(model, reflection) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 89

def self.add_touch_callbacks(model, reflection)
  name  = reflection.name
  touch = reflection.options[:touch]

  callback = lambda { |change_method| lambda { |record|
    BelongsTo.touch_record(record, change_method, name, touch)
  }}

  if reflection.counter_cache_column
    touch_callback = callback.(:saved_change_to_attribute)
    update_callback = lambda { |record|
      instance_exec(record, &touch_callback) unless association(reflection.name).saved_change_to_target?
    }
    model.after_update update_callback, if: :saved_changes?
  else
    model.after_create callback.(:saved_change_to_attribute), if: :saved_changes?
    model.after_update callback.(:saved_change_to_attribute), if: :saved_changes?
    model.after_destroy callback.(:attribute_change_to_be_saved)
  end

  model.after_touch callback.(:attribute_change_to_be_saved)
end

.define_callbacks(model, reflection) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 21

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]
  add_default_callbacks(model, reflection)       if reflection.options[:default]
end

.define_change_tracking_methods(model, reflection) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 163

def self.define_change_tracking_methods(model, reflection)
  model.generated_association_methods.class_eval <<-CODE, __FILE__, __LINE__ + 1
    def #{reflection.name}_changed?
      association = association(:#{reflection.name})
      deprecated_associations_api_guard(association, __method__)
      association.target_changed?
    end

    def #{reflection.name}_previously_changed?
      association = association(:#{reflection.name})
      deprecated_associations_api_guard(association, __method__)
      association.target_previously_changed?
    end
  CODE
end

.define_validations(model, reflection) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 130

def self.define_validations(model, reflection)
  if reflection.options.key?(:required)
    reflection.options[:optional] = !reflection.options.delete(:required)
  end

  if reflection.options[:optional].nil?
    required = model.belongs_to_required_by_default
  else
    required = !reflection.options[:optional]
  end

  super

  if required
    if ActiveRecord.belongs_to_required_validates_foreign_key
      model.validates_presence_of reflection.name, message: :required
    else
      condition = lambda { |record|
        association = record.association(reflection.name)

        fk_missing_or_changed = association.foreign_key.any? do |fk|
          record.read_attribute(fk).nil? || record.attribute_changed?(fk)
        end

        fk_missing_or_changed ||
          (reflection.polymorphic? && (record.read_attribute(association.foreign_type).nil? || record.attribute_changed?(association.foreign_type)))
      }

      model.validates_presence_of reflection.name, message: :required, if: condition
    end
  end
end

.macro (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 5

def self.macro
  :belongs_to
end

.touch_record(o, change_method, name, touch)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 45

def self.touch_record(o, change_method, name, touch) # :nodoc:
  association = o.association(name)
  foreign_key = association.foreign_key

  old_foreign_id = if foreign_key.any? { |fk| o.public_send(change_method, fk) }
    values = foreign_key.map do |fk|
      change = o.public_send(change_method, fk)
      change ? change.first : o.read_attribute(fk)
    end
    foreign_key.composite? ? values : values.first
  end

  if old_foreign_id
    reflection = association.reflection
    if reflection.polymorphic?
      foreign_type = association.foreign_type
      change = o.public_send(change_method, foreign_type)
      klass = (change && change.first) || o.public_send(foreign_type)
      klass = o.class.polymorphic_class_for(klass)
    else
      klass = association.klass
    end
    primary_key = reflection.association_primary_key(klass)
    old_record = klass.find_by(primary_key => [old_foreign_id])

    if old_record
      if touch != true
        old_record.touch_later(touch)
      else
        old_record.touch_later
      end
    end
  end

  record = o.public_send name
  if record && record.persisted?
    if touch != true
      record.touch_later(touch)
    else
      record.touch_later
    end
  end
end

.valid_dependent_options (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 17

def self.valid_dependent_options
  [:destroy, :delete, :destroy_async]
end

.valid_options(options) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/associations/builder/belongs_to.rb', line 9

def self.valid_options(options)
  valid = super + [:polymorphic, :counter_cache, :optional, :default]
  valid << :class_name unless options[:polymorphic]
  valid << :foreign_type if options[:polymorphic]
  valid << :ensuring_owner_was if options[:dependent] == :destroy_async
  valid
end