translation 1.23 → 1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0046f449c37be1ceabd2d200b2cd017e5434e483c2accf142abd28ce13fabdab
-  data.tar.gz: 7389645271366da1d14069303e473305138a055e952d100fea1f75198abaf1c6
+  metadata.gz: 8082495585677aa8e3ca187a4c4a443d3064e479010b4f7519d2ae7318ae5f66
+  data.tar.gz: 5e0f671d44c5aaa4436b4cff506444886a3f817f670f99eabb97b8a7534b7a5f
 SHA512:
-  metadata.gz: bab9f0e545e1278a80ebaa8394d32529b0939f482c352b5aa2c6d82ffdc9362d73dcd36fdb5c1b42022179ad10a75e69b5f7b7018eb8e107f0a1169a74fa6816
-  data.tar.gz: 7e2f84421230950705eaaff50248b9a23178a1d1095e1da1ee202b2c6a7d23a68cbdd4c173bb4512d7fff6ab2c7bf5386326843a90ea790fa4d8e3fdb0c41dc3
+  metadata.gz: 1407033d3f2b08b6429d4bbc10ce6997f2b7f72a8a24832a4b58cb018817a983059b3871cdd91d37fcaf44f9fc7127699ec4920108ac7944bce41e8a3355c62c
+  data.tar.gz: 71c9607dc017aeb3d3843eb462138c372636a752033216ae4211008ba013272e44f84c388ddae8dbbfb24d5679f87124d404e0b09b98262f4645fe3c9bb23b3d

data/README.md

@@ -1,7 +1,7 @@
 # [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.org/translation/rails.svg?branch=master)](https://travis-ci.org/translation/rails)
+[![Build Status](https://travis-ci.com/translation/rails.svg?branch=master)](https://travis-ci.com/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)
@@ -39,6 +39,7 @@ Table of contents
  * [Change the current locale](#change-the-current-locale)
    * [Globally](#globally)
    * [Locally](#locally)
+ * [Frontend Localization](#frontend-localization)
  * [Continuous Integration](#continuous-integration)
  * [Advanced Configuration Options](#advanced-configuration-options)
    * [Disable GetText or YAML](#disable-gettext-or-yaml)
@@ -215,7 +216,7 @@ Its structure should be like:
 "#{existing_language_code}-#{custom_text}"
 ```
 
-where `custom_text` can only contain alphanumeric characters and `-`.
+where `custom_text` can only contain alphabetic characters and `-`.
 
 Examples: `en-microsoft` or `fr-BE-custom`.
 
@@ -267,7 +268,8 @@ 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.
 
-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
 
@@ -283,17 +285,73 @@ 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
+
+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`).
+
 ## 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
 

data/lib/translation.rb

@@ -33,7 +33,6 @@ 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?
@@ -71,12 +70,6 @@ module TranslationIO
       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')
-    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}" }

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.rb

@@ -19,6 +19,8 @@ module TranslationIO
         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.rb

@@ -22,6 +22,8 @@ module TranslationIO
         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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translation
 version: !ruby/object:Gem::Version
-  version: '1.23'
+  version: '1.24'
 platform: ruby
 authors:
 - Michael Hoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-17 00:00:00.000000000 Z
+date: 2021-06-15 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.3.7
   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.3.7
 - !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