Class: ActiveRecord::Associations::Builder::Association

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 151

def self.add_destroy_callbacks(model, reflection)
  if reflection.deprecated?
    # If :dependent is set, destroying the record has a 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

  name = reflection.name
  model.before_destroy(->(o) { o.association(name).handle_dependency })
end

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

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

  reflection = create_reflection(model, name, scope, options, &block)
  ActiveSupport::CodeGenerator.batch(model.generated_association_methods, __FILE__, __LINE__) do |mixin|
    define_accessors(model, reflection, mixin)
    define_change_tracking_methods(model, reflection, mixin)
  end
  define_callbacks(model, reflection)
  define_validations(model, reflection)
  reflection
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 58

def self.build_scope(scope)
  if scope && scope.arity == 0
    scope_body = ActiveSupport::Ractors.try_shareable_proc(scope)
    proc { instance_exec(&scope_body) }
  else
    scope
  end
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 141

def self.check_dependent_options(dependent, model)
  if dependent == :destroy_async && !model.destroy_association_async_job
    err_message = "A valid destroy_association_async_job is required to use `dependent: :destroy_async` on associations"
    raise ActiveRecord::ConfigurationError, err_message
  end
  unless valid_dependent_options.include?(dependent)
    raise ArgumentError, "The :dependent option must be one of #{valid_dependent_options}, but is :#{dependent}"
  end
end

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

def self.create_reflection(model, name, scope, options, &block)
  raise ArgumentError, "association names must be a Symbol" unless name.kind_of?(Symbol)

  validate_options(options)

  extension = define_extensions(model, name, &block)
  options[:extend] = [*options[:extend], extension] if extension

  scope = build_scope(scope)

  ActiveRecord::Reflection.create(macro, name, scope, options, model)
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 105

def self.define_accessors(model, reflection, mixin)
  name = reflection.name

  mixin.define_cached_method(name, namespace: :association_reader) do |batch|
    batch << <<~RUBY
      def #{name}
        association = association(:#{name})
        deprecated_associations_api_guard(association, :#{name})
        association.reader
      end
    RUBY
  end

  mixin.define_cached_method(:"#{name}=", namespace: :association_writer) do |batch|
    batch << <<~RUBY
      def #{name}=(value)
        association = association(:#{name})
        deprecated_associations_api_guard(association, :#{name}=)
        association.writer(value)
      end
    RUBY
  end
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 83

def self.define_callbacks(model, reflection)
  if dependent = reflection.options[:dependent]
    check_dependent_options(dependent, model)
    add_destroy_callbacks(model, reflection)
    add_after_commit_jobs_callback(model, dependent)
  end

  Association.extensions.each do |extension|
    extension.build(model, reflection)
  end
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 133

def self.define_change_tracking_methods(model, reflection, mixin)
  # noop
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 79

def self.define_extensions(model, name)
  # noop
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 129

def self.define_validations(model, reflection)
  # noop
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 67

def self.macro
  raise NotImplementedError
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 137

def self.valid_dependent_options
  raise NotImplementedError
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 71

def self.valid_options(options)
  VALID_OPTIONS + Association.extensions.flat_map(&:valid_options)
end

# File 'activerecord/lib/active_record/associations/builder/association.rb', line 75

def self.validate_options(options)
  options.assert_valid_keys(valid_options(options))
end