translation 1.32 → 1.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a34c57ba0de5df8e9d6e302e24d1d959db4b2a697678d7cfc67e08b36702ef6
-  data.tar.gz: 5e024618fe204efef1a26294ec9e8bb6ab5fe357d9a32d826623a7ed4a5b508b
+  metadata.gz: 61a215cc27f4bfd0954d910e4d76f956e4b6fe54d9cb9caf74ba40cf665dcf83
+  data.tar.gz: e708d5f92493b6085d6062ce1588fa39927795e21805b0413cdcb0723b61ff94
 SHA512:
-  metadata.gz: 59e48c919c27811c8d8ba6f1b29104d9adf2b661ce69a156acaea8ea669d137d87c9a07f0cb2e9e7f8175ca1930419d0ee6f1752fb4abb045fbfea9795185ea9
-  data.tar.gz: c2e556ccaf8f3bec9c833a51ba181c996e76f8f549cb1a180779ba287a9ac56ad992cf8b8fddb40bdb574cb63a3b6130145fe6a09a7d6f93af18dfbad43239af
+  metadata.gz: 5e0e61144155c587eb7d031691d906bafd3611df7566b35adfce44b390b903e6a9c20a0bb8d37f71349c2a8f12731f834bfcc96ed1ffadeed44520197bdfab54
+  data.tar.gz: 6ac7e7b30dea348362b067fcf1a5a12240b60366941431ff5a4b25dcdad47574e33c428b4728dd49bf06ad1fe4b3785fd1238a2ae01a8d4b9a5149cda7675a17

data/README.md

@@ -12,7 +12,7 @@ Use the official Rails syntax (with [YAML](#i18n-yaml) files) or use the [GetTex
 
 Write only the source text, and keep it synchronized with your translators on [Translation.io](https://translation.io).
 
-<a href="https://translation.io">
+<a href="https://translation.io/rails">
   <img width="720px" alt="Translation.io interface" src="https://translation.io/gifs/translation.gif">
 </a>
 
@@ -20,10 +20,9 @@ Write only the source text, and keep it synchronized with your translators on [T
 
 Need help? [contact@translation.io](mailto:contact@translation.io)
 
-Table of contents
-=================
+## Table of contents
 
- * [Translation syntaxes](#translation-syntaxes)
+ * [Localization syntaxes](#localization-syntaxes)
    * [I18n (YAML)](#i18n-yaml)
    * [GetText](#gettext)
  * [Installation](#installation)
@@ -52,23 +51,23 @@ Table of contents
    * [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, React Native and JavaScript](#react-react-native-and-javascript)
+   * [Angular](#angular)
    * [Others](#others)
  * [License](#license)
 
-## Translation syntaxes
+## Localization syntaxes
 
 ### I18n (YAML)
 
 The default [Rails Internationalization API](http://guides.rubyonrails.org/i18n.html).
 
-```ruby
+~~~ruby
 # Regular
 t('inbox.title')
 
@@ -77,11 +76,11 @@ t('inbox.message', count: n)
 
 # Interpolation
 t('inbox.hello', name: @user.name)
-```
+~~~
 
 With the source YAML file:
 
-```yaml
+~~~yaml
 en:
   inbox:
     title:   'Title to be translated'
@@ -90,7 +89,7 @@ en:
       one:   'one message'
       other: '%{count} messages'
     hello:   'Hello %{name}'
-```
+~~~
 
 You can keep your source YAML file automatically updated using [i18n-tasks](https://github.com/glebm/i18n-tasks).
 
@@ -102,7 +101,7 @@ that you use GetText to translate your application since it allows an easier and
 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
+~~~ruby
 # Regular
 _("Text to be translated")
 
@@ -117,7 +116,7 @@ np_("context", "Singular text", "Plural text", number)
 
 # Interpolations
 _('%{city1} is bigger than %{city2}') % { city1: "NYC", city2: "BXL" }
-```
+~~~
 
 More information about GetText syntax [here](https://github.com/ruby-gettext/gettext#usage).
 
@@ -125,28 +124,28 @@ More information about GetText syntax [here](https://github.com/ruby-gettext/get
 
  1. Add the gem to your project's Gemfile:
 
-```ruby
+~~~ruby
 gem 'translation'
-```
+~~~
 
  2. Create a new translation project [from the UI](https://translation.io).
  3. Copy the initializer into your Rails app (`config/initializers/translation.rb`)
 
 The initializer looks like this:
 
-```ruby
+~~~ruby
 TranslationIO.configure do |config|
   config.api_key        = 'abcdefghijklmnopqrstuvwxyz012345'
   config.source_locale  = 'en'
   config.target_locales = ['fr', 'nl', 'de', 'es']
 end
-```
+~~~
 
  4. Initialize your project and push existing translations to Translation.io with:
 
-```bash
+~~~bash
 $ bundle exec rake translation:init
-```
+~~~
 
 If you need to add or remove languages in the future, please read our
 [documentation](https://translation.io/blog/adding-target-languages) about that.
@@ -157,17 +156,17 @@ If you need to add or remove languages in the future, please read our
 
 To send new translatable keys/strings and get new translations from Translation.io, simply run:
 
-```bash
+~~~bash
 $ bundle exec rake translation:sync
-```
+~~~
 
 ### Sync and Show Purgeable
 
 If you need to find out what are the unused keys/strings from Translation.io, using the current branch as reference:
 
-```bash
+~~~bash
 $ bundle exec rake translation:sync_and_show_purgeable
-```
+~~~
 
 As the name says, this operation will also perform a sync at the same time.
 
@@ -175,9 +174,9 @@ As the name says, this operation will also perform a sync at the same time.
 
 If you need to remove unused keys/strings from Translation.io, using the current branch as reference:
 
-```bash
+~~~bash
 $ bundle exec rake translation:sync_and_purge
-```
+~~~
 
 As the name says, this operation will also perform a sync at the same time.
 
@@ -216,9 +215,9 @@ 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
+~~~ruby
 "#{existing_language_code}-#{custom_text}"
-```
+~~~
 
 where `custom_text` can only contain alphabetic characters and `-`.
 
@@ -250,13 +249,13 @@ You can find more information about this
 
 The easiest way to change the current locale is with `set_locale`.
 
-```ruby
+~~~ruby
 class ApplicationController < ActionController::Base
   before_action :set_locale
 
   [...]
 end
-```
+~~~
 
 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
@@ -265,11 +264,11 @@ 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:
 
-```ruby
+~~~ruby
 scope "/:locale", :constraints => { locale: /[a-z]{2}/ } do
   resources :pages
 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.
@@ -283,9 +282,9 @@ More examples here: https://translation.io/blog/set-current-locale-in-your-rails
 
 This command will change the locale for both [I18n (YAML)](#i18n-yaml) and [GetText](#gettext):
 
-```ruby
+~~~ruby
 I18n.locale = 'fr'
-```
+~~~
 
 You can call it several times in the same page if you want to switch between languages.
 
@@ -306,29 +305,29 @@ 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
+~~~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:
 
-```yaml
+~~~yaml
 en:
   my_component:
     your_name: Your name
     title: Title
-```
+~~~
 
 You can also directly use the [GetText](#gettext) syntax:
 
-```erb
+~~~erb
 <%= 
-react_component('MyComponent", {
+react_component("MyComponent", {
   :user_id => current_user.id,
   :i18n => {
     :your_name => _('Your name'),
@@ -336,7 +335,7 @@ react_component('MyComponent", {
   }
 }) 
 %>
-```
+~~~
 
 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.
@@ -368,11 +367,11 @@ Since this task can't be concurrently executed
 a queue but it returns an error under heavy load), we implemented this
 threadsafe readonly task:
 
-```bash
+~~~bash
 $ bundle exec rake translation:sync_readonly
-```
+~~~
 
-This task will prevent your CI to fail and still provide new translations. But
+This task will prevent your CI from failing 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.
@@ -387,24 +386,24 @@ Some options are described below but for an exhaustive list, please refer to [co
 
 If you want to only use YAML files and totally ignore GetText syntax, use:
 
-```ruby
+~~~ruby
 TranslationIO.configure do |config|
   ...
   config.disable_gettext = true
   ...
 end
-```
+~~~
 
 In contrast, if you only want to synchronize GetText files and leave the YAML
 files unchanged, use:
 
-```ruby
+~~~ruby
 TranslationIO.configure do |config|
   ...
   config.disable_yaml = true
   ...
 end
-```
+~~~
 
 ### Ignored YAML keys
 
@@ -413,7 +412,7 @@ You can use the `ignored_key_prefixes` for that.
 
 For example:
 
-```ruby
+~~~ruby
 TranslationIO.configure do |config|
   ...
   config.ignored_key_prefixes = [
@@ -428,7 +427,7 @@ TranslationIO.configure do |config|
   ]
   ...
 end
-```
+~~~
 
 ### Custom localization key prefixes
 
@@ -448,13 +447,13 @@ to add some more, use the `localization_key_prefixes` option.
 
 For example:
 
-```ruby
+~~~ruby
 TranslationIO.configure do |config|
   ...
   config.localization_key_prefixes = ['my_gem.date.formats']
   ...
 end
-```
+~~~
 
 ### Source file formats (for GetText)
 
@@ -467,7 +466,7 @@ If you are using GetText and you want to manage other file formats than:
 
 Just add them in your configuration file like this:
 
-```ruby
+~~~ruby
 TranslationIO.configure do |config|
   ...
   config.source_formats      << 'rb2'
@@ -476,33 +475,33 @@ TranslationIO.configure do |config|
   config.slim_source_formats << 'slim2'
   ...
 end
-```
+~~~
 
 ### Gems with GetText strings
 
 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
+~~~ruby
 TranslationIO.configure do |config|
   ...
   config.parsed_gems = ['your_gem_name']
   ...
 end
-```
+~~~
 
 ### Paths where locales are stored (not recommended)
 
 You can specify where your GetText and YAML files are on disk:
 
-```ruby
+~~~ruby
 TranslationIO.configure do |config|
   ...
   config.locales_path      = 'some/path' # defaults to config/locales/gettext
   config.yaml_locales_path = 'some/path' # defaults to config/locales
   ...
 end
-```
+~~~
 
 ### GetText Object Class Monkey-Patching
 
@@ -512,27 +511,27 @@ 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
+~~~ruby
 TranslationIO.configure do |config|
   ...
   config.gettext_object_delegate = false
   ...
 end
-```
+~~~
 
 Don't forget to manually include the GetText methods where needed:
 
-```ruby
+~~~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:
 
-```ruby
+~~~ruby
   require 'rubygems'
   require 'active_support/all'
   require 'yaml'
@@ -579,44 +578,17 @@ This gem was created specifically for Rails, but you can also use it in a pure R
     config.target_locales    = ['nl', 'de']
     config.metadata_path     = 'i18n/.translation_io'
   end
-```
+~~~
 
 (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:
 
-```bash
+~~~bash
 $ bundle exec rspec
-```
+~~~
 
 ## Contributing
 
@@ -624,15 +596,16 @@ Please read the [CONTRIBUTING](CONTRIBUTING.md) file.
 
 ## List of clients for Translation.io
 
-These implementations were usually started by contributors for their own projects.
-Some of them are officially supported by [Translation.io](https://translation.io)
-and some are not yet supported. However, they are quite well documented.
+The following clients are officially supported by [Translation.io](https://translation.io)
+and are well documented.
 
-Thanks a lot to these contributors for their hard work!
+Some of these implementations (and other non-officially supported ones)
+were started by contributors for their own translation projects.
+We are thankful to all contributors for their hard work!
 
 ### Ruby on Rails (Ruby)
 
-Officially Supported on [https://translation.io/rails](https://translation.io/rails)
+Officially supported on [https://translation.io/rails](https://translation.io/rails)
 
  * GitHub: https://github.com/translation/rails
  * RubyGems: https://rubygems.org/gems/translation/
@@ -641,7 +614,7 @@ Credits: [@aurels](https://github.com/aurels), [@michaelhoste](https://github.co
 
 ### Laravel (PHP)
 
-Officially Supported on [https://translation.io/laravel](https://translation.io/laravel)
+Officially supported on [https://translation.io/laravel](https://translation.io/laravel)
 
  * GitHub: https://github.com/translation/laravel
  * Packagist: https://packagist.org/packages/tio/laravel
@@ -650,7 +623,7 @@ Credits: [@armandsar](https://github.com/armandsar), [@michaelhoste](https://git
 
 ### React, React Native and JavaScript
 
-Officially Supported on [https://translation.io/lingui](https://translation.io/lingui)
+Officially supported on [https://translation.io/lingui](https://translation.io/lingui)
 
 Translation.io is directly integrated in the great
 [Lingui](https://lingui.js.org/) internationalization project.
@@ -658,6 +631,15 @@ Translation.io is directly integrated in the great
  * GitHub: https://github.com/translation/lingui
  * NPM: https://www.npmjs.com/package/@translation/lingui
 
+### Angular
+
+Officially supported on [https://translation.io/angular](https://translation.io/angular)
+
+ * GitHub: https://github.com/translation/angular
+ * NPM: https://www.npmjs.com/package/@translation/angular
+ 
+Credits: [@SimonCorellia](https://github.com/SimonCorellia), [@didier-84](https://github.com/didier-84), [@michaelhoste](https://github.com/michaelhoste)
+
 ### Others
 
 If you want to create a new client for your favorite language or framework, please read our
@@ -668,8 +650,8 @@ guide and use the special
 
 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.
+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_io/client/base_operation/save_new_po_files_step.rb

@@ -2,7 +2,8 @@ module TranslationIO
   class Client
     class BaseOperation
       class SaveNewPoFilesStep
-        def initialize(target_locales, locales_path, parsed_response)
+        def initialize(source_locale, target_locales, locales_path, parsed_response)
+          @source_locale   = source_locale
           @target_locales  = target_locales
           @locales_path    = locales_path
           @parsed_response = parsed_response
@@ -25,8 +26,46 @@ module TranslationIO
             end
           end
 
+          create_source_po(text_domain)
+
           return self
         end
+
+        # Create source locale PO file, with identical source and target
+        # => Useful for correct fallbacks (cf. discussion https://github.com/translation/rails/issues/48)
+        def create_source_po(text_domain)
+          source_locale = Locale::Tag.parse(@source_locale)
+
+          pot_path = File.join(@locales_path, "#{text_domain}.pot")
+          po_path  = File.join(@locales_path, source_locale.to_s, "#{text_domain}.po")
+
+          FileUtils.mkdir_p(File.dirname(po_path))
+          FileUtils.rm(po_path) if File.exist?(po_path)
+
+          # Generate source PO from POT and parse it
+          GetText::Tools::MsgInit.run('-i', pot_path, '-o', po_path, '-l', source_locale.to_s, '--no-translator')
+          po_entries = GetText::PO.new
+          GetText::POParser.new.parse(File.read(po_path), po_entries)
+
+          # With GetText after 3.3.9 and the introduction of optional `red-datasets` dependency, we need to complete the plural forms manually
+          # Source languages must have only 2 plural forms, and only 2 different pluralization rules exist for these languages
+          if %w(ak am as bn fa fr gu hi hy kn ln mg nso pa si ti zu).include?(source_locale.language)
+            po_entries[''].msgstr.gsub!('Plural-Forms: nplurals=; plural=;', 'Plural-Forms: nplurals=2; plural=n > 1;')  # 0 and 1 are singular
+          else
+            po_entries[''].msgstr.gsub!('Plural-Forms: nplurals=; plural=;', 'Plural-Forms: nplurals=2; plural=n != 1;') # only 1 is singular
+          end
+
+          # Fill with same target as source and save it
+          po_entries.each do |po_entry|
+            if po_entry.msgid != '' # header
+              po_entry.msgstr = [po_entry.msgid, po_entry.msgid_plural].compact.join("\000")
+            end
+          end
+
+          File.open(po_path, 'wb') do |file|
+            file.write(po_entries.to_s)
+          end
+        end
       end
     end
   end

data/lib/translation_io/client/init_operation.rb

@@ -46,7 +46,7 @@ module TranslationIO
 
         if !parsed_response.nil?
           if !config.disable_gettext
-            BaseOperation::SaveNewPoFilesStep.new(target_locales, locales_path, parsed_response).run
+            BaseOperation::SaveNewPoFilesStep.new(source_locale, target_locales, locales_path, parsed_response).run
             BaseOperation::CreateNewMoFilesStep.new(locales_path).run
           end
 

data/lib/translation_io/client/sync_operation.rb

@@ -54,7 +54,7 @@ module TranslationIO
 
         if !parsed_response.nil?
           if !config.disable_gettext
-            BaseOperation::SaveNewPoFilesStep.new(target_locales, locales_path, parsed_response).run
+            BaseOperation::SaveNewPoFilesStep.new(source_locale, target_locales, locales_path, parsed_response).run
             BaseOperation::CreateNewMoFilesStep.new(locales_path).run
           end
 

data/lib/translation_io/railtie.rb

@@ -1,5 +1,6 @@
 require 'i18n'
 require 'i18n/config'
+require "i18n/backend/fallbacks"
 
 module TranslationIO
   class Railtie < Rails::Railtie
@@ -20,20 +21,32 @@ module TranslationIO
   end
 end
 
-module I18n
-  class Config
-    def locale=(locale)
-      I18n.enforce_available_locales!(locale) if I18n.respond_to?(:enforce_available_locales!)
-      @locale = locale.to_sym rescue nil
+###
+# Set GetText/Locale current locale based on I18n.locale
+###
+module I18nConfigExtension
+  def locale=(*args)
+    super
 
-      if defined?(GetText)
-        GetText.set_current_locale(locale.to_s.gsub('-', '_').to_sym)
-      end
+    if defined? Locale
+      # GetText/Locale already uses default fallbacks ("en-us-custom" => "en-us" => "en-custom" => "en")
+      # But we want to add them custom fallbacks from I18n (ex:  "fr" => "nl" => "en")
+      # cf. https://github.com/translation/rails/issues/48
+      fallback_locales = I18n.fallbacks[I18n.locale].collect { |l| l.to_s.gsub('-', '_').to_sym }
+
+      Locale.set_current(*fallback_locales)
     end
   end
 end
 
-if defined?(GetText)
+I18n::Config.prepend I18nConfigExtension
+
+###
+# Monkey-Patch GetText to :
+#  * Ignore GetText warnings
+#  * Don't stop code parsing if a file is badly formatted + message
+###
+if defined? GetText
   module GetText
     class POParser < Racc::Parser
       def initialize

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translation
 version: !ruby/object:Gem::Version
-  version: '1.32'
+  version: '1.34'
 platform: ruby
 authors:
 - Michael Hoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gettext