Dynamically render ReportsController translations #2751
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit modifies how translations for report names/descriptions are rendered by the `Spree::Admin::ReportsController` class. The previous implementation generates translations once, at startup, rendering the translated results statically onto the index page. This results in confusing behaviour when attempting to add additional reports to this class via prepended modules or `class_eval`, as the `i18n` subsystem is not initialized until late in the Rails boot process, potentially after these modifications have been loaded. This results in strange and confusing behaviour where the page insists translations are missing, despite being present. To remove this source of confusion, we can store the name/description translation keys in our `@@available_reports` class variable, and generate the translations from them when the index page is rendered.
stewart
force-pushed
the
fix/reports-static-translations
branch
from
35ae3bb to
a737dd3
Compare
stewart
commented
May 29, 2018
|
|
||
| it 'should have the proper sales total report description' do | ||
| expect(Spree::Admin::ReportsController.available_reports[:sales_total][:description]).to eql('Sales Total For All Orders') | ||
| end |
There was a problem hiding this comment.
It may be worth replacing this test with a view spec, but I'm uncertain how much value testing translations provides in this context.
gmacdougall
approved these changes
May 29, 2018
tvdeyen
approved these changes
May 30, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR corrects an issue that occurs when attempting to extend
Spree::Admin::ReportsControllerwith additional reports. TheReportsController.add_available_report!class method currently translates its arguments withI18n.twhen called, rather than when the/admin/reportspage is actually rendered.If additional reports are being decorated onto this controller via
class_evalor prepended modules, there is a possibility that thei18nlibrary has not yet been initialized – this results in static "translation missing" errors in the admin. In particular, this is the case withconfig.to_prepare, which is commonly used to load these kinds of Solidus modifications.To correct this issue, we can switch to dynamically rendering the translations in the view, rather than generating them statically in the controller at startup.