i18n 0.4.2 → 0.5.0beta1

data/CHANGELOG.textile

@@ -1,5 +1,14 @@
 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
@@ -44,7 +53,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)
@@ -93,7 +102,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
@@ -140,4 +149,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/lib/i18n.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # 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/),
@@ -16,6 +14,7 @@ module I18n
   autoload :Config,  'i18n/config'
   autoload :Gettext, 'i18n/gettext'
   autoload :Locale,  'i18n/locale'
+  autoload :Tests,   'i18n/tests'
 
   class << self
     # Gets I18n configuration object.
@@ -252,7 +251,6 @@ module I18n
       self.locale = current_locale if tmp_locale
     end
 
-
     # Merges the given locale, key and scope into a single array of keys.
     # Splits keys that contain dots into multiple keys. Makes sure all
     # keys are Symbols.
@@ -270,15 +268,6 @@ module I18n
   # see http://redmine.ruby-lang.org/repositories/revision/ruby-19?rev=24280
   private
 
-    # Handles exceptions raised in the backend. All exceptions except for
-    # MissingTranslationData exceptions are re-raised. When a MissingTranslationData
-    # was caught and the option :raise is not set the handler returns an error
-    # message string containing the key/scope.
-    def default_exception_handler(exception, locale, key, options)
-      return exception.message if MissingTranslationData === exception
-      raise exception
-    end
-
     # Any exceptions thrown in translate will be sent to the @@exception_handler
     # which can be a Symbol, a Proc or any other Object.
     #
@@ -297,20 +286,14 @@ module I18n
     #  I18n.exception_handler = I18nExceptionHandler.new                # an object
     #  I18n.exception_handler.call(exception, locale, key, options)     # will be called like this
     def handle_exception(exception, locale, key, options)
-      case config.exception_handler
+      case handler = options[:exception_handler] || config.exception_handler
       when Symbol
-        send(config.exception_handler, exception, locale, key, options)
+        send(handler, exception, locale, key, options)
       else
-        config.exception_handler.call(exception, locale, key, options)
+        handler.call(exception, locale, key, options)
       end
     end
 
-    # Deprecated. Will raise a warning in future versions and then finally be
-    # removed. Use I18n.normalize_keys instead.
-    def normalize_translation_keys(locale, key, scope, separator = nil)
-      normalize_keys(locale, key, scope, separator)
-    end
-
     def normalize_key(key, separator)
       normalized_key_cache[separator][key] ||=
         case key
@@ -327,5 +310,19 @@ module I18n
     def normalized_key_cache
       @normalized_key_cache ||= Hash.new { |h,k| h[k] = {} }
     end
+
+    # DEPRECATED. Use I18n.normalize_keys instead.
+    def normalize_translation_keys(locale, key, scope, separator = nil)
+      puts "I18n.normalize_translation_keys is deprecated. Please use the class I18n.normalize_keys instead."
+      normalize_keys(locale, key, scope, separator)
+    end
+
+    # DEPRECATED. Please use the I18n::ExceptionHandler class instead.
+    def default_exception_handler(exception, locale, key, options)
+      puts "I18n.default_exception_handler is deprecated. Please use the class I18n::ExceptionHandler instead " +
+           "(an instance of which is set to I18n.exception_handler by default)."
+      return exception.message if MissingTranslationData === exception
+      raise exception
+    end
   end
 end

data/lib/i18n/backend.rb

@@ -1,6 +1,5 @@
 module I18n
   module Backend
-    autoload :ActiveRecord,          'i18n/backend/active_record'
     autoload :Base,                  'i18n/backend/base'
     autoload :InterpolationCompiler, 'i18n/backend/interpolation_compiler'
     autoload :Cache,                 'i18n/backend/cache'

data/lib/i18n/backend/base.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'yaml'
 require 'i18n/core_ext/hash'
 
