Add new Rails/I18nLocaleTexts cop

[fatkodima]

Closes #624

cc @pirj

[pirj]

Fantastic, thank you (for my dreams come true)!

[pirj]

Cosmetic: is .each necessary? Would just validation_message(node) do |text_node| work?
I understand that def_node_search needs to be replaced with def_node_matcher, and the node pattern gains more weight.

I'm thinking of something like (please accept my apologies for a contrived example):

  validates :username,
    uniqueness: {
      message: ->(object, data) do
        {message: 'ough oh', value: data.value}.to_s
      end
    }

[pirj]

Writing this as:

def on_send(node)
  validation_message?(node, &method(:add_offence))
  redirect_to_flash?(node, &method(:add_offence))
  flash_assignment?(node, &method(:add_offence))
  mail_subject?(node, &method(:add_offence))
end

would also allow getting rid of an early return and to_a.last.

Subjectively, cleaner. But again, pretty cosmetic.

[fatkodima]

Cosmetic: is .each necessary?

Checked, indeed works without it.

Agreed, cleaner, despite I personally not a fan of &method construction.
But the possible problem with this is that all the lines are executed, even if we have validation and it should skip the rest of the checks.

So, should be done as return if something?(...) x 4 ?

[pirj]

I couldn't find a mention of this in Rails guides or API. Does message: :code_format work?
Do you think it would be possible to come up with a more conventional example like:

validates :name, presence: true

The key for the error message in this case is :blank. Active Record will look up this key in the namespaces ... activerecord.errors.models.[model_name].attributes.[attribute_name], ... it will try the following keys:

activerecord.errors.models.user.attributes.name.blank

This way, message: doesn't even have to be specified.

[fatkodima]

https://github.com/rails/rails/blob/9b857799eb35c4175027980651d645bee955e148/activemodel/test/cases/validations/i18n_validation_test.rb#L460-L466

Changed to more conventional example to make it simpler and decrease possible confusion.

[pirj]

Cosmetic: does this need to be double commented? YAML is a file, too, just like Ruby code below. Is there a specific semantic to it, will it appear differently in cop's docs?

[fatkodima]

Unfortunately, this is required, because otherwise documentation generator raises an error regarding colons.

lib/rubocop/cop/rails/i18n_locale_texts.rb: Syntax Error in an example. unexpected token tCOLON

[pirj]

Would $str work the same way as $str_type??

[fatkodima]

Works, thanks 👍

[pirj]

Wondering what it would stumble across real-world-rails apps 🤔

[fatkodima]

Ran on Gitlab's codebase:

24875 files inspected, 87 offenses detected

and 0 errors.

[koic]

Is #bad forgotten?

Suggested change

	# class UserMailer < ApplicationMailer
	# # bad
	# class UserMailer < ApplicationMailer

[koic]

@fatkodima Looks good overall. Can you fix the one left comment (#643 (comment)) and squash your commits into one?

[fatkodima]

@koic Done.

[koic]

Thank you!