r18n-core 0.2.3 → 0.3

data/lib/r18n-core/translation.rb

@@ -24,25 +24,26 @@ require 'yaml'
 module R18n
   # Translation for interface to i18n support. You can load several locales and
   # if translation willn’t be found in first, r18n will be search it in next.
+  # Use R18n::I18n.new to load translations.
   #
   # Translation files use YAML format and has name like en.yml (English) or
-  # en_US.yml (USA English dialect) with language/country code (RFC 3066). In
-  # translation file you can use strings, numbers, floats (any YAML types),
-  # procedures (<tt>!!proc</tt>) and pluralizable values (<tt>!!pl</tt>). You
-  # can use params in string values, which you can replace in program. Just
-  # write <tt>%1</tt>, <tt>%2</tt>, etc and set it values as method arguments,
-  # when you will be get value.
+  # en-US.yml (USA English dialect) with language/country code (RFC 3066). In
+  # translation file you can use strings, numbers, floats (any YAML types)
+  # and pluralizable values (<tt>!!pl</tt>). You can use params in string
+  # values, which you can replace in program. Just write <tt>%1</tt>,
+  # <tt>%2</tt>, etc and set it values as method arguments, when you will be get
+  # value.
   #
-  # If in your system procedures in translations willn’t be secure (user can
-  # upoad or edit it) set <tt>R18n::Translation.call_proc</tt> to false.
+  # You can use filters for some YAML type or for all strings. See R18n::Filters
+  # for details.
   #
   # To get translation value use method with same name. If translation name
   # is equal with Object methods (+new+, +to_s+, +methods+) use
   # <tt>[name, params…]</tt>. If you want to get pluralizable value, just set
   # value for pluralization in first argument of method. See samples below.
   #
-  # Translated strings will have +locale+ methods, which return Locale or it
-  # code, if locale file isn’t exists.
+  # Translated strings will have +locale+ methods, which return Locale or
+  # UnsupportedLocale, if locale file isn’t exists.
   #
   # R18n contain translations for common words (such as “OK”, “Cancel”, etc)
   # for most supported locales. See <tt>base/</tt> dir.
@@ -66,24 +67,21 @@ module R18n
   #     1: one comment
   #     n: %1 comments
   #
-  #   sum: !!proc |x, y| "is #{x + y}"
-  #
   # example.rb
   #
-  #   i18n = R18n::Translation.load(['ru', 'en'], 'translations/')
+  #   locales = [R18n::Locale.load('ru'), R18n::Locale.load('en')]
+  #   i18n = R18n::Translation.load(locales, 'translations/')
   #   i18n.one   #=> "Один"
   #   i18n.two   #=> "Two"
   #   
-  #   i18n.two.locale['code']      #=> "en"
-  #   i18n.two.locale['direction'] #=> "ltr"
+  #   i18n.two.locale.code      #=> "en"
+  #   i18n.two.locale.ltr?      #=> "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"
   #
   #   i18n.yes    #=> "Yes"
   #   i18n.ok     #=> "OK"
@@ -97,8 +95,6 @@ module R18n
   class Translation
     @@extension_translations = [
       Pathname(__FILE__).dirname.expand_path + '../../base']
-      
-    @@call_proc = true
 
     # Get dirs with extension translations. If application translations with
     # same locale isn’t exists, extension file willn’t be used.
@@ -119,41 +115,31 @@ module R18n
       end
     end
 
-    # Load all available translations for +locales+. +Locales+ may be a string
-    # with one user locale or array with many. +Dirs+ may be an array or
-    # a string with path to dir with translations.
+    # Load all available translations for +locales+. +Locales+ must be Locale or
+    # UnsupportedLocale instance or an array them. +Dirs+ may be an array or a
+    # string with path to dir with translations.
+    # 
+    # To load translations use R18n::I18n.new method, which is more usable.
     def self.load(locales, dirs)
-      locales = Array(locales) & self.available(dirs)
       dirs = @@extension_translations + Array(dirs)
       
+      available = self.available(dirs)
       translations = []
-      locales.map! do |locale|
+      locales.each do |locale|
+        next unless available.include? locale.code.downcase
         translation = {}
         dirs.each do |dir|
-          file = File.join(dir, "#{locale}.yml")
+          file = File.join(dir, "#{locale.code.downcase}.yml")
           if File.exists? file
             Utils.deep_merge! translation, YAML::load_file(file)
           end
         end
         translations << translation
-        
-        Locale.load(locale)
       end
   
       self.new(locales, translations)
     end
     
-    # Is procedures in translations will be call. Set to false if user can
-    # upload or edit translations.
-    def self.call_proc=(call)
-      @@call_proc = call
-    end
-    
-    # Is procedures in translations will be call
-    def self.call_proc
-      @@call_proc
-    end
-    
     # Create translation hash for +path+ with messages in +translations+ for
     # +locales+.
     #
@@ -184,49 +170,23 @@ module R18n
       
       @translations.each_with_index do |translation, i|
         result = translation[name]
-        next if result.nil?
-        
-        if result.is_a? YAML::PrivateType
-          case result.type_id
-          when 'proc'
-            if @@call_proc
-              return eval("proc {#{result.value}}").call(*params)
-            else
-              return result.value
-            end
-          when 'pl'
-            locale = @locales[i]
-            
-            type = locale.pluralize(params.first)
-            if params.first.is_a? Float
-              params[0] = locale.format_float(params.first)
-            elsif params.first.is_a? Integer
-              params[0] = locale.format_integer(params.first)
-            end
-            
-            type = 'n' if not result.value.include? type
-            result = result.value[type]
-          else
-            return result
-          end
-        end
+        next unless result
         
-        if result.is_a? String
-          result = result.clone
-          params.each_with_index do |param, i|
-            result.gsub! "%#{i+1}", param.to_s
-          end
-          return TranslatedString.new(result, @locales[i], path)
-        elsif result.is_a? Hash
+        if result.is_a? Hash
           return self.class.new(@locales, @translations.map { |i|
             i[name] or {}
           }, path)
+        elsif result.is_a? YAML::PrivateType
+          type = result.type_id
+          result = result.value
         else
-          return result.clone
+          type = nil
         end
+        
+         return Filters.process(result, @locales[i], path, type, params)
       end
       
-      return Untranslated.new(path, name)
+      Untranslated.new(path, name)
     end
   end
 end

data/lib/r18n-core/unsupported_locale.rb

@@ -22,38 +22,56 @@ module R18n
   # Locale without information file. Contain only it code, empty title and data
   # from default locale.
   class UnsupportedLocale
+    # Locale, to get data and pluralization for unsupported locale.
+    attr_accessor :base
+    
     # Create object for unsupported locale with +code+ and load other locale
-    # data from default locale.
-    def initialize(code)
-      @@default_locale ||= Locale.load(I18n.default)
+    # data from +base+ locale.
+    def initialize(code, base = nil)
       @code = code
+      @base = Locale.load(I18n.default) if @code != I18n.default
+    end
+    
+    # Is locale has information file. In this class always return false.
+    def supported?
+      false
     end
     
-    # Human readable locale code and title
+    # Human readable locale code and title.
     def inspect
       "Unsupported locale #{@code}"
     end
 
-    # Get information about locale
+    # Get information about locale.
     def [](name)
       case name
       when 'code'
         @code
       when 'title'
-        ''
+        @code
       else
-        @@default_locale[name]
+        @base[name]
       end
     end
+    
+    # Locale RFC 3066 code.
+    def code
+      @code
+    end
+    
+    # Locale code as title.
+    def title
+      @code
+    end
 
     # Is another locale has same code
     def ==(locale)
-      @code == locale['code']
+      @code.downcase == locale.code.downcase
     end
     
     #  Proxy to default locale object.
     def method_missing(name, *params)
-      @@default_locale.send(name, *params)
+      @base.send(name, *params)
     end
   end
 end

data/lib/r18n-core/utils.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+=begin
+Common methods 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
+
+# Common methods for another R18n code.
+module R18n
+  module Utils
+    # Recursively hash merge.
+    def self.deep_merge!(a, b)
+      b.each_pair do |name, value|
+        if a[name].is_a? Hash
+          self.deep_merge!(a[name], value)
+        else
+          a[name] = value
+        end
+      end
+      a
+    end
+    
+    # Convert Time to Date. Backport from Ruby 1.9.
+    def self.to_date(time)
+      jd = Date.send(:civil_to_jd, time.year, time.mon, time.mday, Date::ITALY)
+      Date.new!(Date.send(:jd_to_ajd, jd, 0, 0), 0, Date::ITALY)
+    end
+    
+    HTML_ENTRIES = { '&'=>'&amp;', '<'=>'&lt;', '>'=>'&gt;' }
+    
+    # Escape HTML entries (<, >, &). Copy from HAML helper.
+    def self.escape_html(content)
+      content.to_s.gsub(/[><&]/) { |s| HTML_ENTRIES[s] }
+    end
+  end
+end