@@ -10,7 +8,6 @@ module I18n
 
       RESERVED_KEYS = [:scope, :default, :separator, :resolve, :object, :fallback]
       RESERVED_KEYS_PATTERN = /%\{(#{RESERVED_KEYS.join("|")})\}/
-      DEPRECATED_INTERPOLATION_SYNTAX_PATTERN = /(\\)?\{\{([^\}]+)\}\}/
 
       # Accepts a list of paths to translation files. Loads translations from
       # plain Ruby (*.rb) or YAML files (*.yml). See #load_rb and #load_yml
@@ -150,16 +147,6 @@ module I18n
         def interpolate(locale, string, values = {})
           return string unless string.is_a?(::String) && !values.empty?
 
-          string = string.gsub(DEPRECATED_INTERPOLATION_SYNTAX_PATTERN) do
-            escaped, key = $1, $2.to_sym
-            if escaped
-              "{{#{key}}}"
-            else
-              warn_syntax_deprecation!(locale, string)
-              "%{#{key}}"
-            end
-          end
-
           values.each do |key, value|
             value = value.call(values) if interpolate_lambda?(value, string, key)
             value = value.to_s unless value.is_a?(::String)

data/lib/i18n/backend/cache.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # This module allows you to easily cache all responses from the backend - thus
 # speeding up the I18n aspects of your application quite a bit.
 #

data/lib/i18n/backend/cascade.rb

@@ -1,7 +1,3 @@
-# encoding: utf-8
-
-# EXPERIMENTAL
-#
 # The Cascade module adds the ability to do cascading lookups to backends that
 # are compatible to the Simple backend.
 #
@@ -38,19 +34,19 @@ module I18n
       def lookup(locale, key, scope = [], options = {})
         return super unless cascade = options[:cascade]
 
+        cascade   = { :step => 1 } unless cascade.is_a?(Hash)
+        step      = cascade[:step]   || 1
+        offset    = cascade[:offset] || 1
         separator = options[:separator] || I18n.default_separator
         skip_root = cascade.has_key?(:skip_root) ? cascade[:skip_root] : true
-        step      = cascade[:step]
 
-        keys   = I18n.normalize_keys(nil, key, nil, separator)
-        offset = options[:cascade][:offset] || keys.length
-        scope  = I18n.normalize_keys(nil, nil, scope, separator) + keys
-        key    = scope.slice!(-offset, offset).join(separator)
+        scope = I18n.normalize_keys(nil, key, scope, separator)
+        key   = (scope.slice!(-offset, offset) || []).join(separator)
 
         begin
           result = super
           return result unless result.nil?
-        end while !scope.empty? && scope.slice!(-step, step) && (!scope.empty? || !skip_root)
+        end while (!scope.empty? || !skip_root) && scope.slice!(-step, step)
       end
     end
   end

data/lib/i18n/backend/chain.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module I18n
   module Backend
     # Backend that chains multiple other backends and checks each of them when

data/lib/i18n/backend/cldr.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 require 'cldr'
 
 module I18n
@@ -97,4 +96,4 @@ module I18n
         end
     end
   end
-end
+end

data/lib/i18n/backend/fallbacks.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # I18n locale fallbacks are useful when you want your application to use
 # translations from other locales when translations for the current locale are
 # missing. E.g. you might want to use :en translations when translations in

data/lib/i18n/backend/gettext.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'i18n/gettext'
 require 'i18n/gettext/po_parser'
 

data/lib/i18n/backend/interpolation_compiler.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # The InterpolationCompiler module contains optimizations that can tremendously
 # speed up the interpolation process on the Simple backend.
 #
@@ -120,4 +118,4 @@ module I18n
       end
     end
   end
-end
+end

data/lib/i18n/backend/key_value.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'i18n/backend/base'
 require 'active_support/json'
 
@@ -99,4 +97,4 @@ module I18n
       include Implementation
     end
   end
-end
+end

data/lib/i18n/backend/memoize.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Memoize module simply memoizes the values returned by lookup using
 # a flat hash and can tremendously speed up the lookup process in a backend.
 #
@@ -45,4 +43,4 @@ module I18n
         end
     end
   end
-end
+end

data/lib/i18n/backend/pluralization.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # I18n locale fallbacks are useful when you want your application to use
 # translations from other locales when translations for the current locale are
 # missing. E.g. you might want to use :en translations when translations in

data/lib/i18n/backend/simple.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module I18n
   module Backend
     # A simple backend that reads translations from YAML files and stores them in

data/lib/i18n/config.rb

@@ -57,7 +57,7 @@ module I18n
 
     # Return the current exception handler. Defaults to :default_exception_handler.
     def exception_handler
-      @@exception_handler ||= :default_exception_handler
+      @@exception_handler ||= ExceptionHandler.new
     end
 
     # Sets the exception handler.
@@ -83,4 +83,4 @@ module I18n
       @@load_path = load_path
     end
   end
-end
+end

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 =begin
   heavily based on Masao Mutoh's gettext String interpolation extension
   http://github.com/mutoh/gettext/blob/f6566738b981fe0952548c421042ad1e0cdfb31e/lib/gettext/core_ext/string.rb
@@ -95,4 +93,4 @@ rescue ArgumentError
       end
     end
   end
-end
+end

data/lib/i18n/exceptions.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 class KeyError < IndexError
   def initialize(message = nil)
     super(message || "key not found")
@@ -7,6 +5,22 @@ class KeyError < IndexError
 end unless defined?(KeyError)
 
 module I18n
+  # Handles exceptions raised in the backend. All exceptions except for
+  # MissingTranslationData exceptions are re-raised. When a MissingTranslationData
+  # was caught the handler returns an error message string containing the key/scope.
+  # Note that the exception handler is not called when the option :raise was given.
+  class ExceptionHandler
+    include Module.new {
+      def call(exception, locale, key, options)
+        if exception.is_a?(MissingTranslationData)
+          options[:rescue_format] == :html ? exception.html_message : exception.message
+        else
+          raise exception
+        end
+      end
+    }
+  end
+
   class ArgumentError < ::ArgumentError; end
 
   class InvalidLocale < ArgumentError
@@ -27,13 +41,22 @@ module I18n
 
   class MissingTranslationData < ArgumentError
     attr_reader :locale, :key, :options
+
     def initialize(locale, key, opts = nil)
       @key, @locale, @options = key, locale, opts.dup || {}
       options.each { |k, v| options[k] = v.inspect if v.is_a?(Proc) }
+      super "translation missing: #{keys.join('.')}"
+    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>)
+    end
 
