Support for setting labels, hints and legends via Rails' i18n #68

peteryates · 2019-11-12T16:32:52Z

Currently all of the helpers require that the text that's passed in to form labels, hints and legends is supplied inline. Many projects prefer to store the text in the locales files and use Rails' i18n to populate the relevant strings.

There's a working implementation in the GOV.UK elements form builder that can be used for inspiration.

investigate the best approach for generically retrieving localisation values from Rails' store
ensure that strings are chosen in the correct preference order:
1. provided
2. localised
3. automatic
work out the best structure to store hints and legends in the locales file
document the process in the guide

Additional things to check

Should there be translations added for radio buttons and check boxes labels and hints? This might be nice addition and could definitely be useful, but there's already text_method: and :hint_method which probably already do everything that's required 🤔
Should there be a shorthand way to specify to the helper which localisation key to use? Rather than doing something like label: { text: I18n.t('my.favourite.type.of.pasta') } perhaps label: { t: 'my.favourite.type.of.pasta' }? 🤷🏽‍♂️

The text was updated successfully, but these errors were encountered:

The with_localisations method allows us to temporarily set the locale backend and always cleans up after itself. Refs #68

This will pull the correct localisation string from the backend and display it unless it has been overridden by manually supplying text Refs #68

This can now be optionally set and will be used for the retrieval of localisations from the I18n backend Refs #68

Compacting the array and joining the remains can return a hash if it matches the structure of the backend. For example, "helpers.person.." will return the other translations for the object. Instead, return nil unless all parts are present Refs #68

Refs #68

leeky · 2019-12-02T15:49:15Z

This is a great addition!

Are there plans to make the i18n scopes configurable? For example, I'd like to use the ActiveRecord activerecord.attributes.(model).(attribute_name) scope for labels, because this would make the form labels and validations use the same text.

peteryates · 2019-12-02T16:13:54Z

Thank you!

I'm in agreement regarding being able to configure it, and generally being able to configure how the builder works is definitely on my radar (mainly for things like setting default label/legend sizes and tags, etc).

The automatic building of the path is very straightforward and should be easily-overridable, but I think individually configuring the structure labels, hints and legends might get a bit complicated.

Refs #68

CollectionItem will hold functionality that's specific to items belonging to a collection. Initially, this covers the retrieval of the value depending on what's passed into the :text_method, :value_method or :hint_method params. These arguments now accept and properly deal with procs Refs #68

Instead of using `#send` inline to retrieve the value from `@item`, make use of `#retrieve` which works with procs. Refs #68

The :value_method, :text_method and :hint_method params passed to radio collections and the :hint_method params passed to checkbox collections now accept procs which can be used to customise the value retrieved from the item. This could be used for simple transformations like upcasing the text or more-complex operations like localising the value, as per the provided specs Refs #68

CollectionItem will hold functionality that's specific to items belonging to a collection. Initially, this covers the retrieval of the value depending on what's passed into the :text_method, :value_method or :hint_method params. These arguments now accept and properly deal with procs Refs #68

Instead of using `#send` inline to retrieve the value from `@item`, make use of `#retrieve` which works with procs. Refs #68

The :value_method, :text_method and :hint_method params passed to radio collections and the :hint_method params passed to checkbox collections now accept procs which can be used to customise the value retrieved from the item. This could be used for simple transformations like upcasing the text or more-complex operations like localising the value, as per the provided specs Refs #68

peteryates · 2019-12-10T13:22:36Z

This is now in the 1.1.0 branch

Add support for customising the localisation schema (provided in #68) as part of the application config. The configuration allows for the value localisation_schema_fallback to be set, which provides a default 'base' schema; and localisation_schema_label, localisation_schema_hint, and localisation_schema_legend to be set which configures labels, hints and legends respectively. One slightly-breaking change (from the initial version of localisation functionality) is that now we're referring to fieldset legends by legend rather than fieldset. This is more inkeeping with the language used everywhere else in the project and definitely feels cleaner.

The with_localisations method allows us to temporarily set the locale backend and always cleans up after itself. Refs #68

This will pull the correct localisation string from the backend and display it unless it has been overridden by manually supplying text Refs #68

This can now be optionally set and will be used for the retrieval of localisations from the I18n backend Refs #68

Compacting the array and joining the remains can return a hash if it matches the structure of the backend. For example, "helpers.person.." will return the other translations for the object. Instead, return nil unless all parts are present Refs #68

Refs #68

CollectionItem will hold functionality that's specific to items belonging to a collection. Initially, this covers the retrieval of the value depending on what's passed into the :text_method, :value_method or :hint_method params. These arguments now accept and properly deal with procs Refs #68

Instead of using `#send` inline to retrieve the value from `@item`, make use of `#retrieve` which works with procs. Refs #68

The :value_method, :text_method and :hint_method params passed to radio collections and the :hint_method params passed to checkbox collections now accept procs which can be used to customise the value retrieved from the item. This could be used for simple transformations like upcasing the text or more-complex operations like localising the value, as per the provided specs Refs #68

Add support for customising the localisation schema (provided in #68) as part of the application config. The configuration allows for the value localisation_schema_fallback to be set, which provides a default 'base' schema; and localisation_schema_label, localisation_schema_hint, and localisation_schema_legend to be set which configures labels, hints and legends respectively. One slightly-breaking change (from the initial version of localisation functionality) is that now we're referring to fieldset legends by legend rather than fieldset. This is more inkeeping with the language used everywhere else in the project and definitely feels cleaner.

peteryates added the enhancement New feature or request label Nov 12, 2019

peteryates added this to the Version 1.1 milestone Nov 15, 2019

peteryates added a commit that referenced this issue Nov 16, 2019

Add shared examples for localisation functionality

381f4b8

The with_localisations method allows us to temporarily set the locale backend and always cleans up after itself. Refs #68

peteryates added a commit that referenced this issue Nov 16, 2019

Add and integrate the localised_text method

e14df8d

This will pull the correct localisation string from the backend and display it unless it has been overridden by manually supplying text Refs #68

peteryates added a commit that referenced this issue Nov 16, 2019

Allow the fieldset to take object and attr names

b0a49bc

This can now be optionally set and will be used for the retrieval of localisations from the I18n backend Refs #68

peteryates added a commit that referenced this issue Nov 16, 2019

Add object/attribute to field-specific fieldsets

4bc6fdf

Refs #68

peteryates added a commit that referenced this issue Nov 16, 2019

Add example groups to relevant specs

ecbfc40

Refs #68

peteryates mentioned this issue Nov 16, 2019

Internationalisation #69

Merged

peteryates mentioned this issue Dec 3, 2019

Builder configuration #73

Closed

3 tasks

peteryates added a commit that referenced this issue Dec 5, 2019

Add first draft of localisation documentation

08b28f6

Refs #68

peteryates added a commit that referenced this issue Dec 7, 2019

Integrate Traits::CollectionItem with elements

bcc5eec

Instead of using `#send` inline to retrieve the value from `@item`, make use of `#retrieve` which works with procs. Refs #68

peteryates mentioned this issue Dec 7, 2019

Providing procs to collection helpers #75

Merged

peteryates added a commit that referenced this issue Dec 10, 2019

Integrate Traits::CollectionItem with elements

0a5e898

Instead of using `#send` inline to retrieve the value from `@item`, make use of `#retrieve` which works with procs. Refs #68

peteryates closed this as completed Dec 10, 2019

peteryates mentioned this issue Dec 21, 2019

Custom i18n schemas #81

Merged

peteryates added a commit that referenced this issue Jan 9, 2020

Add shared examples for localisation functionality

8c88349

The with_localisations method allows us to temporarily set the locale backend and always cleans up after itself. Refs #68

peteryates added a commit that referenced this issue Jan 9, 2020

Add and integrate the localised_text method

87f57f4

This will pull the correct localisation string from the backend and display it unless it has been overridden by manually supplying text Refs #68

peteryates added a commit that referenced this issue Jan 9, 2020

Allow the fieldset to take object and attr names

aed5492

This can now be optionally set and will be used for the retrieval of localisations from the I18n backend Refs #68

peteryates added a commit that referenced this issue Jan 9, 2020

Add object/attribute to field-specific fieldsets

7c289a3

Refs #68

peteryates added a commit that referenced this issue Jan 9, 2020

Add example groups to relevant specs

b873836

Refs #68

peteryates added a commit that referenced this issue Jan 9, 2020

Add first draft of localisation documentation

0a6c5b7

Refs #68

peteryates added a commit that referenced this issue Jan 9, 2020

Integrate Traits::CollectionItem with elements

de79ebe

Instead of using `#send` inline to retrieve the value from `@item`, make use of `#retrieve` which works with procs. Refs #68

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for setting labels, hints and legends via Rails' i18n #68

Support for setting labels, hints and legends via Rails' i18n #68

peteryates commented Nov 12, 2019 •

edited

Loading

leeky commented Dec 2, 2019

peteryates commented Dec 2, 2019

peteryates commented Dec 10, 2019

Support for setting labels, hints and legends via Rails' i18n #68

Support for setting labels, hints and legends via Rails' i18n #68

Comments

peteryates commented Nov 12, 2019 • edited Loading

Additional things to check

leeky commented Dec 2, 2019

peteryates commented Dec 2, 2019

peteryates commented Dec 10, 2019

peteryates commented Nov 12, 2019 •

edited

Loading