rubi18n 0.3

data/lib/rubi18n/translated_string.rb

@@ -0,0 +1,33 @@
+=begin
+Translation string for i18n support.
+
+Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module Rubi18n
+  # String, which is translated to some locale and loading from Translation.
+  class TranslatedString < String
+    # String locale
+    attr_reader :locale
+    
+    # Returns a new string object containing a copy of str and translated to
+    # +locale+
+    def initialize(str, locale)
+      super(str)
+      @locale = locale
+    end
+  end
+end

data/lib/rubi18n/translation.rb

@@ -0,0 +1,269 @@
+=begin
+Translation to i18n support.
+
+Copyright (C) 2008 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require "pathname"
+require "yaml"
+
+module Rubi18n
+  # Translation for interface to i18n support.
+  #
+  # Translation files use YAML format and has name CODE.yml, where CODE is a
+  # language/country code (RFC 3066) like en_US. For example: en.yaml is a
+  # English translation, en_US.yml is a translation to USA English dialect.
+  #
+  # Rubi18n contain translations for common words (such as “OK”, “Cancel”, etc)
+  # for most supported locales. See <tt>base/</tt> dir.
+  #
+  # You may load several locales. Also for each locale will be load it 
+  # sublocales – languages, which user often know in this locale. For example,
+  # many, who speak on Frensh dialects in Canada can understand original French.
+  # Also many people in Belarus can understand Russian.
+  #
+  # Translated strinsg will have locale methods, which return Locale of locale 
+  # code if locale info file isn't exists.
+  #
+  # == Examples
+  # translations/fr.yaml
+  #
+  #   one: Un
+  #
+  # translations/ru.yaml
+  #
+  #   one: Один
+  #   two: Два
+  #
+  # translations/en.yaml
+  #
+  #   one: One
+  #   two: Two
+  #   three: Three
+  #   
+  #   entry:
+  #     between: Between %1 and %2
+  #   methods: Is %1 method
+  #   
+  #   comments: !!pl
+  #     0: no comments
+  #     1: one comment
+  #     n: %1 comments
+  #
+  #   sum: !!proc |x, y| "is #{x + y}"
+  #
+  # example.rb
+  #
+  #   i18n = Rubi18n::Translation.load(["fr", "ru"], "translations/")
+  #   i18n.one   #=> "Un"
+  #   i18n.two   #=> "Два"
+  #   i18n.three #=> "Three"
+  #   
+  #   i18n.three.locale["code"]      #=> "en"
+  #   i18n.three.locale["direction"] #=> "ltr"
+  #
+  #   i18n.entry.between(2, 3)    #=> "between 2 and 3"
+  #   i18n["methods", "object"]   #=> "Is object method"
+  #   
+  #   i18n.comments(0)            #=> "no comments"
+  #   i18n.comments(10)           #=> "10 comments"
+  #   
+  #   i18n.sum(2, 3) #=> "is 5"
+  #
+  # == Extention translations
+  # You can add dir with translations, which will be used with application
+  # translations. If application translations with same locale isn't exists 
+  # extention files willn't be used.
+  #
+  # It's useful for plugins for rubi18n. For example DB plugin may place
+  # translations for error messages in extention dir. Rubi18n contain 
+  # translations for base words as extention dir too.
+  class Translation
+    @@default = "en"
+
+    # Set default locale code to use when any user locales willn't be founded.
+    # It should has all translations and locale file.
+    def self.default=(locale)
+      @@default = locale
+    end
+
+    # Get default locale code
+    def self.default
+      @@default
+    end
+    
+    @@extension_translations = [
+      Pathname(__FILE__).dirname.expand_path + "../../base"]
+
+    # Get dirs with extention translations. If application translations with
+    # same locale isn't exists extention files willn't be used.
+    def self.extension_translations
+      @@extension_translations
+    end
+    
+    # Return available translations in +translations_dir+
+    def self.available(translations_dir)
+      Dir.glob(File.join(translations_dir, "*.yml")).map do |i|
+        File.basename(i, ".yml")
+      end
+    end
+
+    # Load locale and translations. +locales+ may be string for one user locale
+    # or array with many.
+    #
+    # It load all available translations in +translations_dir+, which exists in
+    # +locales+. Next it load all translations for +sublocales+ in locale info
+    # for all loaded translations.
+    #
+    # == Example
+    # +locales+ is ["fr", "uk"], translations are available for "fr", "be", "ru"
+    # and "en". Translation will be founding firstly in "fr" next in "be" and
+    # next in "ru" and "en" (because many Belarusians know Russian and "be"
+    # locale contain in +sublocales+ "ru" and "en").
+    def self.load(locales, translations_dir)
+      locales = locales.to_a if String == locales.class
+      locales << @@default
+      
+      locales += Locale.find(locales)["sublocales"]
+      locales.each_with_index do |locale, i|
+        # Add language locale for dialects
+        if "_" == locale[2..2]
+          locales.insert(i + 1, locale[0..1])
+        end
+      end
+      locales.uniq!
+      
+      locales &= self.available(translations_dir)
+      
+      translations = []
+      locales.map! do |locale|
+        locale.delete!("/", "\\")
+        
+        translation = {}
+        @@extension_translations.each do |dir|
+          file = File.join(dir, "#{locale}.yml")
+          translation.merge! YAML::load_file(file) if File.exists? file
+        end
+        file = File.join(translations_dir, "#{locale}.yml")
+        translation.merge! YAML::load_file(file)
+        translations << translation
+        
+        if Locale.exists? locale
+          Locale.new(locale)
+        else
+          locale
+        end
+      end
+  
+      self.new(locales, translations)
+    end
+    
+    # Default pluralization rule to translation without locale info
+    def self.pluralize(n)
+      n == 0 ? 0 : n == 1 ? 1 : 'n'
+    end
+    
+    # Create translation hash with messages in +translations+ for +locales+.
+    #
+    # This is internal contructor to load translation use
+    # Rubi18n::Translation.load(locales, translations_dir).
+    def initialize(locales, translations)
+      @locales = locales
+      @translations = translations
+    end
+    
+    # Short and pretty way to get traslation by method name. If translation
+    # has name of object methods ("methods", "strftime") use <tt>[]</tt> method 
+    # to access.
+    #
+    # Translation can contain variable part. Just set is as %1, %2 etc in
+    # translations file and set values as methods params.
+    def method_missing(name, *params)
+      self[name.to_s, *params]
+    end
+    
+    # Return traslation with special name.
+    #
+    # Translation can contain variable part. Just set is as %1, %2 etc in
+    # translations file and set values in next arguments.
+    def [](name, *params)
+      @translations.each_with_index do |translation, i|
+        result = translation[name]
+        next if result.nil?
+        
+        if YAML::PrivateType == result.class
+          case result.type_id
+          when "proc"
+            return eval("proc {#{result.value}}").call(*params)
+          when "pl"
+            pluralizator = @locales[i]
+            pluralizator = self.class if Locale != pluralizator.class
+            
+            params.each do |param|
+              type = pluralizator.pluralize(param)
+              type = "n" if not result.value.include? type
+              result = result.value[type]
+              break if YAML::PrivateType != result.class
+            end
+          else
+            return result
+          end
+        end
+        
+        if String == result.class
+          params.each_with_index do |param, i|
+            result.gsub! "%#{i+1}", param.to_s
+          end
+          return TranslatedString.new(result, @locales[i])
+        elsif Hash == result.class
+          return self.class.new(@locales, @translations.map { |i|
+            i[name] or {}
+          })
+        else
+          return result
+        end
+      end
+      
+      return nil
+    end
+
+    # Format +time+ according to the directives in the given format string and
+    # translate month, week days and meridian indicator (AM/PM) names (%A, %a, 
+    # %B, %b, %p directives).
+    #
+    # See <tt>Time.strftime()</tt> method docs for info about all directives.
+    def strftime(time, format)
+      translated = ""
+      format.scan(/%[EO]?.|./o) do |c|
+        case c.sub(/^%[EO]?(.)$/o, "%\\1")
+        when "%A"
+          translated << self.week.days[time.wday - 1]
+        when "%a"
+          translated << self.week.abbr_days[time.wday - 1]
+        when "%B"
+          translated << self.months.names[time.month - 1]
+        when "%b"
+          translated << self.months.abbr_names[time.month - 1]
+        when "%p"
+          translated << if time.hour < 12 then self.am else self.pm end
+        else
+          translated << c
+        end
+      end
+      time.strftime(translated)
+    end
+  end
+end

data/lib/rubi18n.rb

@@ -0,0 +1,29 @@
+=begin
+Main file to load all neccessary classes for i18n support.
+
+Copyright (C) 2008 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require "pathname"
+
+$KCODE = "u"
+
+dir = Pathname(__FILE__).dirname.expand_path + "rubi18n"
+
+require dir + "locale"
+require dir + "translation"
+require dir + "translated_string"
+require dir + "formatters"

data/locales/en.yml

@@ -0,0 +1,13 @@
+title: English
+code: en
+sublocales: []
+direction: ltr
+
+pluralization: "n == 0 ? 0 : n == 1 ? 1 : 'n'"
+
+week_start: sunday
+
+numbers:
+  separation: classic
+  decimal_separator: "."
+  group_delimiter: ","

data/locales/en_US.yml

@@ -0,0 +1,5 @@
+include: en
+
+code: en_US
+title: English (US)
+sublocales: [en]

data/locales/ru.yml

@@ -0,0 +1,13 @@
+title: Русский
+code: ru
+sublocales: [en]
+direction: ltr
+
+pluralization: "n==0 ? 0 : n%10==1 && n%100!=11 ? 1 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 2 : 'n'"
+
+week_start: monday
+
+numbers:
+  separation: classic
+  decimal_separator: ","
+  group_delimiter: " "

