Support i18n key at translation of value in submit tag

[deraru]

Summary

Currently submit tag value translation does not support i18n key style
locale key.
It confuses me a bit because many other components support i18n key
style locale key.
I added i18n key style locale key support to submit tag.

[rails-bot]

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @chancancode (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

[rafaelfranca]

Could you explain better what is not supported now? For what I could see by the code i18n is supported

[deraru]

I try to write code example.

class RichBlog::PoorPost << ActiveRecord::Base
end

en:
  activerecord:
    models:
      rich_blog/poor_post: blog post
    attributes:
      rich_blog/poor_post:
        title: post title
  helpers:
    submit:
      rich_blog_poor_post:
        create: Post my post

activerecord.models and activerecord.attributes (and more) keys allow rich_blog/poor_post.
But helpers.submit key does not allow rich_blog/poor_post.

[rafaelfranca]

Thanks! It make sense to me. Could you add a test case and a CHANGELOG entry?

[rafaelfranca]

Instead of adding a new lookup can we add the :"helpers.submit.#{object.model_name.i18n_key}.#{key}" if it object responds to model_name and defaults << :"helpers.submit.#{object_name}.#{key}" if it doesn't?

[deraru]

What should I think about specification of :as option?
If :as option is given to form_for method, is it prior than actual model name in translation?
For example,

class Blog::Post << ActiveRecord::Base
end

form_for @blog_post, as: :my_post do |f|
  f.submit
end

en:
  helpers:
    submit:
      "blog/post":
        create: Post blog post
      my_post:
        create: Post my post

Then which value is expected Post blog post or Post my post?

[rafaelfranca]

Instead of adding a new lookup can we add the :"helpers.submit.#{object.model_name.i18n_key}.#{key}" if it object responds to model_name and defaults << :"helpers.submit.#{object_name}.#{key}" if it doesn't?

[deraru]

Could you add a test case and a CHANGELOG entry?

Got it!

[m5o]

i18n-debug is very useful to debug/visualize which translations are being looked up by Rails

Just in case you didn't know this handy helper 🤓

[deraru]

@rafaelfranca Could you reply to #26799 (comment) ?
I think https://github.com/rails/rails/blob/v5.0.0.1/actionview/test/template/form_helper_test.rb#L2217-L2229 is conflicting test case.

[deraru]

@rafaelfranca Any update on this?

[deraru]

Consider :as and :scope option is the top priority for i18n key.

[deraru]

Not modified existing tests.

[deraru]

Add new test about code that I implemented.

[deraru]

@rafaelfranca Could you review again?

[deraru]

@rafaelfranca Hello. Any updates on this?

[deraru]

@rafaelfranca Hello, what should I do for this?

[rafaelfranca]

Sorry, I dropped the ball here. Can you squash your commits and rebase this branch? The code looks good.

[deraru]

Thank you 😄 Got it!

[deraru]

Wow! I'm so happy because this is a my first time Rails contribution!
Thank you @rafaelfranca !

[rafaelfranca]

Thank YOU! And welcome to the list of contributors http://contributors.rubyonrails.org/contributors/rui-onodera/commits

[seppsepp]

@deraru Thanks for your contribution. I'm wondering why this feature does not work as expected for me ...

I got the following namespaced model Attempts::RandomAttempt:

class Attempt < ApplicationRecord
end

class Attempts::RandomAttempt < Attempt
end

In the view helper for the default submit value the code does not reach this line:

https://github.com/rails/rails/blob/main/actionview/lib/action_view/helpers/form_helper.rb#L2682

This line would produce the expected lookup key en.helpers.submit.attempts/random_attempt.create. But one line up i the code the condition object_name.to_s == model.downcase is false because object_name is "attempts_random_attempt" and model is "Random attempt".

That's why the code proceeds with the line defaults << :"helpers.submit.#{object_name}.#{key}" and the lookup key becomes en.helpers.submit.attempts_random_attempt.create with an underscore after attempts which is not expected as far as I understood.

I'm by far not familiar enough with Rails to come up with a better condition in line https://github.com/rails/rails/blob/main/actionview/lib/action_view/helpers/form_helper.rb#L2681 but the current one seems to be too exclusive. Maybe @rafaelfranca can assist?

I'm looking forward to your reply. Thanks a lot in advance.

I'm using Rails 7.0.4.2 btw.

[seppsepp]

For example line https://github.com/rails/rails/blob/main/actionview/lib/action_view/helpers/form_helper.rb#L2674 could be changed from object.model_name.human to object.model_name.param_key which preserves the namespace which otherwise human would remove. I have to admit it feels a bit weird to use a params related method there ¯\_(ツ)_/¯ . I let the ActionView form_helper tests run and they pass with this change.