aboutsummaryrefslogtreecommitdiffstats
path: root/activemodel/test/cases/validations/i18n_validation_test.rb
blob: 35bb918f264e38f85434f8344f71df0aa4363bf3 (plain) (blame)
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
460
461
462
463
464
465
466
# frozen_string_literal: true

require "cases/helper"
require "models/person"

class I18nValidationTest < ActiveModel::TestCase
  def setup
    Person.clear_validators!
    @person = person_class.new

    @old_load_path, @old_backend = I18n.load_path.dup, I18n.backend
    I18n.load_path.clear
    I18n.backend = I18n::Backend::Simple.new
    I18n.backend.store_translations("en", errors: { messages: { custom: nil } })

    @original_i18n_customize_full_message = ActiveModel::Errors.i18n_customize_full_message
    ActiveModel::Errors.i18n_customize_full_message = true
  end

  def teardown
    person_class.clear_validators!
    self.class.send(:remove_const, :Person)
    @person_stub = nil
    I18n.load_path.replace @old_load_path
    I18n.backend = @old_backend
    I18n.backend.reload!
    ActiveModel::Errors.i18n_customize_full_message = @original_i18n_customize_full_message
  end

  def test_full_message_encoding
    I18n.backend.store_translations("en", errors: {
      messages: { too_short: "猫舌" } })
    person_class.validates_length_of :title, within: 3..5
    @person.valid?
    assert_equal ["Title 猫舌"], @person.errors.full_messages
  end

  def test_errors_full_messages_translates_human_attribute_name_for_model_attributes
    @person.errors.add(:name, "not found")
    assert_called_with(person_class, :human_attribute_name, ["name", default: "Name"], returns: "Person's name") do
      assert_equal ["Person's name not found"], @person.errors.full_messages
    end
  end

  def test_errors_full_messages_uses_format
    I18n.backend.store_translations("en", errors: { format: "Field %{attribute} %{message}" })
    @person.errors.add("name", "empty")
    assert_equal ["Field Name empty"], @person.errors.full_messages
  end

  def test_errors_full_messages_doesnt_use_attribute_format_without_config
    ActiveModel::Errors.i18n_customize_full_message = false

    I18n.backend.store_translations("en", activemodel: {
      errors: { models: { person: { attributes: { name: { format: "%{message}" } } } } } })

    person = person_class.new
    assert_equal "Name cannot be blank", person.errors.full_message(:name, "cannot be blank")
    assert_equal "Name test cannot be blank", person.errors.full_message(:name_test, "cannot be blank")
  end

  def test_errors_full_messages_uses_attribute_format
    ActiveModel::Errors.i18n_customize_full_message = true

    I18n.backend.store_translations("en", activemodel: {
      errors: { models: { person: { attributes: { name: { format: "%{message}" } } } } } })

    person = person_class.new
    assert_equal "cannot be blank", person.errors.full_message(:name, "cannot be blank")
    assert_equal "Name test cannot be blank", person.errors.full_message(:name_test, "cannot be blank")
  end

  def test_errors_full_messages_uses_model_format
    ActiveModel::Errors.i18n_customize_full_message = true

    I18n.backend.store_translations("en", activemodel: {
      errors: { models: { person: { format: "%{message}" } } } })

    person = person_class.new
    assert_equal "cannot be blank", person.errors.full_message(:name, "cannot be blank")
    assert_equal "cannot be blank", person.errors.full_message(:name_test, "cannot be blank")
  end

  def test_errors_full_messages_uses_deeply_nested_model_attributes_format
    ActiveModel::Errors.i18n_customize_full_message = true

    I18n.backend.store_translations("en", activemodel: {
      errors: { models: { 'person/contacts/addresses': { attributes: { street: { format: "%{message}" } } } } } })

    person = person_class.new
    assert_equal "cannot be blank", person.errors.full_message(:'contacts/addresses.street', "cannot be blank")
    assert_equal "Contacts/addresses country cannot be blank", person.errors.full_message(:'contacts/addresses.country', "cannot be blank")
  end

  def test_errors_full_messages_uses_deeply_nested_model_model_format
    ActiveModel::Errors.i18n_customize_full_message = true

    I18n.backend.store_translations("en", activemodel: {
      errors: { models: { 'person/contacts/addresses': { format: "%{message}" } } } })

    person = person_class.new
    assert_equal "cannot be blank", person.errors.full_message(:'contacts/addresses.street', "cannot be blank")
    assert_equal "cannot be blank", person.errors.full_message(:'contacts/addresses.country', "cannot be blank")
  end

  def test_errors_full_messages_with_indexed_deeply_nested_attributes_and_attributes_format
    ActiveModel::Errors.i18n_customize_full_message = true

    I18n.backend.store_translations("en", activemodel: {
      errors: { models: { 'person/contacts/addresses': { attributes: { street: { format: "%{message}" } } } } } })

    person = person_class.new
    assert_equal "cannot be blank", person.errors.full_message(:'contacts[0]/addresses[0].street', "cannot be blank")
    assert_equal "Contacts/addresses country cannot be blank", person.errors.full_message(:'contacts[0]/addresses[0].country', "cannot be blank")
  end

  def test_errors_full_messages_with_indexed_deeply_nested_attributes_and_model_format
    ActiveModel::Errors.i18n_customize_full_message = true

    I18n.backend.store_translations("en", activemodel: {
      errors: { models: { 'person/contacts/addresses': { format: "%{message}" } } } })

    person = person_class.new
    assert_equal "cannot be blank", person.errors.full_message(:'contacts[0]/addresses[0].street', "cannot be blank")
    assert_equal "cannot be blank", person.errors.full_message(:'contacts[0]/addresses[0].country', "cannot be blank")
  end

  def test_errors_full_messages_with_indexed_deeply_nested_attributes_and_i18n_attribute_name
    ActiveModel::Errors.i18n_customize_full_message = true

    I18n.backend.store_translations("en", activemodel: {
      attributes: { 'person/contacts/addresses': { country: "Country" } }
    })

    person = person_class.new
    assert_equal "Contacts/addresses street cannot be blank", person.errors.full_message(:'contacts[0]/addresses[0].street', "cannot be blank")
    assert_equal "Country cannot be blank", person.errors.full_message(:'contacts[0]/addresses[0].country', "cannot be blank")
  end

  def test_errors_full_messages_with_indexed_deeply_nested_attributes_without_i18n_config
    ActiveModel::Errors.i18n_customize_full_message = false

    I18n.backend.store_translations("en", activemodel: {
      errors: { models: { 'person/contacts/addresses': { attributes: { street: { format: "%{message}" } } } } } })

    person = person_class.new
    assert_equal "Contacts[0]/addresses[0] street cannot be blank", person.errors.full_message(:'contacts[0]/addresses[0].street', "cannot be blank")
    assert_equal "Contacts[0]/addresses[0] country cannot be blank", person.errors.full_message(:'contacts[0]/addresses[0].country', "cannot be blank")
  end

  def test_errors_full_messages_with_i18n_attribute_name_without_i18n_config
    ActiveModel::Errors.i18n_customize_full_message = false

    I18n.backend.store_translations("en", activemodel: {
      attributes: { 'person/contacts[0]/addresses[0]': { country: "Country" } }
    })

    person = person_class.new
    assert_equal "Contacts[0]/addresses[0] street cannot be blank", person.errors.full_message(:'contacts[0]/addresses[0].street', "cannot be blank")
    assert_equal "Country cannot be blank", person.errors.full_message(:'contacts[0]/addresses[0].country', "cannot be blank")
  end

  # ActiveModel::Validations

  # A set of common cases for ActiveModel::Validations message generation that
  # are used to generate tests to keep things DRY
  #
  COMMON_CASES = [
    # [ case,                              validation_options,            generate_message_options]
    [ "given no options",                  {},                            {}],
    [ "given custom message",              { message: "custom" },         { message: "custom" }],
    [ "given if condition",                { if:                          lambda { true } },  {}],
    [ "given unless condition",            { unless:                      lambda { false } }, {}],
    [ "given option that is not reserved", { format: "jpg" },             { format: "jpg" }]
  ]

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_confirmation_of on generated message #{name}" do
      person_class.validates_confirmation_of :title, validation_options
      @person.title_confirmation = "foo"
      call = [:title_confirmation, :confirmation, generate_message_options.merge(attribute: "Title")]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_acceptance_of on generated message #{name}" do
      person_class.validates_acceptance_of :title, validation_options.merge(allow_nil: false)
      call = [:title, :accepted, generate_message_options]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_presence_of on generated message #{name}" do
      person_class.validates_presence_of :title, validation_options
      call = [:title, :blank, generate_message_options]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_length_of for :within on generated message when too short #{name}" do
      person_class.validates_length_of :title, validation_options.merge(within: 3..5)
      call = [:title, :too_short, generate_message_options.merge(count: 3)]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_length_of for :too_long generated message #{name}" do
      person_class.validates_length_of :title, validation_options.merge(within: 3..5)
      @person.title = "this title is too long"
      call = [:title, :too_long, generate_message_options.merge(count: 5)]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_length_of for :is on generated message #{name}" do
      person_class.validates_length_of :title, validation_options.merge(is: 5)
      call = [:title, :wrong_length, generate_message_options.merge(count: 5)]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_format_of on generated message #{name}" do
      person_class.validates_format_of :title, validation_options.merge(with: /\A[1-9][0-9]*\z/)
      @person.title = "72x"
      call = [:title, :invalid, generate_message_options.merge(value: "72x")]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_inclusion_of on generated message #{name}" do
      person_class.validates_inclusion_of :title, validation_options.merge(in: %w(a b c))
      @person.title = "z"
      call = [:title, :inclusion, generate_message_options.merge(value: "z")]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_inclusion_of using :within on generated message #{name}" do
      person_class.validates_inclusion_of :title, validation_options.merge(within: %w(a b c))
      @person.title = "z"
      call = [:title, :inclusion, generate_message_options.merge(value: "z")]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_exclusion_of generated message #{name}" do
      person_class.validates_exclusion_of :title, validation_options.merge(in: %w(a b c))
      @person.title = "a"
      call = [:title, :exclusion, generate_message_options.merge(value: "a")]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_exclusion_of using :within generated message #{name}" do
      person_class.validates_exclusion_of :title, validation_options.merge(within: %w(a b c))
      @person.title = "a"
      call = [:title, :exclusion, generate_message_options.merge(value: "a")]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_numericality_of generated message #{name}" do
      person_class.validates_numericality_of :title, validation_options
      @person.title = "a"
      call = [:title, :not_a_number, generate_message_options.merge(value: "a")]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_numericality_of for :only_integer on generated message #{name}" do
      person_class.validates_numericality_of :title, validation_options.merge(only_integer: true)
      @person.title = "0.0"
      call = [:title, :not_an_integer, generate_message_options.merge(value: "0.0")]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_numericality_of for :odd on generated message #{name}" do
      person_class.validates_numericality_of :title, validation_options.merge(only_integer: true, odd: true)
      @person.title = 0
      call = [:title, :odd, generate_message_options.merge(value: 0)]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  COMMON_CASES.each do |name, validation_options, generate_message_options|
    test "validates_numericality_of for :less_than on generated message #{name}" do
      person_class.validates_numericality_of :title, validation_options.merge(only_integer: true, less_than: 0)
      @person.title = 1
      call = [:title, :less_than, generate_message_options.merge(value: 1, count: 0)]
      assert_called_with(@person.errors, :generate_message, call) do
        @person.valid?
      end
    end
  end

  # To make things DRY this macro is created to define 3 tests for every validation case.
  def self.set_expectations_for_validation(validation, error_type, &block_that_sets_validation)
    if error_type == :confirmation
      attribute = :title_confirmation
    else
      attribute = :title
    end

    test "#{validation} finds custom model key translation when #{error_type}" do
      I18n.backend.store_translations "en", activemodel: { errors: { models: { person: { attributes: { attribute => { error_type => "custom message" } } } } } }
      I18n.backend.store_translations "en", errors: { messages: { error_type => "global message" } }

      yield(@person, {})
      @person.valid?
      assert_equal ["custom message"], @person.errors[attribute]
    end

    test "#{validation} finds custom model key translation with interpolation when #{error_type}" do
      I18n.backend.store_translations "en", activemodel: { errors: { models: { person: { attributes: { attribute => { error_type => "custom message with %{extra}" } } } } } }
      I18n.backend.store_translations "en", errors: { messages: { error_type => "global message" } }

      yield(@person, { extra: "extra information" })
      @person.valid?
      assert_equal ["custom message with extra information"], @person.errors[attribute]
    end

    test "#{validation} finds global default key translation when #{error_type}" do
      I18n.backend.store_translations "en", errors: { messages: { error_type => "global message" } }

      yield(@person, {})
      @person.valid?
      assert_equal ["global message"], @person.errors[attribute]
    end
  end

  set_expectations_for_validation "validates_confirmation_of", :confirmation do |person, options_to_merge|
    person.class.validates_confirmation_of :title, options_to_merge
    person.title_confirmation = "foo"
  end

  set_expectations_for_validation "validates_acceptance_of", :accepted do |person, options_to_merge|
    person.class.validates_acceptance_of :title, options_to_merge.merge(allow_nil: false)
  end

  set_expectations_for_validation "validates_presence_of", :blank do |person, options_to_merge|
    person.class.validates_presence_of :title, options_to_merge
  end

  set_expectations_for_validation "validates_length_of", :too_short do |person, options_to_merge|
    person.class.validates_length_of :title, options_to_merge.merge(within: 3..5)
  end

  set_expectations_for_validation "validates_length_of", :too_long do |person, options_to_merge|
    person.class.validates_length_of :title, options_to_merge.merge(within: 3..5)
    person.title = "too long"
  end

  set_expectations_for_validation "validates_length_of", :wrong_length do |person, options_to_merge|
    person.class.validates_length_of :title, options_to_merge.merge(is: 5)
  end

  set_expectations_for_validation "validates_format_of", :invalid do |person, options_to_merge|
    person.class.validates_format_of :title, options_to_merge.merge(with: /\A[1-9][0-9]*\z/)
  end

  set_expectations_for_validation "validates_inclusion_of", :inclusion do |person, options_to_merge|
    person.class.validates_inclusion_of :title, options_to_merge.merge(in: %w(a b c))
  end

  set_expectations_for_validation "validates_exclusion_of", :exclusion do |person, options_to_merge|
    person.class.validates_exclusion_of :title, options_to_merge.merge(in: %w(a b c))
    person.title = "a"
  end

  set_expectations_for_validation "validates_numericality_of", :not_a_number do |person, options_to_merge|
    person.class.validates_numericality_of :title, options_to_merge
    person.title = "a"
  end

  set_expectations_for_validation "validates_numericality_of", :not_an_integer do |person, options_to_merge|
    person.class.validates_numericality_of :title, options_to_merge.merge(only_integer: true)
    person.title = "1.0"
  end

  set_expectations_for_validation "validates_numericality_of", :odd do |person, options_to_merge|
    person.class.validates_numericality_of :title, options_to_merge.merge(only_integer: true, odd: true)
    person.title = 0
  end

  set_expectations_for_validation "validates_numericality_of", :less_than do |person, options_to_merge|
    person.class.validates_numericality_of :title, options_to_merge.merge(only_integer: true, less_than: 0)
    person.title = 1
  end

  def test_validations_with_message_symbol_must_translate
    I18n.backend.store_translations "en", errors: { messages: { custom_error: "I am a custom error" } }
    person_class.validates_presence_of :title, message: :custom_error
    @person.title = nil
    @person.valid?
    assert_equal ["I am a custom error"], @person.errors[:title]
  end

  def test_validates_with_message_symbol_must_translate_per_attribute
    I18n.backend.store_translations "en", activemodel: { errors: { models: { person: { attributes: { title: { custom_error: "I am a custom error" } } } } } }
    person_class.validates_presence_of :title, message: :custom_error
    @person.title = nil
    @person.valid?
    assert_equal ["I am a custom error"], @person.errors[:title]
  end

  def test_validates_with_message_symbol_must_translate_per_model
    I18n.backend.store_translations "en", activemodel: { errors: { models: { person: { custom_error: "I am a custom error" } } } }
    person_class.validates_presence_of :title, message: :custom_error
    @person.title = nil
    @person.valid?
    assert_equal ["I am a custom error"], @person.errors[:title]
  end

  def test_validates_with_message_string
    person_class.validates_presence_of :title, message: "I am a custom error"
    @person.title = nil
    @person.valid?
    assert_equal ["I am a custom error"], @person.errors[:title]
  end

  def person_class
    @person_stub ||= self.class.const_set(:Person, Class.new(Person))
  end
end