r18n-core 0.3.2 → 0.4

data/lib/r18n-core/translation.rb

@@ -19,23 +19,15 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 =end
 
 require 'pathname'
-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)
-  # 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.
+  # Struct to containt translation with some type for filter.
+  Typed = Struct.new(:type, :value, :locale, :path)
+  
+  # Translation is container of translated messages.
   #
-  # You can use filters for some YAML type or for all strings. See R18n::Filters
-  # for details.
+  # 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.
   #
   # To get translation value use method with same name. If translation name
   # is equal with Object methods (+new+, +to_s+, +methods+) use
@@ -45,9 +37,6 @@ module R18n
   # 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.
-  #
   # == Examples
   # translations/ru.yml
   #
@@ -69,8 +58,6 @@ module R18n
   #
   # example.rb
   #
-  #   locales = [R18n::Locale.load('ru'), R18n::Locale.load('en')]
-  #   i18n = R18n::Translation.load(locales, 'translations/')
   #   i18n.one   #=> "Один"
   #   i18n.two   #=> "Two"
   #   
@@ -82,73 +69,50 @@ module R18n
   #   
   #   i18n.comments(0)            #=> "no comments"
   #   i18n.comments(10)           #=> "10 comments"
-  #
-  #   i18n.yes    #=> "Yes"
-  #   i18n.ok     #=> "OK"
-  #   i18n.cancel #=> "Cancel"
-  #
-  # == Extension translations
-  # For r18n plugin you can add dir with translations, which will be used with
-  # application translations. For example, DB plugin may place translations for
-  # error messages in extension dir. R18n contain translations for base words as
-  # extension dir too.
   class Translation
-    @@extension_translations = [
-      Pathname(__FILE__).dirname.expand_path + '../../base']
-
-    # Get dirs with extension translations. If application translations with
-    # same locale isn’t exists, extension file willn’t be used.
-    def self.extension_translations
-      @@extension_translations
+    # Create translation hash for +path+ with messages in +data+ for +locale+.
+    #
+    # This is internal a constructor. To load translation use
+    # <tt>R18n::Translation.load(locales, translations_dir)</tt>.
+    def initialize(main_locale, path = '', locale = nil, data = {})
+      @path = path
+      @data = {}
+      @locale = main_locale
+      merge! data, locale unless data.empty?
     end
     
-    # Return available translations in +dirs+
-    def self.available(dirs)
-      if dirs.is_a? Array
-        return dirs.inject([]) do |available, i|
-          available |= self.available(i)
-        end
-      end
-      
-      Dir.glob(File.join(dirs, '*.yml')).map do |i|
-        File.basename(i, '.yml')
-      end
-    end
-
-    # 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)
-      dirs = @@extension_translations + Array(dirs)
-      
-      available = self.available(dirs)
-      translations = []
-      locales.each do |locale|
-        next unless available.include? locale.code.downcase
-        translation = {}
-        dirs.each do |dir|
-          file = File.join(dir, "#{locale.code.downcase}.yml")
-          if File.exists? file
-            Utils.deep_merge! translation, YAML::load_file(file)
+    # Add another hash with +translations+ for some +locale+. Current data is
+    # more priority, that new one in +translations+.
+    def merge!(translations, locale)
+      translations.each_pair do |name, value|
+        if not @data.has_key? name
+          path = @path.empty? ? name : "#{@path}.#{name}"
+          case value
+          when Hash
+            value = Translation.new(@locale, path, locale, value)
+          when String
+            value = TranslatedString.new(value, locale, path)
+          when YAML::PrivateType
+            value = Typed.new(value.type_id, value.value, locale, path)
+          when Typed
+            value.locale = locale
+            value.path = path
           end
+          @data[name] = value
+        elsif @data[name].is_a? Translation
+          @data[name].merge! value, locale
         end
-        translations << translation
       end
-  
-      self.new(locales, translations)
     end
     
-    # Create translation hash for +path+ with messages in +translations+ for
-    # +locales+.
-    #
-    # This is internal a constructor. To load translation use
-    # <tt>R18n::Translation.load(locales, translations_dir)</tt>.
-    def initialize(locales, translations, path = '')
-      @locales = locales
-      @translations = translations
-      @path = path
+    # Use untranslated filter to print path.
+    def to_s
+      Filters.process(Untranslated, @path, @locale, @path, [@path, '', @path])
+    end
+    
+    # Return +default+.
+    def |(default)
+      default
     end
     
     # Short and pretty way to get translation by method name. If translation
@@ -158,7 +122,7 @@ module R18n
     # Translation can contain variable part. Just set is as <tt>%1</tt>,
     # <tt>%2</tt>, etc in translations file and set values as methods params.
     def method_missing(name, *params)
-      self[name.to_s, *params]
+      self[name, *params]
     end
     
     # Return translation with special +name+.
@@ -166,27 +130,19 @@ module R18n
     # Translation can contain variable part. Just set is as <tt>%1</tt>,
     # <tt>%2</tt>, etc in translations file and set values in next +params+.
     def [](name, *params)
-      path = @path.empty? ? name : "#{@path}.#{name}"
-      
-      @translations.each_with_index do |translation, i|
-        result = translation[name]
-        next unless result
-        
-        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
-          type = nil
-        end
-        
-         return Filters.process(result, @locales[i], path, type, params)
+      value = @data[name.to_s]
+      case value
+      when TranslatedString
+        Filters.process_string(value, @path, params)
+      when Typed
+        Filters.process(value.type, value.value, value.locale, value.path,
+                        params)
+      when nil
+        translated = @path.empty? ? '' : "#{@path}."
+        Untranslated.new(translated, name.to_s, @locale)
+      else
+        value
       end
-      
-      Untranslated.new(path, name, @locales)
     end
   end
 end

data/lib/r18n-core/unsupported_locale.rb

@@ -41,18 +41,6 @@ module R18n
     def inspect
       "Unsupported locale #{@code}"
     end
-
-    # Get information about locale.
-    def [](name)
-      case name
-      when 'code'
-        @code
-      when 'title'
-        @code
-      else
-        @base[name]
-      end
-    end
     
     # Locale RFC 3066 code.
     def code
@@ -64,7 +52,7 @@ module R18n
       @code
     end
 
-    # Is another locale has same code
+    # Is another locale has same code.
     def ==(locale)
       @code.downcase == locale.code.downcase
     end

data/lib/r18n-core/untranslated.rb

@@ -40,24 +40,25 @@ module R18n
   # 
   #   R18n::Filters.add(R18n::Untranslated, :hide_untranslated) { '' }
   class Untranslated
-    # Path to translation.
-    attr_reader :path
-    
     # Path, that isn’t in translation.
     attr_reader :untranslated_path
     
     # Path, that exists in translation.
     attr_reader :translated_path
     
-    def initialize(path, untranslated_path, locales)
-      @path = path
-      @locales = locales
+    def initialize(translated_path, untranslated_path, locale)
+      @translated_path = translated_path
       @untranslated_path = untranslated_path
-      @translated_path = path[0...(-untranslated_path.length)]
+      @locale = locale
     end
     
-    def nil?
-      true
+    # Path to translation.
+    def path
+      "#{@translated_path}#{@untranslated_path}"
+    end
+    
+    def translated?
+      false
     end
     
     def method_missing(*params)
@@ -65,16 +66,17 @@ module R18n
     end
     
     def [](*params)
-      Untranslated.new("#{@path}.#{params.first}",
-                       "#{@untranslated_path}.#{params.first}", @locales)
+      Untranslated.new(translated_path, "#{@untranslated_path}.#{params.first}",
+                       @locale)
+    end
+    
+    def |(default)
+      default
     end
     
     def to_s
-      config = OpenStruct.new(:locale  => @locales.first, :path => @path,
-                              :locales => @locales)
-      Filters.enabled[Untranslated].inject(@path) do |string, filter|
-        filter.call(string, config, @translated_path, @untranslated_path, @path)
-      end
+      Filters.process(Untranslated, path, @locale, path,
+                      [@translated_path, @untranslated_path, path])
     end
   end
 end

data/lib/r18n-core/utils.rb

@@ -21,18 +21,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # 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)

data/lib/r18n-core/version.rb

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

data/lib/r18n-core/yaml_loader.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+=begin
+Loader for YAML translations.
+
+Copyright (C) 2009 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 'yaml'
+
+module R18n
+  module Loader
+    # Loader for translations in YAML format. Them should have name like
+    # +en.yml+ (English) or en-US.yml (USA English dialect) with
+    # language/country code (RFC 3066).
+    # 
+    #   R18n::I18n.new('en', R18n::Loader::YAML.new('dir/with/translations'))
+    # 
+    # YAML loader is default loader, so you can just set constructor parameter
+    # to <tt>R18n::I18n.new</tt>:
+    # 
+    #   R18n::I18n.new('en', 'dir/with/translations')
+    class YAML
+      # Dir with translations.
+      attr_reader :dir
+      
+      # Create new loader for +dir+ with YAML translations.
+      def initialize(dir)
+        @dir = File.expand_path(dir)
+      end
+      
+      # Array of locales, which has translations in +dir+.
+      def available
+        Dir.glob(File.join(@dir, '*.yml')).map do |i|
+          R18n::Locale.load(File.basename(i, '.yml'))
+        end
+      end
+      
+      # Return Hash with translations for +locale+.
+      def load(locale)
+        ::YAML::load(IO.read(File.join(@dir, "#{locale.code.downcase}.yml")))
+      end
+      
+      # YAML loader with same +dir+ will be have same +hash+.
+      def hash
+        self.class.hash + @dir.hash
+      end
+      
+      # Is another +loader+ load YAML translations from same +dir+.
+      def ==(loader)
+        self.class == loader.class and self.dir == loader.dir
+      end
+    end
+  end
+end

data/lib/r18n-core.rb

@@ -31,18 +31,40 @@ require dir + 'translated_string'
 require dir + 'untranslated'
 require dir + 'filters'
 require dir + 'translation'
+require dir + 'yaml_loader'
 require dir + 'i18n'
 
 module R18n
   class << self
     # Set I18n object to current thread.
-    def set(i18n)
-      Thread.current['i18n'] = i18n
+    def set(i18n = nil, &block)
+      if block_given?
+        @setter = block
+        @i18n = nil
+      else
+        @i18n = i18n
+      end
     end
     
     # Get I18n object for current thread.
     def get
-      Thread.current['i18n']
+      @i18n ||= (@setter.call if @setter)
     end
+
+    # Default loader class, which will be used if you didn’t send loader to
+    # +I18n.new+ (object with +available+ and +load+ methods).
+    attr_accessor :default_loader
+
+    # Loaders with extension translations. If application translations with
+    # same locale isn’t exists, extension file willn’t be used.
+    attr_accessor :extension_places
+    
+    # Hash of hash-like (see Moneta) object to store loaded translations.
+    attr_accessor :cache
   end
+  
+  self.default_loader = R18n::Loader::YAML
+  self.extension_places = [
+      Loader::YAML.new(Pathname(__FILE__).dirname.expand_path + '../base')]
+  self.cache = {}
 end

data/locales/cs.rb

@@ -1,21 +1,35 @@
+# encoding: utf-8
 module R18n
-  module Locales
-    class Cs < R18n::Locale
-      def pluralize(n)
-        return 0 if n == 0
-        # 0 - 0
-        # 1 - 1
-        # 2..4 - 2
-        # n
+  class Locales::Cs < Locale
+    set :title => 'Český',
+        :sublocales => %w{cz sk en},
+        
+        :wday_names => %w{Neděle Pondělí Úterý Středa Čtvrtek Pátek Sobota},
+        :wday_abbrs => %w{Ne Po Út St Čt Pá So},
+        
+        :month_names => %w{Ledna Února Března Dubna Května Června Července Srpna
+                           Září Října Listopadu Prosince},
+        :month_abbrs => %w{Led Úno Bře Dub Kvě Čer Čvc Srp Zář Říj Lis Pro},
+        :month_standalone => %w{Leden Únor Březen Duben Květen Červen Červenec
+                                Srpen Září Říjen Listopad Prosinec},
+        
+        :time_am => 'dop.',
+        :time_pm => 'odp.',
+        :date_format => '%d.%m.%Y',
+        
+        :number_decimal => ",",
+        :number_group   => " "
     
-        case n
-        when 1
-          1
-        when 2..4
-          2
-        else
-          'n'
-        end
+    def pluralize(n)
+      case n
+      when 0
+        0
+      when 1
+        1
+      when 2..4
+        2
+      else
+        'n'
       end
     end
   end

data/locales/de.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module R18n
+  class Locales::De < Locale
+    set :title => 'Deutsch',
+        
+        :wday_names => %w{Sonntag Montag Dienstag Mittwoch Donnerstag Freitag
+                          Samstag},
+        :wday_abbrs => %w{So Mo Di Mi Do Fr Sa},
+        
+        :month_names => %w{Januar Februar März April Mai Juni Juli August
+                           September Oktober November Dezember},
+        :month_abbrs => %w{Jan Feb Mär Apr Mai Jun Jul Aug Sep Okt Nov Dez},
+        
+        :time_am => 'vormittags',
+        :time_pm => 'nachmittags',
+        :date_format => '%d.%m.%Y',
+        
+        :number_decimal => ",",
+        :number_group   => "."
+  end
+end

