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

Inherits:
Object
  • Object
show all
Defined in:
activerecord/lib/active_record/associations/builder/association.rb

Overview

:nodoc:

Direct Known Subclasses

CollectionAssociation, SingularAssociation

Constant Summary collapse

VALID_OPTIONS =

:nodoc:

[:class_name, :anonymous_class, :foreign_key, :validate]

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.extensionsObject

Returns the value of attribute extensions


15
16
17
# File 'activerecord/lib/active_record/associations/builder/association.rb', line 15

def extensions
  @extensions
end

Class Method Details

.add_destroy_callbacks(model, reflection) ⇒ Object


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

def self.add_destroy_callbacks(model, reflection)
  name = reflection.name
  model.before_destroy lambda { |o| o.association(name).handle_dependency }
end

.build(model, name, scope, options, &block) ⇒ Object


21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'activerecord/lib/active_record/associations/builder/association.rb', line 21

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

  extension = define_extensions model, name, &block
  reflection = create_reflection model, name, scope, options, extension
  define_accessors model, reflection
  define_callbacks model, reflection
  define_validations model, reflection
  reflection
end

.build_scope(scope, extension) ⇒ Object


51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'activerecord/lib/active_record/associations/builder/association.rb', line 51

def self.build_scope(scope, extension)
  new_scope = scope

  if scope && scope.arity == 0
    new_scope = proc { instance_exec(&scope) }
  end

  if extension
    new_scope = wrap_scope new_scope, extension
  end

  new_scope
end

.check_dependent_options(dependent) ⇒ Object


132
133
134
135
136
# File 'activerecord/lib/active_record/associations/builder/association.rb', line 132

def self.check_dependent_options(dependent)
  unless valid_dependent_options.include? dependent
    raise ArgumentError, "The :dependent option must be one of #{valid_dependent_options}, but is :#{dependent}"
  end
end

.create_reflection(model, name, scope, options, extension = nil) ⇒ Object

Raises:

  • (ArgumentError)

36
37
38
39
40
41
42
43
44
45
46
47
48
49
# File 'activerecord/lib/active_record/associations/builder/association.rb', line 36

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

  if scope.is_a?(Hash)
    options = scope
    scope   = nil
  end

  validate_options(options)

  scope = build_scope(scope, extension)

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

.define_accessors(model, reflection) ⇒ Object

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…


101
102
103
104
105
106
# File 'activerecord/lib/active_record/associations/builder/association.rb', line 101

def self.define_accessors(model, reflection)
  mixin = model.generated_association_methods
  name = reflection.name
  define_readers(mixin, name)
  define_writers(mixin, name)
end

.define_callbacks(model, reflection) ⇒ Object


84
85
86
87
88
89
90
91
92
93
# File 'activerecord/lib/active_record/associations/builder/association.rb', line 84

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

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

.define_extensions(model, name) ⇒ Object


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

def self.define_extensions(model, name)
end

.define_readers(mixin, name) ⇒ Object


108
109
110
111
112
113
114
# File 'activerecord/lib/active_record/associations/builder/association.rb', line 108

def self.define_readers(mixin, name)
  mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
    def #{name}(*args)
      association(:#{name}).reader(*args)
    end
  CODE
end

.define_validations(model, reflection) ⇒ Object


124
125
126
# File 'activerecord/lib/active_record/associations/builder/association.rb', line 124

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

.define_writers(mixin, name) ⇒ Object


116
117
118
119
120
121
122
# File 'activerecord/lib/active_record/associations/builder/association.rb', line 116

def self.define_writers(mixin, name)
  mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
    def #{name}=(value)
      association(:#{name}).writer(value)
    end
  CODE
end

.macroObject

Raises:

  • (NotImplementedError)

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

def self.macro
  raise NotImplementedError
end

.valid_dependent_optionsObject

Raises:

  • (NotImplementedError)

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

def self.valid_dependent_options
  raise NotImplementedError
end

.valid_options(options) ⇒ Object


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

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

.validate_options(options) ⇒ Object


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

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

.wrap_scope(scope, extension) ⇒ Object


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

def self.wrap_scope(scope, extension)
  scope
end