translation 1.14 → 1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23364df129fca187e3e946e7e9630262c688095d
-  data.tar.gz: 879857716430eac90526ba693bbcb5a2610a8959
+  metadata.gz: 934c23560bd3bdc6415760fc3ba9d73b277ab308
+  data.tar.gz: 4b0877a129c080dcd85e2c2941590733280e59b5
 SHA512:
-  metadata.gz: 47bebb33125a5f88741b3e073968fa457ac94ebfe6780e38949b97cd64ad455cdc7df103fe7e95b74b5c9a934180d6b8ee2161f797f95c321fcedd223c53affc
-  data.tar.gz: 4d17d4bca46162e0835129a293c9e80f69fa9df5239ca5b56dcb3b06a8de9ae479c3df9085599c4b2f5a9a56dd2deb8eb3bc421d9e96d32069ff6cc1b318ebe7
+  metadata.gz: bd902636f402c04540bff588f873ecdb64ca3de86a97031cff66c659a9e30039104dc37e5153b8655495678bbf6c9be2d810497f97f892ea46c46d996d13e246
+  data.tar.gz: 7ce437178c97a21e5d75377e76078ec1619db2c0771afa3a4ff3dd17bcd043e1cfa1e47ef0f1feafaa3dc59ec34fe111da403d7888dd75574fc5afa703741b1c

data/README.md

