translation 1.21 → 1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ce80b91f3c556815df4339c5fc0b98f5749dd2babb378826053fe99751e5aec
-  data.tar.gz: 1d4126693818e8220f41fa74f56e4d4eec61df651ac52f6429930fda9294a5b6
+  metadata.gz: d45218917c9c922310e60826327cd83f9537b07ece00d855a36a83327e04f8ef
+  data.tar.gz: '009b17548c9e57c0a696d7910cd9a75a4e1329049406a45449e1a17382c94b72'
 SHA512:
-  metadata.gz: b17f56630fba322a948c31b84fb7ed006ef647f4cba40fe2f7ef78fd63e470f5dbbfd01f1ceb31627caabda3d27c0ea6e6c441f377709cc4291dbda07d5f4dc4
-  data.tar.gz: cf424585ff16540e92679195faaa0dff8db5b30faa1b9355ed203fa0e07f1d5a114c643a071f22c4afb7545d2e82d553cd7012a88200319679528a870603bbc6
+  metadata.gz: b438efc2955b5db716b73e8d4ae1044135c6296f57ea829b8f5bc3ba8734ec0f7ff73678842b8a88a0826cc3d8ade340a9dc18ea66e874690ce932b2f9f8c849
+  data.tar.gz: e46d5e83c77b4f3f7fc0b0496c753ca6634b39f0043992b77f83ce604163a4e5433730cff5b3c77318df698a98d936f99a9986fc7b643da1d87c6f009b9b1fbb

data/README.md

