translation 1.17 → 1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 12113892c41a14c8d164e01d9d9c2339a92436f8
-  data.tar.gz: 403abefb4765377f59d145bb39fcfe477099cde3
+SHA256:
+  metadata.gz: d45218917c9c922310e60826327cd83f9537b07ece00d855a36a83327e04f8ef
+  data.tar.gz: '009b17548c9e57c0a696d7910cd9a75a4e1329049406a45449e1a17382c94b72'
 SHA512:
-  metadata.gz: c67cb77f2af77d56b26cfa9869196df3d62f478c3236a11cfdc5fa180d500c5795bbaab08a75920d5e88a1bd48c46a54d97e290dc48772b9ef1920d54582e7a6
-  data.tar.gz: 196ada47e46d5bebdb347b314ca02f3035018341b18d9d57fa4ef39943705588546b1c96173af53ab0f543e1eb7bdaac4b8b788733806f371c6dc768405db555
+  metadata.gz: b438efc2955b5db716b73e8d4ae1044135c6296f57ea829b8f5bc3ba8734ec0f7ff73678842b8a88a0826cc3d8ade340a9dc18ea66e874690ce932b2f9f8c849
+  data.tar.gz: e46d5e83c77b4f3f7fc0b0496c753ca6634b39f0043992b77f83ce604163a4e5433730cff5b3c77318df698a98d936f99a9986fc7b643da1d87c6f009b9b1fbb

data/README.md

