Internationalize/I18n the Dashboard Engine #497

JuanVqz · 2022-01-26T06:00:36Z

@bensheldon, I had a little bit of progress, so I would like to share it with you

Related #408

JuanVqz · 2022-01-27T00:42:15Z

@bensheldon what do you think about the variable's name in the locales/en.yml file?

Is there a convention? Do you know?

bensheldon · 2022-01-27T01:07:50Z

@JuanVqz That looks fantastic! You did what I was imagining: Used relative keys (e.g. .key) that are namespaced to the template 👍

For the key names themselves, generic naming is ideal that describes the purpose of the string, rather than the contents. E.g.

"timezone_notice"
"current_time"
"coming_soon"

@bensheldon

@bensheldon, I had a little bit of progress, so I would like to share it with you

JuanVqz · 2022-01-27T04:01:20Z

I have already fixed the test that struggled in the CI.

bensheldon · 2022-01-27T04:26:31Z

This looks great. I think this would be a good time for you to pause on extracting strings, and next look into UI and routing to display the different locales.

JuanVqz · 2022-01-27T04:38:24Z

This looks great. I think this would be a good time for you to pause on extracting strings, and next look into UI and routing to display the different locales.

Yes, I agree, it seems a good time to pause it. What do you mean by looking into IU, should I add a select field with available languages?

Also, I have a question, until now I have been seen the /good_job page though the rspec test when running the system spec, but I'm wondering how can I see it in a rails app, I saw in the read me that I should point to the local gem but I don't fully understand how can I do it.

Should I create a new rails new app_name or the one is already in the rspec folder?
bundle config local.good_job /path/to/local/git/repository

bensheldon · 2022-01-27T04:59:59Z

What do you mean by looking into UI, should I add a select field with available languages?

Yep. I think simplest would just be a drop down menu in the Navbar with simple links. The Bootstrap docs should show you how to do that.

Great question about running it. You can run GoodJob's dashboard directly from the good job repo:

bin/setup
bin/test_app s # runs rails server

JuanVqz · 2022-01-30T07:52:36Z

Great question about running it. You can run GoodJob's dashboard directly from the good job repo:
bin/setup
bin/test_app s # runs rails server

this is super useful, thank you for sharing it.

I already started playing with the select field in the view, and I noticed that we may use the locale functionality in at least two ways, and I'm wondering which one would you like to have,

1 localhost:3000/en/good_job
I think, I will need to scope the routes in the route file

  # route.rb
  scope :lang do
    # routes
  end

2 localhost:3000/good_job?locale=en

Also, I'm wondering if the select field, should change the language once the user changes the option, or could we have a button to trigger the selection...

bensheldon · 2022-03-24T00:40:08Z

@JuanVqz oops, I didn't answer your question. I think option #2 is good for now.

This is the dropdown menu I think you should use, which would contain links: https://getbootstrap.com/docs/5.1/components/navs-tabs/#using-dropdowns

JuanVqz · 2022-03-29T05:06:58Z

@JuanVqz oops, I didn't answer your question. I think option #2 is good for now.

This is the dropdown menu I think you should use, which would contain links: https://getbootstrap.com/docs/5.1/components/navs-tabs/#using-dropdowns

There are some failing tests but it seems like we have some progress here.

@bensheldon what do you think?

bensheldon · 2022-03-30T03:00:58Z

@JuanVqz AWESOME! I will dive in later this week and get those tests passing. This looks really good.

JuanVqz · 2022-03-31T02:01:06Z

@JuanVqz AWESOME! I will dive in later this week and get those tests passing. This looks really good.

I got it green, there were some minor issues, also, I added the footer partial which didn't exist when I started working on this feature, now it seems ready to go...I'm open to making changes if needed. 👍

…`BaseController#switch_locale` and inline navbar html instead of helpers

JuanVqz · 2022-04-01T15:19:47Z

engine/app/controllers/good_job/base_controller.rb

@@ -3,7 +3,7 @@ module GoodJob
  class BaseController < ActionController::Base # rubocop:disable Rails/ApplicationController
    protect_from_forgery with: :exception

-    before_action :set_locale
+    around_action :switch_locale


why do you prefer around_action over before_action?

JuanVqz · 2022-04-01T15:20:26Z

engine/app/controllers/good_job/base_controller.rb

-    def set_locale
-      I18n.locale = current_locale
+    def switch_locale(&action)
+      I18n.with_locale(current_locale, &action)


what do you prefer with_locale?

Good question. I like that with_locale only changes the locale within the context of the block and then returns to the previous value. Because the Goodjob engine is running in the context of a parent application, I don't want to change the I18n.locale value globally because it might have an unexpected side effect in the parent application.

Good to know, yes, we don't want unexpected behavior 👍

Thank you for the info

bensheldon · 2022-04-02T01:50:38Z

@JuanVqz thank you! I feel great about this. Any items before I merge and release?

Thank you so much!!

JuanVqz · 2022-04-02T01:55:53Z

@JuanVqz thank you! I feel great about this. Any items before I merge and release?

Thank you so much!!

I'm happy to be part of it, I don't think so, I believe it is ready to be merged!

Thank you for the opportunity to contribute, I'll be around if I can take another issue ⚠️

… handle enforce_available_locales

JuanVqz · 2022-04-05T18:16:20Z

