Use human_attribute_name for promo calculator labels
#6195
Conversation
This file contains hidden or 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
github-actions
bot
added
the
changelog:solidus_promotions
mamhoff
force-pushed
the
calculator-label-i18n
branch
from
fc55634 to
8ab1144
Compare
tvdeyen
approved these changes
Mar 27, 2025
Promotion calculators have preferences, and these need to be translated with the correct scope. When you specify a preference for a calculator, a virtual attribute is generated. For example: ``` class MyCalculator < Spree::Calculator preference :percent, :integer, default: 10 end ``` In this scenario, we get a virtual attribute `preferred_percent` on the `MyCalculator` class. The expectation is that then one can translated that attribute by calling: `MyCalculator.human_attribute_name(:preferred_percent)`, and - crucially - that this attribute is used in form labels. While all other calculator forms use this (through `form.label :preferred_percent`) or similar, the default form did not, and instead used `I18n.t(:percent, scope: :spree)`, which is not specific to the calculator, and might lead to mistranslations.
tvdeyen
force-pushed
the
calculator-label-i18n
branch
from
8ab1144 to
e259238
Compare
jarednorman
approved these changes
Mar 27, 2025
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.
Summary
Promotion calculators have preferences, and these need to be translated with the correct scope.
When you specify a preference for a calculator, a virtual attribute is generated. For example:
In this scenario, we get a virtual attribute
preferred_percenton theMyCalculatorclass. The expectation is that then one can translated that attribute by callingMyCalculator.human_attribute_name(:preferred_percent), and - crucially - that this attribute is used in form labels.While all other calculator forms use this (through
form.label :preferred_percent) or similar, the default form did not, and instead usedI18n.t(:percent, scope: :spree), which is not specific to the calculator, and might lead to mistranslations.The following are not always needed: