translation 1.24 → 1.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8082495585677aa8e3ca187a4c4a443d3064e479010b4f7519d2ae7318ae5f66
-  data.tar.gz: 5e0f671d44c5aaa4436b4cff506444886a3f817f670f99eabb97b8a7534b7a5f
+  metadata.gz: c0d2f9ee1b57320b568bf17c4587f74a652ffe61c521d3fb1693d43d8ddbc67d
+  data.tar.gz: ce0293347ec5ade30b2faf5ee6d3698f7b1191895d4cdb6fb23f6c869d057ff0
 SHA512:
-  metadata.gz: 1407033d3f2b08b6429d4bbc10ce6997f2b7f72a8a24832a4b58cb018817a983059b3871cdd91d37fcaf44f9fc7127699ec4920108ac7944bce41e8a3355c62c
-  data.tar.gz: 71c9607dc017aeb3d3843eb462138c372636a752033216ae4211008ba013272e44f84c388ddae8dbbfb24d5679f87124d404e0b09b98262f4645fe3c9bb23b3d
+  metadata.gz: a2e07deb5a081fd8a0d8892b1f1c866db455f7194f7e3047141fccc5e76691997cf475d2a60fe20ed9c43c467f0f950fa9692bf8614ecc7fa2a49a960ef5d8fd
+  data.tar.gz: d53909fdc6398034776f0bb3e682b4d7b26c7edd32e6003098bda6c866249ac79e4af4be27bab7fdd507484d4d96006e6ca112a59ee4269e4d3d7fdd1f96c40c

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)
-[![Build Status](https://travis-ci.com/translation/rails.svg?branch=master)](https://travis-ci.com/translation/rails)
+[![Build Status](https://travis-ci.com/translation/rails.svg?branch=master)](https://app.travis-ci.com/github/translation/rails)
 [![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.
 
@@ -40,6 +40,8 @@ Table of contents
    * [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)
@@ -55,7 +57,7 @@ Table of contents
  * [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)
 
@@ -96,7 +98,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
@@ -145,7 +147,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
@@ -178,7 +180,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
 
@@ -222,10 +225,16 @@ Examples: `en-microsoft` or `fr-BE-custom`.
 
 ### 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.
+If a translation is missing for a regional (`fr-BE`) or custom (`fr-microsoft`)
+language, then it will fallback to the main language (`fr`).
+
+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`.
@@ -234,10 +243,6 @@ Just make sure to add `config.i18n.fallbacks = true` to your `config/application
 You can find more information about this
 [here](https://guides.rubyonrails.org/configuring.html#configuring-i18n).
 
-Using [GetText](#gettext) syntax, it will only fallback to the source language.
-So either you create a fallback mechanism by yourself or you avoid fallbacking
-by translating everything in Translation.io for the regional or custom language.
-
 ## Change the current locale
 
 ### Globally
@@ -287,6 +292,8 @@ 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
@@ -299,10 +306,12 @@ Assuming that you use [reactjs/react-rails](https://github.com/reactjs/react-rai
 it would look like this if you want to use [I18n (YAML)](#i18n-yaml) syntax:
 
 ```erb
-<%= react_component('MyComponent", {
+<%= 
+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:
@@ -317,13 +326,15 @@ en:
 You can also directly use the [GetText](#gettext) syntax:
 
 ```erb
-<%= react_component('MyComponent", {
+<%= 
+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
@@ -334,6 +345,18 @@ In both case, in your React component, you can simply call
  * 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
@@ -597,12 +620,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

@@ -39,6 +39,10 @@ module TranslationIO
           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)
 

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

@@ -35,7 +35,9 @@ 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
 

data/lib/translation_io/client/init_operation.rb

@@ -13,8 +13,8 @@ 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

data/lib/translation_io/client/sync_operation.rb

@@ -16,8 +16,8 @@ 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

data/lib/translation_io/yaml_conversion.rb

@@ -35,9 +35,14 @@ module TranslationIO
         end
       end
 
-      def get_yaml_data_from_flat_translations(flat_translations)
-        remove_empty_keys = TranslationIO.config.yaml_remove_empty_keys
-        translations      = FlatHash.to_hash(flat_translations, remove_empty_keys)
+      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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translation
 version: !ruby/object:Gem::Version
-  version: '1.24'
+  version: '1.29'
 platform: ruby
 authors:
 - Michael Hoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gettext
@@ -23,7 +23,7 @@ dependencies:
         version: 3.2.5
     - - "<="
       - !ruby/object:Gem::Version
-        version: 3.3.7
+        version: 3.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -36,7 +36,7 @@ dependencies:
         version: 3.2.5
     - - "<="
       - !ruby/object:Gem::Version
-        version: 3.3.7
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement