[Feature] Allow to pass an array of fallback translations #230

cibernox · 2015-06-11T11:12:13Z

I'm need to create a helper that translates error messages following the same conventions that rails-i18n uses for translate error messages in active record.

For those not familiar with rails-i18n, the fallback chain that it uses is like this (being Admin a subclass of User)

activerecord.errors.models.admin.attributes.name.blank
activerecord.errors.models.admin.blank
activerecord.errors.models.user.attributes.name.blank
activerecord.errors.models.user.blank
activerecord.errors.messages.blank
errors.attributes.name.blank
errors.messages.blank

While this is specific of my in progress meta-addon (addon built on top of ember-i18n 💥 ), the ability of having fallback translations is a must for me and I think general purpose feature.

ATM i need to compare if the returned string matches the regular expression /Missing translation/ or alternatively use the private API i18n._locale.

The downside of this change is that fallbacks becomes keyword-ish. I'm open to other ideas about how to implement this.

jamesarosen · 2015-06-11T16:51:18Z

ATM i need to compare if the returned string matches the regular expression /Missing translation/ or alternatively use the private API i18n._locale.

We mark missing translations with _isMissing = true. The service:i18n doesn't expose a way to get the compiled translation at the moment, but it could.

jamesarosen · 2015-06-11T16:52:30Z

addon/service.js