❤️ thank you!!!

igas · 2022-04-06T06:49:56Z

engine/app/controllers/good_job/base_controller.rb

@@ -24,10 +24,28 @@ class BaseController < ActionController::Base # rubocop:disable Rails/Applicatio
      request.content_security_policy_nonce_generator = ->(_request) { SecureRandom.base64(16) }
    end

+    def default_url_options(options = {})


Is there a particular need for it to be public? Now it's treated as an action.

@igas good catch. Could you make a PR for that?

JuanVqz force-pushed the internationalize-the-dashboard-engine branch 2 times, most recently from fbe0144 to 0ed18d9 Compare January 27, 2022 00:41

JuanVqz force-pushed the internationalize-the-dashboard-engine branch from 0ed18d9 to 7208bca Compare January 27, 2022 03:25

Internationalize/I18n the Dashboard Engine

cd6539c

@bensheldon, I had a little bit of progress, so I would like to share it with you

JuanVqz force-pushed the internationalize-the-dashboard-engine branch from 7208bca to cd6539c Compare January 27, 2022 04:00

Merge branch 'main' into internationalize-the-dashboard-engine

7565c20

JuanVqz force-pushed the internationalize-the-dashboard-engine branch from b86bd5b to f64254c Compare March 31, 2022 01:14

Add select language field

de6fccd

JuanVqz force-pushed the internationalize-the-dashboard-engine branch from f64254c to de6fccd Compare March 31, 2022 01:39

Add footer's locales

8e45d39

bensheldon added 3 commits April 1, 2022 06:58

Add i18n-tasks; normalize locale files and add datetime strings; use …

efcc43f

…`BaseController#switch_locale` and inline navbar html instead of helpers

Move i18n-tasks gem to lint group

e23bef8

Fix clicking on locale link in tests

4d9a1e4

JuanVqz commented Apr 1, 2022

View reviewed changes

bensheldon mentioned this pull request Apr 4, 2022

I18n::InvalidLocale (:en is not a valid locale): #549

Closed

Intersect I18n's available locales and GoodJob's available locales to…

35d27a4

… handle enforce_available_locales

bensheldon merged commit ee8e1b4 into bensheldon:main Apr 5, 2022

bensheldon mentioned this pull request Apr 5, 2022

Include locale in html lang attribute #556

Merged

JuanVqz deleted the internationalize-the-dashboard-engine branch April 5, 2022 18:16

igas reviewed Apr 6, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Internationalize/I18n the Dashboard Engine #497

Internationalize/I18n the Dashboard Engine #497

JuanVqz commented Jan 26, 2022 •

edited

Loading

JuanVqz commented Jan 27, 2022 •

edited

Loading

bensheldon commented Jan 27, 2022

JuanVqz commented Jan 27, 2022

bensheldon commented Jan 27, 2022

JuanVqz commented Jan 27, 2022 •

edited

Loading

bensheldon commented Jan 27, 2022

JuanVqz commented Jan 30, 2022

bensheldon commented Mar 24, 2022

JuanVqz commented Mar 29, 2022 •

edited

Loading

bensheldon commented Mar 30, 2022

JuanVqz commented Mar 31, 2022 •

edited

Loading

JuanVqz Apr 1, 2022

JuanVqz Apr 1, 2022

bensheldon Apr 1, 2022

JuanVqz Apr 2, 2022

bensheldon commented Apr 2, 2022

JuanVqz commented Apr 2, 2022 •

edited

Loading

JuanVqz commented Apr 5, 2022

igas Apr 6, 2022

bensheldon Apr 6, 2022

Internationalize/I18n the Dashboard Engine #497

Internationalize/I18n the Dashboard Engine #497

Conversation

JuanVqz commented Jan 26, 2022 • edited Loading

JuanVqz commented Jan 27, 2022 • edited Loading

bensheldon commented Jan 27, 2022

JuanVqz commented Jan 27, 2022

bensheldon commented Jan 27, 2022

JuanVqz commented Jan 27, 2022 • edited Loading

bensheldon commented Jan 27, 2022

JuanVqz commented Jan 30, 2022

bensheldon commented Mar 24, 2022

JuanVqz commented Mar 29, 2022 • edited Loading

bensheldon commented Mar 30, 2022

JuanVqz commented Mar 31, 2022 • edited Loading

JuanVqz Apr 1, 2022

Choose a reason for hiding this comment

JuanVqz Apr 1, 2022

Choose a reason for hiding this comment

bensheldon Apr 1, 2022

Choose a reason for hiding this comment

JuanVqz Apr 2, 2022

Choose a reason for hiding this comment

bensheldon commented Apr 2, 2022

JuanVqz commented Apr 2, 2022 • edited Loading

JuanVqz commented Apr 5, 2022

igas Apr 6, 2022

Choose a reason for hiding this comment

bensheldon Apr 6, 2022

Choose a reason for hiding this comment

JuanVqz commented Jan 26, 2022 •

edited

Loading

JuanVqz commented Jan 27, 2022 •

edited

Loading

JuanVqz commented Jan 27, 2022 •

edited

Loading

JuanVqz commented Mar 29, 2022 •

edited

Loading

JuanVqz commented Mar 31, 2022 •

edited

Loading

JuanVqz commented Apr 2, 2022 •

edited

Loading