jro_apps/redmine Commit - r13425:3fcd683e6bad

Force UTF-8 encoding of language names....

Jean-Philippe Lang -

r13425:3fcd683e6bad

parent child

Context file:

r13425:3fcd683e6bad

Collapse all files

lib/redmine/i18n.rb +2 -1

             # Redmine - project management software
             # Copyright (C) 2006-2014  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             module Redmine
               module I18n
                 def self.included(base)
                   base.extend Redmine::I18n
                 end
                 def l(*args)
                   case args.size
                   when 1
                     ::I18n.t(*args)
                   when 2
                     if args.last.is_a?(Hash)
                       ::I18n.t(*args)
                     elsif args.last.is_a?(String)
                       ::I18n.t(args.first, :value => args.last)
                     else
                       ::I18n.t(args.first, :count => args.last)
                     end
                   else
                     raise "Translation string with multiple values: #{args.first}"
                   end
                 end
                 def l_or_humanize(s, options={})
                   k = "#{options[:prefix]}#{s}".to_sym
                   ::I18n.t(k, :default => s.to_s.humanize)
                 end
                 def l_hours(hours)
                   hours = hours.to_f
                   l((hours < 2.0 ? :label_f_hour : :label_f_hour_plural), :value => ("%.2f" % hours.to_f))
                 end
                 def ll(lang, str, value=nil)
                   ::I18n.t(str.to_s, :value => value, :locale => lang.to_s.gsub(%r{(.+)\-(.+)$}) { "#{$1}-#{$2.upcase}" })
                 end
                 def format_date(date)
                   return nil unless date
                   options = {}
                   options[:format] = Setting.date_format unless Setting.date_format.blank?
                   options[:locale] = User.current.language unless User.current.language.blank?
                   ::I18n.l(date.to_date, options)
                 end
                 def format_time(time, include_date = true)
                   return nil unless time
                   options = {}
                   options[:format] = (Setting.time_format.blank? ? :time : Setting.time_format)
                   options[:locale] = User.current.language unless User.current.language.blank?
                   time = time.to_time if time.is_a?(String)
                   zone = User.current.time_zone
                   local = zone ? time.in_time_zone(zone) : (time.utc? ? time.localtime : time)
                   (include_date ? "#{format_date(local)} " : "") + ::I18n.l(local, options)
                 end
                 def day_name(day)
                   ::I18n.t('date.day_names')[day % 7]
                 end
                 def day_letter(day)
                   ::I18n.t('date.abbr_day_names')[day % 7].first
                 end
                 def month_name(month)
                   ::I18n.t('date.month_names')[month]
                 end
                 def valid_languages
                   ::I18n.available_locales
                 end
                 # Returns an array of languages names and code sorted by names, example:
                 # [["Deutsch", "de"], ["English", "en"] ...]
                 #
                 # The result is cached to prevent from loading all translations files
                 # unless :cache => false option is given
                 def languages_options(options={})
-                  if options[:cache] == false
+                  options = if options[:cache] == false
                     valid_languages.
                       select {|locale| ::I18n.exists?(:general_lang_name, locale)}.
                       map {|lang| [ll(lang.to_s, :general_lang_name), lang.to_s]}.
                       sort {|x,y| x.first <=> y.first }
                   else
                     ActionController::Base.cache_store.fetch "i18n/languages_options/#{Redmine::VERSION}" do
                       languages_options :cache => false
                     end
                   end
+                  options.map {|name, lang| [name.force_encoding("UTF-8"), lang.force_encoding("UTF-8")]}
                 end
                 def find_language(lang)
                   @@languages_lookup = valid_languages.inject({}) {|k, v| k[v.to_s.downcase] = v; k }
                   @@languages_lookup[lang.to_s.downcase]
                 end
                 def set_language_if_valid(lang)
                   if l = find_language(lang)
                     ::I18n.locale = l
                   end
                 end
                 def current_language
                   ::I18n.locale
                 end
                 # Custom backend based on I18n::Backend::Simple with the following changes:
                 # * lazy loading of translation files
                 # * available_locales are determined by looking at translation file names
                 class Backend
                   (class << self; self; end).class_eval { public :include }
                   module Implementation
                     include ::I18n::Backend::Base
                     # 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, options = {})
                       locale = locale.to_sym
                       translations[locale] ||= {}
                       data = data.deep_symbolize_keys
                       translations[locale].deep_merge!(data)
                     end
                     # Get available locales from the translations filenames
                     def available_locales
                       @available_locales ||= ::I18n.load_path.map {|path| File.basename(path, '.*')}.uniq.sort.map(&:to_sym)
                     end
                     # Clean up translations
                     def reload!
                       @translations = nil
                       @available_locales = nil
                       super
                     end
                     protected
                     def init_translations(locale)
                       locale = locale.to_s
                       paths = ::I18n.load_path.select {|path| File.basename(path, '.*') == locale}
                       load_translations(paths)
                       translations[locale] ||= {}
                     end
                     def translations
                       @translations ||= {}
                     end
                     # 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 = [], options = {})
                       init_translations(locale) unless translations.key?(locale)
                       keys = ::I18n.normalize_keys(locale, key, scope, options[:separator])
                       keys.inject(translations) do |result, _key|
                         _key = _key.to_sym
                         return nil unless result.is_a?(Hash) && result.has_key?(_key)
                         result = result[_key]
                         result = resolve(locale, _key, result, options.merge(:scope => nil)) if result.is_a?(Symbol)
                         result
                       end
                     end
                   end
                   include Implementation
                   # Adds fallback to default locale for untranslated strings
                   include ::I18n::Backend::Fallbacks
                 end
               end
             end