@@ -19,8 +19,20 @@ export default Ember.Object.extend(Ember.Evented, {
  t: function(key, data = {}) {
    const locale = this.get('_locale');
    Ember.assert("I18n: Cannot translate when locale is null", locale);
+    const fallbacks = get(data, 'fallbacks');


The logic below will be a little cleaner if you do

const fallbacks = getWithDefault(data, 'fallbacks', []);

cibernox · 2015-06-11T22:21:56Z

@jamesarosen Mixin the main key with the fallbacks in a single array and let Locale#getCompiledTemplate do it's job made a lot of sense.

The point am not 100% convinced yet is the fallbacks being specified as a fallbacks option in the hash. Maybe it makes more sense to allow the key itself to be an array. What do you think?

cibernox · 2015-06-14T23:11:49Z

Updated this PR to almost mimic 1:1 rails-i18n behaviour (see http://guides.rubyonrails.org/i18n.html#defaults)

The array of fallbacks is received in the options hash and the name of the key with the fallback translations is named default.
Like rails, that key can contain a single default value or an array of them that are applied in order.

Examples:

// Transltions: { "puppies.cat": "kitty", "puppies.dog": "cub" } 
i18n.t('puppies.tiger', { default: 'puppies.cat' }) // => "kitty"
i18n.t('puppies.wolf', { default: ['puppies.fox', 'puppies.dog'] }) // => "cub"
i18n.t('puppies.ferret', { default: ['puppies.polecat'] }) // => "Translation Missing: puppet.ferret"

cibernox · 2015-06-14T23:12:27Z

Tests are failing because of the glimmer incompatibility.

…er_to_readme Explain that you can't translate until `ember-i18n` initializer runs

jamesarosen · 2015-06-15T00:48:20Z

Tests are failing because of the glimmer incompatibility.

You can either rebase off master now that the beta and canary tests are marked as may-fail, or wait until emberjs/ember.js#11445 and then #227 are merged.

cibernox · 2015-06-15T12:49:03Z

Green 😁

cibernox · 2015-06-23T12:12:00Z

Now that 4.0 is out of the door, can we revisit this?

jamesarosen · 2015-06-25T14:22:48Z

addon/locale.js

    }

-    Ember.assert(`Template for ${key} in ${this.id} is not a function`, Ember.typeOf(result) === 'function');
+    Ember.assert(`Template for ${fallbackChain[0]} in ${this.id} is not a function`, Ember.typeOf(result) === 'function');


This might be confusing, since it could be one of the fallbacks that's wrong. I'm wondering whether we should save off the key of the translation we found so we can use it here.

jamesarosen · 2015-06-25T14:26:23Z

I'm 100% sold on the idea and the API! I made a couple comments about smaller details.

Decission: Receive the fallbacks as an option in the `data` object or is the key itself the one than can be an array

Also, default can be either an array or a string

cibernox · 2015-06-28T20:14:12Z

Feedback applied.

jamesarosen · 2015-06-28T22:32:54Z

addon/locale.js

    }

-    Ember.assert(`Template for ${key} in ${this.id} is not a function`, Ember.typeOf(result) === 'function');
+    Ember.assert(`Template for ${fallbackChain[i]} in ${this.id} is not a function`, Ember.typeOf(result) === 'function');


This should be 0, not i, right?

No, I'm wrong. This is the found version.

jamesarosen · 2015-06-28T22:37:25Z

+1 merging and squashing...

jamesarosen · 2015-06-28T22:46:02Z

Closed in 8aa758c

cibernox · 2015-06-28T22:57:50Z

wohoo!

jamesarosen · 2015-07-08T16:20:25Z

I'd like to document this in the wiki, but I'm not sure of a good spot. Maybe at the bottom of Translating Text in a new "Fallback Translation Keys" section?

cibernox · 2015-07-08T23:56:41Z

Yes, that seems a good place. That section basically teaches all the usages of the library.

Explain that you can't translate until ember-i18n initializer runs

6dd0357

jamesarosen reviewed Jun 11, 2015
View reviewed changes

cibernox force-pushed the allow-array-of-fallbacks branch from 7d073e0 to 2f75ba7 Compare June 12, 2015 11:14

Improve example

fcfbef5

cibernox force-pushed the allow-array-of-fallbacks branch from 77352c9 to f35462f Compare June 14, 2015 22:51

Merge pull request jamesarosen#229 from cibernox/add_initializers_ord…

1780680

…er_to_readme Explain that you can't translate until `ember-i18n` initializer runs

cibernox force-pushed the allow-array-of-fallbacks branch from f35462f to 47a97d8 Compare June 15, 2015 07:53

jamesarosen force-pushed the master branch from 1780680 to 335c4ca Compare June 15, 2015 12:05

Merge branch 'master' of github.com:jamesarosen/ember-i18n

761c7d2

cibernox force-pushed the allow-array-of-fallbacks branch from 47a97d8 to 2825423 Compare June 15, 2015 12:45

jamesarosen reviewed Jun 25, 2015
View reviewed changes

cibernox added 5 commits June 28, 2015 20:27

Merge branch 'master' of github.com:jamesarosen/ember-i18n

c71b9b4

Allow array of fallbacks

10a8c65

Move fallbackChain iteration to Locale#getCompiledTemplate

9fa8e9b

Decission: Receive the fallbacks as an option in the `data` object or is the key itself the one than can be an array

Rename fallbacks to default to mimic rails-i18n

b6a3e63

Also, default can be either an array or a string

Applied feedback

44d76f3

cibernox force-pushed the allow-array-of-fallbacks branch from 2825423 to 44d76f3 Compare June 28, 2015 19:39

Add test for event

860b5b3

jamesarosen reviewed Jun 28, 2015
View reviewed changes

jamesarosen closed this Jun 28, 2015

cibernox mentioned this pull request Jul 14, 2015

Ember i18n lazy lookup #154

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature] Allow to pass an array of fallback translations #230

[Feature] Allow to pass an array of fallback translations #230

cibernox commented Jun 11, 2015

jamesarosen commented Jun 11, 2015

jamesarosen Jun 11, 2015

cibernox commented Jun 11, 2015

cibernox commented Jun 14, 2015

cibernox commented Jun 14, 2015

jamesarosen commented Jun 15, 2015

cibernox commented Jun 15, 2015

cibernox commented Jun 23, 2015

jamesarosen Jun 25, 2015

cibernox Jun 28, 2015

jamesarosen commented Jun 25, 2015

cibernox commented Jun 28, 2015

jamesarosen Jun 28, 2015

jamesarosen commented Jun 28, 2015

jamesarosen commented Jun 28, 2015

cibernox commented Jun 28, 2015

jamesarosen commented Jul 8, 2015

cibernox commented Jul 8, 2015

[Feature] Allow to pass an array of fallback translations #230

[Feature] Allow to pass an array of fallback translations #230

Conversation

cibernox commented Jun 11, 2015

jamesarosen commented Jun 11, 2015

jamesarosen Jun 11, 2015

Choose a reason for hiding this comment

cibernox commented Jun 11, 2015

cibernox commented Jun 14, 2015

cibernox commented Jun 14, 2015

jamesarosen commented Jun 15, 2015

cibernox commented Jun 15, 2015

cibernox commented Jun 23, 2015

jamesarosen Jun 25, 2015

Choose a reason for hiding this comment

cibernox Jun 28, 2015

Choose a reason for hiding this comment

jamesarosen commented Jun 25, 2015

cibernox commented Jun 28, 2015

jamesarosen Jun 28, 2015

Choose a reason for hiding this comment

jamesarosen commented Jun 28, 2015

jamesarosen commented Jun 28, 2015

cibernox commented Jun 28, 2015

jamesarosen commented Jul 8, 2015

cibernox commented Jul 8, 2015