fast_gettext 0.7.1 → 0.8.0

data/lib/fast_gettext/storage.rb

@@ -13,8 +13,7 @@ module FastGettext
     [:available_locales, :_locale, :text_domain, :pluralisation_rule].each do |method_name|
       key = "fast_gettext_#{method_name}".to_sym
       define_method "#{method_name}=" do |value|
-        Thread.current[key]=value
-        update_current_cache
+        update_current_cache if Thread.current[key] != Thread.current[key]=value
       end
     end
 

data/lib/fast_gettext/translation.rb

@@ -17,15 +17,15 @@ module FastGettext
       klas.extend self
     end
 
-    def _(key)
-      FastGettext.cached_find(key) or key
+    def _(key, &block)
+      FastGettext.cached_find(key) or (block ? block.call : key)
     end
 
     #translate pluralized
     # some languages have up to 4 plural forms...
     # n_(singular, plural, plural form 2, ..., count)
     # n_('apple','apples',3)
-    def n_(*keys)
+    def n_(*keys, &block)
       count = keys.pop
       translations = FastGettext.cached_plural_find(*keys)
 
@@ -38,15 +38,15 @@ module FastGettext
       elsif keys[selected]
         _(keys[selected])
       else
-        keys.last
+        block ? block.call : keys.last
       end
     end
 
     #translate, but discard namespace if nothing was found
     # Car|Tire -> Tire if no translation could be found
-    def s_(key,separator=nil)
+    def s_(key, separator=nil, &block)
       translation = FastGettext.cached_find(key) and return translation
-      key.split(separator||NAMESPACE_SEPARATOR).last
+      block ? block.call : key.split(separator||NAMESPACE_SEPARATOR).last
     end
 
     #tell gettext: this string need translation (will be found during parsing)
@@ -59,8 +59,92 @@ module FastGettext
       keys
     end
 
-    def ns_(*args)
-      n_(*args).split(NAMESPACE_SEPARATOR).last
+    def ns_(*args, &block)
+      translation = n_(*args, &block)
+      # block is called once again to compare result
+      block && translation == block.call ? translation : translation.split(NAMESPACE_SEPARATOR).last
+    end
+  end
+
+  # this module should be included for multi-domain support
+  module TranslationMultidomain
+    extend self
+
+    #make it usable in class definition, e.g.
+    # class Y
+    #   include FastGettext::TranslationMultidomain
+    #   @@x = d_('domain', 'y')
+    # end
+    def self.included(klas)  #:nodoc:
+      klas.extend self
+    end
+
+    # helper block for changing domains
+    def _in_domain domain
+      old_domain = FastGettext.text_domain
+      FastGettext.text_domain = domain
+      yield if block_given?
+    ensure
+      FastGettext.text_domain = old_domain
+    end
+
+    # gettext functions to translate in the context of given domain
+    def d_(domain, key, &block)
+      _in_domain domain do
+        FastGettext::Translation._(key, &block)
+      end
+    end
+
+    def dn_(domain, *keys, &block)
+      _in_domain domain do
+        FastGettext::Translation.n_(*keys, &block)
+      end
+    end
+
+    def ds_(domain, key, separator=nil, &block)
+      _in_domain domain do
+        FastGettext::Translation.s_(key, separator, &block)
+      end
+    end
+
+    def dns_(domain, *keys, &block)
+      _in_domain domain do
+        FastGettext::Translation.ns_(*keys, &block)
+      end
+    end
+
+    # gettext functions to translate in the context of any domain
+    # (note: if mutiple domains contains key, random translation is returned)
+    def D_(key)
+      FastGettext.translation_repositories.each_key do |domain|
+        result = FastGettext::TranslationMultidomain.d_(domain, key) {nil}
+        return result unless result.nil?
+      end
+      key
+    end
+
+    def Dn_(*keys)
+      FastGettext.translation_repositories.each_key do |domain|
+        result = FastGettext::TranslationMultidomain.dn_(domain, *keys) {nil}
+        return result unless result.nil?
+      end
+      keys[-3].split(keys[-2]||NAMESPACE_SEPARATOR).last
+    end
+
+    def Ds_(key, separator=nil)
+      FastGettext.translation_repositories.each_key do |domain|
+        result = FastGettext::TranslationMultidomain.ds_(domain, key, separator) {nil}
+        return result unless result.nil?
+      end
+      key.split(separator||NAMESPACE_SEPARATOR).last
+    end
+
+    def Dns_(*keys)
+      FastGettext.translation_repositories.each_key do |domain|
+        result = FastGettext::TranslationMultidomain.dns_(domain, *keys) {nil}
+        return result unless result.nil?
+      end
+      keys[-2].split(NAMESPACE_SEPARATOR).last
     end
   end
 end

