add i18n lib files

This commit is contained in:
Sven Fuchs
2008-07-16 04:16:08 +02:00
parent 731fca8cf6
commit fbe1823117
10 changed files with 1064 additions and 0 deletions

View File

@@ -0,0 +1,20 @@
Copyright (c) 2008 The Ruby I18n team
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@@ -0,0 +1,18 @@
h1. Ruby I18n gem
I18n and localization solution for Ruby.
h2. Authors
* "Matt Aimonetti":http://railsontherun.com
* "Sven Fuchs":http://www.artweb-design.de
* "Joshua Harvey":http://www.workingwithrails.com/person/759-joshua-harvey
* "Saimon Moore":http://saimonmoore.net
* "Stephan Soller":http://www.arkanis-development.de
h2. License
MIT License. See the included MIT-LICENCE file.

View File

@@ -0,0 +1,24 @@
Gem::Specification.new do |s|
s.name = "i18n"
s.version = "0.0.1"
s.date = "2008-06-13"
s.summary = "Internationalization for Ruby"
s.email = "rails-patch-i18n@googlegroups.com"
s.homepage = "http://groups.google.com/group/rails-patch-i18n"
s.description = "Add Internationalization to your Ruby application."
s.has_rdoc = false
s.authors = ['Sven Fuchs', 'Matt Aimonetti', 'Stephan Soller', 'Saimon Moore']
s.files = [
"lib/i18n/backend/minimal.rb",
"lib/i18n/core_ext.rb",
"lib/i18n/localization.rb",
"lib/i18n/translation.rb",
"lib/i18n.rb",
"LICENSE",
"README",
"spec/core_ext_spec.rb",
"spec/i18n_spec.rb",
"spec/spec.opts",
"spec/spec_helper.rb"
]
end

View File

@@ -0,0 +1,182 @@
# Authors:: Matt Aimonetti (http://railsontherun.com/),
# Sven Fuchs (http://www.artweb-design.de),
# Joshua Harvey (http://www.workingwithrails.com/person/759-joshua-harvey),
# Saimon Moore (http://saimonmoore.net),
# Stephan Soller (http://www.arkanis-development.de/)
# Copyright:: Copyright (c) 2008 The Ruby i18n Team
# License:: MIT
require 'i18n/backend/simple'
require 'i18n/exceptions'
module I18n
@@backend = Backend::Simple
@@default_locale = 'en-US'
@@exception_handler = :default_exception_handler
class << self
# Returns the current backend. Defaults to +Backend::Simple+.
def backend
@@backend
end
# Sets the current backend. Used to set a custom backend.
def backend=(backend)
@@backend = backend
end
# Returns the current default locale. Defaults to 'en-US'
def default_locale
@@default_locale
end
# Sets the current default locale. Used to set a custom default locale.
def default_locale=(locale)
@@default_locale = locale
end
# Returns the current locale. Defaults to I18n.default_locale.
def locale
Thread.current[:locale] ||= default_locale
end
# Sets the current locale pseudo-globally, i.e. in the Thread.current hash.
def locale=(locale)
Thread.current[:locale] = locale
end
# Sets the exception handler.
def exception_handler=(exception_handler)
@@exception_handler = exception_handler
end
# Allow client libraries to pass a block that populates the translation
# storage. Decoupled for backends like a db backend that persist their
# translations, so the backend can decide whether/when to yield or not.
def populate(&block)
backend.populate &block
end
# Stores translations for the given locale in the backend.
def store_translations(locale, data)
backend.store_translations locale, data
end
# Translates, pluralizes and interpolates a given key using a given locale,
# scope, and default, as well as interpolation values.
#
# *LOOKUP*
#
# Translation data is organized as a nested hash using the upper-level keys
# as namespaces. <em>E.g.</em>, ActionView ships with the translation:
# <tt>:date => {:formats => {:short => "%b %d"}}</tt>.
#
# Translations can be looked up at any level of this hash using the key argument
# and the scope option. <em>E.g.</em>, in this example <tt>I18n.t :date</tt>
# returns the whole translations hash <tt>{:formats => {:short => "%b %d"}}</tt>.
#
# Key can be either a single key or a dot-separated key (both Strings and Symbols
# work). <em>E.g.</em>, the short format can be looked up using both:
# I18n.t 'date.formats.short'
# I18n.t :'date.formats.short'
#
# Scope can be either a single key, a dot-separated key or an array of keys
# or dot-separated keys. Keys and scopes can be combined freely. So these
# examples will all look up the same short date format:
# I18n.t 'date.formats.short'
# I18n.t 'formats.short', :scope => 'date'
# I18n.t 'short', :scope => 'date.formats'
# I18n.t 'short', :scope => %w(date formats)
#
# *INTERPOLATION*
#
# Translations can contain interpolation variables which will be replaced by
# values passed to #translate as part of the options hash, with the keys matching
# the interpolation variable names.
#
# <em>E.g.</em>, with a translation <tt>:foo => "foo {{bar}}"</tt> the option
# value for the key +bar+ will be interpolated into the translation:
# I18n.t :foo, :bar => 'baz' # => 'foo baz'
#
# *PLURALIZATION*
#
# Translation data can contain pluralized translations. Pluralized translations
# are arrays of singluar/plural versions of translations like <tt>['Foo', 'Foos']</tt>.
#
# Note that <tt>I18n::Backend::Simple</tt> only supports an algorithm for English
# pluralization rules. Other algorithms can be supported by custom backends.
#
# This returns the singular version of a pluralized translation:
# I18n.t :foo, :count => 1 # => 'Foo'
#
# These both return the plural version of a pluralized translation:
# I18n.t :foo, :count => 0 # => 'Foos'
# I18n.t :foo, :count => 2 # => 'Foos'
#
# The <tt>:count</tt> option can be used both for pluralization and interpolation.
# <em>E.g.</em>, with the translation
# <tt>:foo => ['{{count}} foo', '{{count}} foos']</tt>, count will
# be interpolated to the pluralized translation:
# I18n.t :foo, :count => 1 # => '1 foo'
#
# *DEFAULTS*
#
# This returns the translation for <tt>:foo</tt> or <tt>default</tt> if no translation was found:
# I18n.t :foo, :default => 'default'
#
# This returns the translation for <tt>:foo</tt> or the translation for <tt>:bar</tt> if no
# translation for <tt>:foo</tt> was found:
# I18n.t :foo, :default => :bar
#
# Returns the translation for <tt>:foo</tt> or the translation for <tt>:bar</tt>
# or <tt>default</tt> if no translations for <tt>:foo</tt> and <tt>:bar</tt> were found.
# I18n.t :foo, :default => [:bar, 'default']
#
# <b>BULK LOOKUP</b>
#
# This returns an array with the translations for <tt>:foo</tt> and <tt>:bar</tt>.
# I18n.t [:foo, :bar]
#
# Can be used with dot-separated nested keys:
# I18n.t [:'baz.foo', :'baz.bar']
#
# Which is the same as using a scope option:
# I18n.t [:foo, :bar], :scope => :baz
def translate(key, options = {})
locale = options.delete(:locale) || I18n.locale
backend.translate locale, key, options
rescue I18n::ArgumentError => e
raise e if options[:raise]
send @@exception_handler, e, locale, key, options
end
alias :t :translate
# Localizes certain objects, such as dates and numbers to local formatting.
def localize(object, options = {})
locale = options[:locale] || I18n.locale
format = options[:format] || :default
backend.localize(locale, object, format)
end
alias :l :localize
protected
# 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
# 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.
def normalize_translation_keys(locale, key, scope)
keys = [locale] + Array(scope) + [key]
keys = keys.map{|key| key.to_s.split(/\./) }
keys.flatten.map{|key| key.to_sym}
end
end
end

View File

