123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::Associations::Builder::SingularAssociation

Do not use. This class is for internal use only.
Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
BelongsTo, HasOne
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Association
Instance Chain:
self, Association
Inherits: ActiveRecord::Associations::Builder::Association
Defined in: activerecord/lib/active_record/associations/builder/singular_association.rb

Constant Summary

Association - Inherited

VALID_OPTIONS

Class Attribute Summary

Association - Inherited

.extensions

Class Method Summary

Association - Inherited

.build, .create_reflection, .add_after_commit_jobs_callback, .add_destroy_callbacks, .build_scope, .check_dependent_options,
.define_accessors

Defines the setter and getter methods for the association class Post < ::ActiveRecord::Base
.define_callbacks, .define_change_tracking_methods, .define_extensions, .define_validations, .macro, .valid_dependent_options, .valid_options, .validate_options

Class Method Details

.define_accessors(model, reflection, mixin) (private)

[ GitHub ] 

  


# File 'activerecord/lib/active_record/associations/builder/singular_association.rb', line 11



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

  define_constructors(mixin, name) unless reflection.polymorphic?

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

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


  








  

    .define_callbacks(model, reflection)  
  

  [ GitHub ]


  

  


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



def self.define_callbacks(model, reflection)
  super

  # If the record is saved or destroyed and `:touch` is set, the parent
  # record gets a timestamp updated. We want to know about it, because
  # deleting the association would change that side-effect and perhaps there
  # is code relying on it.
  if reflection.deprecated? && reflection.options[:touch]
    model.before_save do
      report_deprecated_association(reflection, context: ":touch has a side effect here")
    end

    model.before_destroy do
      report_deprecated_association(reflection, context: ":touch has a side effect here")
    end
  end
end


  








  

    .define_constructors(mixin, name)   (private)
  



  

    
Defines the (build|create)_association methods for belongs_to or has_one association

  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/associations/builder/singular_association.rb', line 39



def self.define_constructors(mixin, name)
  mixin.define_cached_method(:"build_#{name}", namespace: :association_build) do |batch|
    batch << <<~RUBY
      def build_#{name}(*args, &block)
        association = association(:#{name})
        deprecated_associations_api_guard(association, :build_#{name})
        association.build(*args, &block)
      end
    RUBY
  end

  mixin.define_cached_method(:"create_#{name}", namespace: :association_create) do |batch|
    batch << <<~RUBY
      def create_#{name}(*args, &block)
        association = association(:#{name})
        deprecated_associations_api_guard(association, :create_#{name})
        association.create(*args, &block)
      end
    RUBY
  end

  mixin.define_cached_method(:"create_#{name}!", namespace: :association_create_bang) do |batch|
    batch << <<~RUBY
      def create_#{name}!(*args, &block)
        association = association(:#{name})
        deprecated_associations_api_guard(association, :create_#{name}!)
        association.create!(*args, &block)
      end
    RUBY
  end
end


  








  

    .valid_options(options)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/associations/builder/singular_association.rb', line 7



def self.valid_options(options)
  super + [:required, :touch]
end