test/unit/lib/redmine/i18n_test.rb +5 0

             # Redmine - project management software
             # Copyright (C) 2006-2014  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.expand_path('../../../../test_helper', __FILE__)
             class Redmine::I18nTest < ActiveSupport::TestCase
               include Redmine::I18n
               include ActionView::Helpers::NumberHelper
               def setup
                 User.current.language = nil
               end
               def teardown
                 set_language_if_valid 'en'
               end
               def test_date_format_default
                 set_language_if_valid 'en'
                 today = Date.today
                 with_settings :date_format => '' do
                   assert_equal I18n.l(today), format_date(today)
                 end
               end
               def test_date_format
                 set_language_if_valid 'en'
                 today = Date.today
                 with_settings :date_format => '%d %m %Y' do
                   assert_equal today.strftime('%d %m %Y'), format_date(today)
                 end
               end
               def test_date_format_default_with_user_locale
                 set_language_if_valid 'es'
                 today = now = Time.parse('2011-02-20 14:00:00')
                 with_settings :date_format => '%d %B %Y' do
                   User.current.language = 'fr'
                   s1 = "20 f\xc3\xa9vrier 2011".force_encoding("UTF-8")
                   assert_equal s1, format_date(today)
                   User.current.language = nil
                   assert_equal '20 Febrero 2011', format_date(today)
                 end
               end
               def test_date_and_time_for_each_language
                 with_settings :date_format => '' do
                   valid_languages.each do |lang|
                     set_language_if_valid lang
                     assert_nothing_raised "#{lang} failure" do
                       format_date(Date.today)
                       format_time(Time.now)
                       format_time(Time.now, false)
                       assert_not_equal 'default', ::I18n.l(Date.today, :format => :default),
                                        "date.formats.default missing in #{lang}"
                       assert_not_equal 'time',    ::I18n.l(Time.now, :format => :time),
                                        "time.formats.time missing in #{lang}"
                     end
                     assert l('date.day_names').is_a?(Array)
                     assert_equal 7, l('date.day_names').size
                     assert l('date.month_names').is_a?(Array)
                     assert_equal 13, l('date.month_names').size
                   end
                 end
               end
               def test_time_for_each_zone
                 ActiveSupport::TimeZone.all.each do |zone|
                   User.current.stubs(:time_zone).returns(zone.name)
                   assert_nothing_raised "#{zone} failure" do
                     format_time(Time.now)
                   end
                 end
               end
               def test_time_format
                 set_language_if_valid 'en'
                 now = Time.parse('2011-02-20 15:45:22')
                 with_settings :time_format => '%H:%M' do
                   with_settings :date_format => '' do
                     assert_equal '02/20/2011 15:45', format_time(now)
                     assert_equal '15:45', format_time(now, false)
                   end
                   with_settings :date_format => '%Y-%m-%d' do
                     assert_equal '2011-02-20 15:45', format_time(now)
                     assert_equal '15:45', format_time(now, false)
                   end
                 end
               end
               def test_time_format_default
                 set_language_if_valid 'en'
                 now = Time.parse('2011-02-20 15:45:22')
                 with_settings :time_format => '' do
                   with_settings :date_format => '' do
                     assert_equal '02/20/2011 03:45 PM', format_time(now)
                     assert_equal '03:45 PM', format_time(now, false)
                   end
                   with_settings :date_format => '%Y-%m-%d' do
                     assert_equal '2011-02-20 03:45 PM', format_time(now)
                     assert_equal '03:45 PM', format_time(now, false)
                   end
                 end
               end
               def test_time_format_default_with_user_locale
                 set_language_if_valid 'en'
                 User.current.language = 'fr'
                 now = Time.parse('2011-02-20 15:45:22')
                 with_settings :time_format => '' do
                   with_settings :date_format => '' do
                     assert_equal '20/02/2011 15:45', format_time(now)
                     assert_equal '15:45', format_time(now, false)
                   end
                   with_settings :date_format => '%Y-%m-%d' do
                     assert_equal '2011-02-20 15:45', format_time(now)
                     assert_equal '15:45', format_time(now, false)
                   end
                 end
               end
               def test_utc_time_format
                 set_language_if_valid 'en'
                 now = Time.now
                 with_settings :date_format => '%d %m %Y', :time_format => '%H %M' do
                   assert_equal now.strftime('%d %m %Y %H %M'), format_time(now.utc)
                   assert_equal now.strftime('%H %M'), format_time(now.utc, false)
                 end
               end
               def test_number_to_human_size_for_each_language
                 valid_languages.each do |lang|
                   set_language_if_valid lang
                   assert_nothing_raised "#{lang} failure" do
                     size = number_to_human_size(257024)
                     assert_match /251/, size
                   end
                 end
               end
               def test_day_name
                 set_language_if_valid 'fr'
                 assert_equal 'dimanche', day_name(0)
                 assert_equal 'jeudi', day_name(4)
               end
               def test_day_letter
                 set_language_if_valid 'fr'
                 assert_equal 'd', day_letter(0)
                 assert_equal 'j', day_letter(4)
               end
               def test_number_to_currency_for_each_language
                 valid_languages.each do |lang|
                   set_language_if_valid lang
                   assert_nothing_raised "#{lang} failure" do
                     number_to_currency(-1000.2)
                   end
                 end
               end
               def test_number_to_currency_default
                 set_language_if_valid 'bs'
                 assert_equal "KM -1000,20", number_to_currency(-1000.2)
                 set_language_if_valid 'de'
                 euro_sign = "\xe2\x82\xac".force_encoding('UTF-8')
                 assert_equal "-1000,20 #{euro_sign}", number_to_currency(-1000.2)
               end
               def test_valid_languages
                 assert valid_languages.is_a?(Array)
                 assert valid_languages.first.is_a?(Symbol)
               end
               def test_languages_options
                 options = languages_options
                 assert options.is_a?(Array)
                 assert_equal valid_languages.size, options.size
                 assert_nil options.detect {|option| !option.is_a?(Array)}
                 assert_nil options.detect {|option| option.size != 2}
                 assert_nil options.detect {|option| !option.first.is_a?(String) || !option.last.is_a?(String)}
                 assert_include ["English", "en"], options
                 ja = "Japanese (\xe6\x97\xa5\xe6\x9c\xac\xe8\xaa\x9e)".force_encoding('UTF-8')
                 assert_include [ja, "ja"], options
               end