data/lib/r18n-core/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module R18n
-  VERSION = '0.2.3' unless defined? R18n::VERSION
+  VERSION = '0.3' unless defined? R18n::VERSION
 end

data/lib/r18n-core.rb

@@ -24,10 +24,12 @@ require 'pathname'
 
 dir = Pathname(__FILE__).dirname.expand_path + 'r18n-core'
 require dir + 'version'
+require dir + 'utils'
 require dir + 'locale'
 require dir + 'unsupported_locale'
 require dir + 'translated_string'
 require dir + 'untranslated'
+require dir + 'filters'
 require dir + 'translation'
 require dir + 'i18n'
 
@@ -61,19 +63,5 @@ module R18n
     attr_accessor :untranslated
   end
   
-  self.untranslated = '%1'
-  
-  module Utils
-    # Recursively hash merge.
-    def self.deep_merge!(a, b)
-      b.each_pair do |name, value|
-        if a[name].is_a? Hash
-          self.deep_merge!(a[name], value)
-        else
-          a[name] = value
-        end
-      end
-      a
-    end
-  end
+  self.untranslated = '%2[%3]'
 end

data/locales/cs.rb

@@ -0,0 +1,23 @@
+module R18n
+  module Locales
+    class Cs < R18n::Locale
+      def pluralize(n)
+        return 0 if n == 0
+        # 0 - 0
+        # 1 - 1
+        # 2..4 - 2
+        # n
+    
+        case n
+        when 1
+          1
+        when 2..4
+          2
+        else
+          'n'
+        end
+      end
+    end
+  end
+end
+

data/locales/cs.yml

@@ -0,0 +1,26 @@
+title: Český
+code: cs
+sublocales: [cz, sk]
+direction: ltr
+
+week:
+  start: monday
+  days: [Neděle, Pondělí, Úterý, Středa, Čtvrtek, Pátek, Sobota]
+  abbrs: [Ne, Po, Út, St, Čt, Pá, So]
+
+months:
+  names: [Ledna, Února, Března, Dubna, Května, Června, Července, Srpna, Září, Října, Listopadu, Prosince]
+  abbrs: [Led, Úno, Bře, Dub, Kvě, Čer, Čvc, Srp, Zář, Říj, Lis, Pro]
+  standalone: [Leden, Únor, Březen, Duben, Květen, Červen, Červenec, Srpen, Září, Říjen, Listopad, Prosinec]
+
+time:
+  am: dop.
+  pm: odp.
+  time: " %H:%M"
+  date: "%d.%m.%Y"
+  full: "%e %B"
+  year: "_ %Y"
+
+numbers:
+  decimal_separator: ","
+  group_delimiter: " "

data/locales/de.yml

@@ -16,15 +16,10 @@ months:
 time:
   am: vormittags 
   pm: nachmittags
-
-formats:
-  time: "%H:%M"
+  time: " %H:%M"
   date: "%d.%m.%Y"
-  short_date: "%d %b"
-  long_date: "%d %B %Y"
-  datetime: "%a %d %b %Y %H:%M:%S %Z"
-  short_datetime: "%d %b %H:%M"
-  long_datetime: "%d %B %Y %H:%M"
+  full: "%e %B %Y"
+  year: "_ %Y"
 
 numbers:
   decimal_separator: ","

data/locales/en-us.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), 'en')
+
+module R18n
+  module Locales
+    class EnUs < En
+    end
+  end
+end

data/locales/en-us.yml

@@ -0,0 +1,9 @@
+include: en
+
+code: en-US
+title: English (US)
+sublocales: [en]
+
+time:
+  date: "%m/%d/%Y"
+  full: "%B %e"

data/locales/en.rb

@@ -0,0 +1,26 @@
+module R18n
+  module Locales
+    class En < R18n::Locale
+      def ordinalize(n)
+        if (11..13).include?(n % 100)
+          "#{n}th"
+        else
+          case n % 10
+          when 1; "#{n}st"
+          when 2; "#{n}nd"
+          when 3; "#{n}rd"
+          else "#{n}th"
+          end
+        end
+      end
+      
+      def format_date_full(i18n, date, year = true)
+        format = @data['time']['full']
+        if year
+          format = @data['time']['year'].sub('_', format)
+        end
+        strftime(date, format.sub('%e', ordinalize(date.mday)))
+      end
+    end
+  end
+end