@@ -35,6 +35,7 @@ Table of contents
    * [Add or Remove Language](#add-or-remove-language)
    * [Edit Language](#edit-language)
    * [Custom Languages](#custom-languages)
+   * [Fallbacks](#fallbacks)
  * [Change the current locale](#change-the-current-locale)
    * [Globally](#globally)
    * [Locally](#locally)
@@ -42,9 +43,9 @@ Table of contents
  * [Advanced Configuration Options](#advanced-configuration-options)
    * [Disable GetText or YAML](#disable-gettext-or-yaml)
    * [Ignored YAML keys](#ignored-yaml-keys)
+   * [Custom localization key prefixes](#custom-localization-key-prefixes)
    * [Source file formats (for GetText)](#source-file-formats-for-gettext)
    * [Gems with GetText strings](#gems-with-gettext-strings)
-   * [Custom localization key prefixes](#custom-localization-key-prefixes)
    * [Paths where locales are stored (not recommended)](#paths-where-locales-are-stored-not-recommended)
    * [GetText Object Class Monkey-Patching](#gettext-object-class-monkey-patching)
  * [Pure Ruby (without Rails)](#pure-ruby-without-rails)
@@ -204,27 +205,37 @@ Since you created a new project, the translation history and tags will unfortuna
 
 ### Custom Languages
 
-A custom language is always derived from an existing language. It's useful if you want
-to adapt some translations to another instance of your application, or to a specific
-customer.
+Custom languages are convenient if you want to customize translations for a specific customer
+or another instance of your application.
+
+A custom language is always be derived from an [existing language](https://translation.io/docs/languages).
+Its structure should be like:
+
+```ruby
+"#{existing_language_code}-#{custom_text}"
+```
 
-The structure of a custom language is: `existing language code` + `-` + `custom text`, where
-`custom text` can only contain alphanumeric characters and `-`.
+where `custom_text` can only contain alphanumeric characters and `-`.
 
 Examples: `en-microsoft` or `fr-BE-custom`.
 
-Custom languages can be added and used like any other language.
+### Fallbacks
 
-Fallbacks work as expected. It means that if the `en-microsoft.some_key` is missing,
-then it will fallback to `en.some_key`. So you only need to translate keys that
-should be customized.
+Using [I18n (YAML)](#i18n-yaml) syntax, fallbacks will work as expected for any regional or custom
+language. It means that if the `en-microsoft.example` key is missing,
+then it will fallback to `en.example`. So you only need to translate keys that
+are different from the main language.
 
-Note that fallback are chained, so `fr-BE-custom` will fallback to `fr-BE` that will
+Note that fallbacks are chained, so `fr-BE-custom` will fallback to `fr-BE` that will
 fallback to `fr`.
 
-Using GetText syntax, it will only fallback to the source language. So either you
-create a fallback mechanism by yourself or you avoid fallbacking
-by translating everything in Translation.io for that custom language.
+Just make sure to add `config.i18n.fallbacks = true` to your `config/application.rb` file.
+You can find more information about this
+[here](https://guides.rubyonrails.org/configuring.html#configuring-i18n).
+
+Using [GetText](#gettext) syntax, it will only fallback to the source language.
+So either you create a fallback mechanism by yourself or you avoid fallbacking
+by translating everything in Translation.io for the regional or custom language.
 
 ## Change the current locale
 
@@ -337,6 +348,32 @@ TranslationIO.configure do |config|
 end
 ```
 
+### Custom localization key prefixes
+
+Rails YAML files contain not only translation strings but also localization values (integers, arrays, booleans)
+in the same place and that's bad. For example: date formats, number separators, default
+currency or measure units, etc.
+
+A translator is supposed to translate, not localize. That's not his role to choose how you want your dates or
+numbers to be displayed, right? Moreover, this special keys often contain special constructions (e.g.,
+with percent signs or spaces) that he might break.
+
+We think localization is part of the configuration of the app and it should not reach the translator UI at all.
+That's why these localization keys are detected and separated on a dedicated YAML file with Translation.io.
+
+We automatically treat [known localization keys](lib/translation_io/yaml_entry.rb), but if you would like
+to add some more, use the `localization_key_prefixes` option.
+
+For example:
+
+```ruby
+TranslationIO.configure do |config|
+  ...
+  config.localization_key_prefixes = ['my_gem.date.formats']
+  ...
+end
+```
+
 ### Source file formats (for GetText)
 
 If you are using GetText and you want to manage other file formats than:
@@ -372,32 +409,6 @@ TranslationIO.configure do |config|
 end
 ```
 
-### Custom localization key prefixes
-
-Rails YAML files contain not only translation strings but also localization values (integers, arrays, booleans)
-in the same place and that's bad. For example: date formats, number separators, default
-currency or measure units, etc.
-
-A translator is supposed to translate, not localize. That's not his role to choose how you want your dates or
-numbers to be displayed, right? Moreover, this special keys often contain special constructions (e.g.,
-with percent signs or spaces) that he might break.
-
-We think localization is part of the configuration of the app and it should not reach the translator UI at all.
-That's why these localization keys are detected and separated on a dedicated YAML file with Translation.io.
-
-We automatically treat [known localization keys](lib/translation_io/yaml_entry.rb), but if you would like
-to add some more, use the `localization_key_prefixes` option.
-
-For example:
-
-```ruby
-TranslationIO.configure do |config|
-  ...
-  config.localization_key_prefixes = ['my_gem.date.formats']
-  ...
-end
-```
-
 ### Paths where locales are stored (not recommended)
 
 You can specify where your GetText and YAML files are on disk:

data/lib/translation_io/config.rb

@@ -14,6 +14,7 @@ module TranslationIO
     attr_accessor :ignored_key_prefixes
     attr_accessor :localization_key_prefixes
     attr_accessor :yaml_line_width
+    attr_accessor :yaml_remove_empty_keys
 
     attr_accessor :disable_gettext
 
@@ -75,6 +76,10 @@ module TranslationIO
       # Cf. https://github.com/translation/rails/issues/19
       self.yaml_line_width = nil
 
+      # Remove empty keys from translated YAML files
+      # Cf. https://github.com/translation/rails/pull/37
+      self.yaml_remove_empty_keys = false
+
       #######
       # GetText options
       #######

data/lib/translation_io/flat_hash.rb

@@ -11,7 +11,7 @@ module TranslationIO
         hash = {}
 
         if remove_empty_keys
-          flat_hash = flat_hash.reject { |k, v| v.nil? && !k.end_with?(']') }
+          flat_hash = flat_hash.reject { |k, v| v.blank? && !k.end_with?(']') }
         end
 
         flat_hash.each_pair do |key, value|

data/lib/translation_io/railtie.rb

@@ -7,8 +7,10 @@ module TranslationIO
       require 'translation_io/tasks'
     end
 
-    initializer 'translation.rails_extensions' do
-      ActionController::Base.send(:include, TranslationIO::Controller)
+    initializer 'translation.controller_helper' do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send(:include, TranslationIO::Controller)
+      end
     end
 
     config.after_initialize do

data/lib/translation_io/yaml_conversion.rb

@@ -36,7 +36,8 @@ module TranslationIO
       end
 
       def get_yaml_data_from_flat_translations(flat_translations)
-        translations = FlatHash.to_hash(flat_translations)
+        remove_empty_keys = TranslationIO.config.yaml_remove_empty_keys
+        translations      = FlatHash.to_hash(flat_translations, remove_empty_keys)
 
         if TranslationIO.config.yaml_line_width
           data = translations.to_yaml(:line_width => TranslationIO.config.yaml_line_width)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translation
 version: !ruby/object:Gem::Version
-  version: '1.21'
+  version: '1.22'
 platform: ruby
 authors:
 - Michael Hoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-30 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gettext
@@ -143,7 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Localize your app with YAML or GetText. Synchronize with your translators