data/lib/fast_gettext/translation_repository/db_models/translation_key.rb

@@ -1,3 +1,5 @@
+require "protected_attributes" if ActiveRecord::VERSION::MAJOR >= 4
+
 class TranslationKey < ActiveRecord::Base
   has_many :translations, :class_name => 'TranslationText', :dependent => :destroy
 
@@ -17,7 +19,13 @@ class TranslationKey < ActiveRecord::Base
   end
 
   def self.available_locales
-    @@available_locales ||= TranslationText.count(:group=>:locale).keys.sort
+    @@available_locales ||= begin
+      if ActiveRecord::VERSION::MAJOR >= 3
+        TranslationText.group(:locale).count
+      else
+        TranslationText.count(:group=>:locale)
+      end.keys.sort
+    end
   end
 
   protected

data/lib/fast_gettext/translation_repository/db_models/translation_text.rb

@@ -1,3 +1,5 @@
+require "protected_attributes" if ActiveRecord::VERSION::MAJOR >= 4
+
 class TranslationText < ActiveRecord::Base
   belongs_to :translation_key, :class_name => 'TranslationKey'
   validates_presence_of :locale

data/lib/fast_gettext/version.rb

@@ -1,3 +1,3 @@
 module FastGettext
-  VERSION = Version = '0.7.1'
+  VERSION = Version = '0.8.0'
 end

data/spec/fast_gettext/storage_spec.rb

@@ -61,7 +61,7 @@ describe 'Storage' do
 
   describe :pluralisation_rule do
     it "defaults to singular-if-1 when it is not set" do
-      stub!(:current_repository).and_return mock('',:pluralisation_rule=>nil)
+      should_receive(:current_repository).at_least(1).and_return double(:pluralisation_rule => nil)
       self.pluralisation_rule = nil
       pluralisation_rule.call(1).should == false
       pluralisation_rule.call(0).should == true
@@ -256,8 +256,8 @@ describe 'Storage' do
       FastGettext.text_domain = 'xxx'
       FastGettext.available_locales = ['de','en']
       FastGettext.locale = 'de'
-      FastGettext.current_repository.stub!(:"[]").with('abc').and_return 'old'
-      FastGettext.current_repository.stub!(:"[]").with('unfound').and_return nil
+      FastGettext.current_repository.stub(:"[]").with('abc').and_return 'old'
+      FastGettext.current_repository.stub(:"[]").with('unfound').and_return nil
       FastGettext._('abc')
       FastGettext._('unfound')
       FastGettext.locale = 'en'
@@ -333,7 +333,6 @@ describe 'Storage' do
 
     it "does not overwrite an existing cache value" do
       current_cache['xxx']='xxx'
-      stub!(:current_repository).and_return 'xxx'=>'1'
       key_exist?('xxx')
       current_cache['xxx'].should == 'xxx'
     end

data/spec/fast_gettext/translation_repository/chain_spec.rb

@@ -36,9 +36,9 @@ describe 'FastGettext::TranslationRepository::Chain' do
   describe "filled chain" do
     before do
       @one = MockRepo.new
-      @one.stub!(:singular).with('xx').and_return 'one'
+      @one.stub(:singular).with('xx').and_return 'one'
       @two = MockRepo.new
-      @two.stub!(:singular).with('xx').and_return 'two'
+      @two.stub(:singular).with('xx').and_return 'two'
       @rep = FastGettext::TranslationRepository.build('chain', :chain=>[@one, @two], :type=>:chain)
     end
 

data/spec/fast_gettext/translation_repository/mo_spec.rb

@@ -31,11 +31,11 @@ describe 'FastGettext::TranslationRepository::Mo' do
     it "can reload" do
       FastGettext.locale = 'de'
 
-      @rep['Untranslated'].should be_nil
+      @rep['Untranslated and translated in test2'].should be_nil
 
       @rep.reload
 
-      @rep['Untranslated'].should == 'Translated'
+      @rep['Untranslated and translated in test2'].should == 'Translated'
     end
 
     it "returns true" do
@@ -51,6 +51,8 @@ describe 'FastGettext::TranslationRepository::Mo' do
   end
 
   it "can work in SAFE mode" do