@@ -35,16 +35,19 @@ 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)
  * [Continuous Integration](#continuous-integration)
  * [Advanced Configuration Options](#advanced-configuration-options)
-   * [Disable GetText](#disable-gettext)
+   * [Disable GetText or YAML](#disable-gettext-or-yaml)
    * [Ignored YAML keys](#ignored-yaml-keys)
-   * [Source file formats (for GetText)](#source-file-formats-for-gettext)
    * [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)
    * [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)
  * [Testing](#testing)
  * [Contributing](#contributing)
@@ -202,24 +205,37 @@ 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 alphanumeric 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
+
+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 fallbacks are chained, so `fr-BE-custom` will fallback to `fr-BE` that will
+fallback to `fr`.
 
-Note that fallback are chained, so `fr-be-custom` will fallback to `fr-be` that will
-itself 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).
 
-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.
+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
 
@@ -235,9 +251,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
@@ -245,7 +264,8 @@ 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).
 
@@ -265,9 +285,9 @@ More examples here: https://translation.io/blog/rails-i18n-with-locale
 
 ## 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
@@ -281,12 +301,9 @@ The `TranslationIO.configure` block in `config/initializers/translation.rb` can
 
 Some options are described below but for an exhaustive list, please refer to [config.rb](https://github.com/translation/rails/blob/master/lib/translation_io/config.rb).
 
-### Disable GetText
+### Disable GetText or YAML
 
-Sometimes, you only want to use YAML and don't want to be bothered by GetText at all.
-For these cases, you just have to add `disable_gettext` in the config file.
-
-For example:
+If you want to only use YAML files and totally ignore GetText syntax, use:
 
 ```ruby
 TranslationIO.configure do |config|
@@ -296,6 +313,17 @@ TranslationIO.configure do |config|
 end
 ```
 
+In contrast, if you only want to synchronize GetText files and leave the YAML
+files unchanged, use:
+
+```ruby
+TranslationIO.configure do |config|
+  ...
+  config.disable_yaml = true
+  ...
+end
+```
+
 ### Ignored YAML keys
 
 Sometimes you would like to ignore some YAML keys coming from gems or so.
@@ -307,19 +335,45 @@ For example:
 TranslationIO.configure do |config|
   ...
   config.ignored_key_prefixes = [
-    'number.human.',
-    'admin.',
-    'errors.messages.',
-    'activerecord.errors.messages.',
-    'will_paginate.',
-    'helpers.page_entries_info.',
-    'views.pagination.',
-    'enumerize.visibility.'
+    'number.human',
+    'admin',
+    'errors.messages',
+    'activerecord.errors.messages',
+    'will_paginate',
+    'helpers.page_entries_info',
+    'views.pagination',
+    'enumerize.visibility'
   ]
   ...
 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:
@@ -342,28 +396,15 @@ 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.
+### Gems with GetText strings
 
-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:
+Public gems usually don't make use of GetText strings, but if you created and localized your own gems
+with the GetText syntax, you'll want to be able to synchronize them:
 
 ```ruby
 TranslationIO.configure do |config|
   ...
-  config.localization_key_prefixes = ['my_gem.date.formats']
+  config.parsed_gems = ['your_gem_name']
   ...
 end
 ```
@@ -381,6 +422,30 @@ TranslationIO.configure do |config|
 end
 ```
 
+### GetText Object Class Monkey-Patching
+
+GetText methods (`_('')`, etc.) are available everywhere in your application.
+This is made by extending the global `Object` class.
+
+You can disable the built-in `Object` monkey-patching if you
+prefer a more granular approach:
+
+```ruby
+TranslationIO.configure do |config|
+  ...
+  config.gettext_object_delegate = false
+  ...
+end
+```
+
+Don't forget to manually include the GetText methods where needed:
+
+```ruby
+class Contact < ApplicationRecord
+  extend TranslationIO::Proxy
+end
+```
+
 ## Pure Ruby (without Rails)
 
 This gem was created specifically for Rails, but you can also use it in a pure Ruby project by making some arrangements:
@@ -483,9 +548,16 @@ Credits: [@deecewan](https://github.com/deecewan)
 
 ### Others
 
-If you want to create a new client for your favorite language or framework, feel
-free to reach us on [contact@translation.io](mailto:contact@translation.io) and
-we'll assist you with the workflow logic and send you API docs.
+If you want to create a new client for your favorite language or framework, please read our
+[Create a Translation.io Library](https://translation.io/docs/create-library)
+guide and use the special
+[init](https://translation.io/docs/create-library#initialization) and
+[sync](https://translation.io/docs/create-library#synchronization) endpoints.
+
+You can also use the more [traditional API](https://translation.io/docs/api).
+
+Feel free to contact us on [contact@translation.io](mailto:contact@translation.io) if
+you need some help or if you want to share your library.
 
 ## License
 

data/lib/translation.rb

@@ -5,8 +5,6 @@ module TranslationIO
     :nsgettext, :pgettext, :npgettext, :sgettext, :ngettext, :gettext,
     :np_, :ns_, :Nn_, :n_, :p_, :s_, :N_, :_
   ]
-
-  TEXT_DOMAIN = 'app'
 end
 
 require 'translation_io/config'
@@ -33,7 +31,7 @@ module TranslationIO
 
       yield @config
 
-      unless @config.disable_gettext
+      if !@config.disable_gettext
         require_gettext_dependencies
         add_missing_locales
         add_parser_for_erb_source_formats(@config.erb_source_formats)
@@ -45,13 +43,18 @@ module TranslationIO
         # include is private until Ruby 2.1
         Proxy.send(:include, GetText)
 
-        Proxy.bindtextdomain(TEXT_DOMAIN, {
-          :path           => @config.locales_path,
-          :output_charset => @config.charset
-        })
+        @config.bound_text_domains.each do |bound_text_domain|
+          Proxy.bindtextdomain(bound_text_domain, {
+            :path           => @config.locales_path,
+            :output_charset => @config.charset
+          })
+        end
+
+        Proxy.textdomain(@config.text_domain)
 
-        Proxy.textdomain(TEXT_DOMAIN)
-        Object.delegate *GETTEXT_METHODS, :to => Proxy
+        if @config.gettext_object_delegate
+          Object.delegate *GETTEXT_METHODS, :to => Proxy
+        end
       end
 
       @client = Client.new(@config.api_key, @config.endpoint)

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

@@ -9,8 +9,10 @@ module TranslationIO
         def run
           TranslationIO.info "Creating new MO files."
 
-          Dir["#{@locales_path}/*/#{TEXT_DOMAIN}.po"].each do |po_path|
-            mo_path = "#{File.dirname(po_path)}/LC_MESSAGES/app.mo"
+          text_domain = TranslationIO.config.text_domain
+
+          Dir["#{@locales_path}/*/#{text_domain}.po"].each do |po_path|
+            mo_path = "#{File.dirname(po_path)}/LC_MESSAGES/#{text_domain}.mo"
             TranslationIO.info mo_path, 2, 2
             FileUtils.mkdir_p(File.dirname(mo_path))
             GetText::Tools::MsgFmt.run(po_path, '-o', mo_path)

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

@@ -11,9 +11,11 @@ module TranslationIO
         def run
           TranslationIO.info "Saving new PO files."
 
+          text_domain = TranslationIO.config.text_domain
+
           @target_locales.each do |target_locale|
             if @parsed_response.has_key?("po_data_#{target_locale}")
-              po_path = File.join(@locales_path, Locale::Tag.parse(target_locale).to_s, "#{TEXT_DOMAIN}.po")
+              po_path = File.join(@locales_path, Locale::Tag.parse(target_locale).to_s, "#{text_domain}.po")
               FileUtils.mkdir_p(File.dirname(po_path))
               TranslationIO.info po_path, 2, 2
 

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

@@ -19,7 +19,7 @@ module TranslationIO
 
               yaml_data = YAMLConversion.get_yaml_data_from_po_data(@parsed_response["yaml_po_data_#{target_locale}"], target_locale)
 
-              top_comment = <<EOS
+              top_comment = <<-EOS
 # WARNING. THIS FILE WAS AUTO-GENERATED BY THE TRANSLATION GEM.
 # IF YOU UPDATE IT, YOUR CHANGES WILL BE LOST AT THE NEXT SYNC.
 #

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

@@ -24,6 +24,8 @@ module TranslationIO
             YamlEntry.localization?(key, value)
           end
 
+          params = {}
+
           @target_locales.each do |target_locale|
             yaml_path = File.join(@yaml_locales_path, "localization.#{target_locale}.yml")
 
@@ -35,32 +37,36 @@ module TranslationIO
 
             yaml_data = YAMLConversion.get_yaml_data_from_flat_translations(target_flat_special_translations)
 
-            File.open(yaml_path, 'wb') do |file|
-              file.write(self.class.top_comment)
-              file.write(yaml_data)
-            end
-          end
+            params["yaml_data_#{target_locale}"] = yaml_data
 
-          if not TranslationIO.config.test
-            # Get YAML localization entries
-            params = {}
-            @target_locales.each do |target_locale|
-              yaml_path = File.join(@yaml_locales_path, "localization.#{target_locale}.yml")
-              params["yaml_data_#{target_locale}"] = File.read(yaml_path)
+            # To have a localization.xx.yml file during tests (without call to backend)
+            if TranslationIO.config.test
+              if YAML::load(yaml_data).present?
+                File.open(yaml_path, 'wb') do |file|
+                  file.write(self.class.top_comment)
+                  file.write(yaml_data)
+                end
+              end
             end
+          end
 
-            TranslationIO.info "Collecting YAML localization entries from server."
+          TranslationIO.info "Collecting YAML localization entries from server."
 
+          # To have a localization.xx.yml file with call to backend
+          if !TranslationIO.config.test
             uri             = URI("#{TranslationIO.client.endpoint}/projects/#{TranslationIO.client.api_key}/fill_yaml_localizations")
             parsed_response = BaseOperation.perform_request(uri, params)
 
-            unless parsed_response.nil?
+            if !parsed_response.nil?
               @target_locales.each do |target_locale|
                 yaml_path = File.join(@yaml_locales_path, "localization.#{target_locale}.yml")
+                yaml_data = parsed_response["yaml_data_#{target_locale}"]
 
-                File.open(yaml_path, 'wb') do |file|
-                  file.write(self.class.top_comment)
-                  file.write(parsed_response["yaml_data_#{target_locale}"])
+                if yaml_data.present? && YAML::load(yaml_data).present?
+                  File.open(yaml_path, 'wb') do |file|
+                    file.write(self.class.top_comment)
+                    file.write(yaml_data)
+                  end
                 end
               end
             end
@@ -68,7 +74,7 @@ module TranslationIO
         end
 
         def self.top_comment
-          <<EOS
+          <<-EOS
 # THIS FILE CONTAINS LOCALIZATION KEYS : date and number formats, number precisions,
 # number separators and all non-textual values depending on the language.
 # These values must not reach the translator, so they are separated in this file.

data/lib/translation_io/client/init_operation.rb

@@ -19,7 +19,7 @@ module TranslationIO
         yaml_locales_path = config.yaml_locales_path
         yaml_file_paths   = config.yaml_file_paths
 
-        unless config.disable_gettext
+        if !config.disable_gettext
           BaseOperation::DumpMarkupGettextKeysStep.new(haml_source_files, :haml).run
           BaseOperation::DumpMarkupGettextKeysStep.new(slim_source_files, :slim).run
         end
@@ -27,27 +27,34 @@ module TranslationIO
         UpdatePotFileStep.new(pot_path, source_files + erb_source_files).run(params)
         UpdateAndCollectPoFilesStep.new(target_locales, pot_path, locales_path).run(params)
 
-        create_yaml_pot_files_step = CreateYamlPoFilesStep.new(source_locale, target_locales, yaml_file_paths)
-        create_yaml_pot_files_step.run(params)
+        if !config.disable_yaml
+          create_yaml_pot_files_step = CreateYamlPoFilesStep.new(source_locale, target_locales, yaml_file_paths)
+          create_yaml_pot_files_step.run(params)
 
-        all_used_yaml_locales = create_yaml_pot_files_step.all_used_yaml_locales.to_a.map(&:to_s).sort
+          all_used_yaml_locales = create_yaml_pot_files_step.all_used_yaml_locales.to_a.map(&:to_s).sort
 
-        warn_source_locale_unfound(source_locale, all_used_yaml_locales)
-        warn_target_locale_unfound(target_locales, all_used_yaml_locales)
+          warn_source_locale_unfound(source_locale, all_used_yaml_locales)
+          warn_target_locale_unfound(target_locales, all_used_yaml_locales)
+        end
 
         TranslationIO.info "Sending data to server (it may take some time, please be patient. Sync will be faster)."
 
         uri             = URI("#{client.endpoint}/projects/#{client.api_key}/init")
         parsed_response = BaseOperation.perform_request(uri, params)
 
-        unless parsed_response.nil?
-          BaseOperation::SaveNewPoFilesStep.new(target_locales, locales_path, parsed_response).run
-          BaseOperation::SaveNewYamlFilesStep.new(target_locales, yaml_locales_path, parsed_response).run
-          BaseOperation::SaveSpecialYamlFilesStep.new(source_locale, target_locales, yaml_locales_path, yaml_file_paths).run
-          CleanupYamlFilesStep.new(source_locale, target_locales, yaml_file_paths, yaml_locales_path).run
-          BaseOperation::CreateNewMoFilesStep.new(locales_path).run
+        if !parsed_response.nil?
+          if !config.disable_gettext
+            BaseOperation::SaveNewPoFilesStep.new(target_locales, locales_path, parsed_response).run
+            BaseOperation::CreateNewMoFilesStep.new(locales_path).run
+          end
+
+          if !config.disable_yaml
+            BaseOperation::SaveNewYamlFilesStep.new(target_locales, yaml_locales_path, parsed_response).run
+            BaseOperation::SaveSpecialYamlFilesStep.new(source_locale, target_locales, yaml_locales_path, yaml_file_paths).run
+            CleanupYamlFilesStep.new(source_locale, target_locales, yaml_file_paths, yaml_locales_path).run
+            info_yaml_directory_structure
+          end
 
-          info_yaml_directory_structure
           info_project_url(parsed_response)
         end
 
@@ -55,7 +62,7 @@ module TranslationIO
       end
 
       def warn_source_locale_unfound(source_locale, all_used_yaml_locales)
-        is_source_locale_unfound = !source_locale.in?(all_used_yaml_locales)
+        is_source_locale_unfound = !all_used_yaml_locales.include?(source_locale)
 
         if is_source_locale_unfound
           puts
@@ -81,7 +88,7 @@ module TranslationIO
           puts
           puts "----------"
           puts "Your `config.target_locales` are [#{target_locales.sort.join(', ')}]."
-          puts "But we haven't found any YAML key for [#{target_locales_unfound.join(', ')}], is this normal?"
+          puts "But we haven't found any YAML key for [#{target_locales_unfound.sort.join(', ')}], is this normal?"
           puts "If not, check that you haven't misspelled the locale (ex. 'en-GB' instead of 'en')."
           puts "----------"
           puts "Do you want to continue? (y/N)"

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

@@ -13,22 +13,28 @@ 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        = YAML::load(File.read(locale_file_path)) || {}
+                source_content_hash = content_hash.select { |k| k.to_s == @source_locale.to_s }
 
-                if content_hash
-                  new_content_hash = content_hash.keep_if { |k| k.to_s == @source_locale.to_s }
-                else # loading an empty file returns false
-                  new_content_hash = {}
-                end
-
-                if new_content_hash.keys.any?
+                if source_content_hash.empty?
+                  TranslationIO.info "Removing #{locale_file_path}", 2, 2
+                  FileUtils.rm(locale_file_path)
+                elsif content_hash != source_content_hash # in case of mixed languages in source YAML file
                   TranslationIO.info "Rewriting #{locale_file_path}", 2, 2
+
+                  if TranslationIO.config.yaml_line_width
+                    file_content = source_content_hash.to_yaml(:line_width => TranslationIO.config.yaml_line_width)
+                  else
+                    file_content = source_content_hash.to_yaml
+                  end
+
+                  file_content = file_content.gsub(/ $/, '') # remove trailing spaces
+
                   File.open(locale_file_path, 'wb') do |file|
-                    file.write(new_content_hash.to_yaml)
+                    file.write(file_content)
                   end
                 else
-                  TranslationIO.info "Removing #{locale_file_path}", 2, 2
-                  FileUtils.rm(locale_file_path)
+                  # don't touch source
                 end
               end
             end

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

@@ -11,8 +11,10 @@ module TranslationIO
         def run(params)
           TranslationIO.info "Updating PO files."
 
+          text_domain = TranslationIO.config.text_domain
+
           @target_locales.each do |target_locale|
-            po_path = "#{@locales_path}/#{Locale::Tag.parse(target_locale).to_s}/#{TEXT_DOMAIN}.po"
+            po_path = "#{@locales_path}/#{Locale::Tag.parse(target_locale).to_s}/#{text_domain}.po"
             TranslationIO.info po_path, 2, 2
 
             if File.exist?(po_path)

data/lib/translation_io/client/sync_operation.rb

@@ -22,15 +22,20 @@ module TranslationIO
         yaml_locales_path = config.yaml_locales_path
         yaml_file_paths   = config.yaml_file_paths
 
-        ApplyYamlSourceEditsStep.new(yaml_file_paths, source_locale).run(params)
+        if !config.disable_yaml
+          ApplyYamlSourceEditsStep.new(yaml_file_paths, source_locale).run(params)
+        end
 
-        unless config.disable_gettext
+        if !config.disable_gettext
           BaseOperation::DumpMarkupGettextKeysStep.new(haml_source_files, :haml).run
           BaseOperation::DumpMarkupGettextKeysStep.new(slim_source_files, :slim).run
         end
 
         UpdatePotFileStep.new(pot_path, source_files + erb_source_files).run(params)
-        CreateYamlPotFileStep.new(source_locale, yaml_file_paths).run(params)
+
+        if !config.disable_yaml
+          CreateYamlPotFileStep.new(source_locale, yaml_file_paths).run(params)
+        end
 
         if purge
           params['purge'] = 'true'
@@ -45,11 +50,16 @@ module TranslationIO
         uri             = URI("#{client.endpoint}/projects/#{client.api_key}/sync")
         parsed_response = BaseOperation.perform_request(uri, params)
 
-        unless parsed_response.nil?
-          BaseOperation::SaveNewPoFilesStep.new(target_locales, locales_path, parsed_response).run
-          BaseOperation::CreateNewMoFilesStep.new(locales_path).run
-          BaseOperation::SaveNewYamlFilesStep.new(target_locales, yaml_locales_path, parsed_response).run
-          BaseOperation::SaveSpecialYamlFilesStep.new(source_locale, target_locales, yaml_locales_path, yaml_file_paths).run
+        if !parsed_response.nil?
+          if !config.disable_gettext
+            BaseOperation::SaveNewPoFilesStep.new(target_locales, locales_path, parsed_response).run
+            BaseOperation::CreateNewMoFilesStep.new(locales_path).run
+          end
+
+          if !config.disable_yaml
+            BaseOperation::SaveNewYamlFilesStep.new(target_locales, yaml_locales_path, parsed_response).run
+            BaseOperation::SaveSpecialYamlFilesStep.new(source_locale, target_locales, yaml_locales_path, yaml_file_paths).run
+          end
 
           display_unused_segments(parsed_response, show_purgeable, purge)
 

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

@@ -12,66 +12,123 @@ 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."
-
-            parsed_response['source_edits'].each do |source_edit|
-              inserted = 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)
-
-                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
-
-                      if locale_file_path_in_project?(file_path)
-                        flat_yaml_hash[key] = source_edit['new_text']
-
-                        File.open(file_path, 'w') do |f|
-                          f.write(FlatHash.to_hash(flat_yaml_hash).to_yaml)
-                        end
-                      else # override source text of gem
-                        yaml_path = File.join(TranslationIO.config.yaml_locales_path, "#{@source_locale}.yml")
-
-                        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
-
-                        flat_yaml_hash["#{@source_locale}.#{source_edit['key']}"] = source_edit['new_text']
-
-                        File.open(yaml_path, 'w') do |f|
-                          f.write(FlatHash.to_hash(flat_yaml_hash).to_yaml)
-                        end
-                      end
-
-                      inserted = true
-                      break
-                    else
-                      TranslationIO.info "#{source_edit['key']} | Ignored because translation was also updated in source YAML file", 2, 2
-                    end
-                  end
-                end
+          TranslationIO.info "Applying YAML source editions."
+
+          source_edits.each do |source_edit|
+            applied = false
+
+            reload_or_reuse_yaml_sources
 
-                break if inserted
+            @yaml_sources.each do |yaml_source|
+              yaml_file_path = yaml_source[:yaml_file_path]
+              yaml_flat_hash = yaml_source[:yaml_flat_hash]
+
+              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
+
+              break if applied
             end
           end
 
-          File.open(TranslationIO.config.metadata_path, 'w') do |f|
-            f.write({ 'timestamp' => Time.now.utc.to_i }.to_yaml)
-          end
+          update_metadata_timestamp
         end
 
         private
 
+        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      = 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_sources
+          end
+        end
+
+        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
+
+        def apply_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+          full_key = "#{@source_locale}.#{source_edit['key']}"
+
+          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
+
+            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
+
+        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
+
+        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"))
+
+          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)
+          else
+            content = yaml_hash.to_yaml
+          end
+
+          content.gsub(/ $/, '') # remove trailing spaces
+        end
+
         def metadata_timestamp
           if File.exist?(TranslationIO.config.metadata_path)
             metadata_content = File.read(TranslationIO.config.metadata_path)
@@ -87,26 +144,26 @@ module TranslationIO
           end
         end
 
+        def update_metadata_timestamp
+          File.open(TranslationIO.config.metadata_path, 'w') do |f|
+            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/config.rb

@@ -1,24 +1,40 @@
 module TranslationIO
   class Config
-    attr_accessor :api_key, :locales_path, :yaml_locales_path
-    attr_accessor :source_locale, :target_locales
+    attr_accessor :api_key
+    attr_accessor :source_locale
+    attr_accessor :target_locales
     attr_accessor :endpoint
+    attr_accessor :metadata_path
     attr_accessor :verbose
     attr_accessor :test
 
+    attr_accessor :disable_yaml
+
+    attr_accessor :yaml_locales_path
     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
+
+    attr_accessor :gettext_object_delegate
+
+    attr_accessor :locales_path
+
     attr_accessor :ignored_source_paths
     attr_accessor :ignored_source_files
 
+    attr_accessor :parsed_gems
+
     attr_accessor :source_formats
     attr_accessor :erb_source_formats
     attr_accessor :haml_source_formats
     attr_accessor :slim_source_formats
 
-    attr_accessor :localization_key_prefixes
-    attr_accessor :disable_gettext
+    attr_accessor :text_domain
+    attr_accessor :bound_text_domains
     attr_accessor :charset
-    attr_accessor :metadata_path
 
     attr_accessor :pot_msgid_bugs_address
     attr_accessor :pot_package_name
@@ -27,37 +43,84 @@ module TranslationIO
     attr_accessor :pot_copyright_year
 
     def initialize
-      self.locales_path              = File.join('config', 'locales', 'gettext')
-      self.yaml_locales_path         = File.join('config', 'locales')
-      self.source_locale             = :en
-      self.target_locales            = []
-      self.endpoint                  = 'https://translation.io/api'
-      self.verbose                   = 1
-      self.test                      = false
-
-      self.ignored_key_prefixes      = []
-      self.ignored_source_paths      = ['vendor/', 'tmp/']
-      self.ignored_source_files      = [] # Files not parsed for GetText entries
-
-      self.source_formats            = ['rb', 'ruby', 'rabl']
-      self.erb_source_formats        = ['erb', 'inky']
-      self.haml_source_formats       = ['haml', 'mjmlhaml']
-      self.slim_source_formats       = ['slim', 'mjmlslim']
 
+      #######
+      # Global options
+      #######
+
+      self.api_key        = ''
+      self.source_locale  = :en
+      self.target_locales = []
+      self.endpoint       = 'https://translation.io/api'
+      self.metadata_path  = File.join('config', 'locales', '.translation_io')
+      self.verbose        = 1
+      self.test           = false
+
+      #######
+      # YAML options
+      #######
+
+      self.disable_yaml = false
+
+      # YAML directory
+      self.yaml_locales_path = File.join('config', 'locales')
+
+      # Ignored YAML key prefixes (like 'will_paginate.')
+      self.ignored_key_prefixes = []
+
+      # Cf. https://github.com/translation/rails#custom-localization-key-prefixes
       self.localization_key_prefixes = []
-      self.disable_gettext           = false
-      self.charset                   = 'UTF-8'
-      self.metadata_path             = File.join('config', 'locales', '.translation_io')
-
-      self.pot_msgid_bugs_address    = 'contact@translation.io'
-      self.pot_package_name          = File.basename(Dir.pwd)
-      self.pot_package_version       = '1.0'
-      self.pot_copyright_holder      = File.basename(Dir.pwd)
-      self.pot_copyright_year        = Date.today.year
+
+      # Define max line width of generated YAML files:
+      # Can be nil (default behaviour of Ruby version), -1 (no wrapping) or positive integer (wrapping)
+      # 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
+      #######
+
+      self.disable_gettext = false
+
+      # Cf. https://github.com/translation/rails#gettext-object-class-monkey-patching
+      self.gettext_object_delegate = true
+
+      # GetText directory for PO and MO files
+      self.locales_path = File.join('config', 'locales', 'gettext')
+
+      # These paths and files will not be parsed for GetText entries
+      self.ignored_source_paths = ['vendor/', 'tmp/', 'node_modules/', 'logs/', '.git/', 'public/', 'private/']
+      self.ignored_source_files = []
+
+      # These gems will be parsed by GetText (use gem names)
+      self.parsed_gems = []
+
+      # Extensions for rb/erb/haml/slim file parsers
+      self.source_formats      = ['rb', 'ruby', 'rabl']
+      self.erb_source_formats  = ['erb', 'inky']
+      self.haml_source_formats = ['haml', 'mjmlhaml']
+      self.slim_source_formats = ['slim', 'mjmlslim']
+
+      # 'text_domain' will be synced (name of .po/.mo files)
+      # 'bound_text_domains' will be read during execution (in that priority order)
+      self.text_domain        = 'app'
+      self.bound_text_domains = ['app']
+      self.charset            = 'UTF-8'
+
+      # POT header informations
+      self.pot_msgid_bugs_address = 'contact@translation.io'
+      self.pot_package_name       = File.basename(Dir.pwd)
+      self.pot_package_version    = '1.0'
+      self.pot_copyright_holder   = File.basename(Dir.pwd)
+      self.pot_copyright_year     = Date.today.year
     end
 
     def pot_path
-      File.join(locales_path, "#{TEXT_DOMAIN}.pot")
+      File.join(locales_path, "#{text_domain}.pot")
     end
 
     def yaml_file_paths
@@ -83,19 +146,45 @@ module TranslationIO
     end
 
     def source_files_for_formats(formats)
-      file_paths = Dir["**/*.{#{formats.join(',')}}"]
-
-      # remove ignored files
-      file_paths = file_paths - ignored_source_files
+      file_paths = []
+      root_paths = ['.']
+
+      # Add gem paths that need to be parsed by GetText ("parsed_gem" option)
+      parsed_gems.each do |gem_name|
+        if Gem.loaded_specs[gem_name]
+          root_paths << Gem.loaded_specs[gem_name].full_gem_path
+        end
+      end
 
-      # remove ignored paths
-      ignored_source_paths.each do |ignored_source_path|
-        file_paths = file_paths.select { |file_path| !file_path.start_with?(ignored_source_path) }
+      root_paths.each do |root_path|
+        Pathname.new(root_path).find do |path|
+          if path.directory?
+            if is_ignored_path?(path)
+              Find.prune
+            end
+          else
+            if formats.include?(path.extname[1..-1]) && !is_ignored_file?(path)
+              file_paths << path.to_s
+            end
+          end
+        end
       end
 
       file_paths
     end
 
+    def is_ignored_path?(path)
+      ignored_source_paths.any? do |ignored_source_path|
+        path == Pathname.new(ignored_source_path).cleanpath
+      end
+    end
+
+    def is_ignored_file?(path)
+      ignored_source_files.any? do |ignored_source_file|
+        path == Pathname.new(ignored_source_file).cleanpath
+      end
+    end
+
     def to_s
       "API Key: #{api_key} | Languages: #{source_locale} => [#{target_locales.join(', ')}]"
     end

data/lib/translation_io/flat_hash.rb

@@ -7,9 +7,13 @@ module TranslationIO
         get_flat_hash_for_level(hash)
       end
 
-      def to_hash(flat_hash)
+      def to_hash(flat_hash, remove_empty_keys = false)
         hash = {}
 
+        if remove_empty_keys
+          flat_hash = flat_hash.reject { |k, v| v.blank? && !k.end_with?(']') }
+        end
+
         flat_hash.each_pair do |key, value|
           build_hash_with_flat(hash, key, value)
         end

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
@@ -49,8 +51,12 @@ if defined?(GetText)
             begin
               parse_path(path, po)
             rescue SystemExit => e
-              # puts(_("Error parsing %{path}") % {:path => path})
               puts
+              puts "---------------"
+              puts "Error while parsing this file for GetText: #{path}"
+              puts "Are you sure the file is correctly formatted?"
+              puts "Feel free to contact us to get some help: contact@translation.io"
+              puts "---------------"
               puts
             end
           end

data/lib/translation_io/yaml_conversion.rb

@@ -36,8 +36,16 @@ module TranslationIO
       end
 
       def get_yaml_data_from_flat_translations(flat_translations)
-        translations = FlatHash.to_hash(flat_translations)
-        return translations.to_yaml
+        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)
+        else
+          data = translations.to_yaml
+        end
+
+        data.gsub(/ $/, '') # remove trailing spaces
       end
 
     end

data/lib/translation_io/yaml_entry.rb

@@ -2,7 +2,7 @@ module TranslationIO
   module YamlEntry
 
     IGNORED_KEY_PREFIXES = [
-      'faker.'
+      'faker'
     ]
 
     LOCALIZATION_KEY_PREFIXES = [
@@ -31,7 +31,7 @@ module TranslationIO
       end
 
       def ignored?(key)
-        key.present? && ignored_key_prefixes.any? { |p| key_without_locale(key).start_with?(p) }
+        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).start_with?(prefix)
+          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.17'
+  version: '1.22'
 platform: ruby
 authors:
 - Michael Hoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gettext
@@ -35,30 +35,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -144,10 +144,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Localize your app with YAML or GetText. Synchronize with your translators
   on Translation.io.
 test_files: []
-has_rdoc: false