1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
require 'enumerator'
module ActiveRecord
# = Active Record Through Association
module Associations
module ThroughAssociation #:nodoc:
delegate :source_options, :through_options, :source_reflection, :through_reflection,
:through_reflection_chain, :through_conditions, :to => :reflection
protected
# We merge in these scopes for two reasons:
#
# 1. To get the scope_for_create on through reflection when building associated objects
# 2. To get the type conditions for any STI classes in the chain
#
# TODO: Don't actually do this. Getting the creation attributes for a non-nested through
# is a special case. The rest (STI conditions) should be handled by the reflection
# itself.
def target_scope
scope = super
through_reflection_chain[1..-1].each do |reflection|
scope = scope.merge(reflection.klass.scoped)
end
scope
end
def association_scope
scope = super.joins(construct_joins)
scope = scope.where(reflection_conditions(0))
unless options[:include]
scope = scope.includes(source_options[:include])
end
scope
end
private
# This scope affects the creation of the associated records (not the join records). At the
# moment we only support creating on a :through association when the source reflection is a
# belongs_to. Thus it's not necessary to set a foreign key on the associated record(s), so
# this scope has can legitimately be empty.
def creation_attributes
{ }
end
# TODO: Needed?
def aliased_through_table
name = through_reflection.table_name
reflection.table_name == name ?
through_reflection.klass.arel_table.alias(name + "_join") :
through_reflection.klass.arel_table
end
def construct_owner_conditions
reflection = through_reflection_chain.last
if reflection.macro == :has_and_belongs_to_many
table = tables[reflection].first
else
table = Array.wrap(tables[reflection]).first
end
super(table, reflection)
end
def construct_joins
joins, right_index = [], 1
# Iterate over each pair in the through reflection chain, joining them together
through_reflection_chain.each_cons(2) do |left, right|
left_table, right_table = tables[left], tables[right]
if left.source_reflection.nil?
case left.macro
when :belongs_to
joins << inner_join(
right_table,
left_table[left.association_primary_key],
right_table[left.foreign_key],
reflection_conditions(right_index)
)
when :has_many, :has_one
joins << inner_join(
right_table,
left_table[left.foreign_key],
right_table[right.association_primary_key],
reflection_conditions(right_index)
)
when :has_and_belongs_to_many
joins << inner_join(
right_table,
left_table.first[left.foreign_key],
right_table[right.klass.primary_key],
reflection_conditions(right_index)
)
end
else
case left.source_reflection.macro
when :belongs_to
joins << inner_join(
right_table,
left_table[left.association_primary_key],
right_table[left.foreign_key],
reflection_conditions(right_index)
)
when :has_many, :has_one
if right.macro == :has_and_belongs_to_many
join_table, right_table = tables[right]
end
joins << inner_join(
right_table,
left_table[left.foreign_key],
right_table[left.source_reflection.active_record_primary_key],
reflection_conditions(right_index)
)
if right.macro == :has_and_belongs_to_many
joins << inner_join(
join_table,
right_table[right.klass.primary_key],
join_table[right.association_foreign_key]
)
end
when :has_and_belongs_to_many
join_table, left_table = tables[left]
joins << inner_join(
join_table,
left_table[left.klass.primary_key],
join_table[left.association_foreign_key]
)
joins << inner_join(
right_table,
join_table[left.foreign_key],
right_table[right.klass.primary_key],
reflection_conditions(right_index)
)
end
end
right_index += 1
end
joins
end
# Construct attributes for :through pointing to owner and associate. This is used by the
# methods which create and delete records on the association.
#
# We only support indirectly modifying through associations which has a belongs_to source.
# This is the "has_many :tags, :through => :taggings" situation, where the join model
# typically has a belongs_to on both side. In other words, associations which could also
# be represented as has_and_belongs_to_many associations.
#
# We do not support creating/deleting records on the association where the source has
# some other type, because this opens up a whole can of worms, and in basically any
# situation it is more natural for the user to just create or modify their join records
# directly as required.
def construct_join_attributes(*records)
if source_reflection.macro != :belongs_to
raise HasManyThroughCantAssociateThroughHasOneOrManyReflection.new(owner, reflection)
end
join_attributes = {
source_reflection.foreign_key =>
records.map { |record|
record.send(source_reflection.association_primary_key)
}
}
if options[:source_type]
join_attributes[source_reflection.foreign_type] =
records.map { |record| record.class.base_class.name }
end
if records.count == 1
Hash[join_attributes.map { |k, v| [k, v.first] }]
else
join_attributes
end
end
def alias_tracker
@alias_tracker ||= AliasTracker.new
end
# TODO: It is decidedly icky to have an array for habtm entries, and no array for others
def tables
@tables ||= begin
Hash[
through_reflection_chain.map do |reflection|
table = alias_tracker.aliased_table_for(
reflection.table_name,
table_alias_for(reflection, reflection != self.reflection)
)
if reflection.macro == :has_and_belongs_to_many ||
(reflection.source_reflection &&
reflection.source_reflection.macro == :has_and_belongs_to_many)
join_table = alias_tracker.aliased_table_for(
(reflection.source_reflection || reflection).options[:join_table],
table_alias_for(reflection, true)
)
[reflection, [join_table, table]]
else
[reflection, table]
end
end
]
end
end
def table_alias_for(reflection, join = false)
name = alias_tracker.pluralize(reflection.name)
name << "_#{self.reflection.name}"
name << "_join" if join
name
end
def inner_join(table, left_column, right_column, *conditions)
conditions << left_column.eq(right_column)
table.create_join(
table,
table.create_on(table.create_and(conditions.flatten.compact)))
end
def reflection_conditions(index)
reflection = through_reflection_chain[index]
conditions = through_conditions[index]
unless conditions.empty?
Arel::Nodes::And.new(process_conditions(conditions, reflection))
end
end
def process_conditions(conditions, reflection)
conditions.map do |condition|
condition = reflection.klass.send(:sanitize_sql, interpolate(condition), reflection.table_name)
condition = Arel.sql(condition) unless condition.is_a?(Arel::Node)
condition
end
end
# TODO: Think about this in the context of nested associations
def stale_state
if through_reflection.macro == :belongs_to
owner[through_reflection.foreign_key].to_s
end
end
def foreign_key_present?
through_reflection.macro == :belongs_to &&
!owner[through_reflection.foreign_key].nil?
end
def ensure_not_nested
if reflection.nested?
raise HasManyThroughNestedAssociationsAreReadonly.new(owner, reflection)
end
end
end
end
end
|