data/locales/en.yml

@@ -16,15 +16,10 @@ months:
 time:
   am: AM
   pm: PM
-
-formats:
-  time: "%H:%M"
+  time: " %H:%M"
   date: "%d/%m/%Y"
-  short_date: "%d %b"
-  long_date: "%d %B, %Y"
-  datetime: "%a %d %b %H:%M:%S %Z %Y"
-  short_datetime: "%d %b %H:%M"
-  long_datetime: "%d %B, %Y %H:%M"
+  full: "%e of %B"
+  year: "_, %Y"
 
 numbers:
   decimal_separator: "."

data/locales/eo.yml

@@ -16,15 +16,10 @@ months:
 time:
   am: AM
   pm: PM
-
-formats:
-  time: "%H:%M"
+  time: " %H:%M"
   date: "%Y-%m-%d"
-  short_date: "%d %b"
-  long_date: "la %d-a de %B de %Y"
-  datetime: "%a, %d %b %Y, %H:%M:%S %Z"
-  short_datetime: "%d %b, %H:%M"
-  long_datetime: "la %d-a de %B de %Y, %H:%M"
+  full: "la %e-a de %B"
+  year: "_ de %Y"
 
 numbers:
   decimal_separator: "."

data/locales/fr.rb

@@ -0,0 +1,14 @@
+module R18n
+  module Locales
+    class Fr < R18n::Locale
+      def format_date_full(i18n, date, year = true)
+        full = super(i18n, date, year)
+        if ' 1' == full[0..1]
+          '1er' + full[2..-1] 
+        else
+          full
+        end
+      end
+    end
+  end
+end

data/locales/fr.yml

@@ -16,15 +16,10 @@ months:
 time:
   am: AM
   pm: PM
-
-formats:
-  time: "%H:%M"
+  time: " %H:%M"
   date: "%d/%m/%Y"
-  short_date: "%d %b"
-  long_date: "%d %B %Y"
-  datetime: "%a %d %b %Y %H:%M:%S %Z"
-  short_datetime: "%d %b %H:%M"
-  long_datetime: "%d %B %Y %H:%M"
+  full: "%e %B"
+  year: "_ %Y"
 
 numbers:
   decimal_separator: ","

data/locales/kk.yml

@@ -16,15 +16,10 @@ months:
 time:
   am: " ертеңің"
   pm: " кештің"
-
-formats:
-  time: "%H:%M"
+  time: " %H:%M"
   date: "%Y-%m-%d"
-  short_date: "%b %d"
-  long_date: "%Y жылы %B %d-і"
-  datetime: "%a, %Y ж. %b %d-і, %H:%M:%S %Z"
-  short_datetime: "%b %d, %H:%M"
-  long_datetime: "%Y жылы %B %d-і, %H:%M"
+  full: "%Y %B %e-і"
+  year: "%Y жылы _"
 
 numbers:
   decimal_separator: ","

data/locales/pl.yml

@@ -1,10 +1,8 @@
 title: Polski
 code: pl
-sublocales: []
+sublocales: [en]
 direction: ltr
 
-pluralization: "n == 0 ? 0 : n == 1 ? 1 : 'n'"
-
 week:
   start: monday
   days: [Niedziela, Poniedziałek, Wtorek, Sroda, Czwartek, Piątek, Sobota]
@@ -18,15 +16,10 @@ months:
 time:
   am: AM
   pm: PM
-
-formats:
-  time: "%H:%M"
+  time: " %H:%M"
   date: "%d/%m/%Y"
-  short_date: "%d %b"
-  long_date: "%d %B, %Y"
-  datetime: "%a %d %b %H:%M:%S %Z %Y"
-  short_datetime: "%d %b %H:%M"
-  long_datetime: "%d %B, %Y %H:%M"
+  full: "%e %B"
+  year: "_ %Y"
 
 numbers:
   decimal_separator: "."

data/locales/ru.yml

@@ -16,15 +16,10 @@ months:
 time:
   am: " утра"
   pm: " вечера"
-
-formats:
-  time: "%H:%M"
+  time: " %H:%M"
   date: "%d.%m.%Y"
-  short_date: "%d %b"
-  long_date: "%d %B %Y"
-  datetime: "%a, %d %b %Y, %H:%M:%S %Z"
-  short_datetime: "%d %b, %H:%M"
-  long_datetime: "%d %B %Y, %H:%M"
+  full: "%e %B"
+  year: "_ %Y"
 
 numbers:
   decimal_separator: ","