translation 1.13 → 1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0996e9a0abfdaf72b371f4eec7d9a9e1bd75f8a
-  data.tar.gz: 3914c3b256f65f209647084328428a9e9fe66d10
+  metadata.gz: 23364df129fca187e3e946e7e9630262c688095d
+  data.tar.gz: 879857716430eac90526ba693bbcb5a2610a8959
 SHA512:
-  metadata.gz: 4b859ce80f4c38534ad1d0b1040c841a69573557f06c207a1419cd2dd93e64f15b1fb3777a566952533dd3e7f458a8c1b991a0d50d17f592d5e9956912d2931f
-  data.tar.gz: c5f40af5277977307397f7fa1364699f192301ca916eff27b8d4f89e6222df9e453717cce34476ebab41f66954ee9d72cf54c92fc240432ed7d3825e1ea126df
+  metadata.gz: 47bebb33125a5f88741b3e073968fa457ac94ebfe6780e38949b97cd64ad455cdc7df103fe7e95b74b5c9a934180d6b8ee2161f797f95c321fcedd223c53affc
+  data.tar.gz: 4d17d4bca46162e0835129a293c9e80f69fa9df5239ca5b56dcb3b06a8de9ae479c3df9085599c4b2f5a9a56dd2deb8eb3bc421d9e96d32069ff6cc1b318ebe7

data/README.md

@@ -1,21 +1,25 @@
-# Gem for [Translation.io](http://translation.io) [ ![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)
+# [Translation.io](https://translation.io) client for Ruby on Rails
 