+              def test_languages_options_should_return_strings_with_utf8_encoding
+                strings = languages_options.flatten
+                assert_equal ["UTF-8"], strings.map(&:encoding).uniq.map(&:name).sort
+              end
               def test_languages_options_should_ignore_locales_without_general_lang_name_key
                 stubs(:valid_languages).returns([:en, :foo])
                 assert_equal [["English", "en"]], languages_options(:cache => false)
               end
               def test_locales_validness
                 lang_files_count = Dir["#{Rails.root}/config/locales/*.yml"].size
                 assert_equal lang_files_count, valid_languages.size
                 valid_languages.each do |lang|
                   assert set_language_if_valid(lang)
                 end
                 set_language_if_valid('en')
               end
               def test_valid_language
                 to_test = {'fr' => :fr,
                            'Fr' => :fr,
                            'zh' => :zh,
                            'zh-tw' => :"zh-TW",
                            'zh-TW' => :"zh-TW",
                            'zh-ZZ' => nil }
                 to_test.each {|lang, expected| assert_equal expected, find_language(lang)}
               end
               def test_fallback
                 ::I18n.backend.store_translations(:en, {:untranslated => "Untranslated string"})
                 ::I18n.locale = 'en'
                 assert_equal "Untranslated string", l(:untranslated)
                 ::I18n.locale = 'fr'
                 assert_equal "Untranslated string", l(:untranslated)
                 ::I18n.backend.store_translations(:fr, {:untranslated => "Pas de traduction"})
                 ::I18n.locale = 'en'
                 assert_equal "Untranslated string", l(:untranslated)
                 ::I18n.locale = 'fr'
                 assert_equal "Pas de traduction", l(:untranslated)
               end
               def test_utf8
                 set_language_if_valid 'ja'
                 str_ja_yes  = "\xe3\x81\xaf\xe3\x81\x84".force_encoding('UTF-8')
                 i18n_ja_yes = l(:general_text_Yes)
                 assert_equal str_ja_yes, i18n_ja_yes
                 assert_equal "UTF-8", i18n_ja_yes.encoding.to_s
               end
               def test_traditional_chinese_locale
                 set_language_if_valid 'zh-TW'
                 str_tw = "Traditional Chinese (\xe7\xb9\x81\xe9\xab\x94\xe4\xb8\xad\xe6\x96\x87)".force_encoding('UTF-8')
                 assert_equal str_tw, l(:general_lang_name)
               end
               def test_french_locale
                 set_language_if_valid 'fr'
                 str_fr = "Fran\xc3\xa7ais".force_encoding('UTF-8')
                 assert_equal str_fr, l(:general_lang_name)
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages