i18n 0.5.0 → 0.5.2

data/CHANGELOG.textile

@@ -1,14 +1,5 @@
 h1. Changelog
 
-h2. 0.5.0
-
-* "Extract Backend::ActiveRecord to a separate gem":https://github.com/svenfuchs/i18n/commit/197dacebad356b910d69fa69a719c2ad10cf49e6 (see "i18n-active_record":https://github.com/svenfuchs/i18n-active_record)
-* "Improve exception handling":https://github.com/svenfuchs/i18n/commit/2913ff9a7544f223f60e7d7b32c2a0e1af89812b (deprectates I18n.default_exception_handler)
-* "Change MissingTranslationData message to 'translation missing: foo.bar'":https://github.com/svenfuchs/i18n/commit/68fdfe47952325411afe5942e971ce10b2bdf900
-* "Expose MissingTranslationsData#keys method":https://github.com/svenfuchs/i18n/commit/3a37a389ecaac9670355b334e23e775549ee9822
-* "Improve Cascade#lookup (add default options)":https://github.com/svenfuchs/i18n/commit/0b9a1f2058a2be9543106cc19d08071c359511e1
-* "Finally remove deprecated interpolation syntax":https://github.com/svenfuchs/i18n/commit/2d43846d2b2a2e596f30fa58ea1c9ddb2243bb64
-
 h2. 0.4.2 (2010-10-26)
 
 * "Improve UTF8 handling":http://github.com/svenfuchs/i18n/commit/e8d5820a3b08eeca28de1a2b9c8a6ad2b9e6476c
@@ -53,7 +44,7 @@ h2. 0.3.6 (2010-03-23)
 
 h2. 0.3.5 (2010-02-26)
 
-* "Delegate I18n.normalize_translation_keys to I18n.normalize_keys and deprecate
+* "Delegate I18n.normalize_translation_keys to I18n.normalize_keys and deprecate 
 the former":http://github.com/svenfuchs/i18n/commit/7284b04d5f5dd9679cb68875515cdd0cdfc96fef
 
 h2. 0.3.4 (2010-02-25)
@@ -102,7 +93,7 @@ h2. 0.3.0 (2009-11-30)
 h2. 0.2.0 (2009-07-12)
 
 * "Allow using Ruby 1.9 syntax for string interpolation (API addition)":http://github.com/svenfuchs/i18n/commit/c6e0b06d512f2af57199a843a1d8a40241b32861
-* "Allow configuring the default scope separator, allow to pass a custom scope separator(API addition)":http://github.com/svenfuchs/i18n/commit/5b75bfbc348061adc11e3790187a187275bfd471 (e.g. I18n.t(:'foo|bar', :separator => '|')
+* "Allow configuring the default scope separator, allow to pass a custom scope separator(API addition)":http://github.com/svenfuchs/i18n/commit/5b75bfbc348061adc11e3790187a187275bfd471 (e.g. I18n.t(:'foo|bar', :separator => '|') 
 * "Pass :format option to #translate for #localize more useful lambda support":http://github.com/svenfuchs/i18n/commit/e277711b3c844fe7589b8d3f9af0f7d1b969a273
 * "Refactor Simple backend #resolve to #default and #resolve for more consistency. Now allows to pass lambdas as defaults and re-resolve Symbols":http://github.com/svenfuchs/i18n/commit/8c4ce3d923ce5fa73e973fe28217e18165549aba
 * "Add lambda support to #translate (API addition)":http://github.com/svenfuchs/i18n/commit/c90e62d8f7d3d5b78f34cfe328d871b58884f115
@@ -149,4 +140,4 @@ h2. More information
 * "Wiki":http://rails-i18n.org/wiki
 * "Mailinglist":http://groups.google.com/group/rails-i18n
 * "About the project/history":http://www.artweb-design.de/2008/7/18/finally-ruby-on-rails-gets-internationalized
-* "Initial API Intro":http://www.artweb-design.de/2008/7/18/the-ruby-on-rails-i18n-core-api
+* "Initial API Intro":http://www.artweb-design.de/2008/7/18/the-ruby-on-rails-i18n-core-api

data/README.textile

@@ -64,12 +64,25 @@ h2. Tests
 You can run tests both with
 
 * `rake test` or just `rake`
-* run any test file directly, e.g. `ruby -Ilib -Itest test/api/simple_test.rb`
-* run all tests with `ruby -Ilib -Itest test/all.rb`
+* run any test file directly, e.g. `ruby test/api/simple_test.rb`
+* run all tests with `ruby test/all.rb`
 
-You can run all tests against all Gemfiles with
+You can parametrize the test suite for using different sets of dependencies by
+using:
 
-* `ruby test/run_all.rb`
+.pre `ruby test/all.rb -w DEPENDENCIES`
+
+... where DEPENDENCIES is a comma-separated list of:
+
+* r23 or rails-2.3.x
+* r3 or rails-3.x
+* no-rails
+* sqlite
+* mysql
+
+So, e.g. this would run the test suite against Rails 2.3.x using mysql:
+
+.pre `ruby test/all.rb -w r23,mysql`
 
 The structure of the test suite is a bit unusual as it uses modules to reuse
 particular tests in different test cases.

data/lib/i18n.rb

@@ -1,6 +1,13 @@
+# Authors::   Sven Fuchs (http://www.artweb-design.de),
+#             Joshua Harvey (http://www.workingwithrails.com/person/759-joshua-harvey),
+#             Stephan Soller (http://www.arkanis-development.de/),
+#             Saimon Moore (http://saimonmoore.net),
+#             Matt Aimonetti (http://railsontherun.com/)
+# Copyright:: Copyright (c) 2008 The Ruby i18n Team
+# License::   MIT
 require 'i18n/version'
 require 'i18n/exceptions'
-require 'i18n/interpolate/ruby.rb'
+require 'i18n/core_ext/string/interpolate'
 
 module I18n
   autoload :Backend, 'i18n/backend'
@@ -9,9 +16,6 @@ module I18n
   autoload :Locale,  'i18n/locale'
   autoload :Tests,   'i18n/tests'
 
-  RESERVED_KEYS = [:scope, :default, :separator, :resolve, :object, :fallback, :format, :cascade, :raise, :rescue_format]
-  RESERVED_KEYS_PATTERN = /%\{(#{RESERVED_KEYS.join("|")})\}/
-
   class << self
     # Gets I18n configuration object.
     def config
@@ -25,7 +29,7 @@ module I18n
 
     # Write methods which delegates to the configuration object
     %w(locale backend default_locale available_locales default_separator
-      exception_handler load_path).each do |method|
+      exception_handler load_path enforce_available_locales).each do |method|
       module_eval <<-DELEGATORS, __FILE__, __LINE__ + 1
         def #{method}
           config.#{method}
@@ -147,6 +151,7 @@ module I18n
       locale  = options.delete(:locale) || config.locale
       raises  = options.delete(:raise)
 
+      enforce_available_locales!(locale)
       raise I18n::ArgumentError if key.is_a?(String) && key.empty?
 
       if key.is_a?(Array)
@@ -222,6 +227,7 @@ module I18n
       locale       = options && options.delete(:locale) || config.locale
       raises       = options && options.delete(:raise)
       replacement  = options && options.delete(:replacement)
+      enforce_available_locales!(locale)
       config.backend.transliterate(locale, key, replacement)
     rescue I18n::ArgumentError => exception
       raise exception if raises
@@ -232,6 +238,7 @@ module I18n
     def localize(object, options = {})
       locale = options.delete(:locale) || config.locale
       format = options.delete(:format) || :default
+      enforce_available_locales!(locale)
       config.backend.localize(locale, object, format, options)
     end
     alias :l :localize
@@ -260,6 +267,24 @@ module I18n
       keys
     end
 
+    # Returns true when the passed locale is in I18.available_locales.
+    # Returns false otherwise.
+    # Compare with Strings as `locale` may be coming from user input
+    def locale_available?(locale)
+      I18n.available_locales.map(&:to_s).include?(locale.to_s)
+    end
+
+    # Raises an InvalidLocale exception when the passed locale is not
+    # included in I18n.available_locales.
+    # Returns false otherwise
+    def enforce_available_locales!(locale)
+      handle_enforce_available_locales_deprecation
+
+      if config.enforce_available_locales
+        raise I18n::InvalidLocale.new(locale) if !locale_available?(locale)
+      end
+    end
+
   # making these private until Ruby 1.9.2 can send to protected methods again
   # see http://redmine.ruby-lang.org/repositories/revision/ruby-19?rev=24280
   private
@@ -290,6 +315,13 @@ module I18n
       end
     end
 
+    def handle_enforce_available_locales_deprecation
+      if config.enforce_available_locales.nil? && !@unenforced_available_locales_deprecation
+        $stderr.puts "[deprecated] I18n.enforce_available_locales will default to true in the future. If you really want to skip validation of your locale you can set I18n.enforce_available_locales = false to avoid this message."
+        @unenforced_available_locales_deprecation = true
+      end
+    end
+
     def normalize_key(key, separator)
       normalized_key_cache[separator][key] ||=
         case key

data/lib/i18n/backend.rb

@@ -5,6 +5,7 @@ module I18n
     autoload :Cache,                 'i18n/backend/cache'
     autoload :Cascade,               'i18n/backend/cascade'
     autoload :Chain,                 'i18n/backend/chain'
+    autoload :Cldr,                  'i18n/backend/cldr'
     autoload :Fallbacks,             'i18n/backend/fallbacks'
     autoload :Flatten,               'i18n/backend/flatten'
     autoload :Gettext,               'i18n/backend/gettext'

data/lib/i18n/backend/base.rb

@@ -1,12 +1,14 @@
 require 'yaml'
 require 'i18n/core_ext/hash'
-require 'i18n/core_ext/kernel/surpress_warnings'
 
 module I18n
   module Backend
     module Base
       include I18n::Backend::Transliterator
 
+      RESERVED_KEYS = [:scope, :default, :separator, :resolve, :object, :fallback]
+      RESERVED_KEYS_PATTERN = /%\{(#{RESERVED_KEYS.join("|")})\}/
+
       # Accepts a list of paths to translation files. Loads translations from
       # plain Ruby (*.rb) or YAML files (*.yml). See #load_rb and #load_yml
       # for details.
@@ -138,14 +140,34 @@ module I18n
         #
         #   interpolate "file %{file} opened by %%{user}", :file => 'test.txt', :user => 'Mr. X'
         #   # => "file test.txt opened by %{user}"
+        #
+        # Note that you have to double escape the <tt>\\</tt> when you want to escape
+        # the <tt>{{...}}</tt> key in a string (once for the string and once for the
+        # interpolation).
         def interpolate(locale, string, values = {})
-          if string.is_a?(::String) && !values.empty?
-            I18n.interpolate(string, values)
+          return string unless string.is_a?(::String) && !values.empty?
+
+          values.each do |key, value|
+            value = value.call(values) if interpolate_lambda?(value, string, key)
+            value = value.to_s unless value.is_a?(::String)
+            values[key] = value
+          end
+
+          string % values
+        rescue KeyError => e
+          if string =~ RESERVED_KEYS_PATTERN
+            raise ReservedInterpolationKey.new($1.to_sym, string)
           else
-            string
+            raise MissingInterpolationArgument.new(values, string)
           end
         end
 
+        # returns true when the given value responds to :call and the key is
+        # an interpolation placeholder in the given string
+        def interpolate_lambda?(object, string, key)
+          object.respond_to?(:call) && string =~ /%\{#{key}\}|%\<#{key}>.*?\d*\.?\d*[bBdiouxXeEfgGcps]\}/
+        end
+
         # Loads a single translations file by delegating to #load_rb or
         # #load_yml depending on the file extension and directly merges the
         # data to the existing translations. Raises I18n::UnknownFileType
@@ -169,6 +191,12 @@ module I18n
         def load_yml(filename)
           YAML.load_file(filename)
         end
+
+        def warn_syntax_deprecation!(locale, string) #:nodoc:
+          return if @skip_syntax_deprecation
+          warn "The {{key}} interpolation syntax in I18n messages is deprecated. Please use %{key} instead.\n#{locale} - #{string}\n"
+          @skip_syntax_deprecation = true
+        end
     end
   end
 end

data/lib/i18n/backend/cldr.rb

@@ -0,0 +1,99 @@
+require 'cldr'
+
+module I18n
+  module Backend
+    module Cldr
+      include ::Cldr::Format
+
+      def localize(locale, object, format = :default, options = {})
+        options[:as] ||= detect_type(object, options)
+        send(:"format_#{options[:as]}", locale, object, format, options)
+      end
+
+      def format_decimal(locale, object, format = :default, options = {})
+        formatter(locale, :decimal, format).apply(object, options)
+      end
+
+      def format_integer(locale, object, format = :default, options = {})
+        format_object(number, options.merge(:precision => 0))
+      end
+
+      def format_currency(locale, object, format = :default, options = {})
+        options.merge!(:currency => lookup_currency(locale, options[:currency], object)) if options[:currency].is_a?(Symbol)
+        formatter(locale, :currency, format).apply(object, options)
+      end
+
+      def format_percent(locale, object, format = :default, options = {})
+        formatter(locale, :percent, format).apply(object, options)
+      end
+
+      def format_date(locale, object, format = :default, options = {})
+        formatter(locale, :date, format).apply(object, options)
+      end
+
+      def format_time(locale, object, format = :default, options = {})
+        formatter(locale, :time, format).apply(object, options)
+      end
+
+      def format_datetime(locale, object, format = :default, options = {})
+        key  = :"calendars.gregorian.formats.datetime.#{format}.pattern"
+        date = I18n.l(object, :format => options[:date_format] || format, :locale => locale, :as => :date)
+        time = I18n.l(object, :format => options[:time_format] || format, :locale => locale, :as => :time)
+        I18n.t(key, :date => date, :time => time, :locale => locale, :raise => true)
+      end
+
+      protected
+
+        def detect_type(object, options)
+          options.has_key?(:currency) ? :currency : case object
+          when ::Numeric
+            :decimal
+          when ::Date, ::DateTime, ::Time
+            object.class.name.downcase.to_sym
+          else
+            raise_unspecified_format_type!
+          end
+        end
+
+        def formatter(locale, type, format)
+          (@formatters ||= {})[:"#{locale}.#{type}.#{format}"] ||= begin
+            format = lookup_format(locale, type, format)
+            data   = lookup_format_data(locale, type)
+            ::Cldr::Format.const_get(type.to_s.camelize).new(format, data)
+          end
+        end
+
+        def lookup_format(locale, type, format)
+          key = case type
+          when :date, :time, :datetime
+            :"calendars.gregorian.formats.#{type}.#{format}.pattern"
+          else
+            :"numbers.formats.#{type}.patterns.#{format || :default}"
+          end
+          I18n.t(key, :locale => locale, :raise => true)
+        end
+
+        def lookup_format_data(locale, type)
+          key = case type
+          when :date, :time, :datetime
+            :'calendars.gregorian'
+          else
+            :'numbers.symbols'
+          end
+          I18n.t(key, :locale => locale, :raise => true)
+        end
+
+        def lookup_currency(locale, currency, count)
+          I18n.t(:"currencies.#{currency}", :locale => locale, :count => count)
+        end
+
+        def raise_unspecified_format_type!
+          raise ArgumentError.new("You have to specify a format type, e.g. :as => :number.")
+        end
+
+        def raise_unspecified_currency!
+          raise ArgumentError.new("You have to specify a currency, e.g. :currency => 'EUR'.")
+        end
+    end
+  end
+end

data/lib/i18n/backend/gettext.rb

@@ -43,8 +43,8 @@ module I18n
               key, value = normalize_pluralization(locale, key, value) if key.index("\000")
 
               parts = key.split('|').reverse
-              normalized = parts.inject({}) do |_normalized, part|
-                { part => _normalized.empty? ? value : _normalized }
+              normalized = parts.inject({}) do |normalized, part|
+                normalized = { part => normalized.empty? ? value : normalized }
               end
 
               result.deep_merge!(normalized)
@@ -62,7 +62,7 @@ module I18n
           raise "invalid number of plurals: #{values.size}, keys: #{keys.inspect}" if values.size != keys.size
 
           result = {}
-          values.each_with_index { |_value, ix| result[keys[ix]] = _value }
+          values.each_with_index { |value, ix| result[keys[ix]] = value }
           [key, result]
         end
 

data/lib/i18n/backend/interpolation_compiler.rb

@@ -61,7 +61,7 @@ module I18n
 
         def interpolate_or_raise_missing(key)
           escaped_key = escape_key_sym(key)
-          RESERVED_KEYS.include?(key) ? reserved_key(escaped_key) : interpolate_key(escaped_key)
+          Base::RESERVED_KEYS.include?(key) ? reserved_key(escaped_key) : interpolate_key(escaped_key)
         end
 
         def interpolate_key(key)

data/lib/i18n/backend/metadata.rb

@@ -38,7 +38,7 @@ module I18n
           :scope     => options[:scope],
           :default   => options[:default],
           :separator => options[:separator],
-          :values    => options.reject { |name, value| RESERVED_KEYS.include?(name) }
+          :values    => options.reject { |name, value| Base::RESERVED_KEYS.include?(name) }
         }
         with_metadata(metadata) { super }
       end

data/lib/i18n/config.rb

@@ -8,6 +8,7 @@ module I18n
 
     # Sets the current locale pseudo-globally, i.e. in the Thread.current hash.
     def locale=(locale)
+      I18n.enforce_available_locales!(locale)
       @locale = locale.to_sym rescue nil
     end
 
@@ -28,6 +29,7 @@ module I18n
 
     # Sets the current default locale. Used to set a custom default locale.
     def default_locale=(locale)
+      I18n.enforce_available_locales!(locale)
       @@default_locale = locale.to_sym rescue nil
     end
 
@@ -41,7 +43,7 @@ module I18n
 
     # Sets the available locales.
     def available_locales=(locales)
-      @@available_locales = Array(locales).map { |locale| locale.to_sym }
+      @@available_locales = Array(locales).map {|locale| locale.to_sym}
       @@available_locales = nil if @@available_locales.empty?
     end
 
@@ -82,5 +84,15 @@ module I18n
     def load_path=(load_path)
       @@load_path = load_path
     end
+
+    # [Deprecated] this will default to true in the future
+    # Defaults to nil so that it triggers the deprecation warning
+    def enforce_available_locales
+      @@enforce_available_locales ||= nil
+    end
+
+    def enforce_available_locales=(enforce_available_locales)
+      @@enforce_available_locales = enforce_available_locales
+    end
   end
 end

data/lib/i18n/core_ext/string/interpolate.rb

@@ -1,12 +1,3 @@
-# This backports the Ruby 1.9 String interpolation syntax to Ruby 1.8.
-#
-# This backport has been shipped with I18n for a number of versions. Meanwhile
-# Rails has started to rely on it and we are going to move it to ActiveSupport.
-# See https://rails.lighthouseapp.com/projects/8994/tickets/6013-move-19-string-interpolation-syntax-backport-from-i18n-to-activesupport
-#
-# Once the above patch has been applied to Rails the following code will be
-# removed from I18n.
-
 =begin
   heavily based on Masao Mutoh's gettext String interpolation extension
   http://github.com/mutoh/gettext/blob/f6566738b981fe0952548c421042ad1e0cdfb31e/lib/gettext/core_ext/string.rb

data/lib/i18n/exceptions.rb

@@ -1,3 +1,11 @@
+require 'cgi'
+
+class KeyError < IndexError
+  def initialize(message = nil)
+    super(message || "key not found")
+  end
+end unless defined?(KeyError)
+
 module I18n
   # Handles exceptions raised in the backend. All exceptions except for
   # MissingTranslationData exceptions are re-raised. When a MissingTranslationData
@@ -7,7 +15,19 @@ module I18n
     include Module.new {
       def call(exception, locale, key, options)
         if exception.is_a?(MissingTranslationData)
-          options[:rescue_format] == :html ? exception.html_message : exception.message
+          #
+          # TODO: this block is to be replaced by `exception.message` when
+          # rescue_format is removed
+          if options[:rescue_format] == :html
+            if @rescue_format_deprecation
+              $stderr.puts "[DEPRECATED] I18n's :recue_format option will be removed from a future release. All exception messages will be plain text. If you need the exception handler to return an html format please set or pass a custom exception handler."
+              @rescue_format_deprecation = true
+            end
+            exception.html_message
+          else
+            exception.message
+          end
+
         else
           raise exception
         end
@@ -43,8 +63,9 @@ module I18n
     end
 
     def html_message
-      key = keys.last.to_s.gsub('_', ' ').gsub(/\b('?[a-z])/) { $1.capitalize }
-      %(<span class="translation_missing" title="translation missing: #{keys.join('.')}">#{key}</span>)
+      key  = CGI.escapeHTML titleize(keys.last)
+      path = CGI.escapeHTML keys.join('.')
+      %(<span class="translation_missing" title="translation missing: #{path}">#{key}</span>)
     end
 
     def keys
@@ -52,6 +73,13 @@ module I18n
         keys << 'no key' if keys.size < 2
       end
     end
+
+    protected
+
+    # TODO : remove when #html_message is removed
+    def titleize(key)
+      key.to_s.gsub('_', ' ').gsub(/\b('?[a-z])/) { $1.capitalize }
+    end
   end
 
   class InvalidPluralizationData < ArgumentError