data/spec/formatters_spec.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Rubi18n::Formatters do
+
+  it "should format number in local traditions" do
+    Rubi18n::Locale.current = "en"
+    -123456789.to_ls.should == "−123,456,789"
+    
+    -123456789.to_ls(Rubi18n::Locale.new("ru")).should == "−123 456 789"
+  end
+
+  it "should format float in local traditions" do
+    Rubi18n::Locale.current = "en"
+    -12345.67.to_ls.should == "−12,345.67"
+    
+    -12345.67.to_ls(Rubi18n::Locale.new("ru")).should == "−12 345,67"
+  end
+
+end

data/spec/locale_spec.rb

@@ -0,0 +1,71 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Rubi18n::Locale do
+
+  it "should check is locale exists" do
+    Rubi18n::Locale.exists?("ru").should be_true
+    Rubi18n::Locale.exists?("no_LC").should be_false
+  end
+
+  it "should load locale" do
+    locale = Rubi18n::Locale.new "ru"
+    locale["code"].should == "ru"
+    locale["title"].should == "Русский"
+  end
+
+  it "should include locale by 'include' option" do
+    en_US = Rubi18n::Locale.new "en_US"
+    en = Rubi18n::Locale.new "en"
+    en_US["title"].should == "English (US)"
+    en["title"].should == "English"
+    en_US["week"].should == en["week"]
+  end
+
+  it "should raise error if locale isn't exists" do
+    lambda {
+      Rubi18n::Locale.new "no_LC"
+    }.should raise_error
+  end
+
+  it "should be equal to another locale with same code" do
+    ru = Rubi18n::Locale.new "ru"
+    en = Rubi18n::Locale.new "en"
+    another = Rubi18n::Locale.new "en"
+    en.should_not == ru
+    en.should == another
+  end
+
+  it "should print human readable representation" do
+    Rubi18n::Locale.new("ru").inspect.should == "Locale ru (Русский)"
+  end
+
+  it "should has current locale to use in +to_ls+ methods" do
+    en = Rubi18n::Locale.new "en"
+    Rubi18n::Locale.current = en
+    Rubi18n::Locale.current.should == en
+    Rubi18n::Locale.current = "en"
+    Rubi18n::Locale.current.should == en
+    Rubi18n::Locale.current = "ru"
+    Rubi18n::Locale.current.should_not == en
+  end
+
+  it "should return all available locales" do
+    Rubi18n::Locale.locales.sort.should == ["en", "en_US", "ru"]
+  end
+
+  it "should load first available locale" do
+    Rubi18n::Locale.find(["no_LC", "en", "ru"])["code"].should == "en"
+  end
+  
+  it "should find a short name of locale" do
+    Rubi18n::Locale.find("ru_RU.UTF-8")["code"].should == "ru"
+  end
+  
+  it "should return pluralization type by elements count" do
+    locale = Rubi18n::Locale.new "en"
+    locale.pluralize(0).should == 0
+    locale.pluralize(1).should == 1
+    locale.pluralize(:n).should == 'n'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "rubi18n")
+
+$KCODE = "u"

data/spec/translation_spec.rb

