rails-i18n 0.1.0 → 5.1.3

data/README.md

@@ -1,99 +1,144 @@
 Rails Locale Data Repository
 ============================
 
-Central point to collect locale data for use in Ruby on Rails.
+[![Gem Version](https://badge.fury.io/rb/rails-i18n.svg)](http://badge.fury.io/rb/rails-i18n)
+[![Build Status](https://secure.travis-ci.org/svenfuchs/rails-i18n.png)](http://travis-ci.org/svenfuchs/rails-i18n)
 
-## Gem installation
+Centralization of locale data collection for Ruby on Rails.
 
-Add to your Gemfile:
+## Gem Installation
 
-    gem 'rails-i18n'
+Include the gem to your Gemfile:
 
-or run this command:
+    gem 'rails-i18n', '~> 5.1' # For 5.0.x, 5.1.x and 5.2.x
+    gem 'rails-i18n', '~> 4.0' # For 4.0.x
+    gem 'rails-i18n', '~> 3.0' # For 3.x
+    gem 'rails-i18n', github: 'svenfuchs/rails-i18n', branch: 'master' # For 5.x
+    gem 'rails-i18n', github: 'svenfuchs/rails-i18n', branch: 'rails-4-x' # For 4.x
+    gem 'rails-i18n', github: 'svenfuchs/rails-i18n', branch: 'rails-3-x' # For 3.x
 
-    gem install rails-i18n
+Alternatively, execute the following command:
 
+    gem install rails-i18n -v '~> 5.1' # For  For 5.0.x, 5.1.x and 5.2.x
+    gem install rails-i18n -v '~> 4.0' # For 4.0.x
+    gem install rails-i18n -v '~> 3.0' # For 3.x
 
-## Manual installation
+Note that your Ruby on Rails version must be 3.0 or higher in order to install the `rails-i18n` gem. For rails 2.x, install it manually as described in the Manual Installation section below.
 
-Download the locale files that are found in the directory [rails/locale](http://github.com/svenfuchs/rails-i18n/tree/master/rails/locale/) and put them into the `config/locales` directory of your Rails application.
+## Configuration
+
+`rails-i18n` gem initially loads all available locale files, pluralization and transliteration rules. This default behaviour can be changed. If you specify in `config/environments/*` the locales which have to be loaded via `I18n.available_locales` option:
+
+    config.i18n.available_locales = ['es-CO', :de]
+
+or
+
+    config.i18n.available_locales = :nl
+
+## Manual Installation
+
+Download desired locale files found in [rails/locale](http://github.com/svenfuchs/rails-i18n/tree/master/rails/locale/) directory and move them into the `config/locales` directory of your Rails application.
 
 If any translation doesn't suit well to the requirements of your application, edit them or add your own locale files.
 
 For more information, visit [Rails Internationalization (I18n) API](http://guides.rubyonrails.org/i18n.html) on the _RailsGuides._
 
-Available locales are:
+## Usage on Rails 2.3
 
-> ar, bg, bn-IN, bs, ca, cs, cy, da, de, de-AT, de-CH, dsb, el, en-AU, en-GB, en-US, eo, es,
-> es-AR, es-CL, es-CO, es-MX, es-PE, et, eu, fa, fi, fr, fr-CA, fr-CH, fur, gl-ES,
-> gsw-CH, he, hi-IN, hr, hsb, hu, id, is, it, ja, kn, ko, lo, lt, lv, mk, mn, nb,
-> nl, nn, pl, pt-BR, pt-PT, rm, ro, ru, sk, sl, sr, sr-Latn, sv-SE, sw, th,
-> tr, uk, vi, zh-CN, zh-TW
+Locale data whose structure is compatible with Rails 2.3 are available on the separate branch [rails-2-3](https://github.com/svenfuchs/rails-i18n/tree/rails-2-3).
 
-Note that all locale files are not yet ready for Rails 3. Currently, following locales are ready for Rails 2 and 3:
+## Available Locales
 
-> ar, ca, cs, cy, da, de, en-AU, en-GB, en-US, eo, es, es-AR, es-CL, es-CO, es-MX, et, eu, fa, fi, fr, fr-CA, fr-CH, gsw-CH, he, hi, hi-IN, hu, is, it, ja, kn, ko, lv, nb, nl, pl, pt-BR, pt-PT, ro, ru, sk, sv-SE, sw, th, uk, zh-CN, zh-TW
+Available locales:
 
-Not-yet-ready locales are:
+> af, ar, az, be, bg, bn, bs, ca, cs, cy, da, de, de-AT, de-CH, de-DE, el, el-CY,
+> en, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-US, en-ZA, en-CY,eo, es,
+> es-419, es-AR, es-CL, es-CO, es-CR, es-EC, es-ES, es-MX, es-NI, es-PA, es-PE, es-US, es-VE,
+> et, eu, fa, fi, fr, fr-CA, fr-CH, fr-FR, gl, he, hi, hi-IN, hr, hu, id, is, it,
+> it-CH, ja, ka, km, kn, ko, lb, lo, lt, lv, mk, ml, mn, mr-IN, ms, nb, ne, nl, nn, oc, or,
+> pa, pl, pt, pt-BR, rm, ro, ru, sk, sl, sq, sr, sw, ta, te, th, tl, tr, tt, ug,
+> ur, uz, vi, wo, zh-CN, zh-HK, zh-TW, zh-YUE
 
-> bg, bn-IN, bs, de-AT, de-CH, dsb, el, es-PE, fur, gl-ES, hr, hsb, id, lo, lt, mk, mn, nn, rm, sl, sr, sr-Latn, tr, vi
+Complete locales:
+
+> af, da, de, de-AT, de-CH, de-DE, en-US, es, es-419, es-AR, es-CL, es-CO, es-CR, es-EC,
+> es-ES, es-MX, es-NI, es-PA, es-PE, es-US, es-VE, et, fa, fr, fr-CA, fr-CH, fr-FR, id, ja, ka, ml, nb,
+> nl, nn, pt-BR, sv, sv-SE, tr, zh-CN, zh-HK, zh-TW, zh-YUE, uk
+
+Currently, most locales are incomplete. Typically they lack the following keys:
+
+- `activerecord.errors.messages.record_invalid`
+- `activerecord.errors.messages.restrict_dependent_destroy.has_one`
+- `activerecord.errors.messages.restrict_dependent_destroy.has_many`
+- `errors.messages.model_invalid`
+- `errors.messages.required`
 
 We always welcome your contributions!
 
-## How to contribute
+## Currency Symbols
+
+Some locales have the symbol of the currency (e.g. `€`) under the key `number.currency.format.unit`,
+while others have the code (e.g. `CHF`). The value of the key depends on the widespread adoption of
+the unicode currency symbols by fonts.
+
+For example the Turkish Lira sign (`₺`) was recently added in Unicode 6.2 and while most popular
+fonts have a glyph, there are still many fonts that will not render the character correctly.
 
-### Quick contribution
+If you want to provide a different value, you can create a custom locale file under
+`config/locales/tr.yml` and override the respective key:
 
-If you are familiar with GitHub operations, follow the procedures described in the subsequent sections.
+```YAML
+tr:
+  number:
+    currency:
+      format:
+        unit: TL
+```
 
-If you are not,
+## How to Contribute
+
+### Quick Contribution
+
+If you are familiar with GitHub operations, then follow the procedures described in the subsequent sections.
+
+If not,
 
 * Save your locale data on the [Gist](http://gist.github.com).
 * Open an issue with reference to the Gist you created.
 
-### Fetch the `rails-18n` repository
+### Fetching the `rails-i18n` Repository
 
 * Get a github account and Git program if you haven't. See [Help.Github](http://help.github.com/) for instructions.
 * Fork `svenfuchs/rails-i18n` repository and clone it into your PC.
 
-### Create or edit your locale file
+### Creating or Editing your Locale File
 
-* Have a look in `rails/locale/en-US.yml`, which can be used as the base of your translation.
-  This file is a compound of all translation files in the Rails 2 and 3 packages.
-  Note that we use `&errors_messages` and `<<: *errors_messages` to anchor and merge a part of translation data.
+* Have a look in `rails/locale/en.yml`, which should be used as the base of your translation.
 * Create or edit your locale file.
-  Please include a comment with the language/locale name and your name and email address (or other contact information like your github profile) to the locale file so people can come contact you and ask questions etc.
-  Also, please pay attention to save your files as UTF-8.
-
-### Test your locale file
-
-Before commit and push your changes, test the integrity of your locale file.
-
-Make sure you have the <code>i18n</code> and <code>thor</code> installed. If you haven't, install them:
+  Please pay attention to save your files as UTF-8.
 
-    sudo gem install i18n thor
+### Testing your Locale File
 
-You can test your locale by running following command on the root directory of this repository:
+Before committing and pushing your changes, test the integrity of your locale file.
 
-    thor locales:test [your-locale]
+    bundle exec rake spec
 
-Assuming that there is a file <code>rails/locale/[your-locale].{rb,yml}</code> you will get a list of keys missing from your locale data.
+Make sure you have included all translations with:
 
-Invoke following command to test all locale files:
+    bundle exec rake i18n-spec:completeness rails/locale/en.yml rails/locale/YOUR_NEW_LOCALE.yml
 
-    thor locales:test_all
+You can list all complete and incomplete locales:
 
-You can list all locales that are ready both for Rails version 2 and 3:
+    thor locales:complete
+    thor locales:incomplete
 
-    thor locales:ready
+Also, you can list all available locales:
 
-You can also list the locales ready for a specific version of Rails. For example:
-
-    thor locales:ready_for 3
+    thor locales:list
 
-Lastly, you can list all available locales:
+You can list all missing keys:
 
-    thor locales:list
+    i18n-tasks missing es
 
 ### Edit README.md
 
@@ -105,6 +150,17 @@ If you are ready, push the repository into the Github and send us a pull request
 
 We will do the formality check and publish it as quick as we can.
 
+## See also
+
+* [devise-i18n](https://github.com/tigrish/devise-i18n)
+* [will-paginate-i18n](https://github.com/tigrish/will-paginate-i18n)
+* [kaminari-i18n](https://github.com/tigrish/kaminari-i18n)
+* [i18n-country-translation](https://github.com/onomojo/i18n-country-translations) for translations of country names
+* [i18n-timezones](https://github.com/onomojo/i18n-timezones) for translations of Rails time zones
+* [i18n-spec](https://github.com/tigrish/i18n-spec) for RSpec matchers to test your locale files
+* [iso](https://github.com/tigrish/iso) for the list of valid language/region codes and their translations
+* [i18n-tasks](https://github.com/glebm/i18n-tasks)
+
 ## License
 
 [MIT](https://github.com/svenfuchs/rails-i18n/blob/master/MIT-LICENSE.txt)

data/lib/rails-i18n.rb

@@ -1,4 +1 @@
-ActiveSupport.on_load(:i18n) do
-  I18n.load_path << Dir[File.join(File.expand_path(File.dirname(__FILE__) + '/../rails/locale'), '*.{rb,yml}')]
-  I18n.load_path.flatten!
-end
+require 'rails_i18n'

data/lib/rails_i18n.rb

@@ -0,0 +1,2 @@
+require 'rails_i18n/unicode'
+require 'rails_i18n/railtie'

data/lib/rails_i18n/common_pluralizations/east_slavic.rb

@@ -0,0 +1,42 @@
+# Originally was implemented by Yaroslav Markin in "russian" gem
+# (http://github.com/yaroslav/russian)
+#
+# Used for Belarusian, Bosnian, Croatian, Russian, Serbian, Serbo-Croatian, Ukrainian.
+
+module RailsI18n
+  module Pluralization
+    module EastSlavic
+
+      FROM_2_TO_4   = (2..4).to_a.freeze
+      FROM_5_TO_9   = (5..9).to_a.freeze
+      FROM_11_TO_14 = (11..14).to_a.freeze
+      FROM_12_TO_14 = (12..14).to_a.freeze
+
+      def self.rule
+        lambda do |n|
+          n ||= 0
+          mod10 = n % 10
+          mod100 = n % 100
+
+          if mod10 == 1 && mod100 != 11
+            :one
+          elsif FROM_2_TO_4.include?(mod10) && !FROM_12_TO_14.include?(mod100)
+            :few
+          elsif mod10 == 0 || FROM_5_TO_9.include?(mod10) || FROM_11_TO_14.include?(mod100)
+            :many
+          else
+            :other
+          end
+        end
+      end
+
+      def self.with_locale(locale)
+        { locale => {
+            :i18n => {
+              :plural => {
+                :keys => [:one, :few, :many, :other],
+                :rule => rule }}}}
+      end
+    end
+  end
+end

data/lib/rails_i18n/common_pluralizations/one_other.rb

@@ -0,0 +1,19 @@
+# Used as "default" pluralization rule
+
+module RailsI18n
+  module Pluralization
+    module OneOther
+      def self.rule
+        lambda { |n| n == 1 ? :one : :other }
+      end
+
+      def self.with_locale(locale)
+        { locale => {
+            :'i18n' => {
+              :plural => {
+                :keys => [:one, :other],
+                :rule => rule }}}}
+      end
+    end
+  end
+end

data/lib/rails_i18n/common_pluralizations/one_two_other.rb

@@ -0,0 +1,28 @@
+# Used for Cornish, Inari Sami, Inuktitut, Lule Sami, Nama, Northern Sami,
+# Sami Language, Skolt Sami, Southern Sami.
+
+module RailsI18n
+  module Pluralization
+    module OneTwoOther
+      def self.rule
+        lambda do |n|
+          if n == 1
+            :one
+          elsif n == 2
+            :two
+          else
+            :other
+          end
+        end
+      end
+
+      def self.with_locale(locale)
+        { locale => {
+            :'i18n' => {
+              :plural => {
+                :keys => [:one, :two, :other],
+                :rule => rule }}}}
+      end
+    end
+  end
+end

data/lib/rails_i18n/common_pluralizations/one_upto_two_other.rb

@@ -0,0 +1,19 @@
+# Used for French, Fulah, Kabyle.
+
+module RailsI18n
+  module Pluralization
+    module OneUptoTwoOther
+      def self.rule
+        lambda { |n| n && n >= 0 && n < 2 ? :one : :other }
+      end
+
+      def self.with_locale(locale)
+        { locale => {
+            :'i18n' => {
+              :plural => {
+                :keys => [:one, :other],
+                :rule => rule }}}}
+      end
+    end
+  end
+end

data/lib/rails_i18n/common_pluralizations/one_with_zero_other.rb

@@ -0,0 +1,20 @@
+# Used in Akan, Amharic, Bihari, Filipino, guw, Hindi, Lingala, Malagasy,
+# Northen Sotho, Tachelhit, Tagalog, Tigrinya, Walloon.
+
+module RailsI18n
+  module Pluralization
+    module OneWithZeroOther
+      def self.rule
+        lambda { |n| n == 0 || n == 1 ? :one : :other }
+      end
+
+      def self.with_locale(locale)
+        { locale => {
+            :'i18n' => {
+              :plural => {
+                :keys => [:one, :other],
+                :rule => rule }}}}
+      end
+    end
+  end
+end

data/lib/rails_i18n/common_pluralizations/other.rb

@@ -0,0 +1,17 @@
+module RailsI18n
+  module Pluralization
+    module Other
+      def self.rule
+        Proc.new { :other }
+      end
+
+      def self.with_locale(locale)
+        { locale => {
+            :'i18n' => {
+              :plural => {
+                :keys => [:other],
+                :rule => rule }}}}
+      end
+    end
+  end
+end

data/lib/rails_i18n/common_pluralizations/romanian.rb

@@ -0,0 +1,28 @@
+# Used for Moldavian, Romanian.
+
+module RailsI18n
+  module Pluralization
+    module Romanian
+      def self.rule
+        lambda do |n|
+          n ||= 0
+          if n == 1
+            :one
+          elsif n == 0 || (1..19).to_a.include?(n % 100)
+            :few
+          else
+            :other
+          end
+        end
+      end
+
+      def self.with_locale(locale)
+        { locale => {
+            :'i18n' => {
+              :plural => {
+                :keys => [:one, :few, :other],
+                :rule => rule }}}}
+      end
+    end
+  end
+end

data/lib/rails_i18n/common_pluralizations/west_slavic.rb

@@ -0,0 +1,27 @@
+# Used for Czech, Slovak.
+
+module RailsI18n
+  module Pluralization
+    module WestSlavic
+      def self.rule
+        lambda do |n|
+          if n == 1
+            :one
+          elsif [2, 3, 4].include?(n)
+            :few
+          else
+            :other
+          end
+        end
+      end
+
+      def self.with_locale(locale)
+        { locale => {
+            :'i18n' => {
+              :plural => {
+                :keys => [:one, :few, :other],
+                :rule => rule }}}}
+      end
+    end
+  end
+end

data/lib/rails_i18n/railtie.rb

@@ -0,0 +1,33 @@
+require 'rails'
+
+module RailsI18n
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'rails-i18n' do |app|
+      RailsI18n::Railtie.instance_eval do
+        pattern = pattern_from app.config.i18n.available_locales
+
+        add("rails/locale/#{pattern}.yml")
+        add("rails/pluralization/#{pattern}.rb")
+        add("rails/transliteration/#{pattern}.{rb,yml}")
+
+        init_pluralization_module
+      end
+    end
+
+    protected
+
+    def self.add(pattern)
+      files = Dir[File.join(File.dirname(__FILE__), '../..', pattern)]
+      I18n.load_path.concat(files)
+    end
+
+    def self.pattern_from(args)
+      array = Array(args || [])
+      array.blank? ? '*' : "{#{array.join ','}}"
+    end
+
+    def self.init_pluralization_module
+      I18n.backend.class.send(:include, I18n::Backend::Pluralization)
+    end
+  end
+end