r18n-core 0.4.3 → 0.4.4

data/ChangeLog

@@ -1,3 +1,12 @@
+== 0.4.4 (Frank)
+* Use before filter to lazy set I18n object in Sinatra extension.
+* Set I18n object to thread (by Simon Hafner).
+* Add to l Rails helper R18n syntax.
+* Add common helpers.
+* Clear cache in R18n.reset.
+* Clean up code and fix bug (by Akzhan Abdulin).
+* Add Thai locale (by Felix Hanley).
+
 == 0.4.3 (Flange)
 * Add R18n style methods to Rails controllers.
 * Fix for non-string translations in Rails I18n.

data/README.rdoc

@@ -143,6 +143,24 @@ Sinatra, Merb and desktop applications.
 
 == Usage
 
+To add i18n support to your app, you can use special plugin for your
+environment: <tt>r18n-rails</tt>, <tt>sinatra-r18n</tt> or
+<tt>r18n-desktop</tt>.
+
+If you develop you own plugin or want to use only core gem, you must to create
+I18n object and set to global variable by <tt>R18n.set</tt> or to current thread
+by <tt>R18n.thread_set</tt>:
+
+  R18n.set(R18n::I18n.new('en', 'path/to/translations'))
+  
+You can add helpers to access to current I18n object:
+
+  include R18n::Helpers
+  
+  t.yes              #=> "Yes"
+  l Time.now, :human #=> "now"
+  r18n.locale.code   #=> "en"
+
 === Translation
 
 Translation files use YAML format and has name like en.yml (English) or

data/base/th.yml

@@ -0,0 +1,19 @@
+ok: OK
+save: บันทึก
+cancel: ยกเลิก
+'yes': ใช่
+'no': ไม่ใช่
+exit: ออก จาก
+delete: ลบ
+
+human_time:
+  after_days: หลงจาก %1 วัน
+  tomorrow: พรุ่งนี้
+  after_hours: หลงจาก %1 ชั่วโมง
+  after_minutes: หลงจาก %1 นาที
+  now: ตอน นี้
+  today: วัน นี้
+  minutes_ago: %1 นาที ที่ ผ่าน มา
+  hours_ago: %1 ชั่วโมง ที่ ผ่าน มา
+  yesterday: เมื่อ วาน
+  days_ago: %1 วัน ที่ ผ่าน มา

data/lib/r18n-core.rb

@@ -33,10 +33,12 @@ require dir + 'filters'
 require dir + 'translation'
 require dir + 'yaml_loader'
 require dir + 'i18n'
+require dir + 'helpers'
 
 module R18n
   class << self
-    # Set I18n object to current thread.
+
+    # Set I18n object globally.
     def set(i18n = nil, &block)
       if block_given?
         @setter = block
@@ -45,10 +47,32 @@ module R18n
         @i18n = i18n
       end
     end
-    
+
+    # Set I18n object to current thread.
+    def thread_set(i18n = nil, &block)
+      if block_given?
+        Thread.current[:r18n_setter] = block
+        Thread.current[:r18n_i18n] = nil
+      else
+        Thread.current[:r18n_i18n] = i18n
+      end
+    end
+
     # Get I18n object for current thread.
     def get
-      @i18n ||= (@setter.call if @setter)
+      (thread[:r18n_i18n] ||= ((block = thread[:r18n_setter]) && block.call)) ||
+      (@i18n ||= (@setter && @setter.call))
+    end
+
+    # Delete I18n object from current thread and global variable.
+    def reset
+      thread[:r18n_i18n] = thread[:r18n_setter] = @i18n = @setter = nil
+      self.cache = {}
+    end
+
+    # Get the current thread.
+    def thread
+      Thread.current
     end
 
     # Default loader class, which will be used if you didn’t send loader to