@@ -0,0 +1,106 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Rubi18n::Translation do
+  DIR = File.join(File.dirname(__FILE__), "translations", "general")
+  EXT = File.join(File.dirname(__FILE__), "translations", "extention")
+
+  it "should return all available translations" do
+    Rubi18n::Translation.available(DIR).sort.should == ["en", "fr", "no_LC", "ru"]
+  end
+
+  it "should has default locale to use when there aren't any user locales" do
+    Rubi18n::Translation.default = "en"
+    Rubi18n::Translation.default.should == "en"
+    Rubi18n::Translation.load("no_TR", DIR).one.should == "One"
+  end
+
+  it "should load translations" do
+    translation = Rubi18n::Translation.load("en", DIR)
+    translation.one.should == "One"
+    translation["one"].should == "One"
+  end
+  
+  it "should find in subtranslations" do
+    translation = Rubi18n::Translation.load(["fr", "ru"], DIR)
+    translation.one.should == "Un"
+    translation.two.should == "Два"
+    translation.three.should == "Three"
+  end
+  
+  it "should return nil if translation isn't found" do
+    translation = Rubi18n::Translation.load("en", DIR)
+    translation.without_translation.should be_nil
+  end
+  
+  it "should search language locale for dialect" do
+    translation = Rubi18n::Translation.load("fr_CA", DIR)
+    translation.one.should == "Un"
+  end
+
+  it "should can use params in translation" do
+    translation = Rubi18n::Translation.load("en", DIR)
+    translation.params(1, 2).should == "Is 1 between 1 and 2?"
+    translation["params", 1, 2].should == "Is 1 between 1 and 2?"
+  end
+  
+  it "should load use hierarchical translations" do
+    translation = Rubi18n::Translation.load(["ru", "en"], DIR)
+    translation.in.another.should == "Иерархический"
+    translation["in"]["another"].should == "Иерархический"
+    translation.only.english.should == "Only in English"
+  end
+  
+  it "should return string with locale info" do
+    translation = Rubi18n::Translation.load(["fr", "ru"], DIR)
+    translation.one.locale.should == "fr"
+    translation.two.locale.should == Rubi18n::Locale.new("ru")
+    translation.three.locale.should == Rubi18n::Locale.new("en")
+  end
+  
+  it "should use extention translations" do
+    Rubi18n::Translation.extension_translations << EXT
+    
+    translation = Rubi18n::Translation.load("en", DIR)
+    translation.ext.should == "Extention"
+    translation.one.should == "One"
+  end
+  
+  it "shouldn't use extention without app translations with same locale" do
+    Rubi18n::Translation.extension_translations << EXT
+    
+    translation = Rubi18n::Translation.load(["no_TR", "en"], DIR)
+    translation.ext.should == "Extention"
+  end
+  
+  it "should translate month, week days and am/pm names in strftime" do
+    translation = Rubi18n::Translation.load("ru", DIR)
+    
+    time = Time.at(0).utc
+    translation.strftime(time, "%a %A").should == 'Срд Среда'
+    translation.strftime(time, "%b %B").should == 'Янв Январь'
+    translation.strftime(time, "%H:%M%p").should == '00:00AM'
+  end
+  
+  it "should call proc in translation" do
+    translation = Rubi18n::Translation.load("en", DIR)
+    translation.sum(2, 3).should == 5
+  end
+  
+  it "should pluralize translation" do
+    translation = Rubi18n::Translation.load("en", DIR)
+    translation.comments(0, "article").should == "no comments for article"
+    translation.comments(1, "article").should == "one comment for article"
+    translation.comments(5, "article").should == "5 comments for article"
+    
+    translation.files(0).should == "0 files"
+    
+    translation.authors(1, 4).should == "One author with many comments"
+  end
+  
+  it "should pluralize translation without locale" do
+    translation = Rubi18n::Translation.load("no_LC", DIR)
+    translation.entries(1).should == "ONE"
+    translation.entries(5).should == "N"
+  end
+
+end

data/spec/translations/extention/en.yml

@@ -0,0 +1,2 @@
+one: No one
+ext: Extention

data/spec/translations/extention/no_TR.yml

@@ -0,0 +1 @@
+ext: NO

data/spec/translations/general/en.yml

@@ -0,0 +1,31 @@
+one: One
+two: Two
+three: Three
+
+params: Is %1 between %1 and %2?
+
+in:
+  another: Hierarchical
+
+only:
+  english: Only in English
+
+sum: !!proc |x, y| x + y
+
+comments: !!pl
+  0: no comments for %2
+  1: one comment for %2
+  n: %1 comments for %2
+
+files: !!pl
+  1: 1 file
+  n: %1 files
+
+authors: !!pl
+  0: No authors 
+  1: !!pl
+    1: One author with one comment
+    n: One author with many comments
+  n: !!pl
+    1: Many authors with one comment
+    n: Many authors with many comments

data/spec/translations/general/fr.yml

@@ -0,0 +1 @@
+one: Un

data/spec/translations/general/no_LC.yml

@@ -0,0 +1,4 @@
+entries: !!pl
+  1: ONE
+  2: TWO
+  n: N

data/spec/translations/general/ru.yml

@@ -0,0 +1,5 @@
+one: Один
+two: Два
+
+in:
+  another: Иерархический