-Add this gem to your [Rails](http://rubyonrails.org) application to localize it using
-[I18n (YAML)](#i18n-yaml) or [GetText](#gettext) syntaxes.
+[![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)
+
+Add this gem to translate your application with [I18n (YAML)](#i18n-yaml) or
+[GetText](#gettext) syntaxes.
 
 Keep it synchronized with your translators on [Translation.io](https://translation.io).
 
-[![Image](https://github.com/aurels/translation-gem/raw/master/interface.png)](https://translation.io)
+[![Image](https://translation.io/interface.png)](https://translation.io)
 
 Need help? [contact@translation.io](mailto:contact@translation.io)
 
 Table of contents
 =================
 
- * [Installation](#installation)
  * [Translation syntaxes](#translation-syntaxes)
    * [I18n (YAML)](#i18n-yaml)
    * [GetText](#gettext)
+ * [Installation](#installation)
  * [Usage](#usage)
    * [Sync](#sync)
    * [Sync and Show Purgeable](#sync-and-show-purgeable)
@@ -27,39 +31,14 @@ 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)
- * [Other implementations](#other-implementations)
-   * [React and React-Intl (JavaScript)](#react-and-react-intl-javascript)
+ * [List of clients for Translation.io](#list-of-clients-for-translationio)
+   * [Ruby on Rails (Ruby)](#ruby-on-rails-ruby)
    * [Laravel (PHP)](#laravel-php)
- * [Tests](#tests)
+   * [React and React-Intl (JavaScript)](#react-and-react-intl-javascript)
+ * [Testing](#testing)
  * [Contributing](#contributing)
  * [Credits](#credits)
 
-## Installation
-
- 1. Add the gem to your project's Gemfile:
-
-```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
-TranslationIO.configure do |config|
-  config.api_key        = 'abcdefghijklmnopqrstuvwxyz012345'
-  config.source_locale  = 'en'
-  config.target_locales = ['fr', 'nl', 'de', 'es']
-end
-```
-
- 4. Initialize your translation project with `bundle exec rake translation:init`
-
-If you later need to add/remove target languages, please read our
-[documentation](https://translation.io/blog/adding-target-languages) about that.
-
 ## Translation syntaxes
 
 #### I18n (YAML)
@@ -70,19 +49,19 @@ The default [Rails Internationalization API](http://guides.rubyonrails.org/i18n.
 # Regular
 t('inbox.title')
 
-# Plural management
+# Pluralization
 t('inbox.message', count: n)
 
 # Interpolation
 t('inbox.hello', name: @user.name)
 ```
 
-...with the source YAML file:
+With the source YAML file:
 
 ```yaml
 en:
   inbox:
-    title:   'text to be translated'
+    title:   'Title to be translated'
     message:
       zero:  'no messages'
       one:   'one message'
@@ -99,36 +78,73 @@ that you use GetText to translate your applications since it allows a simpler an
 
 ```ruby
 # Regular
-_("text to be translated")
+_("Text to be translated")
 
-# Plural management
-n_("singular text", "plural text", number)
+# Pluralization
+n_("Singular text", "Plural text", number)
 
 # Regular with context
-p_("context", "text to be translated")
+p_("context", "Text to be translated")
 
-# Plural management with context
-np_("context", "singular text", "plural text", number)
+# Pluralization with context
+np_("context", "Singular text", "Plural text", number)
 
 # Interpolations
 _('%{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
+
+ 1. Add the gem to your project's Gemfile:
+
+```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
+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
+$ bundle exec rake translation:init
+```
+
+If you later need to add/remove target languages, please read our
+[documentation](https://translation.io/blog/adding-target-languages) about that.
+
 ## Usage
 
 #### Sync
 
 To send new translatable keys/strings and get new translations from Translation.io, simply run:
 
-    bundle exec rake translation:sync
+```bash
+$ bundle exec rake translation:sync
+```
 
 #### Sync and Show Purgeable
 
-If you need to see what are the unused keys/strings from Translation.io, using the current branch as reference:
+If you need to find out what are the unused keys/strings from Translation.io, using the current branch as reference:
 
-    bundle exec rake translation:sync_and_show_purgeable
+```bash
+$ bundle exec rake translation:sync_and_show_purgeable
+```
 
 As the name says, this operation will also perform a sync at the same time.
 
@@ -136,7 +152,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:
 
-    bundle exec rake translation:sync_and_purge
+```bash
+$ bundle exec rake translation:sync_and_purge
+```
 
 As the name says, this operation will also perform a sync at the same time.
 
@@ -301,40 +319,58 @@ 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!)
 
-## Other implementations
+## List of clients for Translation.io
 
-These implementations are made by contributors for their own projects and are not
-*currently* supported by [Translation.io](https://translation.io). However, they are quite well documented.
+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.
 
 Thanks a lot to these contributors for their hard work!
 
-#### React and React-Intl (JavaScript)
+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.
 
- * GitHub: https://github.com/deecewan/translation-io
- * NPM: https://www.npmjs.com/package/translation-io
+#### Ruby on Rails (Ruby)
+
+Officially Supported on [https://translation.io/rails](https://translation.io/rails)
 
-Credit: [@deecewan](https://github.com/deecewan)
+ * GitHub: https://github.com/aurels/translation-gem
+ * RubyGems: https://rubygems.org/gems/translation/
+
+Credits: [@aurels](https://github.com/aurels), [@michaelhoste](https://github.com/michaelhoste)
 
 #### Laravel (PHP)
 
- * GitHub: https://github.com/armandsar/laravel-translationio
- * Packagist: https://packagist.org/packages/armandsar/laravel-translationio
+Officially Supported on [https://translation.io/laravel](https://translation.io/laravel)
+
+ * GitHub: https://github.com/translation/laravel
+ * Packagist: https://packagist.org/packages/tio/laravel
 
-Credit: [@armandsar](https://github.com/armandsar)
+Credits: [@armandsar](https://github.com/armandsar), [@michaelhoste](https://github.com/michaelhoste)
 
-## Tests
+#### 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
 
 To run the specs:
 
-    bundle exec rspec
+```bash
+$ bundle exec rspec
+```
 
 ## Contributing
 
-Please read the [CONTRIBUTING](https://github.com/aurels/translation-gem/blob/master/CONTRIBUTING.md) file.
+Please read the [CONTRIBUTING](CONTRIBUTING.md) file.
 
 ## Credits
 
 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](http://80limit.com) (see LICENSE file).
+[Aurélien Malisart](http://aurelien.malisart.be) and [Michaël Hoste](https://80limit.com) (see [LICENSE](LICENSE) file).
 
 (c) [https://translation.io](https://translation.io) / [contact@translation.io](mailto:contact@translation.io)

data/lib/translation_io/client/base_operation.rb

@@ -20,7 +20,8 @@ module TranslationIO
       def self.perform_request(uri, params)
         begin
           params.merge!({
-            'gem_version'        => TranslationIO.version,
+            'client'             => 'rails',
+            'version'            => TranslationIO.version,
             'source_language'    => TranslationIO.config.source_locale.to_s,
             'target_languages[]' => TranslationIO.config.target_locales.map(&:to_s)
           })

data/lib/translation_io/client/sync_operation.rb

@@ -65,7 +65,7 @@ module TranslationIO
             puts
             puts "----------"
             puts "#{yaml_size + gettext_size} keys/strings are in Translation.io but not in your current branch."
-            puts 'Execute "rake translation:sync_and_show_purgeable" to list these keys/strings'
+            puts 'Execute "rake translation:sync_and_show_purgeable" to list these keys/strings.'
           end
         # Complete summary for sync_and_show_purgeable or sync_and_purge
         else
@@ -108,7 +108,7 @@ module TranslationIO
           if show_purgeable && total_size > 0
             puts
             puts "----------"
-            puts "If you know what you are doing, you can remove them using \"rake translation:sync_and_purge\""
+            puts "If you know what you are doing, you can remove them using \"rake translation:sync_and_purge\"."
           end
         end
       end

data/lib/translation_io/tasks.rb

@@ -5,12 +5,12 @@ require 'gettext/tools'
 
 namespace :translation do
 
-  desc "Get configuration infos of Translation gem"
+  desc "Get configuration infos of Translation gem."
   task :config => :environment do
     puts TranslationIO.config
   end
 
-  desc "Initialize your Translation.io project"
+  desc "Initialize Translation.io with existing keys/strings."
   task :init => :environment do
     if client_ready?
       TranslationIO.client.init
@@ -24,14 +24,14 @@ namespace :translation do
     end
   end
 
-  desc "Sync and show unused keys/strings from Translation.io using the current branch as reference"
+  desc "Sync translations and find out the unused keys/string from Translation.io, using the current branch as reference."
   task :sync_and_show_purgeable => :environment do
     if client_ready?
       TranslationIO.client.sync_and_show_purgeable
     end
   end
 
-  desc "Sync and remove unused keys/strings from Translation.io using the current branch as reference"
+  desc "Sync translations and remove unused keys from Translation.io, using the current branch as reference."
   task :sync_and_purge => :environment do
     if client_ready?
       TranslationIO.client.sync_and_purge

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translation
 version: !ruby/object:Gem::Version
-  version: '1.13'
+  version: '1.14'
 platform: ruby
 authors:
 - Aurelien Malisart
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gettext
@@ -95,9 +95,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
-description: Rails translation made _("simple") with YAML and GetText. Localize your
-  app using either t(".keys") or _("free text") and type "rake translation:sync" to
-  synchronize with your translators.
+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
 executables: []
 extensions: []
@@ -151,5 +150,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Rails translation made _("simple") with YAML and GetText.
+summary: Rails translation made _("simple") with YAML and GetText using Translation.io.
 test_files: []