Add a locale switcher, second try #656
Conversation
Adds a :locale parameter (which should come from the URL, e.g.: `refugerestrooms.org/?locale=en` or something like that.)
Allows URLs auto-generated by Rails to automatically be expanded to include "?locale=xyz" or "&locale=xyz" See: https://guides.rubyonrails.org/v5.2.4/i18n.html#setting-the-locale-from-url-params For example, this affects URLs made with ActionView URL helpers ('button_to', 'link_to', etc.) See: https://api.rubyonrails.org/v5.2.4/classes/ActionView/Helpers/UrlHelper.html (Hard-coded URLS will generally not get the parameter added.)
Use a link_to helper to dynamically create the homepage link, because URL helpers now automatically include the 'locale=' parameter.
Use the 'api_docs_path' helper, rather than hard-coding '/api/docs'. (This is for the navigation header, under the "Resources" drop-down.)
Adds an optional locale prefix for almost every page in the app. See: https://guides.rubyonrails.org/v5.2.4/i18n.html#setting-the-locale-from-url-params You can now visit e.g. '/es/restrooms/new' and you will see the "Submit a New Restroom" page in Spanish. All links in the app auto-generate this locale prefix, so users can specify a locale via visiting a specific locale prefix, and the links in the app will not misdirect them into another locale. (You can still visit URLs without a locale prefix, like '/restrooms/new', and the app will simply auto-detect the locale based on the preferred languages in your browser settings.) This preserves the existing URLs in working order, and any links out there on the web, or in people's bookmarks, will still work.) The home page does not always get the prefix: - The home page link in nav is just '/?locale=[I18n.locale]' - You can visit '/?locale=es' to see the homepage in Spanish. - The homepage link in the nav are auto-generated as '/?locale=[I18n.locale]'; This is equivalent in functionality to the locale prefixes (e.g. '/es/'). - The homepage links in the footer are auto-generated as '/[I18n.locale]/'. - You can visit '/es/' to see the homepage in Spanish.
Adds locale switcher links in the footer, which displays at the bottom of every page. These links dynamically link to the current page the user is viewing, but with the current locale overridden with a specific, new locale. Uses the Rails API's "ActionDispatch::Request" feature to get a string containing the last requested page, (i.e. the page the user is currently viewing). This includes query parameters, such as "?lat=[num]&long=[num]" See: https://api.rubyonrails.org/v5.2.4/classes/ActionDispatch/Request.html#method-i-GET (Parameters can also be derived from the URL, such as the "es/" in "/es/restrooms/new", if routed properly.) See: https://guides.rubyonrails.org/routing.html See these StackOverflow answers/this Wikipedia article for details: - https://stackoverflow.com/questions/3762430/rails-preserving-get-query-string-parameters-in-link-to - https://stackoverflow.com/questions/6885990/rails-params-explained - https://en.wikipedia.org/wiki/Query_string
Spaced out the links a bit, and added bullet-point separators.
Passing the whole array of restroom data was causing the whole array to be erroneously interpreted as if it was the :locale prefix in the path. Explicitly pass :id, and only :id, to the `restroom_path` route helper for this test. (We only need the :id from the newly-constructed test restroom in order to visit the correct path. Other restroom data isn't needed here anyhow.) Co-authored-by: Mikena Wood <mi-wood@users.noreply.github.com>
This reverts commit 85f1998. Try this pull request again, without the `locale/` URL prefix feature.
Dynamically compose the "Business FAQ" link on the "About" page and the "About Page" link on the "Business FAQ" page using Rails link helpers, so that the locale (and any other default URL parameters) are automatically added to these links. In other words, "un-hard-code" these links. (In this commit, updated the Haml source of the About and Business FAQ pages, and only the English internationalization (I18n) strings.)
Update the formatting of the "About" and "Business FAQ" links in the various locales other than English.
|
Hi @brunoocasali, I hope you are doing well. I've been working on finishing the locale switcher feature for Refuge Restrooms. I think it's ready now! If you are interested in helping with adding tests for locales other than English, I think this could be a reasonable place to do that. It would, of course, be much appreciated. Best Regards, - DeeDeeG |
There was a problem hiding this comment.
🥇 good work @DeeDeeG
After these changes get merged, I can submit a PR to add tests to it!
Co-authored-by: Bruno Casali <brunoocasali@gmail.com>
|
@brunoocasali I added the changes you suggested, matching the Rubocop-linted style. During testing, I found out that there is a problem still. Might you be able to help troubleshoot this? When starting a new search for restrooms using the search bar, the locale parameter is not preserved. It appears to me that the search results page is generated only with the following parameters (with the example search "San Francisco").
But no It's not immediately clear to me how these parameters are generated, as I'm not familiar with that part of the codebase. (I suspect it might be part of Refuge Restrooms' JavaScript code, but I'm not sure.) If I knew where these were generated, then perhaps it would be easier to ensure the |
|
@DeeDeeG I could help you with this tomorrow, okay? :) |
|
That would be great! I'm getting more confident that it's in |
* Create a LocaleService to centralize locale logic * Create a way to keep track of current_locale even between actions
Context
application_controller.rbto add locales to dynamic links, and set the current locale based on the URL parameter if present. Updates hard-coded links within the app to dynamic ones.Summary of Changes
localethat will appear as?locale=[your-locale-code-here]in the URL. For example:/restrooms/new?locale=esis the "Add a New Restroom" page, explicitly in Spanish.link_to), automagically use the URL parameter?locale=[some_locale_here]now.Enable optional routing to locale-prefixed versions of most URLs in the app. For example:(Disabled for now, as this wasn't working as intended.)/fr/restrooms/newis the "Add a New Restroom" page, explicitly in French.Checklist
Screenshots
Before
After