translation 1.19 → 1.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff2388659bd454e1ff1cbcad7133161a66902007d08e4735b80c628289665c15
-  data.tar.gz: d9a4222b6014f21dc2b29cc9de1afb60d725301d6d93a9cd7f0ba5b0cbc8d2e8
+  metadata.gz: 7a34c57ba0de5df8e9d6e302e24d1d959db4b2a697678d7cfc67e08b36702ef6
+  data.tar.gz: 5e024618fe204efef1a26294ec9e8bb6ab5fe357d9a32d826623a7ed4a5b508b
 SHA512:
-  metadata.gz: 917f60afd4befcabb144943a3b9ebd26d2d4cd372ef286432d0bc0c03aafc9aff6bae7e4b956abcc11506f35be33e752cd011ff10f1b8a7b77e84038a0bf783f
-  data.tar.gz: 8a9b12a2c66a7f060f2861150ad171ab4ebeb94b87fb18bc4763c2529871f8b58963c221cd9844844a3ef56dd9e4e32c262cf85b5df751a650f19e97e0de2a7e
+  metadata.gz: 59e48c919c27811c8d8ba6f1b29104d9adf2b661ce69a156acaea8ea669d137d87c9a07f0cb2e9e7f8175ca1930419d0ee6f1752fb4abb045fbfea9795185ea9
+  data.tar.gz: c2e556ccaf8f3bec9c833a51ba181c996e76f8f549cb1a180779ba287a9ac56ad992cf8b8fddb40bdb574cb63a3b6130145fe6a09a7d6f93af18dfbad43239af

data/README.md

@@ -1,12 +1,12 @@
 # [Translation.io](https://translation.io) client for Ruby on Rails
 