@@ -1,15 +1,22 @@
 # [Translation.io](https://translation.io) client for Ruby on Rails
 
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
-[![Codeship Status](https://app.codeship.com/projects/f7cd4ac0-b73c-0131-51ea-522dcd2196ed/status?branch=master)](https://app.codeship.com/projects/20528)
-[![Test Coverage](https://codeclimate.com/github/aurels/translation-gem/badges/coverage.svg)](https://codeclimate.com/github/aurels/translation-gem/coverage)
+[![Build Status](https://img.shields.io/travis/translation/rails/master.svg?style=flat-square)](https://travis-ci.org/translation/rails)
+[![Test Coverage](https://codeclimate.com/github/translation/rails/badges/coverage.svg)](https://codeclimate.com/github/translation/rails/coverage)
+[![Gem Version](https://badge.fury.io/rb/translation.svg)](https://badge.fury.io/rb/translation)
+[![Downloads](https://img.shields.io/gem/dt/translation.svg)](https://rubygems.org/gems/translation)
 
-Add this gem to translate your application with [I18n (YAML)](#i18n-yaml) or
-[GetText](#gettext) syntaxes.
+Add this gem to localize your Ruby on Rails application.
 
-Keep it synchronized with your translators on [Translation.io](https://translation.io).
+Use the official Rails syntax (with [YAML](#i18n-yaml) files) or use the [GetText](#gettext) syntax.
 
-[![Image](https://translation.io/interface.png)](https://translation.io)
+Write only the source text, and keep it synchronized with your translators on [Translation.io](https://translation.io).
+
+<a href="https://translation.io">
+  <img width="720px" alt="Translation.io interface" src="https://translation.io/gifs/translation.gif">
+</a>
+
+[Technical Demo](https://translation.io/videos/rails.mp4) (2.5min)
 
 Need help? [contact@translation.io](mailto:contact@translation.io)
 
@@ -24,6 +31,13 @@ Table of contents
    * [Sync](#sync)
    * [Sync and Show Purgeable](#sync-and-show-purgeable)
    * [Sync and Purge](#sync-and-purge)
+ * [Manage Languages](#manage-languages)
+   * [Add or Remove Language](#add-or-remove-language)
+   * [Edit Language](#edit-language)
+   * [Custom Languages](#custom-languages)
+ * [Change the current locale](#change-the-current-locale)
+   * [Globally](#globally)
+   * [Locally](#locally)
  * [Advanced Configuration Options](#advanced-configuration-options)
    * [Disable GetText](#disable-gettext)
    * [Ignored YAML keys](#ignored-yaml-keys)
@@ -31,17 +45,18 @@ Table of contents
    * [Custom localization key prefixes](#custom-localization-key-prefixes)
    * [Paths where locales are stored (not recommended)](#paths-where-locales-are-stored-not-recommended)
  * [Pure Ruby (without Rails)](#pure-ruby-without-rails)
+ * [Testing](#testing)
+ * [Contributing](#contributing)
  * [List of clients for Translation.io](#list-of-clients-for-translationio)
    * [Ruby on Rails (Ruby)](#ruby-on-rails-ruby)
    * [Laravel (PHP)](#laravel-php)
    * [React and React-Intl (JavaScript)](#react-and-react-intl-javascript)
- * [Testing](#testing)
- * [Contributing](#contributing)
- * [Credits](#credits)
+   * [Others](#others)
+ * [License](#license)
 
 ## Translation syntaxes
 
-#### I18n (YAML)
+### I18n (YAML)
 
 The default [Rails Internationalization API](http://guides.rubyonrails.org/i18n.html).
 
@@ -71,10 +86,13 @@ en:
 
 You can keep your source YAML file automatically updated using [i18n-tasks](https://github.com/glebm/i18n-tasks).
 
-#### GetText
+### GetText
 
 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 applications since it allows a simpler and more maintainable syntax.
+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
+automatically scanned for any string to translate.
 
 ```ruby
 # Regular
@@ -93,9 +111,6 @@ np_("context", "Singular text", "Plural text", number)
 _('%{city1} is bigger than %{city2}') % { city1: "NYC", city2: "BXL" }
 ```
 
-You don't need another file with source text or translations, everything will
-be synchronized from Translation.io, and stored on PO/MO files.
-
 More information about GetText syntax [here](https://github.com/ruby-gettext/gettext#usage).
 
 ## Installation
@@ -130,7 +145,7 @@ If you later need to add/remove target languages, please read our
 
 ## Usage
 
-#### Sync
+### Sync
 
 To send new translatable keys/strings and get new translations from Translation.io, simply run:
 
@@ -138,7 +153,7 @@ To send new translatable keys/strings and get new translations from Translation.
 $ bundle exec rake translation:sync
 ```
 
-#### Sync and Show Purgeable
+### 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:
 
@@ -148,7 +163,7 @@ $ bundle exec rake translation:sync_and_show_purgeable
 
 As the name says, this operation will also perform a sync at the same time.
 
-#### Sync and Purge
+### Sync and Purge
 
 If you need to remove unused keys/strings from Translation.io, using the current branch as reference:
 
@@ -160,13 +175,100 @@ 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**.
 
+## Manage Languages
+
+### Add or Remove Language
+
+You can add or remove a language by updating `config.target_locales = []` in your
+`config/initializers/translation.rb` file, and executing `rake translation:sync`.
+
+If you want to add a new language with existing translations (ex. if you already have
+a translated YAML file in your project), you will need to create a new project on
+Translation.io and run `rake translation:init` for them to appear.
+
+### Edit Language
+
+To edit existing languages while keeping their translations (e.g. changing from `en` to `en-US`).
+
+ 1. Create a new project on Translation.io with the correct languages.
+ 2. Adapt `config/initializers/translation.rb` (new API key and languages)
+ 3. Adapt language names and root keys of the YAML files in your project (optional: adapt GetText directories and `.po` headers)
+ 4. Execute `rake translation:init` and check that everything went fine.
+ 5. Invite your collaborators in the new project.
+ 6. Remove the old project.
+
+Since you created a new project, the translation history and tags will unfortunately be lost.
+
+### 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.
+
+The structure of a custom language is : existing language code + "-" + custom text.
+
+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.
+
+Note that fallback are chained, so `fr-be-custom` will fallback to `fr-be` that will
+itself fallback to `fr`.
+
+Using GetText syntax, it will only fallback to the source language. So either you
+create a fallback mechanism by yourself or you avoid fallbacking
+by translating everything in Translation.io for that custom language.
+
+## Change the current locale
+
+### Globally
+
+The easiest way to change the current locale is with `set_locale`.
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :set_locale
+
+  [...]
+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.
+
+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
+  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.
+
+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
+
+### Locally
+
+This command will change the locale for both [I18n (YAML)](#i18n-yaml) and [GetText](#gettext):
+
+```ruby
+I18n.locale = 'fr'
+```
+
+You can call it several times in the same page if you want to switch between languages.
+
+More examples here: https://translation.io/blog/rails-i18n-with-locale
+
 ## Advanced Configuration Options
 
 The `TranslationIO.configure` block in `config/initializers/translation.rb` can take several optional configuration options.
 
-Some options are described below but for an exhaustive list, please refer to [config.rb](https://github.com/aurels/translation-gem/blob/master/lib/translation_io/config.rb).
+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
 
 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.
@@ -181,7 +283,7 @@ TranslationIO.configure do |config|
 end
 ```
 
-#### Ignored YAML keys
+### Ignored YAML keys
 
 Sometimes you would like to ignore some YAML keys coming from gems or so.
 You can use the `ignored_key_prefixes` for that.
@@ -205,7 +307,7 @@ TranslationIO.configure do |config|
 end
 ```
 
-#### Source file formats (for GetText)
+### Source file formats (for GetText)
 
 If you are using GetText and you want to manage other file formats than:
 
@@ -225,7 +327,7 @@ TranslationIO.configure do |config|
 end
 ```
 
-#### Custom localization key prefixes
+### 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
@@ -251,7 +353,7 @@ TranslationIO.configure do |config|
 end
 ```
 
-#### Paths where locales are stored (not recommended)
+### Paths where locales are stored (not recommended)
 
 You can specify where your GetText and YAML files are on disk:
 
@@ -319,6 +421,18 @@ This gem was created specifically for Rails, but you can also use it in a pure R
 
 (Thanks [@kubaw](https://github.com/kubaw) for this snippet!)
 
+## Testing
+
+To run the specs:
+
+```bash
+$ bundle exec rspec
+```
+
+## Contributing
+
+Please read the [CONTRIBUTING](CONTRIBUTING.md) file.
+
 ## List of clients for Translation.io
 
 These implementations were usually started by contributors for their own projects.
@@ -327,20 +441,16 @@ and some are not yet supported. However, they are quite well documented.
 
 Thanks a lot to these contributors for their hard work!
 
-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.
-
-#### Ruby on Rails (Ruby)
+### Ruby on Rails (Ruby)
 
 Officially Supported on [https://translation.io/rails](https://translation.io/rails)
 
- * GitHub: https://github.com/aurels/translation-gem
+ * GitHub: https://github.com/translation/rails
  * RubyGems: https://rubygems.org/gems/translation/
 
 Credits: [@aurels](https://github.com/aurels), [@michaelhoste](https://github.com/michaelhoste)
 
-#### Laravel (PHP)
+### Laravel (PHP)
 
 Officially Supported on [https://translation.io/laravel](https://translation.io/laravel)
 
@@ -349,26 +459,20 @@ 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 and React-Intl (JavaScript)
 
  * GitHub: https://github.com/deecewan/translation-io
  * NPM: https://www.npmjs.com/package/translation-io
 
 Credits: [@deecewan](https://github.com/deecewan)
 
-## Testing
+### Others
 
-To run the specs:
-
-```bash
-$ bundle exec rspec
-```
-
-## Contributing
-
-Please read the [CONTRIBUTING](CONTRIBUTING.md) file.
+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.
 
-## Credits
+## License
 
 The [translation gem](https://rubygems.org/gems/translation) in released under MIT license by
 [Aurélien Malisart](http://aurelien.malisart.be) and [Michaël Hoste](https://80limit.com) (see [LICENSE](LICENSE) file).

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

@@ -77,7 +77,7 @@ module TranslationIO
 # You can edit and/or add new localization keys here, they won't be touched by Translation.io.
 #
 # If you want to add a new localization key prefix, use the option described here:
-# https://github.com/aurels/translation-gem#custom-localization-key-prefixes
+# https://github.com/translation/rails#custom-localization-key-prefixes
 #
 EOS
         end

data/lib/translation_io/flat_hash.rb

@@ -33,7 +33,7 @@ module TranslationIO
             key_string = '[' + key_string
           end
 
-          while key_string != ''
+          while key_string != '' && !current_object.is_a?(String) && !current_object.nil?
             # Next is array
             if key_string[0] == '['
               array_pos = key_string.split(']', 2)[0]
@@ -54,7 +54,7 @@ module TranslationIO
                 current_object[array_pos] = value if current_object.is_a?(Array)
               end
             # next is hash
-            elsif key_string[0] != '[' && (key_string.include?('.') or key_string.include?('['))
+            elsif key_string[0] != '[' && (key_string.include?('.') || key_string.include?('['))
               splitted   = key_string.split(/\.|\[/, 2)
               new_key    = splitted[0]
               key_string = splitted[1]
@@ -86,7 +86,10 @@ module TranslationIO
       end
 
       def no_key?(array_or_hash, key)
-        (array_or_hash.is_a?(Hash) && !array_or_hash.has_key?(key)) || !array_or_hash[key]
+        is_a_hash_without_key   = array_or_hash.is_a?(Hash)  && (!array_or_hash.has_key?(key) || array_or_hash[key] == nil)
+        is_an_array_without_key = array_or_hash.is_a?(Array) && array_or_hash[key] == nil
+
+        is_a_hash_without_key || is_an_array_without_key
       end
 
       def get_flat_hash_for_level(value, parent_key = nil)

metadata

@@ -1,20 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: translation
 version: !ruby/object:Gem::Version
-  version: '1.14'
+  version: '1.15'
 platform: ruby
 authors:
-- Aurelien Malisart
 - Michael Hoste
+- Aurelien Malisart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gettext
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.5
@@ -22,6 +25,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.5
@@ -29,72 +35,58 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '4.1'
 description: Localize your app using either t(".keys") or _("source text") and type
   "rake translation:sync" to synchronize with your translators on Translation.io.
 email: contact@translation.io
@@ -130,7 +122,12 @@ files:
 homepage: https://translation.io
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/translation/rails/issues
+  changelog_uri: https://github.com/translation/rails/blob/master/CHANGELOG.md
+  documentation_uri: https://translation.io/usage
+  homepage_uri: https://translation.io
+  source_code_uri: https://github.com/translation/rails
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -147,8 +144,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Rails translation made _("simple") with YAML and GetText using Translation.io.
+summary: Localize your app with YAML or GetText. Synchronize with your translators
+  on Translation.io.
 test_files: []
+has_rdoc: false