data/lib/r18n-core/helpers.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+=begin
+Mixin with common methods.
+
+Copyright (C) 2010 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 R18n
+  # Useful aliases. Set I18n object before use them:
+  # 
+  #   R18n.set R18n::I18n.new('en')
+  #   
+  #   t.ok               #=> "OK"
+  #   l Time.now, :human #=> "now"
+  #   r18n.locale.code   #=> "en"
+  module Helpers
+    # Get current I18n object.
+    def r18n
+      R18n.get
+    end
+    alias i18n r18n
+    
+    # Translate message. Alias for <tt>r18n.t</tt>.
+    def t(*params)
+      R18n.get.t(*params)
+    end
+    
+    # Localize object. Alias for <tt>r18n.l</tt>.
+    def l(*params)
+      R18n.get.l(*params)
+    end
+  end
+end

data/lib/r18n-core/i18n.rb

@@ -267,16 +267,6 @@ module R18n
       @translation
     end
     
-    # Short and pretty way to get translation by method name. If translation
-    # has name like object methods (+new+, +to_s+, +methods+) use <tt>[]</tt>
-    # method to access.
-    #
-    # 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)
-      @translation.send(name, *params)
-    end
-    
     # Return translation with special +name+.
     #
     # Translation can contain variable part. Just set is as <tt>%1</tt>,
@@ -284,5 +274,6 @@ module R18n
     def [](name, *params)
       @translation[name, *params]
     end
+    alias method_missing []
   end
 end

data/lib/r18n-core/translation.rb

@@ -124,16 +124,6 @@ module R18n
       default
     end
     
-    # Short and pretty way to get translation by method name. If translation
-    # has name like object methods (+new+, +to_s+, +methods+) use <tt>[]</tt>
-    # method to access.
-    #
-    # 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, *params]
-    end
-    
     # Return translation with special +name+.
     #
     # Translation can contain variable part. Just set is as <tt>%1</tt>,
@@ -153,5 +143,6 @@ module R18n
         value
       end
     end
+    alias method_missing []
   end
 end

data/lib/r18n-core/utils.rb

@@ -49,10 +49,10 @@ module R18n
     def self.deep_merge!(a, b)
       b.each_pair do |key, value|
         another = a[key]
-        if another.nil?
-          a[key] = value
-        elsif another.is_a?(Hash) and value.is_a?(Hash)
-          a[key] = deep_merge!(another, value)
+        a[key] = if another.is_a?(Hash) && value.is_a?(Hash)
+          deep_merge!(another, value)
+        else
+          value
         end
       end
       a

data/lib/r18n-core/version.rb

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

data/lib/r18n-core/yaml_loader.rb

@@ -51,8 +51,8 @@ module R18n
       # Return Hash with translations for +locale+.
       def load(locale)
         translations = {}
-        Dir.glob(File.join(@dir, "**/#{locale.code.downcase}.yml")).each do |i|
-          Utils.deep_merge!(translations, ::YAML::load_file(i))
+        Dir.glob(File.join(@dir, "**/#{locale.code.downcase}.yml")).each do |file_name|
+          Utils.deep_merge!(translations, ::YAML::load_file(file_name))
         end
         transform(translations)
       end
@@ -70,11 +70,14 @@ module R18n
       # Wrap YAML private types to Typed.
       def transform(a_hash)
         R18n::Utils.hash_map(a_hash) do |key, value|
-          [key, case value
-          when ::YAML::PrivateType then Typed.new(value.type_id, value.value)
-          when Hash                then transform(value)
-          else                          value
-          end]
+          [key,
+           case value
+             when ::YAML::PrivateType
+               Typed.new(value.type_id, value.value)
+             when Hash
+               transform(value)
+             else value
+           end]
         end
       end
     end

data/locales/th.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module R18n
+  class Locales::Th < R18n::Locale
+    set :title => 'ภาษาไทย',
+
+      :wday_names => %w{วันอาทิตย์ วันจันทร์ วันอังคาร วันพุธ วันพฤหัสบดี วันศุกร์ วันวัน วันเสาร์},
+      :wday_abbrs => %w{อาทิตย์ จันทร์ อังคาร พุธ พฤหัสบดี ศุกร์ เสาร์},
+
+      :month_names => %w{มกราคม กุมภาพันธ์ มีนาคม เมษายน พฤษภาคม มิถุนายน กรกฎาคม สิงหาคม กันยายน ตุลาคม พฤศจิกายน},
+      :month_abbrs => %w{ม.ค. ก.พ. มี.ค. เม.ย. พ.ค. มิ.ย. ก.ค. ส.ค. ก.ย. ต.ค. พ.ย. ธ.ค.},
+
+      :date_format => '%d/%m/%Y',
+      :full_format => '%e %B',
+      :year_format => '_, %Y',
+
+      :number_decimal => ".",
+      :number_group =>   ","
+    
+    def strftime(time, format)
+      year = (time.year + 543).to_s
+      super(time, format.gsub('%Y', year).gsub('%y', year[-2..-1]))
+    end
+  end
+end

