Rails/RedundantPresenceValidationOnBelongsTo detect an offence on validations with custom messages.

[desheikh]

Rails/RedundantPresenceValidationOnBelongsTo detect and offence with a custom message attribute.

---

Expected behavior

validates :user presence: {
    message: 'My custom error message',
 }

rubocop should not raise an offense.

Actual behavior

rubocop raises an offense and will remove the validation on autocorrect.

Steps to reproduce the problem

Add a validation block to a model as above and run rubocop.

RuboCop version

$ [bundle exec] rubocop -V
1.24.1 (using Parser 3.1.0.0, rubocop-ast 1.15.1, running on ruby 2.7.5 x86_64-darwin19)
  - rubocop-rails 2.13.1
  - rubocop-rspec 2.7.0

[pirj]

I believe that the correct way of setting the message is via I18n files. E.g. for

class Foo < ApplicationRecord
  belongs_to :bar
  validates :bar, presence: { message: 'show me the way to the next whiskey bar' }
end

The convention is to:

# config/locales/en.yml (or config/locales/activerecord/en.yml depending on your preference)
en:
  activerecord:
    errors:
      models:
        foo:
          attributes:
            name:
              required: show me the way to the next whiskey bar

I don't particularly agree that the cop should ignore such validation.

We've marked the cop as unsafe for autocorrection, see #615, specifically because it affects the wording of the error message.

Would you like to send a PR with a clarification regarding error message I18n for @safety section?

[koic]

I think this issue can be divided as follows:

• Rails/RedundantPresenceValidationOnBelongsTo cop does not register an offense when using presence: { message: 'message' } option.
• Another cop registers an offense to replace the option with I18n for that case.

[desheikh]

Pirj, I wonder how common that is for rails apps unless they are localizing.
I like Koic's approach, as it separates the two concerns into individual rules.

[pirj]

Sounds reasonable 👍

Let's split the job, I can take care of the I18n cop. Would you send a PR with RedundantPresenceValidationOnBelongsTo changes?

[koic]

Rails/RedundantPresenceValidationOnBelongsTo cop does not register an offense when using presence: { message: 'message' } option.

I will take it because there are #616 adjustments.

[pirj]

how common that is for rails apps unless they are localizing

Should be pretty common: https://rails.rubystyle.guide/#locale-texts