-    `ruby spec/cases/safe_mode_can_handle_locales.rb 2>&1`.should == 'true'
+    pending_if RUBY_VERSION > "2.0" do
+      `ruby spec/cases/safe_mode_can_handle_locales.rb 2>&1`.should == 'true'
+    end
   end
 end

data/spec/fast_gettext/translation_repository/yaml_spec.rb

@@ -61,7 +61,7 @@ describe 'FastGettext::TranslationRepository::Yaml' do
   end
 
   it "can be used to translate plural forms" do
-    FastGettext.stub!(:current_repository).and_return @rep
+    FastGettext.stub(:current_repository).and_return @rep
     FastGettext.n_('cars.axis','cars.axis',2).should == 'Achsen'
     FastGettext.n_('cars.axis',2).should == 'Achsen'
     FastGettext.n_('cars.axis',1).should == 'Achse'
@@ -69,8 +69,8 @@ describe 'FastGettext::TranslationRepository::Yaml' do
 
   4.times do |i|
     it "can be used to do wanky pluralisation rules #{i}" do
-      FastGettext.stub!(:current_repository).and_return @rep
-      @rep.stub!(:pluralisation_rule).and_return lambda{|x| i}
+      FastGettext.stub(:current_repository).and_return @rep
+      @rep.stub(:pluralisation_rule).and_return lambda{|x| i}
       FastGettext.n_('cars.silly',1).should == i.to_s # cars.silly translations are 0,1,2,3
     end
   end

data/spec/fast_gettext/translation_spec.rb

@@ -2,6 +2,7 @@ require "spec_helper"
 
 describe FastGettext::Translation do
   include FastGettext::Translation
+  include FastGettext::TranslationMultidomain
 
   before do
     default_setup
@@ -42,6 +43,14 @@ describe FastGettext::Translation do
     it "does not return the gettext meta information" do
       _('').should == ''
     end
+
+    it "returns nil when specified" do
+      _('not found'){nil}.should be_nil
+    end
+
+    it "returns block when specified" do
+      _('not found'){:block}.should == :block
+    end
   end
 
   describe :n_ do
@@ -85,6 +94,10 @@ describe FastGettext::Translation do
       FastGettext.pluralisation_rule = lambda{|x|4}
       n_('Apple','Apples',2).should == 'Apples'
     end
+
+    it "returns block when specified" do
+      n_('not found'){:block}.should == :block
+    end
   end
 
   describe :s_ do
@@ -99,6 +112,10 @@ describe FastGettext::Translation do
     it "can use a custom seperator" do
       s_("XXX/not found",'/').should == "not found"
     end
+
+    it "returns block when specified" do
+      s_('not found'){:block}.should == :block
+    end
   end
 
   describe :N_ do
@@ -117,13 +134,181 @@ describe FastGettext::Translation do
     it "translates whith namespace" do
       ns_('Fruit|Apple','Fruit|Apples',2).should == 'Apples'
     end
+
+    it "returns block when specified" do
+      ns_('not found'){:block}.should == :block
+      ns_('not found'){nil}.should be_nil
+    end
   end
 
+  describe :multi_domain do
+    before do
+      setup_extra_domain
+    end
+
+    describe :_in_domain do
+      it "changes domain via in_domain" do
+        Thread.current[:fast_gettext_text_domain].should == "test"
+        _in_domain "fake" do
+          Thread.current[:fast_gettext_text_domain].should == "fake"
+        end
+        Thread.current[:fast_gettext_text_domain].should == "test"
+      end
+    end
+
+    describe :d_ do
+      it "translates simple text" do
+        d_('test', 'car').should == 'Auto'
+      end
+
+      it "translates simple text in different domain" do
+        d_('test2', 'car').should == 'Auto 2'
+      end
+
+      it "translates simple text in different domain one transaction" do
+        d_('test', 'car').should == 'Auto'
+        d_('test2', 'car').should == 'Auto 2'
+      end
+
+      it "returns the original string if its translation is blank" do
+        d_('test', 'Untranslated').should == 'Untranslated'
+      end
+
+      it "sets text domain back to previous one" do
+        old_domain = FastGettext.text_domain
+        d_('test2', 'car').should == 'Auto 2'
+        FastGettext.text_domain.should == old_domain
+      end
+
+      it "returns appropriate key if translation is not found in a domain" do
+        FastGettext.translation_repositories['fake'] = {}
+        d_('fake', 'car').should == 'car'
+      end
+    end
+
+    describe :dn_ do
+      before do
+        FastGettext.pluralisation_rule = nil
+      end
+
+      it "translates pluralized" do
+        dn_('test', 'Axis','Axis',1).should == 'Achse'
+        dn_('test2', 'Axis','Axis',1).should == 'Achse 2'
+      end
+
+      it "returns a simple translation when no combined was found" do
+        dn_('test', 'Axis','NOTFOUNDs',1).should == 'Achse'
+        dn_('test2', 'Axis','NOTFOUNDs',1).should == 'Achse 2'
+      end
+
+      it "returns the appropriate key if no translation was found" do
+        dn_('test', 'NOTFOUND','NOTFOUNDs',1).should == 'NOTFOUND'
+        dn_('test', 'NOTFOUND','NOTFOUNDs',2).should == 'NOTFOUNDs'
+      end
+
+      it "returns the last key when no translation was found and keys where to short" do
+        FastGettext.pluralisation_rule = lambda{|x|4}
+        dn_('test', 'Apple','Apples',2).should == 'Apples'
+      end
+    end
+
+    describe :ds_ do
+      it "translates simple text" do
+        ds_('test2', 'car').should == 'Auto 2'
+        ds_('test', 'car').should == 'Auto'
+      end
+
+      it "returns cleaned key if a translation was not found" do
+        ds_('test2', "XXX|not found").should == "not found"
+      end
+
+      it "can use a custom seperator" do
+        ds_('test2', "XXX/not found",'/').should == "not found"
+      end
+    end
+
+    describe :dns_ do
+      it "translates whith namespace" do
+        dns_('test', 'Fruit|Apple','Fruit|Apples',2).should == 'Apples'
+        dns_('test2', 'Fruit|Apple','Fruit|Apples',2).should == 'Apples'
+      end
+    end
+  end
+
+  describe :multidomain_all do
+    before do
+      setup_extra_domain
+    end
+
+    describe :D_ do
+      it "translates simple text" do
+        D_('not found').should == 'not found'
+        D_('only in test2 domain').should == 'nur in test2 Domain'
+      end
+
+      it "returns translation from random domain" do
+        D_('car').should match('(Auto|Auto 2)')
+      end
+
+      it "sets text domain back to previous one" do
+        old_domain = FastGettext.text_domain
+        D_('car').should == 'Auto'
+        FastGettext.text_domain.should == old_domain
+      end
+    end
+
+    describe :Dn_ do
+      before do
+        FastGettext.pluralisation_rule = nil
+      end
+
+      it "translates pluralized" do
+        Dn_('Axis','Axis',1).should match('(Achse|Achse 2)')
+      end
+
+      it "returns a simple translation when no combined was found" do
+        Dn_('Axis','NOTFOUNDs',1).should match('(Achse|Achse 2)')
+      end
+
+      it "returns the appropriate key if no translation was found" do
+        Dn_('NOTFOUND','NOTFOUNDs',1).should == 'NOTFOUND'
+      end
+
+      it "returns the last key when no translation was found and keys where to short" do
+        Dn_('Apple','Apples',2).should == 'Apples'
+      end
+    end
+
+    describe :Ds_ do
+      it "translates simple text" do
+        Ds_('car').should match('(Auto|Auto 2)')
+      end
+
+      it "returns cleaned key if a translation was not found" do
+        Ds_("XXX|not found").should == "not found"
+      end
+
+      it "can use a custom seperator" do
+        Ds_("XXX/not found",'/').should == "not found"
+      end
+    end
+
+    describe :Dns_ do
+      it "translates whith namespace" do
+        Dns_('Fruit|Apple','Fruit|Apples',1).should == 'Apple'
+        Dns_('Fruit|Apple','Fruit|Apples',2).should == 'Apples'
+      end
+
+      it "returns cleaned key if a translation was not found" do
+        Dns_("XXX|not found", "YYY|not found", 1).should == "not found"
+        Dns_("XXX|not found", "YYY|not found", 2).should == "not found"
+      end
+    end
+  end
 
   describe :caching do
     describe :cache_hit do
       before do
-        FastGettext.translation_repositories.replace({})
         #singular cache keys
         FastGettext.current_cache['xxx'] = '1'
 
@@ -166,5 +351,13 @@ describe FastGettext::Translation do
       FastGettext.text_domain = 'test'
       _('car').should == 'Auto'
     end
+
+    it "caches different textdomains seperatly for d_" do
+      _('car').should == 'Auto'
+
+      FastGettext.translation_repositories['fake'] = {}
+      d_('fake', 'car').should == 'car'
+      d_('test','car').should == 'Auto'
+    end
   end
 end