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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
|
describe "attribute aliases" do
around do |example|
original_aliases = FactoryBot.aliases.dup
example.run
ensure
FactoryBot.aliases.clear
FactoryBot.aliases.concat(original_aliases)
end
describe "basic alias functionality" do
it "allows using different parameter names that map to model attributes" do
FactoryBot.aliases << [/author_name/, "name"]
define_model("User", name: :string, author_name: :string)
FactoryBot.define do
factory :user do
name { "Default Name" }
end
end
user = FactoryBot.create(:user, author_name: "Custom Name")
expect(user.author_name).to eq "Custom Name"
expect(user.name).to be_nil
end
it "ignores factory defaults when alias is used" do
FactoryBot.aliases << [/display_name/, "name"]
define_model("User", name: :string, display_name: :string)
FactoryBot.define do
factory :user do
name { "Factory Name" }
end
end
user = FactoryBot.create(:user, display_name: "Override Name")
expect(user.display_name).to eq "Override Name"
expect(user.name).to be_nil
end
end
describe "built-in _id aliases" do
it "automatically alias between associations and foreign keys" do
define_model("User", name: :string)
define_model("Post", user_id: :integer) do
belongs_to :user, optional: true
end
FactoryBot.define do
factory :user do
name { "Test User" }
end
factory :post
end
user = FactoryBot.create(:user)
post_with_direct_id = FactoryBot.create(:post, user_id: user.id)
expect(post_with_direct_id.user_id).to eq user.id
post_with_association = FactoryBot.create(:post, user: user)
expect(post_with_association.user_id).to eq user.id
end
it "prevents conflicts between associations and foreign keys" do
define_model("User", name: :string, age: :integer)
define_model("Post", user_id: :integer) do
belongs_to :user
end
FactoryBot.define do
factory :user do
factory :user_with_name do
name { "John Doe" }
end
end
factory :post do
user
end
end
post_with_foreign_key = FactoryBot.build(:post, user_id: 1)
expect(post_with_foreign_key.user_id).to eq 1
end
it "allows passing attributes to associated factories" do
define_model("User", name: :string, age: :integer)
define_model("Post", user_id: :integer) do
belongs_to :user
end
FactoryBot.define do
factory :user do
factory :user_with_name do
name { "John Doe" }
end
end
factory :post do
user
end
factory :post_with_named_user, class: Post do
user factory: :user_with_name, age: 20
end
end
created_user = FactoryBot.create(:post_with_named_user).user
expect(created_user.name).to eq "John Doe"
expect(created_user.age).to eq 20
end
end
describe "custom alias patterns" do
it "supports regex patterns with capture groups" do
FactoryBot.aliases << [/(.+)_alias/, '\1']
define_model("User", name: :string, name_alias: :string, email: :string, email_alias: :string)
FactoryBot.define do
factory :user do
name { "Default Name" }
email { "default@example.com" }
end
end
user = FactoryBot.create(:user, name_alias: "Aliased Name", email_alias: "aliased@example.com")
expect(user.name).to be_nil
expect(user.email).to be_nil
expect(user.name_alias).to eq "Aliased Name"
expect(user.email_alias).to eq "aliased@example.com"
end
it "supports multiple alias patterns working together" do
FactoryBot.aliases << [/primary_(.+)/, '\1']
FactoryBot.aliases << [/alt_name/, "name"]
define_model("User", name: :string, email: :string, primary_email: :string, alt_name: :string)
FactoryBot.define do
factory :user do
name { "Default Name" }
email { "default@example.com" }
end
end
user = FactoryBot.create(:user, primary_email: "primary@example.com", alt_name: "Alternative Name")
expect(user.name).to be_nil
expect(user.email).to be_nil
expect(user.primary_email).to eq "primary@example.com"
expect(user.alt_name).to eq "Alternative Name"
end
it "works with custom foreign key names" do
FactoryBot.aliases << [/owner_id/, "user_id"]
define_model("User", name: :string)
define_model("Document", user_id: :integer, owner_id: :integer, title: :string) do
belongs_to :user, optional: true
end
FactoryBot.define do
factory :user do
name { "Test User" }
end
factory :document do
title { "Test Document" }
end
end
document_owner = FactoryBot.create(:user)
document = FactoryBot.create(:document, owner_id: document_owner.id)
expect(document.user_id).to be_nil
expect(document.owner_id).to eq document_owner.id
expect(document.title).to eq "Test Document"
end
end
describe "edge cases" do
it "allows setting nil values through aliases" do
FactoryBot.aliases << [/clear_name/, "name"]
define_model("User", name: :string, clear_name: :string)
FactoryBot.define do
factory :user do
name { "Default Name" }
end
end
user = FactoryBot.create(:user, clear_name: nil)
expect(user.name).to be_nil
expect(user.clear_name).to be_nil
end
context "when both alias and target attributes exist on model" do
it "ignores factory defaults for target when alias is used" do
FactoryBot.aliases << [/one/, "two"]
define_model("User", two: :string, one: :string)
FactoryBot.define do
factory :user do
two { "set value" }
end
end
user = FactoryBot.create(:user, one: "override")
expect(user.one).to eq "override"
expect(user.two).to be_nil
end
end
end
describe "with attributes_for strategy" do
it "includes alias names in hash and ignores aliased factory defaults" do
FactoryBot.aliases << [/author_name/, "name"]
define_model("User", name: :string, author_name: :string)
FactoryBot.define do
factory :user do
name { "Default Name" }
end
end
attributes = FactoryBot.attributes_for(:user, author_name: "Custom Name")
expect(attributes[:author_name]).to eq "Custom Name"
expect(attributes[:name]).to be_nil
end
end
describe "attribute conflicts with _id patterns" do
it "doesn't set factory defaults when alias is used instead of target attribute" do
define_model("User", name: :string, response_id: :integer)
FactoryBot.define do
factory :user do
name { "orig name" }
response_id { 42 }
end
end
attributes = FactoryBot.attributes_for(:user, name: "new name", response: 13.75)
expect(attributes[:name]).to eq "new name"
expect(attributes[:response]).to eq 13.75
expect(attributes[:response_id]).to be_nil
end
it "allows setting both attribute and attribute_id without conflicts" do
define_model("User", name: :string, response: :string, response_id: :float)
FactoryBot.define do
factory :user do
name { "orig name" }
response { "orig response" }
response_id { 42 }
end
end
user = FactoryBot.build(:user, name: "new name", response: "new response", response_id: 13.75)
expect(user.name).to eq "new name"
expect(user.response).to eq "new response"
expect(user.response_id).to eq 13.75
end
context "when association overrides trait foreign key" do
before do
define_model("User", name: :string)
define_model("Post", user_id: :integer, title: :string) do
belongs_to :user, optional: true
end
FactoryBot.define do
factory :user do
name { "Test User" }
end
factory :post do
association :user
title { "Test Post" }
trait :with_system_user_id do
user_id { 999 }
end
trait :with_user_id_100 do
user_id { 100 }
end
trait :with_user_id_200 do
user_id { 200 }
end
end
end
end
it "prefers association override over trait foreign key" do
user = FactoryBot.create(:user)
post = FactoryBot.build(:post, :with_system_user_id, user: user)
expect(post.user).to be user
expect(post.user_id).to eq user.id
end
it "uses trait foreign key when no association override is provided" do
post = FactoryBot.build(:post, :with_system_user_id)
expect(post.user).to be nil
expect(post.user_id).to eq 999
end
it "handles multiple traits with foreign keys correctly" do
user = FactoryBot.create(:user)
post = FactoryBot.build(:post, :with_user_id_100, :with_user_id_200, user: user)
expect(post.user).to be user
expect(post.user_id).to eq user.id
end
end
end
context "when a factory defines attributes for both sides of an association" do
before do
define_model("User", name: :string, age: :integer)
define_model("Post", user_id: :integer, title: :string) do
belongs_to :user
end
end
context "when using the build strategy" do
it "prefers the :user association when defined after the :user_id attribute" do
FactoryBot.define do
factory :user
factory :post do
user_id { 999 }
user
end
end
user = FactoryBot.build_stubbed(:user)
post = FactoryBot.build(:post, user_id: user.id)
# A regression from v6.5.5 resulted in an extraneous user instance being
# built and assigned to post.user; it also failed to use the user_id override
expect(post.user).to be nil
expect(post.user_id).to eq user.id
end
it "prefers the :user_id attribute when defined after the :user attribute" do
FactoryBot.define do
factory :user
factory :post do
user
user_id { 999 }
end
end
user = FactoryBot.build_stubbed(:user)
post = FactoryBot.build(:post, user: user)
# A regression from v6.5.5 erroneously assigns the value of 999 to post.user_id
# and fails to assign the user override
expect(post.user).to be user
expect(post.user_id).to be user.id
end
end
context "when using the create strategy" do
it "handles an override of the foreign key when the :user association is declared last" do
FactoryBot.define do
factory :user
factory :post do
user_id { 999 }
user
end
end
user = FactoryBot.create(:user)
post = FactoryBot.create(:post, user_id: user.id)
# A regression in v6.5.5 created an erroneous second user and assigned
# that to post.user and post.user_id.
expect(post.user.id).to be user.id
expect(post.user_id).to eq user.id
expect(User.count).to eq 1
end
it "handles an override of the associated object when the :user association is declared last" do
FactoryBot.define do
factory :user
factory :post do
user_id { 999 }
user
end
end
user = FactoryBot.create(:user)
post = FactoryBot.create(:post, user: user)
# This worked fine in v6.5.5, no regression behavior exhibited
expect(post.user).to eq user
expect(post.user_id).to eq user.id
expect(User.count).to eq 1
end
it "handles an override of the associated object when :user_id is declared last" do
FactoryBot.define do
factory :user
factory :post do
user
# this :user_id attribute is purposely declared after :user
user_id { 999 }
end
end
user = FactoryBot.create(:user)
post = FactoryBot.create(:post, user: user)
# A regression from v6.5.5 erroneously asignes 999 to post.user_id
# and leaves post.user assigned to nil
expect(post.user_id).to eq user.id
expect(post.user).to eq user
expect(User.count).to eq 1
end
it "handles an override of the foreign key when :user_id is declared last" do
FactoryBot.define do
factory :user do
name { "tester" }
age { 99 }
end
factory :post do
user
# this :user_id attribute is purposely declared after :user
user_id { 999 }
end
end
user = FactoryBot.create(:user)
post = FactoryBot.create(:post, user_id: user.id)
# A regression from v6.5.5 assigns the expected values to post.user and post.user_id
# An erroneous second user instance, however, is created in the background
expect(post.user_id).to eq user.id
expect(post.user.id).to be user.id
expect(User.count).to eq 1
end
end
end
end
|