data/locales/en-us.rb

@@ -1,8 +1,13 @@
 require File.join(File.dirname(__FILE__), 'en')
 
-module R18n
-  module Locales
-    class EnUs < En
-    end
+module R18n::Locales
+  class EnUs < En
+    set :title => 'English (US)',
+        :code =>  'en-US',
+        :sublocales => %w{en},
+        
+        :time_format => ' %I:%M %p',
+        :date_format => '%m/%d/%Y',
+        :full_format => '%B %e'
   end
 end

data/locales/en.rb

@@ -1,26 +1,41 @@
 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
+  class Locales::En < Locale
+    set :title => 'English',
+        :sublocales => [],
+        
+        :week_start => :sunday,
+        :wday_names => %w{Sunday Monday Tuesday Wednesday Thursday Friday
+                          Saturday},
+        :wday_abbrs => %w{Sun Mon Tue Wed Thu Fri Sat},
+        
+        :month_names => %w{January February March April May June July August
+                           September October November December},
+        :month_abbrs => %w{Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec},
+        
+        :date_format => '%d/%m/%Y',
+        :full_format => '%e of %B',
+        :year_format => '_, %Y',
+        
+        :number_decimal => ".",
+        :number_group =>   ","
+    
+    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
-      
-      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
+    
+    def format_date_full(date, year = true, *params)
+      format = full_format
+      format = year_format.sub('_', format) if year
+      strftime(date, format.sub('%e', ordinalize(date.mday)))
     end
   end
 end

data/locales/eo.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module R18n
+  class Locales::Eo < Locale
+    set :title => 'Esperanto',
+        
+        :wday_names => %w{dimanĉo lundo mardo merkredo ĵaŭdo vendredo sabato},
+        :wday_abbrs => %w{dim lun mar mer ĵaŭ ven seb},
+        
+        :month_names => %w{januaro februaro marto aprilo majo junio julio
+                           aŭgusto septembro oktobro novembro decembro},
+        :month_abbrs => %w{jan feb mar apr maj jun jul aŭg sep okt nov dec},
+        
+        :date_format => '%Y-%m-%d',
+        :full_format => 'la %e-a de %B',
+        :year_format => '_ de %Y',
+        
+        :number_decimal => ".",
+        :number_group   => " "
+  end
+end

data/locales/es.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module R18n
+  class Locales::Es < Locale
+    set :title => 'Español',
+        
+        :wday_names => %w{domingo lunes martes miércoles jueves viernes sábado},
+        :wday_abbrs => %w{dom lun mar mie jue mie sab},
+        
+        :month_names => %w{Enero Febrero Marzo Abril Mayo Junio Julio Agosto
+                           Septiembre Octubre Noviembre Diciembre},
+        :month_abbrs => %w{ene feb mar abr may jun jul ago sep oct nov dic},
+        
+        :date_format => '%d/%m/%Y',
+        :full_format => '%d de %B',
+        :year_format => '_ de %Y',
+        
+        :number_decimal => ",",
+        :number_group   => "."
+  end
+end

data/locales/fr.rb

@@ -1,13 +1,28 @@
+# encoding: utf-8
 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
+  class Locales::Fr < Locale
+    set :title => 'Français',
+        
+        :wday_names => %w{dimanche lundi mardi mercredi jeudi vendredi samedi},
+        :wday_abbrs => %w{dim lun mar mer jeu ven sam},
+        
+        :month_names => %w{janvier février mars avril mai juin juillet août
+                         septembre octobre novembre décembre},
+        :month_abbrs => %w{jan fév mar avr mai jun jui aoû sep oct nov déc},
+        :month_standalone => %w{Janvier Février Mars Avril Mai Juin Juillet Août
+                                Septembre Octobre Novembre Décembre},
+        
+        :date_format => '%d/%m/%Y',
+        
+        :number_decimal => ",",
+        :number_group   => " "
+    
+    def format_date_full(date, year = true, *params)
+      full = super(date, year)
+      if ' 1' == full[0..1]
+        '1er' + full[2..-1] 
+      else
+        full
       end
     end
   end