data/spec/locales/cs_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-require File.join(File.dirname(__FILE__), '..', '..', 'locales', 'cs')
 
 describe R18n::Locales::Cs do
   it "should use Czech pluralization" do

data/spec/locales/en-us_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-require File.join(File.dirname(__FILE__), '..', '..', 'locales', 'en-us')
 
 describe R18n::Locales::EnUs do
   it "should format American English date" do

data/spec/locales/en_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-require File.join(File.dirname(__FILE__), '..', '..', 'locales', 'en')
 
 describe R18n::Locales::En do
   it "should format English date" do

data/spec/locales/fr_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-require File.join(File.dirname(__FILE__), '..', '..', 'locales', 'fr')
 
 describe R18n::Locales::Fr do
   it "should format French date" do

data/spec/locales/it_spec.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-require File.join(File.dirname(__FILE__), '..', '..', 'locales', 'it')
  
 describe R18n::Locales::It do
   it "should format Italian date" do

data/spec/locales/pl_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-require File.join(File.dirname(__FILE__), '..', '..', 'locales', 'pl')
 
 describe R18n::Locales::Pl do
   it "should use Polish pluralization" do

data/spec/locales/ru_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-require File.join(File.dirname(__FILE__), '..', '..', 'locales', 'ru')
 
 describe R18n::Locales::Ru do
   it "should use Russian pluralization" do

data/spec/locales/sk_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-require File.join(File.dirname(__FILE__), '..', '..', 'locales', 'sk')
 
 describe R18n::Locales::Sk do
   it "should use Slovak pluralization" do

data/spec/locales/th_spec.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe R18n::Locales::Ru do
+  it "should use Thai calendar" do
+    th = R18n::I18n.new('th')
+    th.l(Time.at(0).utc, '%Y %y').should ==  '2513 13'
+    th.l(Time.at(0).utc).should == '01/01/2513 00:00'
+  end
+end

data/spec/r18n_spec.rb

@@ -2,8 +2,11 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe R18n do
+  include R18n::Helpers
+    
   after do
     R18n.default_loader = R18n::Loader::YAML
+    R18n.reset
   end
 
   it "should store I18n" do
@@ -11,7 +14,7 @@ describe R18n do
     R18n.set(i18n)
     R18n.get.should == i18n
     
-    R18n.set(nil)
+    R18n.reset
     R18n.get.should be_nil
   end
   
@@ -24,7 +27,35 @@ describe R18n do
     
     R18n.get.should == i18n
   end
+
+  it "should store I18n via thread_set" do
+    i18n = R18n::I18n.new('en')
+    R18n.thread_set(i18n)
+    R18n.get.should == i18n
+    
+    R18n.reset
+    R18n.get.should be_nil
+  end
   
+  it "should reset I18n objects and cache" do
+    R18n.cache[:a] = 1
+    R18n.thread_set(R18n::I18n.new('en'))
+    
+    R18n.reset
+    R18n.get.should be_nil
+    R18n.cache.should be_empty
+  end
+
+  it "should thread_set setter to I18n" do
+    i18n = R18n::I18n.new('en')
+    R18n.thread_set(i18n)
+    
+    i18n = R18n::I18n.new('ru')
+    R18n.thread_set { i18n }
+    
+    R18n.get.should == i18n
+  end
+
   it "should store default loader class" do
     R18n.default_loader.should == R18n::Loader::YAML
     R18n.default_loader = Class