-[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
-[![Build Status](https://img.shields.io/travis/translation/rails/master.svg?style=flat-square)](https://travis-ci.org/translation/rails)
-[![Test Coverage](https://codeclimate.com/github/translation/rails/badges/coverage.svg)](https://codeclimate.com/github/translation/rails/coverage)
-[![Gem Version](https://badge.fury.io/rb/translation.svg)](https://badge.fury.io/rb/translation)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
+[![Build Status](https://github.com/translation/rails/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/translation/rails/actions/workflows/test.yml)
+[![Test Coverage](https://codeclimate.com/github/translation/rails/badges/coverage.svg)](https://codeclimate.com/github/translation/rails/test_coverage)
+[![Gem Version](https://badgen.net/rubygems/v/translation)](https://rubygems.org/gems/translation)
 [![Downloads](https://img.shields.io/gem/dt/translation.svg)](https://rubygems.org/gems/translation)
 
-Add this gem to localize your Ruby on Rails application.
+Add this gem to localize your **Ruby on Rails** application.
 
 Use the official Rails syntax (with [YAML](#i18n-yaml) files) or use the [GetText](#gettext) syntax.
 
@@ -35,25 +35,30 @@ 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)
+ * [Frontend Localization](#frontend-localization)
+   * [Using this Gem](#using-this-gem)
+   * [Using our official React & JavaScript package](#using-our-official-react--javascript-package)
  * [Continuous Integration](#continuous-integration)
  * [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)
+ * [Limitations](#limitations)
  * [Testing](#testing)
  * [Contributing](#contributing)
  * [List of clients for Translation.io](#list-of-clients-for-translationio)
    * [Ruby on Rails (Ruby)](#ruby-on-rails-ruby)
    * [Laravel (PHP)](#laravel-php)
-   * [React and React-Intl (JavaScript)](#react-and-react-intl-javascript)
+   * [React, React Native and JavaScript](#react-react-native-and-javascript)
    * [Others](#others)
  * [License](#license)
 
@@ -94,7 +99,7 @@ You can keep your source YAML file automatically updated using [i18n-tasks](http
 This gem adds the GetText support to Rails. We [strongly suggest](https://translation.io/blog/gettext-is-better-than-rails-i18n)
 that you use GetText to translate your application since it allows an easier and more complete syntax.
 
-Also, you won't need to create and manage any YAML file since your code will be
+Moreover, you won't need to create and manage any YAML file since your code will be
 automatically scanned for any string to translate.
 
 ```ruby
@@ -143,7 +148,7 @@ end
 $ bundle exec rake translation:init
 ```
 
-If you later need to add/remove target languages, please read our
+If you need to add or remove languages in the future, please read our
 [documentation](https://translation.io/blog/adding-target-languages) about that.
 
 ## Usage
@@ -176,7 +181,8 @@ $ bundle exec rake translation:sync_and_purge
 
 As the name says, this operation will also perform a sync at the same time.
 
-Warning: all keys that are not present in the current branch will be **permanently deleted from Translation.io**.
+Warning: all keys that are not present in the current local branch
+will be **permanently deleted from Translation.io**.
 
 ## Manage Languages
 
@@ -204,24 +210,39 @@ Since you created a new project, the translation history and tags will unfortuna
 
 ### Custom Languages
 
-You may want to add a custom language that is derived from an existing language.
-It's useful if you want to change some translations for another instance of the
-application or for 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 alphabetic characters and `-`.
 
 Examples: `en-microsoft` or `fr-BE-custom`.
 
-Custom languages can be added like any other language and 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.
+### Fallbacks
 
-Note that fallback are chained, so `fr-be-custom` will fallback to `fr-be` that will
-itself fallback to `fr`.
+If a translation is missing for a regional (`fr-BE`) or custom (`fr-microsoft`)
+language, then it will fallback to the main language (`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.
+Locale fallbacks will work as expected with both [I18n (YAML)](#i18n-yaml) 
+and [GetText](#gettext) syntaxes.
+
+A good way to leverage this feature is to ignore sentences from a regional language
+that would have the same translation as the main language (usually most of them).
+It's way easier to maintain the project over time if only 10% of the regional sentences
+need to be adapted.
+
+Note that fallbacks are chained, so `fr-BE-custom` will fallback to `fr-BE` that will
+fallback to `fr`.
+
+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).
 
 ## Change the current locale
 
@@ -237,9 +258,12 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-It will automatically set the locale extracted from the user's browser `HTTP_ACCEPT_LANGUAGE` value, and keep it in the session between requests.
+First time the user will connect, it will automatically set the locale extracted
+from the user's browser `HTTP_ACCEPT_LANGUAGE` value, and keep it in the session between
+requests.
 
-Update the current locale by redirecting the user to https://yourdomain.com?locale=fr or even https://yourdomain.com/fr if you scoped your routes like this:
+Update the current locale by redirecting the user to https://yourdomain.com?locale=fr
+or even https://yourdomain.com/fr if you scoped your routes like this:
 
 ```ruby
 scope "/:locale", :constraints => { locale: /[a-z]{2}/ } do
@@ -247,9 +271,11 @@ scope "/:locale", :constraints => { locale: /[a-z]{2}/ } do
 end
 ```
 
-The `set_locale` code is [here](https://github.com/translation/rails/blob/master/lib/translation_io/controller.rb#L3), feel free to override it with your own locale management.
+The `set_locale` code is [here](https://github.com/translation/rails/blob/master/lib/translation_io/controller.rb#L3),
+feel free to override it with your own locale management.
 
-Don't forget to define your available locales with [I18n.available_locales](http://guides.rubyonrails.org/i18n.html#setup-the-rails-application-for-internationalization).
+Don't forget to define your available locales with
+[I18n.available_locales](http://guides.rubyonrails.org/i18n.html#setup-the-rails-application-for-internationalization).
 
 More examples here: https://translation.io/blog/set-current-locale-in-your-rails-app
 
@@ -265,17 +291,91 @@ You can call it several times in the same page if you want to switch between lan
 
 More examples here: https://translation.io/blog/rails-i18n-with-locale
 
+## Frontend Localization
+
+### Using this Gem
+
+This gem is also able to cover frontend localization (React, Vue, ...).
+
+There are several ways to pass the translation strings from the backend
+to the frontend: JavaScript serialization, `data-` HTML attributes, JSON files etc.
+
+The easiest strategy when dealing with React/Vue would be to pass the corresponding
+translations as props when mounting the components.
+
+Assuming that you use [reactjs/react-rails](https://github.com/reactjs/react-rails),
+it would look like this if you want to use [I18n (YAML)](#i18n-yaml) syntax:
+
+```erb
+<%= 
+react_component('MyComponent", {
+  :user_id => current_user.id,
+  :i18n    => YAML.load_file("config/locales/#{I18n.locale}.yml")[I18n.locale.to_s]["my_component"]
+}) 
+%>
+```
+
+Your `en.yml` should look like this:
+
+```yaml
+en:
+  my_component:
+    your_name: Your name
+    title: Title
+```
+
+You can also directly use the [GetText](#gettext) syntax:
+
+```erb
+<%= 
+react_component('MyComponent", {
+  :user_id => current_user.id,
+  :i18n => {
+    :your_name => _('Your name'),
+    :title     => _('Title')
+  }
+}) 
+%>
+```
+
+In both case, in your React component, you can simply call
+`this.props.i18n.yourName` and your text will be localized with the current locale.
+
+**Notes:**
+
+ * You can also structure the i18n props with multiple levels of depth and pass the subtree as props to each of your sub-components.
+ * It also works great with server-side rendering of your components (`:prerender => true`).
+
+### Using our official React & JavaScript package
+
+As Translation.io is directly integrated in the great
+[Lingui](https://lingui.js.org/) internationalization framework,
+you can also consider frontend localization as a completely different
+localization project.
+
+Please read more about this on:
+
+ * Website: [https://translation.io/lingui](https://translation.io/lingui)
+ * GitHub page: [https://github.com/translation/lingui](https://github.com/translation/lingui)
+
 ## Continuous Integration
 
-If you want fresh translations in your Continuous Integration workflow, you may find yourself calling `bundle exec rake translation:sync` very frequently.
+If you want fresh translations in your Continuous Integration workflow, you may
+find yourself calling `bundle exec rake translation:sync` very frequently.
 
-Since this task can't be concurrently executed (we have a [mutex](https://en.wikipedia.org/wiki/Mutual_exclusion) strategy with a queue but it returns an error under heavy load), we implemented this threadsafe readonly task:
+Since this task can't be concurrently executed
+(we have a [mutex](https://en.wikipedia.org/wiki/Mutual_exclusion) strategy with
+a queue but it returns an error under heavy load), we implemented this
+threadsafe readonly task:
 
 ```bash
 $ bundle exec rake translation:sync_readonly
 ```
 
-This task will prevent your CI to fail and still provide new translations. But be aware that it won't send new keys from your code to Translation.io so you still need to call `bundle exec rake translation:sync` at some point during development.
+This task will prevent your CI to fail and still provide new translations. But
+be aware that it won't send new keys from your code to Translation.io so you
+still need to call `bundle exec rake translation:sync` at some point during
+development.
 
 ## Advanced Configuration Options
 
@@ -330,6 +430,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:
@@ -365,32 +491,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:
@@ -483,6 +583,33 @@ This gem was created specifically for Rails, but you can also use it in a pure R
 
 (Thanks [@kubaw](https://github.com/kubaw) for this snippet!)
 
+## Limitations
+
+If you localize `.erb` files with the [GetText syntax](#gettext), please avoid
+the use of `case` and `when` that are not correctly parsed by ERB.
+
+This syntax will break and your file will be ignored:
+
+```erb
+<% case @state %>
+<% when 'received' %>
+```
+
+Instead, use `if`/`elsif` or this `case` syntax:
+
+```erb
+<% 
+case @state
+when 'received'
+%>
+```
+
+These are the related discussions: [ruby/erb#4](https://github.com/ruby/erb/issues/4) and [translation/rails#44](https://github.com/translation/rails/issues/44).
+
+There is currently an open PR ([ruby-gettext/gettext#91](https://github.com/ruby-gettext/gettext/pull/91)), switching ERB for [Erubi](https://github.com/jeremyevans/erubi), 
+that is waiting to be merged into GetText, but it may have unknown undesirable  
+side effects.
+
 ## Testing
 
 To run the specs:
@@ -521,12 +648,15 @@ Officially Supported on [https://translation.io/laravel](https://translation.io/
 
 Credits: [@armandsar](https://github.com/armandsar), [@michaelhoste](https://github.com/michaelhoste)
 
-### React and React-Intl (JavaScript)
+### React, React Native and JavaScript
+
+Officially Supported on [https://translation.io/lingui](https://translation.io/lingui)
 
- * GitHub: https://github.com/deecewan/translation-io
- * NPM: https://www.npmjs.com/package/translation-io
+Translation.io is directly integrated in the great
+[Lingui](https://lingui.js.org/) internationalization project.
 
-Credits: [@deecewan](https://github.com/deecewan)
+ * GitHub: https://github.com/translation/lingui
+ * NPM: https://www.npmjs.com/package/@translation/lingui
 
 ### Others
 

data/lib/translation.rb

@@ -33,13 +33,16 @@ module TranslationIO
 
       if !@config.disable_gettext
         require_gettext_dependencies
-        add_missing_locales
         add_parser_for_erb_source_formats(@config.erb_source_formats)
 
         if Rails.env.development?
           GetText::TextDomainManager.cached = false
         end
 
+        # Set default GetText locale (last fallback) as config.source_locale instead of "en" (default)
+        gettext_locale = @config.source_locale.to_s.gsub('-', '_').to_sym
+        Locale.set_default(gettext_locale)
+
         # include is private until Ruby 2.1
         Proxy.send(:include, GetText)
 
@@ -69,19 +72,20 @@ module TranslationIO
       require 'gettext/tools'
       require 'gettext/text_domain_manager'
       require 'gettext/tools/xgettext'
-    end
-
-    # Missing languages from Locale that are in Translation.io
-    def add_missing_locales
-      Locale::Info.three_languages['wee'] = Locale::Info::Language.new('', 'wee', 'I', 'L', 'Lower Sorbian')
-      Locale::Info.three_languages['wen'] = Locale::Info::Language.new('', 'wen', 'I', 'L', 'Upper Sorbian')
+      require "gettext/tools/parser/erubi" if Gem::Version.new(GetText::VERSION) >= Gem::Version.new('3.4.3')
     end
 
     def add_parser_for_erb_source_formats(new_erb_formats)
-      existing_extensions = GetText::ErbParser.instance_variable_get("@config")[:extnames]
       new_extensions = new_erb_formats.collect { |ext| ".#{ext}" }
 
+      existing_extensions = GetText::ErbParser.instance_variable_get("@config")[:extnames]
       GetText::ErbParser.instance_variable_get("@config")[:extnames] = (existing_extensions + new_extensions).uniq
+
+      # for gettext >= 3.4.3 (erubi compatibility)
+      if defined?(GetText::ErubiParser)
+        existing_extensions = GetText::ErubiParser.instance_variable_get("@config")[:extnames]
+        GetText::ErubiParser.instance_variable_get("@config")[:extnames] = (existing_extensions + new_extensions).uniq
+      end
     end
 
     def info(message, level = 0, verbose_level = 0)
@@ -96,6 +100,15 @@ module TranslationIO
       File.expand_path(relative_or_absolute_path).gsub("#{Dir.pwd}/", '')
     end
 
+    # Cf. https://github.com/translation/rails/issues/47
+    def yaml_load(source)
+      begin
+        YAML.load(source, :aliases => true) || {}
+      rescue ArgumentError
+        YAML.load(source) || {}
+      end
+    end
+
     def version
       Gem::Specification::find_by_name('translation').version.to_s
     end

data/lib/translation_io/client/base_operation/save_special_yaml_files_step.rb

@@ -35,13 +35,15 @@ module TranslationIO
               YamlEntry.from_locale?(key, target_locale) && !YamlEntry.ignored?(key)
             end
 
-            yaml_data = YAMLConversion.get_yaml_data_from_flat_translations(target_flat_special_translations)
+            yaml_data = YAMLConversion.get_yaml_data_from_flat_translations(target_flat_special_translations, **{
+              :force_keep_empty_keys => true # We want to keep empty keys from localization.xx.yml files (sometimes needed for delimiters!)
+            })
 
             params["yaml_data_#{target_locale}"] = yaml_data
 
             # To have a localization.xx.yml file during tests (without call to backend)
             if TranslationIO.config.test
-              if YAML::load(yaml_data).present?
+              if TranslationIO.yaml_load(yaml_data).present?
                 File.open(yaml_path, 'wb') do |file|
                   file.write(self.class.top_comment)
                   file.write(yaml_data)
@@ -62,7 +64,7 @@ module TranslationIO
                 yaml_path = File.join(@yaml_locales_path, "localization.#{target_locale}.yml")
                 yaml_data = parsed_response["yaml_data_#{target_locale}"]
 
-                if yaml_data.present? && YAML::load(yaml_data).present?
+                if yaml_data.present? && TranslationIO.yaml_load(yaml_data).present?
                   File.open(yaml_path, 'wb') do |file|
                     file.write(self.class.top_comment)
                     file.write(yaml_data)

data/lib/translation_io/client/base_operation/update_pot_file_step.rb

@@ -16,12 +16,29 @@ module TranslationIO
           TranslationIO.info "Updating POT file."
 
           FileUtils.mkdir_p(File.dirname(@pot_path))
-          GetText::Tools::XGetText.run(*@source_files, '-o', @pot_path,
-                                       '--msgid-bugs-address', TranslationIO.config.pot_msgid_bugs_address,
-                                       '--package-name',       TranslationIO.config.pot_package_name,
-                                       '--package-version',    TranslationIO.config.pot_package_version,
-                                       '--copyright-holder',   TranslationIO.config.pot_copyright_holder,
-                                       '--copyright-year',     TranslationIO.config.pot_copyright_year.to_s)
+
+          # for gettext >= 3.4.3 (erubi compatibility)
+          if defined?(GetText::ErubiParser)
+            GetText::Tools::XGetText.run(
+              *@source_files, '-o', @pot_path,
+              '--msgid-bugs-address', TranslationIO.config.pot_msgid_bugs_address,
+              '--package-name',       TranslationIO.config.pot_package_name,
+              '--package-version',    TranslationIO.config.pot_package_version,
+              '--copyright-holder',   TranslationIO.config.pot_copyright_holder,
+              '--copyright-year',     TranslationIO.config.pot_copyright_year.to_s,
+              '--require',            'gettext/tools/parser/erubi', # Cf. (1) https://github.com/ruby-gettext/gettext/pull/91
+              '--parser',             'GetText::ErubiParser'        #     (2) https://github.com/ruby-gettext/gettext/commit/0eb06a88323a5cc16065680ffe228d978fb87c88
+            )
+          else
+            GetText::Tools::XGetText.run(
+              *@source_files, '-o', @pot_path,
+              '--msgid-bugs-address', TranslationIO.config.pot_msgid_bugs_address,
+              '--package-name',       TranslationIO.config.pot_package_name,
+              '--package-version',    TranslationIO.config.pot_package_version,
+              '--copyright-holder',   TranslationIO.config.pot_copyright_holder,
+              '--copyright-year',     TranslationIO.config.pot_copyright_year.to_s
+            )
+          end
 
           FileUtils.rm_f(@tmp_empty_file) if @tmp_empty_file.present?
 

data/lib/translation_io/client/base_operation.rb

@@ -17,6 +17,38 @@ module TranslationIO
 
       private
 
+      def warn_wrong_locales(source_locale, target_locales)
+        if target_locales.uniq != target_locales
+          duplicate_locale = target_locales.detect { |locale| target_locales.count(locale) > 1 }
+
+          puts
+          puts "----------"
+          puts "Your `config.target_locales` has a duplicate locale (#{duplicate_locale})."
+          puts "Please clean your configuration file and execute this command again."
+          puts "----------"
+          exit(true)
+        end
+
+        if target_locales.include?(source_locale)
+          puts
+          puts "----------"
+          puts "The `config.source_locale` (#{source_locale}) can't be included in the `config.target_locales`."
+          puts "If you want to customize your source locale, check this link: https://github.com/translation/rails#custom-languages"
+          puts "Please clean your configuration file and execute this command again."
+          puts "----------"
+          exit(true)
+        end
+
+        if target_locales.empty?
+          puts
+          puts "----------"
+          puts "Your `config.target_locales` is empty."
+          puts "Please clean your configuration file and execute this command again."
+          puts "----------"
+          exit(true)
+        end
+      end
+
       def self.perform_request(uri, params)
         begin
           params.merge!({

data/lib/translation_io/client/init_operation/cleanup_yaml_files_step.rb

@@ -13,7 +13,7 @@ module TranslationIO
           @yaml_file_paths.each do |locale_file_path|
             if locale_file_removable?(locale_file_path)
               if File.exist?(locale_file_path)
-                content_hash        = YAML::load(File.read(locale_file_path)) || {}
+                content_hash        = TranslationIO.yaml_load(File.read(locale_file_path)) || {}
                 source_content_hash = content_hash.select { |k| k.to_s == @source_locale.to_s }
 
                 if source_content_hash.empty?

data/lib/translation_io/client/init_operation/create_yaml_po_files_step.rb

@@ -18,7 +18,7 @@ module TranslationIO
 
           @yaml_file_paths.each do |file_path|
             TranslationIO.info file_path, 2, 2
-            file_translations = YAML::load(File.read(file_path))
+            file_translations = TranslationIO.yaml_load(File.read(file_path))
 
             unless file_translations.blank?
               all_translations = all_translations.deep_merge(file_translations)

data/lib/translation_io/client/init_operation.rb

@@ -13,12 +13,14 @@ module TranslationIO
         haml_source_files = config.haml_source_files
         slim_source_files = config.slim_source_files
         pot_path          = config.pot_path
-        source_locale     = config.source_locale
-        target_locales    = config.target_locales
+        source_locale     = config.source_locale.to_s
+        target_locales    = config.target_locales.map(&:to_s)
         locales_path      = config.locales_path
         yaml_locales_path = config.yaml_locales_path
         yaml_file_paths   = config.yaml_file_paths
 
+        warn_wrong_locales(source_locale, target_locales)
+
         if !config.disable_gettext
           BaseOperation::DumpMarkupGettextKeysStep.new(haml_source_files, :haml).run
           BaseOperation::DumpMarkupGettextKeysStep.new(slim_source_files, :slim).run

data/lib/translation_io/client/sync_operation/apply_yaml_source_edits_step.rb

@@ -12,72 +12,113 @@ module TranslationIO
 
           params.merge!({ :timestamp => metadata_timestamp })
           parsed_response = perform_source_edits_request(params)
+          source_edits    = parsed_response['source_edits'].to_a
 
-          unless parsed_response.nil?
-            TranslationIO.info "Applying YAML source editions."
+          TranslationIO.info "Applying YAML source editions."
 
-            parsed_response['source_edits'].each do |source_edit|
-              inserted = false
+          source_edits.each do |source_edit|
+            applied = false
 
-              sort_by_project_locales_first(@yaml_file_paths).each do |file_path|
-                yaml_hash      = YAML::load(File.read(file_path))
-                flat_yaml_hash = FlatHash.to_flat_hash(yaml_hash)
+            reload_or_reuse_yaml_sources
 
-                flat_yaml_hash.each do |key, value|
-                  if key == "#{@source_locale}.#{source_edit['key']}"
-                    if value == source_edit['old_text']
-                      TranslationIO.info "#{source_edit['key']} | #{source_edit['old_text']} -> #{source_edit['new_text']}", 2, 2
+            @yaml_sources.to_a.each do |yaml_source|
+              yaml_file_path = yaml_source[:yaml_file_path]
+              yaml_flat_hash = yaml_source[:yaml_flat_hash]
 
-                      if locale_file_path_in_project?(file_path)
-                        flat_yaml_hash[key] = source_edit['new_text']
+              yaml_flat_hash.each do |full_key, value|
+                if full_key == "#{@source_locale}.#{source_edit['key']}"
+                  apply_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+                  applied = true
+                  break
+                end
+              end
 
-                        file_content = to_hash_to_yaml(flat_yaml_hash)
+              break if applied
+            end
+          end
 
-                        File.open(file_path, 'w') do |f|
-                          f.write(file_content)
-                        end
-                      else # override source text of gem
-                        yaml_path = File.join(TranslationIO.config.yaml_locales_path, "#{@source_locale}.yml")
+          update_metadata_timestamp
+        end
 
-                        if File.exists?(yaml_path) # source yaml file
-                          yaml_hash      = YAML::load(File.read(yaml_path))
-                          flat_yaml_hash = FlatHash.to_flat_hash(yaml_hash)
-                        else
-                          FileUtils::mkdir_p File.dirname(yaml_path)
-                          flat_yaml_hash = {}
-                        end
+        private
 
-                        flat_yaml_hash["#{@source_locale}.#{source_edit['key']}"] = source_edit['new_text']
+        def reload_or_reuse_yaml_sources
+          if yaml_sources_reload_needed?
+            @yaml_sources = sort_by_project_locales_first(@yaml_file_paths).collect do |yaml_file_path|
+              yaml_content   = File.read(yaml_file_path)
+              yaml_hash      = TranslationIO.yaml_load(yaml_content)
+              yaml_flat_hash = FlatHash.to_flat_hash(yaml_hash)
+
+              {
+                :yaml_file_path => yaml_file_path,
+                :yaml_flat_hash => yaml_flat_hash
+              }
+            end
+          else
+            @yaml_source
+          end
+        end
 
-                        file_content = to_hash_to_yaml(flat_yaml_hash)
+        def yaml_sources_reload_needed?
+          @yaml_file_paths.sort != @yaml_sources.to_a.collect { |y_s| y_s[:yaml_file_path] }.sort
+        end
+
+        # Sort YAML file paths by project locales first, gem locales after
+        # (to replace "overridden" source first)
+        def sort_by_project_locales_first(yaml_file_paths)
+          yaml_file_paths.sort do |x, y|
+            a = locale_file_path_in_project?(x)
+            b = locale_file_path_in_project?(y)
+            (!a && b) ? 1 : ((a && !b) ? -1 : 0)
+          end
+        end
 
-                        File.open(yaml_path, 'w') do |f|
-                          f.write(file_content)
-                        end
-                      end
+        def apply_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+          full_key = "#{@source_locale}.#{source_edit['key']}"
 
-                      inserted = true
-                      break
-                    else
-                      TranslationIO.info "#{source_edit['key']} | Ignored because translation was also updated in source YAML file", 2, 2
-                    end
-                  end
-                end
+          if yaml_flat_hash[full_key] == source_edit['old_text']
+            TranslationIO.info "#{source_edit['key']} | #{source_edit['old_text']} -> #{source_edit['new_text']}", 2, 2
 
-                break if inserted
-              end
+            if locale_file_path_in_project?(yaml_file_path)
+              apply_application_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+            else # Override source text of gem inside the app
+              apply_gem_source_edit(source_edit)
             end
+          else
+            TranslationIO.info "#{source_edit['key']} | #{source_edit['old_text']} -> #{source_edit['new_text']} | Ignored because translation was also updated in source YAML file", 2, 2
           end
+        end
 
-          File.open(TranslationIO.config.metadata_path, 'w') do |f|
-            f.write({ 'timestamp' => Time.now.utc.to_i }.to_yaml)
+        def apply_application_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+          full_key                 = "#{@source_locale}.#{source_edit['key']}"
+          yaml_flat_hash[full_key] = source_edit['new_text']
+          file_content             = to_hash_to_yaml(yaml_flat_hash)
+
+          File.open(yaml_file_path, 'w') do |f|
+            f.write(file_content)
           end
         end
 
-        private
+        def apply_gem_source_edit(source_edit)
+          # Source yaml file like config/locales/en.yml
+          yaml_file_path = File.expand_path(File.join(TranslationIO.config.yaml_locales_path, "#{@source_locale}.yml"))
 
-        def to_hash_to_yaml(flat_yaml_hash)
-          yaml_hash = FlatHash.to_hash(flat_yaml_hash)
+          if File.exists?(yaml_file_path)
+            # Complete existing hash if YAML file already exists
+            existing_yaml_source = @yaml_sources.detect { |y_s| normalize_path(y_s[:yaml_file_path]) == normalize_path(yaml_file_path) }
+            yaml_flat_hash       = existing_yaml_source[:yaml_flat_hash]
+          else
+            # Create new hash if YAML file doesn't exist yet
+            FileUtils::mkdir_p File.dirname(yaml_file_path)
+            yaml_flat_hash = {}
+            @yaml_file_paths.push(yaml_file_path) # Application YAML are at the end of the list
+          end
+
+          apply_application_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+        end
+
+        def to_hash_to_yaml(yaml_flat_hash)
+          yaml_hash = FlatHash.to_hash(yaml_flat_hash)
 
           if TranslationIO.config.yaml_line_width
             content = yaml_hash.to_yaml(:line_width => TranslationIO.config.yaml_line_width)
@@ -92,37 +133,45 @@ module TranslationIO
           if File.exist?(TranslationIO.config.metadata_path)
             metadata_content = File.read(TranslationIO.config.metadata_path)
 
+            # If any conflicts in file, take the lowest timestamp and potentially reapply some source edits
             if metadata_content.include?('>>>>') || metadata_content.include?('<<<<')
-              TranslationIO.info "[Error] #{TranslationIO.config.metadata_path} file is corrupted and seems to have unresolved versioning conflicts. Please resolve them and try again."
-              exit(false)
+              timestamps = metadata_content.scan(/timestamp: (\d*)/).flatten.uniq.collect(&:to_i)
+              return timestamps.min || 0
             else
-              return YAML::load(metadata_content)['timestamp'] rescue 0
+              return YAML.load(metadata_content)['timestamp'] rescue 0
             end
           else
             return 0
           end
         end
 
+        def update_metadata_timestamp
+          File.open(TranslationIO.config.metadata_path, 'w') do |f|
+            f.puts '# This file is used in the context of Translation.io source editions.'
+            f.puts '# Please see: https://translation.io/blog/new-feature-copywriting'
+            f.puts '#'
+            f.puts '# If you have any git conflicts, either keep the smaller timestamp or'
+            f.puts '# ignore the conflicts and "sync" again, it will fix this file for you.'
+            f.puts
+
+            f.write({ 'timestamp' => Time.now.utc.to_i }.to_yaml)
+          end
+        end
+
         def perform_source_edits_request(params)
           uri             = URI("#{TranslationIO.client.endpoint}/projects/#{TranslationIO.client.api_key}/source_edits")
           parsed_response = BaseOperation.perform_request(uri, params)
         end
 
-        # Sort YAML file paths by project locales first, gem locales after
-        # (to replace "overridden" source first)
-        def sort_by_project_locales_first(yaml_file_paths)
-          yaml_file_paths.sort do |x, y|
-            a = locale_file_path_in_project?(x)
-            b = locale_file_path_in_project?(y)
-            (!a && b) ? 1 : ((a && !b) ? -1 : 0)
-          end
-        end
-
         def locale_file_path_in_project?(locale_file_path)
-          TranslationIO.normalize_path(locale_file_path).start_with?(
-            TranslationIO.normalize_path(TranslationIO.config.yaml_locales_path)
+          normalize_path(locale_file_path).start_with?(
+            normalize_path(TranslationIO.config.yaml_locales_path)
           )
         end
+
+        def normalize_path(path)
+          TranslationIO.normalize_path(path)
+        end
       end
     end
   end

data/lib/translation_io/client/sync_operation/create_yaml_pot_file_step.rb

@@ -14,7 +14,7 @@ module TranslationIO
 
           @yaml_file_paths.each do |file_path|
             TranslationIO.info file_path, 2, 2
-            file_translations = YAML::load(File.read(file_path))
+            file_translations = TranslationIO.yaml_load(File.read(file_path))
 
             unless file_translations.blank?
               all_translations = all_translations.deep_merge(file_translations)

data/lib/translation_io/client/sync_operation.rb

@@ -16,12 +16,14 @@ module TranslationIO
         haml_source_files = config.haml_source_files
         slim_source_files = config.slim_source_files
         pot_path          = config.pot_path
-        source_locale     = config.source_locale
-        target_locales    = config.target_locales
+        source_locale     = config.source_locale.to_s
+        target_locales    = config.target_locales.map(&:to_s)
         locales_path      = config.locales_path
         yaml_locales_path = config.yaml_locales_path
         yaml_file_paths   = config.yaml_file_paths
 
+        warn_wrong_locales(source_locale, target_locales)
+
         if !config.disable_yaml
           ApplyYamlSourceEditsStep.new(yaml_file_paths, source_locale).run(params)
         end

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
       #######
@@ -119,7 +124,7 @@ module TranslationIO
     end
 
     def yaml_file_paths
-      I18n.load_path.select do |p|
+      I18n.load_path.collect(&:to_s).uniq.select do |p|
         File.exist?(p) && (File.extname(p) == '.yml' || File.extname(p) == '.yaml')
       end
     end

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

@@ -26,7 +26,7 @@ module TranslationIO
       end
 
       def get_flat_translations_for_yaml_data(yaml_data)
-        translations = YAML::load(yaml_data)
+        translations = TranslationIO.yaml_load(yaml_data)
 
         if translations
           return FlatHash.to_flat_hash(translations)
@@ -35,8 +35,14 @@ module TranslationIO
         end
       end
 
-      def get_yaml_data_from_flat_translations(flat_translations)
-        translations = FlatHash.to_hash(flat_translations)
+      def get_yaml_data_from_flat_translations(flat_translations, force_keep_empty_keys: false)
+        if force_keep_empty_keys
+          remove_empty_keys = false
+        else
+          remove_empty_keys = TranslationIO.config.yaml_remove_empty_keys
+        end
+
+        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)

data/lib/translation_io/yaml_entry.rb

@@ -31,7 +31,7 @@ module TranslationIO
       end
 
       def ignored?(key)
-        key.present? && ignored_key_prefixes.any? { |p| key_without_locale(key).match(/^#{p}\b/) != nil }
+        key.present? && ignored_key_prefixes.any? { |prefix| key_without_locale(key).match(/^#{Regexp.escape(prefix)}\b/) != nil }
       end
 
       def localization?(key, value)
@@ -40,7 +40,7 @@ module TranslationIO
 
       def localization_prefix?(key)
         localization_key_prefixes.any? do |prefix|
-          key_without_locale(key).match(/^#{prefix}\b/) != nil
+          key_without_locale(key).match(/^#{Regexp.escape(prefix)}\b/) != nil
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translation
 version: !ruby/object:Gem::Version
-  version: '1.19'
+  version: '1.32'
 platform: ruby
 authors:
 - Michael Hoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-13 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gettext
@@ -21,6 +21,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.5
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 3.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,6 +34,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.5
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 3.4.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -65,14 +71,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Localize your app with YAML or GetText. Synchronize with your translators