l10n 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 866b98e1c6683bc7ec991e01d7d2d1ee67311906
-  data.tar.gz: 3c5bb6f5e84a1d83839e35d470c9482fb764c9bb
+  metadata.gz: d7f3cc16fbc921b6681758f6c4ff7f3d2f783052
+  data.tar.gz: 617e2a3795ac781d6ba43c0d66288aa2f872afb8
 SHA512:
-  metadata.gz: 3b955a86b74e926412306b7e03b7e81c93a781a7f866c0c92de4b1b46d005158e7b8700c572cc9b449fb49345f7dac135c20c2c3e0f44370de257e6a8ee8cbdb
-  data.tar.gz: 71f8806d4025bfb63697d44a0e1b76cd8da2a9fccc2b61378135eb9d512a5cef886d7f13b6564e31307dde6958128009258679b71fc0671935c43d8ce780d8b2
+  metadata.gz: 701003456bee2225f62ac1951c5a2432303ec43b671f6fdf1f00fbab1b97783b84eff05ef0d9f21faf3892a8e867562b5c63e64bbe326a5c95b6bad9361dbe70
+  data.tar.gz: c19dc9321a710cc84dd2f0a5b087b8995c995e01aabb703d13fe9381431a68a2644eea6c64c144f97ba2c96e89de4453fb601fd972d3ef28cfc62b96febe2149

data/README.md

@@ -1,5 +1,7 @@
 # L10n - I18n that roarrrs
 
+L10n provides some useful extensions for Rails I18n, including column translations, localization of numeric form fields and JavaScript translation support.
+
 ## Installation
 
 ```ruby
@@ -9,20 +11,20 @@ gem 'l10n'
 
 ## Setting up your app
 
-In your <language>.yml, make sure to have definitions for 
+In your `<locale>.yml`, make sure to have definitions for 
 
+```yaml
 number:
   precision:
     format:
-      separator: ","
       delimiter: "."
-      precision: 2
-      
-As there is currently a bug in Rails: https://github.com/rails/rails/issues/4420
+```
 
 ## Features
 
-### ActiveRecord column translations
+### Active Record attribute translations
+
+Translated attributes provide an `<attr>_t` suffix, which maps to the column determined by the current locale. There is no whatsoever "magic" remapping of actual attributes. The `<attr>_t` accessor is used exclusively for mapping to the column referred to by the current locale.
 
 ```ruby
 class Fruit < ActiveRecord::Base
@@ -40,8 +42,23 @@ I18n.as(:fr) { apple.name_t } => "Pomme"
 apple.name_translations => { en: "Apple", de: "Apfel", fr: "Pomme" }
 ```
 
-Translated columns also support validation:
+The `<attr>_t` and `<attr>_translations` setters map to the current locale:
+```ruby
+pear = Fruit.new
+pear.name_translations = { en: 'Pear', de: 'Birne', fr: 'Poire' }
 
+I18n.locale = :fr
+pear.name => "Pear"
+pear.name_t => "Poire"
+
+I18n.locale = :en
+pear.name => "Pear"
+pear.name_t => "Pear"
+pear.name_t = 'Williams Christ'
+pear.name => "Williams Christ"
+```
+
+Translated columns also support validation:
 ```ruby
 class Fruit < ActiveRecord::Base
   translates :name
@@ -55,6 +72,8 @@ end
 
 #### String and Symbol
 
+Strings and symbols provide a `translate` method, aliased as `t` which maps to `I18n.t`.
+
 ```yaml
 # de.yml
 de:
@@ -76,19 +95,21 @@ I18n.locale = :de
 'hello'.t(name: 'Otto') => "Hallo Otto!"
 ```
 
-This also works with symbols.
-
 #### Formatting of numbers
 
+Calling `to_formatted_s` on `Numeric`s returns the number as a formatted string. The format is defined by the current locale and respects the decimal delimiters and separators defined in your `<locale>.yml`.
+
 ```ruby
 I18n.as('de') { 1234.5.to_formatted_s } => "1.234,50"
 I18n.as('en') { 1234.5.to_formatted_s } => "1,234.50"
 ```
 
-This also works with instances of BigDecimal.
+This also works with `BigDecimal`s.
 
 #### Localization of decimal separator and delimiter for numbers
 
+Localization converts decimal separators and delimiters between locales without re-formatting strings. `to_localized_s` can be called on any object.
+
 ```ruby
 I18n.as('de') { 1234.5.to_localized_s } => "1.234,5"
 I18n.as('en') { 1234.5.to_localized_s } => "1,234.5"
@@ -103,10 +124,12 @@ I18n.as(:en) { Numeric.localize('1,234.50') } => "1,234.50"
 
 ### Automatic localization of numeric values in Rails forms and models
 
+The `amount_field` form helper automatically formats numbers in the current locale. Numeric columns automatically convert the localized strings into numbers, respecting decimal delimiters and separators.
+
 ```ruby
 # in your template
 <%= form_for @car do |f| %>
-  <% f.amount_field :price, precision: 2 %>
+  <%= f.amount_field :price, precision: 2 %>
 <% end %>
 
 # in your controller, or elsewhere
@@ -121,7 +144,7 @@ I18n.locale = :en
 
 ### Accept-Language header parsing in ActionDispatch::Request
 
-The Accept-Language header will be parsed, and locales will be returned ordered by user preference.
+The `Accept-Language` HTTP header will be parsed, and locales will be returned ordered by user preference. This comes in handy when setting the current locale in a `before_action`.
 
 ```ruby
 # in your controller
@@ -130,6 +153,15 @@ request.accept_locales => ["en-US", "en", "en-GB"]
 
 ### Javascript I18n, interpolation and pluralization
 
+If you need I18n support in your javascripts, require the `i18n` javascript from your `application.js`:
+
+```javascript
+/* application.js */
+//= require i18n
+```
+
+The JS `String` prototype is extended with a `t()` function, supporting translation, pluralization and interpolation:
+
 ```yaml
 # en.yml
 en:
@@ -150,5 +182,5 @@ en:
 // in any javascript
 "hello".t({ name: "JS" }) => "Hello JS!"
 
-"apple".t({ count: 4 }) => "5 apples"
+"apple".t({ count: 5 }) => "5 apples"
 ```

data/lib/l10n/request.rb

@@ -7,11 +7,11 @@ module L10n
       preferred_locales = []
       for locale_group in locale_groups
         locale = locale_group.split(';')
-        language_code, params = locale[0].to_s.strip, locale[1]
+        language_code, params = locale[0].to_s.strip, locale[1].to_s.strip
         if /\A[A-z]{2}(-[A-z]{2})?\z/.match(language_code)
-          if params
+          if params.present?
             name, value = params.split('=')
-            q = (name == 'q' and value.to_f > 0 ? value.to_f : 1.0)
+            q = (name == 'q' && value.to_f > 0 ? value.to_f : 1.0)
           else
             q = 1.0
           end

data/lib/l10n/version.rb

@@ -1,3 +1,3 @@
 module L10n
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: l10n
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Matthias Grosser
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: I18n that roarrrs