@@ -59,8 +90,18 @@ describe R18n do
     
     R18n::Utils.deep_merge!(a, b)
     a.should == { :a => 1,
-                  :b => { :ba => 1, :bb => 1, :bc => 2 },
-                  :c => 1 }
+                  :b => { :ba => 1, :bb => 2, :bc => 2 },
+                  :c => 2 }
+  end
+  
+  it "should have helpers" do
+    obj = R18n::I18n.new 'en'
+    R18n.set(obj)
+    
+    r18n.should == obj
+    i18n.should == obj
+    t.yes.should == 'Yes'
+    l(Time.at(0).utc).should == '01/01/1970 00:00'
   end
 
 end

data/spec/spec_helper.rb

@@ -5,11 +5,12 @@ require 'pp'
 dir = Pathname(__FILE__).dirname
 
 require dir + '../lib/r18n-core'
+Pathname.glob(dir.join('../locales/*.rb').to_s) { |locale| require locale }
 
-TRANSALTIONS = dir + 'translations'
-DIR = TRANSALTIONS + 'general' unless defined? DIR
-TWO = TRANSALTIONS + 'two' unless defined? TWO
-EXT = R18n::Loader::YAML.new(TRANSALTIONS + 'extension') unless defined? EXT
+TRANSLATIONS = dir + 'translations' unless defined? TRANSLATIONS
+DIR = TRANSLATIONS + 'general' unless defined? DIR
+TWO = TRANSLATIONS + 'two' unless defined? TWO
+EXT = R18n::Loader::YAML.new(TRANSLATIONS + 'extension') unless defined? EXT
 
 Spec::Runner.configure do |config|
   config.before { R18n.cache.clear }

data/spec/translations/extension/deep/en.yml

@@ -0,0 +1 @@
+deep: Deep one

data/spec/translations/extension/en.yml

@@ -1,2 +1,3 @@
 one: No one
 ext: Extension
+deep: "no"

data/spec/yaml_loader_spec.rb

@@ -32,7 +32,7 @@ describe R18n::Loader::YAML do
   end
   
   it "should load in dir recursively" do
-    loader = R18n::Loader::YAML.new(TRANSALTIONS)
+    loader = R18n::Loader::YAML.new(TRANSLATIONS)
     loader.available.should =~ [R18n::Locale.load('ru'),
                                 R18n::Locale.load('en'),
                                 R18n::Locale.load('fr'),
@@ -40,9 +40,10 @@ describe R18n::Loader::YAML do
                                 R18n::Locale.load('no-lc')]
     
     translation = loader.load(R18n::Locale.load('en'))
-    translation['one'].should       == 'One'
+    translation['two'].should       == 'Two'
     translation['in']['two'].should == 'Two'
     translation['ext'].should       == 'Extension'
+    translation['deep'].should      == 'Deep one'
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: r18n-core
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors: 
 - Andrey "A.I." Sitnik
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-26 00:00:00 +03:00
+date: 2010-03-29 00:00:00 +04:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +35,7 @@ files:
 - base/pt_br.yml
 - base/es.yml
 - base/fr.yml
+- base/th.yml
 - base/en.yml
 - base/zh.yml
 - lib/r18n-core.rb
@@ -49,6 +50,7 @@ files:
 - lib/r18n-core/unsupported_locale.rb
 - lib/r18n-core/locale.rb
 - lib/r18n-core/i18n.rb
+- lib/r18n-core/helpers.rb
 - locales/it.rb
 - locales/pl.rb
 - locales/en.rb
@@ -57,6 +59,7 @@ files:
 - locales/kk.rb
 - locales/en-us.rb
 - locales/zh.rb
+- locales/th.rb
 - locales/fr.rb
 - locales/ru.rb
 - locales/sk.rb
@@ -97,6 +100,7 @@ summary: I18n tool to translate your Ruby application.
 test_files: 
 - spec/translated_spec.rb
 - spec/locales/it_spec.rb
+- spec/locales/th_spec.rb
 - spec/locales/fr_spec.rb
 - spec/locales/sk_spec.rb
 - spec/locales/pl_spec.rb
@@ -115,6 +119,7 @@ test_files:
 - spec/translations/two/en.yml
 - spec/translations/extension/no-tr.yml
 - spec/translations/extension/en.yml
+- spec/translations/extension/deep/en.yml
 - spec/filters_spec.rb
 - spec/i18n_spec.rb
 - spec/locale_spec.rb