-      keys = I18n.normalize_keys(locale, key, options[:scope])
-      keys << 'no key' if keys.size < 2
-      super "translation missing: #{keys.join(', ')}"
+    def keys
+      @keys ||= I18n.normalize_keys(locale, key, options[:scope]).tap do |keys|
+        keys << 'no key' if keys.size < 2
+      end
     end
   end
 
@@ -68,4 +91,4 @@ module I18n
       super "can not load translations from #{filename}, the file type #{type} is not known"
     end
   end
-end
+end

data/lib/i18n/gettext.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module I18n
   module Gettext
     PLURAL_SEPARATOR  = "\001"

data/lib/i18n/gettext/helpers.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 require 'i18n/gettext'
 
 module I18n

data/lib/i18n/locale/fallbacks.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # Locale Fallbacks
 #
 # Extends the I18n module to hold a fallbacks instance which is set to an

data/lib/i18n/locale/tag/parents.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module I18n
   module Locale
     module Tag

data/lib/i18n/locale/tag/rfc4646.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # RFC 4646/47 compliant Locale tag implementation that parses locale tags to
 # subtags such as language, script, region, variant etc.
 #

data/lib/i18n/locale/tag/simple.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # Simple Locale tag implementation that computes subtags by simply splitting
 # the locale tag at '-' occurences.
 module I18n

data/lib/i18n/tests.rb

@@ -0,0 +1,12 @@
+module I18n
+  module Tests
+    autoload :Basics,        'i18n/tests/basics'
+    autoload :Defaults,      'i18n/tests/defaults'
+    autoload :Interpolation, 'i18n/tests/interpolation'
+    autoload :Link,          'i18n/tests/link'
+    autoload :Localization,  'i18n/tests/localization'
+    autoload :Lookup,        'i18n/tests/lookup'
+    autoload :Pluralization, 'i18n/tests/pluralization'
+    autoload :Procs,         'i18n/tests/procs'
+  end
+end

data/lib/i18n/tests/basics.rb

@@ -0,0 +1,54 @@
+module I18n
+  module Tests
+    module Basics
+      def teardown
+        I18n.available_locales = nil
+      end
+
+      test "available_locales returns the locales stored to the backend by default" do
+        I18n.backend.store_translations('de', :foo => 'bar')
+        I18n.backend.store_translations('en', :foo => 'foo')
+
+        assert I18n.available_locales.include?(:de)
+        assert I18n.available_locales.include?(:en)
+      end
+
+      test "available_locales can be set to something else independently from the actual locale data" do
+        I18n.backend.store_translations('de', :foo => 'bar')
+        I18n.backend.store_translations('en', :foo => 'foo')
+
+        I18n.available_locales = :foo
+        assert_equal [:foo], I18n.available_locales
+
+        I18n.available_locales = [:foo, 'bar']
+        assert_equal [:foo, :bar], I18n.available_locales
+
+        I18n.available_locales = nil
+        assert I18n.available_locales.include?(:de)
+        assert I18n.available_locales.include?(:en)
+      end
+
+      test "available_locales memoizes when set explicitely" do
+        I18n.backend.expects(:available_locales).never
+        I18n.available_locales = [:foo]
+        I18n.backend.store_translations('de', :bar => 'baz')
+        I18n.reload!
+        assert_equal [:foo], I18n.available_locales
+      end
+
+      test "available_locales delegates to the backend when not set explicitely" do
+        I18n.backend.expects(:available_locales).twice
+        assert_equal I18n.available_locales, I18n.available_locales
+      end
+
+      test "storing a nil value as a translation removes it from the available locale data" do
+        I18n.backend.store_translations(:en, :to_be_deleted => 'bar')
+        assert_equal 'bar', I18n.t(:to_be_deleted, :default => 'baz')
+
+        I18n.cache_store.clear if I18n.respond_to?(:cache_store) && I18n.cache_store
+        I18n.backend.store_translations(:en, :to_be_deleted => nil)
+        assert_equal 'baz', I18n.t(:to_be_deleted, :default => 'baz')
+      end
+    end
+  end
+end