@@ -0,0 +1,154 @@
require 'strscan'
module I18n
module Backend
module Simple
@@translations = {}
class << self
# Allow client libraries to pass a block that populates the translation
# storage. Decoupled for backends like a db backend that persist their
# translations, so the backend can decide whether/when to yield or not.
def populate(&block)
yield
end
# Stores translations for the given locale in memory.
# This uses a deep merge for the translations hash, so existing
# translations will be overwritten by new ones only at the deepest
# level of the hash.
def store_translations(locale, data)
merge_translations(locale, data)
end
def translate(locale, key, options = {})
raise InvalidLocale.new(locale) if locale.nil?
return key.map{|key| translate locale, key, options } if key.is_a? Array
reserved = :scope, :default
count, scope, default = options.values_at(:count, *reserved)
options.delete(:default)
values = options.reject{|name, value| reserved.include? name }
entry = lookup(locale, key, scope) || default(locale, default, options) || raise(I18n::MissingTranslationData.new(locale, key, options))
entry = pluralize entry, count
entry = interpolate entry, values
entry
end
# Acts the same as +strftime+, but returns a localized version of the
# formatted date string. Takes a key from the date/time formats
# translations as a format argument (<em>e.g.</em>, <tt>:short</tt> in <tt>:'date.formats'</tt>).
def localize(locale, object, format = :default)
raise ArgumentError, "Object must be a Date, DateTime or Time object. #{object.inspect} given." unless object.respond_to?(:strftime)
type = object.respond_to?(:sec) ? 'time' : 'date'
formats = translate(locale, :"#{type}.formats")
format = formats[format.to_sym] if formats && formats[format.to_sym]
# TODO raise exception unless format found?
format = format.to_s.dup
format.gsub!(/%a/, translate(locale, :"date.abbr_day_names")[object.wday])
format.gsub!(/%A/, translate(locale, :"date.day_names")[object.wday])
format.gsub!(/%b/, translate(locale, :"date.abbr_month_names")[object.mon])
format.gsub!(/%B/, translate(locale, :"date.month_names")[object.mon])
format.gsub!(/%p/, translate(locale, :"time.#{object.hour < 12 ? :am : :pm}")) if object.respond_to? :hour
object.strftime(format)
end
protected
# Looks up a translation from the translations hash. Returns nil if
# eiher key is nil, or locale, scope or key do not exist as a key in the
# nested translations hash. Splits keys or scopes containing dots
# into multiple keys, i.e. <tt>currency.format</tt> is regarded the same as
# <tt>%w(currency format)</tt>.
def lookup(locale, key, scope = [])
return unless key
keys = I18n.send :normalize_translation_keys, locale, key, scope
keys.inject(@@translations){|result, key| result[key.to_sym] or return nil }
end
# Evaluates a default translation.
# If the given default is a String it is used literally. If it is a Symbol
# it will be translated with the given options. If it is an Array the first
# translation yielded will be returned.
#
# <em>I.e.</em>, <tt>default(locale, [:foo, 'default'])</tt> will return +default+ if
# <tt>translate(locale, :foo)</tt> does not yield a result.
def default(locale, default, options = {})
case default
when String then default
when Symbol then translate locale, default, options
when Array then default.each do |obj|
result = default(locale, obj, options.dup) and return result
end
end
rescue MissingTranslationData
nil
end
# Picks a translation from an array according to English pluralization
# rules. It will pick the first translation if count is not equal to 1
# and the second translation if it is equal to 1. Other backends can
# implement more flexible or complex pluralization rules.
def pluralize(entry, count)
return entry unless entry.is_a?(Array) and count
raise InvalidPluralizationData.new(entry, count) unless entry.size == 2
entry[count == 1 ? 0 : 1]
end
# Interpolates values into a given string.
#
# 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(string, values = {})
return string if !string.is_a?(String)
map = {'%d' => '{{count}}', '%s' => '{{value}}'} # TODO deprecate this?
string.gsub!(/#{map.keys.join('|')}/){|key| map[key]}
s = StringScanner.new string.dup
while s.skip_until(/\{\{/)
s.string[s.pos - 3, 1] = '' and next if s.pre_match[-1, 1] == '\\'
start_pos = s.pos - 2
key = s.scan_until(/\}\}/)[0..-3]
end_pos = s.pos - 1
raise ReservedInterpolationKey.new(key, string) if %w(scope default).include?(key)
raise MissingInterpolationArgument.new(key, string) unless values.has_key? key.to_sym
s.string[start_pos..end_pos] = values[key.to_sym].to_s
s.unscan
end
s.string
end
# Deep merges the given translations hash with the existing translations
# for the given locale
def merge_translations(locale, data)
locale = locale.to_sym
@@translations[locale] ||= {}
data = deep_symbolize_keys data
# deep_merge by Stefan Rusterholz, see http://www.ruby-forum.com/topic/142809
merger = proc{|key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
@@translations[locale].merge! data, &merger
end
# Return a new hash with all keys and nested keys converted to symbols.
def deep_symbolize_keys(hash)
hash.inject({}){|result, (key, value)|
value = deep_symbolize_keys(value) if value.is_a? Hash
result[(key.to_sym rescue key) || key] = value
result
}
end
end
end
end
end

View File

@@ -0,0 +1,45 @@
module I18n
class ArgumentError < ::ArgumentError; end
class InvalidLocale < ArgumentError
attr_reader :locale
def initialize(locale)
@locale = locale
super "#{locale.inspect} is not a valid locale"
end
end
class MissingTranslationData < ArgumentError
attr_reader :locale, :key, :options
def initialize(locale, key, options)
@key, @locale, @options = key, locale, options
keys = I18n.send(:normalize_translation_keys, locale, key, options[:scope])
keys << 'no key' if keys.size < 2
super "translation missing: #{keys.join(', ')}"
end
end
class InvalidPluralizationData < ArgumentError
attr_reader :entry, :count
def initialize(entry, count)
@entry, @count = entry, count
super "translation data #{entry.inspect} can not be used with :count => #{count}"
end
end
class MissingInterpolationArgument < ArgumentError
attr_reader :key, :string
def initialize(key, string)
@key, @string = key, string
super "interpolation argument #{key} missing in #{string.inspect}"
end
end
class ReservedInterpolationKey < ArgumentError
attr_reader :key, :string
def initialize(key, string)
@key, @string = key, string
super "reserved key #{key.inspect} used in #{string.inspect}"
end
end
end

View File

@@ -0,0 +1,4 @@
dir = File.dirname(__FILE__)
require dir + '/i18n_test.rb'
require dir + '/simple_backend_test.rb'
require dir + '/i18n_exceptions_test.rb'

View File

@@ -0,0 +1,100 @@
$:.unshift "lib"
require 'rubygems'
require 'test/unit'
require 'mocha'
require 'i18n'
require 'active_support'
class I18nExceptionsTest < Test::Unit::TestCase
def test_invalid_locale_stores_locale
force_invalid_locale
rescue I18n::ArgumentError => e
assert_nil e.locale
end
def test_invalid_locale_message
force_invalid_locale
rescue I18n::ArgumentError => e
assert_equal 'nil is not a valid locale', e.message
end
def test_missing_translation_data_stores_locale_key_and_options
force_missing_translation_data
rescue I18n::ArgumentError => e
options = {:scope => :bar}
assert_equal 'de-DE', e.locale
assert_equal :foo, e.key
assert_equal options, e.options
end
def test_missing_translation_data_message
force_missing_translation_data
rescue I18n::ArgumentError => e
assert_equal 'translation missing: de-DE, bar, foo', e.message
end
def test_invalid_pluralization_data_stores_entry_and_count
force_invalid_pluralization_data
rescue I18n::ArgumentError => e
assert_equal [:bar], e.entry
assert_equal 1, e.count
end
def test_invalid_pluralization_data_message
force_invalid_pluralization_data
rescue I18n::ArgumentError => e
assert_equal 'translation data [:bar] can not be used with :count => 1', e.message
end
def test_missing_interpolation_argument_stores_key_and_string
force_missing_interpolation_argument
rescue I18n::ArgumentError => e
assert_equal 'bar', e.key
assert_equal "{{bar}}", e.string
end
def test_missing_interpolation_argument_message
force_missing_interpolation_argument
rescue I18n::ArgumentError => e
assert_equal 'interpolation argument bar missing in "{{bar}}"', e.message
end
def test_reserved_interpolation_key_stores_key_and_string
force_reserved_interpolation_key
rescue I18n::ArgumentError => e
assert_equal 'scope', e.key
assert_equal "{{scope}}", e.string
end
def test_reserved_interpolation_key_message
force_reserved_interpolation_key
rescue I18n::ArgumentError => e
assert_equal 'reserved key "scope" used in "{{scope}}"', e.message
end
private
def force_invalid_locale
I18n.backend.translate nil, :foo
end
def force_missing_translation_data
I18n.store_translations 'de-DE', :bar => nil
I18n.backend.translate 'de-DE', :foo, :scope => :bar
end
def force_invalid_pluralization_data
I18n.store_translations 'de-DE', :foo => [:bar]
I18n.backend.translate 'de-DE', :foo, :count => 1
end
def force_missing_interpolation_argument
I18n.store_translations 'de-DE', :foo => "{{bar}}"
I18n.backend.translate 'de-DE', :foo, :baz => 'baz'
end
def force_reserved_interpolation_key
I18n.store_translations 'de-DE', :foo => "{{scope}}"
I18n.backend.translate 'de-DE', :foo, :baz => 'baz'
end
end

View File

@@ -0,0 +1,141 @@
$:.unshift "lib"
require 'rubygems'
require 'test/unit'
require 'mocha'
require 'i18n'
require 'active_support'
class I18nTest < Test::Unit::TestCase
def setup
I18n.store_translations :'en-US', {
:currency => {
:format => {
:separator => '.',
:delimiter => ',',
}
}
}
end
def test_uses_simple_backend_set_by_default
assert_equal I18n::Backend::Simple, I18n.backend
end
def test_can_set_backend
assert_nothing_raised{ I18n.backend = self }
assert_equal self, I18n.backend
I18n.backend = I18n::Backend::Simple
end
def test_uses_en_us_as_default_locale_by_default
assert_equal 'en-US', I18n.default_locale
end
def test_can_set_default_locale
assert_nothing_raised{ I18n.default_locale = 'de-DE' }
assert_equal 'de-DE', I18n.default_locale
I18n.default_locale = 'en-US'
end
def test_uses_default_locale_as_locale_by_default
assert_equal I18n.default_locale, I18n.locale
end
def test_can_set_locale_to_thread_current
assert_nothing_raised{ I18n.locale = 'de-DE' }
assert_equal 'de-DE', I18n.locale
assert_equal 'de-DE', Thread.current[:locale]
I18n.locale = 'en-US'
end
def test_can_set_exception_handler
assert_nothing_raised{ I18n.exception_handler = :custom_exception_handler }
I18n.exception_handler = :default_exception_handler # revert it
end
def test_uses_custom_exception_handler
I18n.exception_handler = :custom_exception_handler
I18n.expects(:custom_exception_handler)
I18n.translate :bogus
I18n.exception_handler = :default_exception_handler # revert it
end
def test_delegates_translate_to_backend
I18n.backend.expects(:translate).with 'de-DE', :foo, {}
I18n.translate :foo, :locale => 'de-DE'
end
def test_delegates_localize_to_backend
I18n.backend.expects(:localize).with 'de-DE', :whatever, :default
I18n.localize :whatever, :locale => 'de-DE'
end
def test_delegates_store_translations_to_backend
I18n.backend.expects(:store_translations).with 'de-DE', {:foo => :bar}
I18n.store_translations 'de-DE', {:foo => :bar}
end
def test_delegates_populate_to_backend
I18n.backend.expects(:populate) # can't specify a block here as an expected argument
I18n.populate{ }
end
def test_populate_yields_the_block
tmp = nil
I18n.populate do tmp = 'yielded' end
assert_equal 'yielded', tmp
end
def test_translate_given_no_locale_uses_i18n_locale
I18n.backend.expects(:translate).with 'en-US', :foo, {}
I18n.translate :foo
end
def test_translate_on_nested_symbol_keys_works
assert_equal ".", I18n.t(:'currency.format.separator')
end
def test_translate_with_nested_string_keys_works
assert_equal ".", I18n.t('currency.format.separator')
end
def test_translate_with_array_as_scope_works
assert_equal ".", I18n.t(:separator, :scope => ['currency.format'])
end
def test_translate_with_array_containing_dot_separated_strings_as_scope_works
assert_equal ".", I18n.t(:separator, :scope => ['currency.format'])
end
def test_translate_with_key_array_and_dot_separated_scope_works
assert_equal [".", ","], I18n.t(%w(separator delimiter), :scope => 'currency.format')
end
def test_translate_with_dot_separated_key_array_and_scope_works
assert_equal [".", ","], I18n.t(%w(format.separator format.delimiter), :scope => 'currency')
end
def test_translate_with_options_using_scope_works
I18n.backend.expects(:translate).with('de-DE', :precision, :scope => :"currency.format")
I18n.with_options :locale => 'de-DE', :scope => :'currency.format' do |locale|
locale.t :precision
end
end
# def test_translate_given_no_args_raises_missing_translation_data
# assert_equal "translation missing: en-US, no key", I18n.t
# end
def test_translate_given_a_bogus_key_raises_missing_translation_data
assert_equal "translation missing: en-US, bogus", I18n.t(:bogus)
end
def test_localize_nil_raises_argument_error
assert_raises(I18n::ArgumentError) { I18n.l nil }
end
def test_localize_object_raises_argument_error
assert_raises(I18n::ArgumentError) { I18n.l Object.new }
end
end

View File

@@ -0,0 +1,376 @@
$:.unshift "lib"
require 'rubygems'
require 'test/unit'
require 'mocha'
require 'i18n'
module I18nSimpleBackendTestSetup
def setup_backend
@backend = I18n::Backend::Simple
@backend.send :class_variable_set, :@@translations, {}
@backend.store_translations 'en-US', :foo => {:bar => 'bar', :baz => 'baz'}
end
alias :setup :setup_backend
def add_datetime_translations
@backend.store_translations :'de-DE', {
:date => {
:formats => {
:default => "%d.%m.%Y",
:short => "%d. %b",
:long => "%d. %B %Y",
},
:day_names => %w(Sonntag Montag Dienstag Mittwoch Donnerstag Freitag Samstag),
:abbr_day_names => %w(So Mo Di Mi Do Fr Sa),
:month_names => %w(Januar Februar März April Mai Juni Juli August September Oktober November Dezember).unshift(nil),
:abbr_month_names => %w(Jan Feb Mar Apr Mai Jun Jul Aug Sep Okt Nov Dez).unshift(nil),
:order => [:day, :month, :year]
},
:time => {
:formats => {
:default => "%a, %d. %b %Y %H:%M:%S %z",
:short => "%d. %b %H:%M",
:long => "%d. %B %Y %H:%M",
},
:am => 'am',
:pm => 'pm'
},
:datetime => {
:distance_in_words => {
:half_a_minute => 'half a minute',
:less_than_x_seconds => ['less than 1 second', 'less than {{count}} seconds'],
:x_seconds => ['1 second', '{{count}} seconds'],
:less_than_x_minutes => ['less than a minute', 'less than {{count}} minutes'],
:x_minutes => ['1 minute', '{{count}} minutes'],
:about_x_hours => ['about 1 hour', 'about {{count}} hours'],
:x_days => ['1 day', '{{count}} days'],
:about_x_months => ['about 1 month', 'about {{count}} months'],
:x_months => ['1 month', '{{count}} months'],
:about_x_years => ['about 1 year', 'about {{count}} year'],
:over_x_years => ['over 1 year', 'over {{count}} years']
}
}
}
end
end
class I18nSimpleBackendTranslationsTest < Test::Unit::TestCase
include I18nSimpleBackendTestSetup
def test_store_translations_adds_translations # no, really :-)
@backend.store_translations :'en-US', :foo => 'bar'
assert_equal Hash[:'en-US', {:foo => 'bar'}], @backend.send(:class_variable_get, :@@translations)
end
def test_store_translations_deep_merges_translations
@backend.store_translations :'en-US', :foo => {:bar => 'bar'}
@backend.store_translations :'en-US', :foo => {:baz => 'baz'}
assert_equal Hash[:'en-US', {:foo => {:bar => 'bar', :baz => 'baz'}}], @backend.send(:class_variable_get, :@@translations)
end
def test_store_translations_forces_locale_to_sym
@backend.store_translations 'en-US', :foo => 'bar'
assert_equal Hash[:'en-US', {:foo => 'bar'}], @backend.send(:class_variable_get, :@@translations)
end
def test_store_translations_covert_key_symbols
@backend.send :class_variable_set, :@@translations, {} # reset translations
@backend.store_translations :'en-US', 'foo' => {'bar' => 'baz'}
assert_equal Hash[:'en-US', {:foo => {:bar => 'baz'}}],
@backend.send(:class_variable_get, :@@translations)
end
end
class I18nSimpleBackendTranslateTest < Test::Unit::TestCase
include I18nSimpleBackendTestSetup
def test_translate_calls_lookup_with_locale_given
@backend.expects(:lookup).with('de-DE', :bar, [:foo]).returns 'bar'
@backend.translate 'de-DE', :bar, :scope => [:foo]
end
def test_translate_given_a_symbol_as_a_default_translates_the_symbol
assert_equal 'bar', @backend.translate('en-US', nil, :scope => [:foo], :default => :bar)
end
def test_translate_given_an_array_as_default_uses_the_first_match
assert_equal 'bar', @backend.translate('en-US', :does_not_exist, :scope => [:foo], :default => [:does_not_exist_2, :bar])
end
def test_translate_an_array_of_keys_translates_all_of_them
assert_equal %w(bar baz), @backend.translate('en-US', [:bar, :baz], :scope => [:foo])
end
def test_translate_calls_pluralize
@backend.expects(:pluralize).with 'bar', 1
@backend.translate 'en-US', :bar, :scope => [:foo], :count => 1
end
def test_translate_calls_interpolate
@backend.expects(:interpolate).with 'bar', {}
@backend.translate 'en-US', :bar, :scope => [:foo]
end
def test_translate_calls_interpolate_including_count_as_a_value
@backend.expects(:interpolate).with 'bar', {:count => 1}
@backend.translate 'en-US', :bar, :scope => [:foo], :count => 1
end
def test_given_no_keys_it_returns_the_default
assert_equal 'default', @backend.translate('en-US', nil, :default => 'default')
end
def test_translate_given_nil_as_a_locale_raises_an_argument_error
assert_raises(I18n::InvalidLocale){ @backend.translate nil, :bar }
end
def test_translate_with_a_bogus_key_and_no_default_raises_missing_translation_data
assert_raises(I18n::MissingTranslationData){ @backend.translate 'de-DE', :bogus }
end
end
class I18nSimpleBackendLookupTest < Test::Unit::TestCase
include I18nSimpleBackendTestSetup
# useful because this way we can use the backend with no key for interpolation/pluralization
def test_lookup_given_nil_as_a_key_returns_nil
assert_nil @backend.send(:lookup, 'en-US', nil)
end
def test_lookup_given_nested_keys_looks_up_a_nested_hash_value
assert_equal 'bar', @backend.send(:lookup, 'en-US', :bar, [:foo])
end
end
class I18nSimpleBackendPluralizeTest < Test::Unit::TestCase
include I18nSimpleBackendTestSetup
def test_pluralize_given_nil_returns_the_given_entry
assert_equal ['bar', 'bars'], @backend.send(:pluralize, ['bar', 'bars'], nil)
end
def test_pluralize_given_0_returns_plural_string
assert_equal 'bars', @backend.send(:pluralize, ['bar', 'bars'], 0)
end
def test_pluralize_given_1_returns_singular_string
assert_equal 'bar', @backend.send(:pluralize, ['bar', 'bars'], 1)
end
def test_pluralize_given_2_returns_plural_string
assert_equal 'bars', @backend.send(:pluralize, ['bar', 'bars'], 2)
end
def test_pluralize_given_3_returns_plural_string
assert_equal 'bars', @backend.send(:pluralize, ['bar', 'bars'], 3)
end
def test_interpolate_given_invalid_pluralization_data_raises_invalid_pluralization_data
assert_raises(I18n::InvalidPluralizationData){ @backend.send(:pluralize, ['bar'], 2) }
end
end
class I18nSimpleBackendInterpolateTest < Test::Unit::TestCase
include I18nSimpleBackendTestSetup
def test_interpolate_given_a_value_hash_interpolates_the_values_to_the_string
assert_equal 'Hi David!', @backend.send(:interpolate, 'Hi {{name}}!', :name => 'David')
end
def test_interpolate_given_nil_as_a_string_returns_nil
assert_nil @backend.send(:interpolate, nil, :name => 'David')
end
def test_interpolate_given_an_non_string_as_a_string_returns_nil
assert_equal [], @backend.send(:interpolate, [], :name => 'David')
end
def test_interpolate_given_a_values_hash_with_nil_values_interpolates_the_string
assert_equal 'Hi !', @backend.send(:interpolate, 'Hi {{name}}!', {:name => nil})
end
def test_interpolate_given_an_empty_values_hash_raises_missing_interpolation_argument
assert_raises(I18n::MissingInterpolationArgument) { @backend.send(:interpolate, 'Hi {{name}}!', {}) }
end
def test_interpolate_given_a_string_containing_a_reserved_key_raises_reserved_interpolation_key
assert_raises(I18n::ReservedInterpolationKey) { @backend.send(:interpolate, '{{default}}', {:default => nil}) }
end
end
class I18nSimpleBackendLocalizeDateTest < Test::Unit::TestCase
include I18nSimpleBackendTestSetup
def setup
@backend = I18n::Backend::Simple
add_datetime_translations
@date = Date.new 2008, 1, 1
end
def test_translate_given_the_short_format_it_uses_it
assert_equal '01. Jan', @backend.localize('de-DE', @date, :short)
end
def test_translate_given_the_long_format_it_uses_it
assert_equal '01. Januar 2008', @backend.localize('de-DE', @date, :long)
end
def test_translate_given_the_default_format_it_uses_it
assert_equal '01.01.2008', @backend.localize('de-DE', @date, :default)
end
def test_translate_given_a_day_name_format_it_returns_a_day_name
assert_equal 'Dienstag', @backend.localize('de-DE', @date, '%A')
end
def test_translate_given_an_abbr_day_name_format_it_returns_an_abbrevated_day_name
assert_equal 'Di', @backend.localize('de-DE', @date, '%a')
end
def test_translate_given_a_month_name_format_it_returns_a_month_name
assert_equal 'Januar', @backend.localize('de-DE', @date, '%B')
end
def test_translate_given_an_abbr_month_name_format_it_returns_an_abbrevated_month_name
assert_equal 'Jan', @backend.localize('de-DE', @date, '%b')
end
def test_translate_given_no_format_it_does_not_fail
assert_nothing_raised{ @backend.localize 'de-DE', @date }
end
def test_translate_given_an_unknown_format_it_does_not_fail
assert_nothing_raised{ @backend.localize 'de-DE', @date, '%x' }
end
def test_localize_nil_raises_argument_error
assert_raises(I18n::ArgumentError) { @backend.localize 'de-DE', nil }
end
def test_localize_object_raises_argument_error
assert_raises(I18n::ArgumentError) { @backend.localize 'de-DE', Object.new }
end
end
class I18nSimpleBackendLocalizeDateTimeTest < Test::Unit::TestCase
include I18nSimpleBackendTestSetup
def setup
@backend = I18n::Backend::Simple
add_datetime_translations
@morning = DateTime.new 2008, 1, 1, 6
@evening = DateTime.new 2008, 1, 1, 18
end
def test_translate_given_the_short_format_it_uses_it
assert_equal '01. Jan 06:00', @backend.localize('de-DE', @morning, :short)
end
def test_translate_given_the_long_format_it_uses_it
assert_equal '01. Januar 2008 06:00', @backend.localize('de-DE', @morning, :long)
end
def test_translate_given_the_default_format_it_uses_it
assert_equal 'Di, 01. Jan 2008 06:00:00 +0000', @backend.localize('de-DE', @morning, :default)
end
def test_translate_given_a_day_name_format_it_returns_the_correct_day_name
assert_equal 'Dienstag', @backend.localize('de-DE', @morning, '%A')
end
def test_translate_given_an_abbr_day_name_format_it_returns_the_correct_abbrevated_day_name
assert_equal 'Di', @backend.localize('de-DE', @morning, '%a')
end
def test_translate_given_a_month_name_format_it_returns_the_correct_month_name
assert_equal 'Januar', @backend.localize('de-DE', @morning, '%B')
end
def test_translate_given_an_abbr_month_name_format_it_returns_the_correct_abbrevated_month_name
assert_equal 'Jan', @backend.localize('de-DE', @morning, '%b')
end
def test_translate_given_a_meridian_indicator_format_it_returns_the_correct_meridian_indicator
assert_equal 'am', @backend.localize('de-DE', @morning, '%p')
assert_equal 'pm', @backend.localize('de-DE', @evening, '%p')
end
def test_translate_given_no_format_it_does_not_fail
assert_nothing_raised{ @backend.localize 'de-DE', @morning }
end
def test_translate_given_an_unknown_format_it_does_not_fail
assert_nothing_raised{ @backend.localize 'de-DE', @morning, '%x' }
end
end
class I18nSimpleBackendLocalizeTimeTest < Test::Unit::TestCase
include I18nSimpleBackendTestSetup
def setup
@old_timezone, ENV['TZ'] = ENV['TZ'], 'UTC'
@backend = I18n::Backend::Simple
add_datetime_translations
@morning = Time.parse '2008-01-01 6:00 UTC'
@evening = Time.parse '2008-01-01 18:00 UTC'
end
def teardown
ENV['TZ'] = @old_timezone
end
def test_translate_given_the_short_format_it_uses_it
assert_equal '01. Jan 06:00', @backend.localize('de-DE', @morning, :short)
end
def test_translate_given_the_long_format_it_uses_it
assert_equal '01. Januar 2008 06:00', @backend.localize('de-DE', @morning, :long)
end
# TODO Seems to break on Windows because ENV['TZ'] is ignored. What's a better way to do this?
# def test_translate_given_the_default_format_it_uses_it
# assert_equal 'Di, 01. Jan 2008 06:00:00 +0000', @backend.localize('de-DE', @morning, :default)
# end
def test_translate_given_a_day_name_format_it_returns_the_correct_day_name
assert_equal 'Dienstag', @backend.localize('de-DE', @morning, '%A')
end
def test_translate_given_an_abbr_day_name_format_it_returns_the_correct_abbrevated_day_name
assert_equal 'Di', @backend.localize('de-DE', @morning, '%a')
end
def test_translate_given_a_month_name_format_it_returns_the_correct_month_name
assert_equal 'Januar', @backend.localize('de-DE', @morning, '%B')
end
def test_translate_given_an_abbr_month_name_format_it_returns_the_correct_abbrevated_month_name
assert_equal 'Jan', @backend.localize('de-DE', @morning, '%b')
end
def test_translate_given_a_meridian_indicator_format_it_returns_the_correct_meridian_indicator
assert_equal 'am', @backend.localize('de-DE', @morning, '%p')
assert_equal 'pm', @backend.localize('de-DE', @evening, '%p')
end
def test_translate_given_no_format_it_does_not_fail
assert_nothing_raised{ @backend.localize 'de-DE', @morning }
end
def test_translate_given_an_unknown_format_it_does_not_fail
assert_nothing_raised{ @backend.localize 'de-DE', @morning, '%x' }
end
end
class I18nSimpleBackendHelperMethodsTest < Test::Unit::TestCase
def setup
@backend = I18n::Backend::Simple
end
def test_deep_symbolize_keys_works
result = @backend.send :deep_symbolize_keys, 'foo' => {'bar' => {'baz' => 'bar'}}
expected = {:foo => {:bar => {:baz => 'bar'}}}
assert_equal expected, result
end
end