File: cascade.rb [i18n-0.6.9 Documentation]

Last Modified
  2014-02-16 06:57:56 +0000
Requires

## Description

The Cascade module adds the ability to do cascading lookups to backends that are compatible to the Simple backend.

By cascading lookups we mean that for any key that can not be found the Cascade module strips one segment off the scope part of the key and then tries to look up the key in that scope.

E.g. when a lookup for the key :"foo.bar.baz" does not yield a result then the segment :bar will be stripped off the scope part :"foo.bar" and the new scope :foo will be used to look up the key :baz. If that does not succeed then the remaining scope segment :foo will be omitted, too, and again the key :baz will be looked up (now with no scope).

To enable a cascading lookup one passes the :cascade option:

    I18n.t(:'foo.bar.baz', :cascade => true)

This will return the first translation found for :"foo.bar.baz", :"foo.baz" or :baz in this order.

The cascading lookup takes precedence over resolving any given defaults. I.e. defaults will kick in after the cascading lookups haven't succeeded.

This behavior is useful for libraries like ActiveRecord validations where the library wants to give users a bunch of more or less fine-grained options of scopes for a particular key.

Thanks to Clemens Kofler for the initial idea and implementation! See github.com/clemens/i18n-cascading-backend