grosser-fast_gettext 0.3.8 → 0.4.0

data/README.markdown

@@ -105,6 +105,26 @@ is sufficient and no more `text_domain=` is needed
 ###default_locale
 If the simple rule of "first `availble_locale` or 'en'" is not suficcient for you, simply set `FastGettext.default_locale = 'de'`.
 
+###Chains
+You can use any number of repositories to find a translation. Simply add them to a chain and when
+the first cannot translate a given key, the next is asked and so forth.
+    repos = [
+      FastGettext::TranslationRepository.build('old', :path=>'....'),
+      FastGettext::TranslationRepository.build('new', :path=>'....')
+    ]
+    FastGettext.add_text_domain 'combined', :type=>:chain, :chain=>repos
+
+#Logger
+When you want to know which keys could not be translated, or where used, add a Logger to a Chain:
+    repos = [
+      FastGettext::TranslationRepository.build('app', :path=>'....')
+      FastGettext::TranslationRepository.build('logger', :type=>:logger, :callback=>lamda{|msgid_or_array_of_ids| ... }),
+    }
+    FastGettext.add_text_domain 'combined', :type=>:chain, :chain=>repos
+If the Logger is in position #1 it will see all translations, if it is in position #2 it will only see the unfound.
+Unfound may not always mean missing, if you chose not to translate a word because the msgid is a good translation, it will appear nevertheless.
+A lambda or anything that responds to `call` will do as callback.
+
 ###Plugins
 Want a yml, xml, database version ?
 Write your own TranslationRepository!
@@ -112,7 +132,8 @@ Write your own TranslationRepository!
     module FastGettext
       module TranslationRepository
         class Wtf
-          define initialize(name,options), available_locales, [key], plural(*msgids)
+          define initialize(name,options), [key], plural(*msgids) and
+          either inherit from Base or define available_locales and pluralisation rule
         end
       end
     end

data/Rakefile

@@ -0,0 +1,32 @@
+desc "Run all specs in spec directory"
+task :default do |t|
+  options = "--colour --format progress --loadby --reverse"
+  files = FileList['spec/**/*_spec.rb']
+  system("spec #{options} #{files}")
+end
+
+task :benchmark do
+  %w[baseline ideal fast_gettext original i18n_simple].each do |bench|
+    puts `ruby benchmark/#{bench}.rb`
+    puts ""
+  end
+end
+
+task :namespaces do
+  puts `ruby benchmark/namespace/original.rb`
+  puts `ruby benchmark/namespace/fast_gettext.rb`
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fast_gettext"
+    gem.summary = "A simple, fast and threadsafe implementation of GetText"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/fast_gettext"
+    gem.authors = ["Michael Grosser"]
+    gem.files += (FileList["{vendor,lib,spec}/**/*"] + FileList["VERSION.yml"] + FileList["README.markdown"]).to_a.sort
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 3
-:patch: 8
+:minor: 4
+:patch: 0

data/examples/missing_translation_logger.rb

@@ -0,0 +1,13 @@
+class MissingTranslationLogger
+  def call(unfound)
+    logger.warn "#{FastGettext.locale}: #{unfound}" unless FastGettext.locale == 'en'
+  end
+
+  private
+
+  def logger
+    return @logger if @logger
+    require 'logger'
+    @logger = Logger.new("log/unfound_translations", 2, 5*(1024**2))#max 2x 5mb logfile
+  end
+end

data/lib/fast_gettext/storage.rb

@@ -10,7 +10,7 @@ module FastGettext
       end
     end
 
-    [:available_locales, :_locale, :text_domain].each do |method_name|
+    [:available_locales, :_locale, :text_domain, :pluralisation_rule].each do |method_name|
       key = "fast_gettext_#{method_name}".to_sym
       define_method method_name do
         Thread.current[key]
@@ -27,6 +27,10 @@ module FastGettext
       Thread.current[:fast_gettext_text_domain] || default_text_domain
     end
 
+    def pluralisation_rule
+      Thread.current[:fast_gettext_pluralisation_rule] ||  current_repository.pluralisation_rule || lambda{|i| i!=1}
+    end
+
     def current_cache
       Thread.current[:fast_gettext_current_cache] || {}
     end

data/lib/fast_gettext/translation.rb

@@ -28,9 +28,10 @@ module FastGettext
     # n_('apple','apples',3)
     def n_(*msgids)
       count = msgids.pop
-      
-      translations = FastGettext.current_repository.plural(*msgids)
-      selected = FastGettext.current_repository.pluralisation_rule.call(count)
+      repo = FastGettext.current_repository
+
+      translations = repo.plural(*msgids)
+      selected = FastGettext.pluralisation_rule.call(count)
       selected = selected ? 1 : 0 unless selected.is_a? Numeric #convert booleans to numbers
       translations[selected] || msgids[selected] || msgids.last
     end

data/lib/fast_gettext/translation_repository/base.rb

@@ -5,7 +5,6 @@ module FastGettext
     #  - fallback as empty repository, that cannot translate anything but does not crash
     class Base
       attr_accessor :locale
-      attr_writer :pluralisation_rule
 
       def initialize(name,options={})
         @name = name
@@ -13,7 +12,7 @@ module FastGettext
       end
 
       def pluralisation_rule
-        @pluralisation_rule || lambda{|n| n==1 ? 0 : 1}
+        nil
       end
 
       def available_locales

data/lib/fast_gettext/translation_repository/chain.rb

@@ -0,0 +1,43 @@
+require 'fast_gettext/translation_repository/base'
+
+module FastGettext
+  module TranslationRepository
+    # Responsibility:
+    #  - delegate calls to members of the chain in turn
+    #TODO cache should be expired after a repo was added
+    class Chain < Base
+      attr_accessor :chain
+
+      def initialize(name,options={})
+        super
+        self.chain = options[:chain]
+      end
+
+      def available_locales
+        chain.map{|c|c.available_locales}.flatten.uniq
+      end
+
+      def pluralisation_rule
+        chain.each do |c|
+          result = c.pluralisation_rule and return result
+        end
+        nil
+      end
+
+      def [](key)
+        chain.each do |c|
+          result = c[key] and return result
+        end
+        nil
+      end
+
+      def plural(*msgids)
+        chain.each do |c|
+          result = c.plural(*msgids)
+          return result unless result.compact.empty?
+        end
+        []
+      end
+    end
+  end
+end

data/lib/fast_gettext/translation_repository/logger.rb

@@ -0,0 +1,27 @@
+require 'fast_gettext/translation_repository/base'
+
+module FastGettext
+  module TranslationRepository
+    # This should be used in a TranslationRepository::Chain, so tat untranslated keys can be found
+    # Responsibility:
+    #  - log every translation call
+    class Logger < Base
+      attr_accessor :callback
+
+      def initialize(name,options={})
+        super
+        self.callback = options[:callback]
+      end
+
+      def [](key)
+        callback.call(key)
+        nil
+      end
+
+      def plural(*msgids)
+        callback.call(msgids)
+        []
+      end
+    end
+  end
+end

data/lib/fast_gettext/translation_repository/mo.rb

@@ -15,7 +15,7 @@ module FastGettext
       end
 
       def pluralisation_rule
-        current_translations.pluralisation_rule || super
+        current_translations.pluralisation_rule
       end
 
       protected

data/spec/fast_gettext/storage_spec.rb

@@ -6,29 +6,29 @@ include FastGettext::Storage
 describe 'Storage' do
   before do
     #reset everything to nil
+    self.available_locales = nil
     self.default_text_domain = nil
     self.default_locale = nil
-    self.available_locales = nil
     send(:_locale=,nil)#nil is not allowed to be set...
     default_locale.should be_nil
     available_locales.should be_nil
     locale.should == 'en'
   end
 
-  def thread_save(method)
-    send("#{method}=",'de')
+  def thread_save(method, value)
+    send("#{method}=",value)
 
     # mess around with other threads
     100.times do
       Thread.new {FastGettext.send("#{method}=",'en')}
     end
     
-    send(method) == 'de'
+    send(method) == value
   end
 
-  [:locale, :available_locales, :text_domain].each do |method|
+  {:locale=>'de', :available_locales=>['de'], :text_domain=>'xx', :pluralisation_rule=>lambda{|x|x==4}}.each do |method, value|
     it "stores #{method} thread-save" do
-      thread_save(method).should == true
+      thread_save(method, value).should == true
     end
   end
 
@@ -39,9 +39,19 @@ describe 'Storage' do
     self.translation_repositories[:x].should == 2
   end
 
+  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)
+      self.pluralisation_rule = nil
+      pluralisation_rule.call(1).should == false
+      pluralisation_rule.call(0).should == true
+      pluralisation_rule.call(2).should == true
+    end
+  end
+
   describe :default_locale do
     it "stores default_locale non-thread-safe" do
-      thread_save(:default_locale).should == false
+      thread_save(:default_locale, 'de').should == false
     end
 
     it "does not overwrite locale" do
@@ -70,7 +80,7 @@ describe 'Storage' do
 
   describe :default_text_domain do
     it "stores default_text_domain non-thread-safe" do
-      thread_save(:default_text_domain).should == false
+      thread_save(:default_text_domain, 'xx').should == false
     end
 
     it "uses default_text_domain when text_domain is not set" do

data/spec/fast_gettext/translation_repository/chain_spec.rb

@@ -0,0 +1,82 @@
+current_folder = File.dirname(__FILE__)
+require File.join(current_folder,'..','..','spec_helper')
+
+class MockRepo
+  def [](key)#should_receive :[] does not work so well...
+    singular key
+  end
+end
+
+describe 'FastGettext::TranslationRepository::Chain' do
+  describe "empty chain" do
+    before do
+      @rep = FastGettext::TranslationRepository.build('chain', :chain=>[], :type=>:chain)
+    end
+
+    it "has no locales" do
+      @rep.available_locales.should == []
+    end
+
+    it "cannot translate" do
+      @rep['car'].should == nil
+    end
+
+    it "cannot pluralize" do
+      @rep.plural('Axis','Axis').should == []
+    end
+
+    it "has no pluralisation rule" do
+      @rep.pluralisation_rule.should == nil
+    end
+  end
+
+  describe "filled chain" do
+    before do
+      @one = MockRepo.new
+      @one.stub!(:singular).with('xx').and_return 'one'
+      @two = MockRepo.new
+      @two.stub!(:singular).with('xx').and_return 'two'
+      @rep = FastGettext::TranslationRepository.build('chain', :chain=>[@one, @two], :type=>:chain)
+    end
+
+    describe :singular do
+      it "uses the first repo in the chain if it responds" do
+        @rep['xx'].should == 'one'
+      end
+
+      it "uses the second repo in the chain if the first does not respond" do
+        @one.should_receive(:singular).and_return nil
+        @rep['xx'].should == 'two'
+      end
+    end
+
+    describe :plural do
+      it "uses the first repo in the chain if it responds" do
+        @one.should_receive(:plural).with('a','b').and_return ['A','B']
+        @rep.plural('a','b').should == ['A','B']
+      end
+
+      it "uses the second repo in the chain if the first does not respond" do
+        @one.should_receive(:plural).with('a','b').and_return [nil,nil]
+        @two.should_receive(:plural).with('a','b').and_return ['A','B']
+        @rep.plural('a','b').should == ['A','B']
+      end
+    end
+
+    describe :available_locales do
+      it "should be the sum of all added repositories" do
+        @one.should_receive(:available_locales).and_return ['de']
+        @two.should_receive(:available_locales).and_return ['de','en']
+        @rep.available_locales.should == ['de','en']
+      end
+    end
+
+    describe :pluralisation_rule do
+      it "chooses the first that exists" do
+        @one.should_receive(:pluralisation_rule).and_return nil
+        @two.should_receive(:pluralisation_rule).and_return 'x'
+        @rep.pluralisation_rule.should == 'x'
+      end
+    end
+  end
+end

data/spec/fast_gettext/translation_repository/logger_spec.rb

@@ -0,0 +1,41 @@
+current_folder = File.dirname(__FILE__)
+require File.join(current_folder,'..','..','spec_helper')
+
+describe 'FastGettext::TranslationRepository::Logger' do
+  before do
+    @callback = lambda{}
+    @rep = FastGettext::TranslationRepository.build('test', :type=>:logger, :callback=>@callback)
+    @rep.is_a?(FastGettext::TranslationRepository::Logger).should be_true
+  end
+  subject{@rep}
+
+  it{ should have(0).available_locales}
+
+  it "has no pluralisation_rule" do
+    @rep.pluralisation_rule.should == nil
+  end
+
+  describe :single do
+    it "logs every call" do
+      @callback.should_receive(:call).with('the_key')
+      @rep['the_key']
+    end
+
+    it "returns nil" do
+      @callback.should_receive(:call).with('the_key').and_return 'something'
+      @rep['the_key'].should == nil
+    end
+  end
+
+  describe :plural do
+    it "logs every call" do
+      @callback.should_receive(:call).with(['a','b'])
+      @rep.plural('a','b')
+    end
+
+    it "returns an empty array" do
+      @callback.should_receive(:call).with(['a','b']).and_return 'something'
+      @rep.plural('a','b').should == []
+    end
+  end
+end

data/spec/fast_gettext/translation_repository/mo_spec.rb

@@ -5,23 +5,23 @@ require File.join(current_folder,'..','..','spec_helper')
 describe 'FastGettext::TranslationRepository::Mo' do
   before do
     @rep = FastGettext::TranslationRepository.build('test',:path=>File.join(current_folder,'..','..','locale'))
-    @rep.is_a? FastGettext::TranslationRepository::Mo
+    @rep.is_a?(FastGettext::TranslationRepository::Mo).should be_true
   end
+
   it "can be built" do
     @rep.available_locales.should == ['de','en']
   end
+
   it "can translate" do
     FastGettext.locale = 'de'
     @rep['car'].should == 'Auto'
   end
+
   it "can pluralize" do
     FastGettext.locale = 'de'
     @rep.plural('Axis','Axis').should == ['Achse','Achsen']
   end
-  it "stores pluralisation rule" do
-    @rep.pluralisation_rule = lambda{|n|n+1}
-    @rep.pluralisation_rule.call(3).should == 4
-  end
+
   it "has access to the mo repositories pluralisation rule" do
     FastGettext.locale = 'en'
     rep = FastGettext::TranslationRepository.build('plural_test',:path=>File.join(current_folder,'..','..','locale'))

data/spec/fast_gettext/translation_repository/po_spec.rb

@@ -5,19 +5,23 @@ require File.join(current_folder,'..','..','spec_helper')
 describe 'FastGettext::TranslationRepository::Po' do
   before do
     @rep = FastGettext::TranslationRepository.build('test',:path=>File.join(current_folder,'..','..','locale'),:type=>:po)
-    @rep.is_a? FastGettext::TranslationRepository::Po
+    @rep.is_a?(FastGettext::TranslationRepository::Po).should be_true
   end
+
   it "can be built" do
     @rep.available_locales.should == ['de','en']
   end
+
   it "can translate" do
     FastGettext.locale = 'de'
     @rep['car'].should == 'Auto'
   end
+
   it "can pluralize" do
     FastGettext.locale = 'de'
     @rep.plural('Axis','Axis').should == ['Achse','Achsen']
   end
+
   it "has access to the mo repositories pluralisation rule" do
     FastGettext.locale = 'en'
     rep = FastGettext::TranslationRepository.build('plural_test',:path=>File.join(current_folder,'..','..','locale'),:type=>:po)

data/spec/fast_gettext/translation_spec.rb

@@ -34,7 +34,7 @@ describe FastGettext::Translation do
 
   describe :n_ do
     before do
-      FastGettext.current_repository.pluralisation_rule = lambda{|n|n==1?0:1}
+      FastGettext.pluralisation_rule = nil
     end
 
     it "translates pluralized" do
@@ -45,17 +45,17 @@ describe FastGettext::Translation do
 
     describe "pluralisations rules" do
       it "supports abstract pluralisation rules" do
-        FastGettext.current_repository.pluralisation_rule = lambda{|n|2}
+        FastGettext.pluralisation_rule = lambda{|n|2}
         n_('a','b','c','d',4).should == 'c'
       end
 
       it "supports false as singular" do
-        FastGettext.current_repository.pluralisation_rule = lambda{|n|n!=2}
+        FastGettext.pluralisation_rule = lambda{|n|n!=2}
         n_('singular','plural','c','d',2).should == 'singular'
       end
 
       it "supports true as plural" do
-        FastGettext.current_repository.pluralisation_rule = lambda{|n|n==2}
+        FastGettext.pluralisation_rule = lambda{|n|n==2}
         n_('singular','plural','c','d',2).should == 'plural'
       end
     end
@@ -66,7 +66,7 @@ describe FastGettext::Translation do
     end
 
     it "returns the last msgid when no translation was found and msgids where to short" do
-      FastGettext.current_repository.pluralisation_rule = lambda{|x|4}
+      FastGettext.pluralisation_rule = lambda{|x|4}
       n_('Apple','Apples',2).should == 'Apples'
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grosser-fast_gettext
 version: !ruby/object:Gem::Version 
-  version: 0.3.8
+  version: 0.4.0
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-14 00:00:00 -07:00
+date: 2009-04-19 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -19,46 +19,41 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.markdown
 files: 
 - README.markdown
+- Rakefile
 - VERSION.yml
-- lib/fast_gettext
+- examples/missing_translation_logger.rb
 - lib/fast_gettext.rb
 - lib/fast_gettext/mo_file.rb
 - lib/fast_gettext/po_file.rb
 - lib/fast_gettext/storage.rb
 - lib/fast_gettext/translation.rb
-- lib/fast_gettext/translation_repository
 - lib/fast_gettext/translation_repository.rb
 - lib/fast_gettext/translation_repository/base.rb
+- lib/fast_gettext/translation_repository/chain.rb
+- lib/fast_gettext/translation_repository/logger.rb
 - lib/fast_gettext/translation_repository/mo.rb
 - lib/fast_gettext/translation_repository/po.rb
 - spec/aa_unconfigued_spec.rb
-- spec/fast_gettext
 - spec/fast_gettext/mo_file_spec.rb
 - spec/fast_gettext/storage_spec.rb
-- spec/fast_gettext/translation_repository
 - spec/fast_gettext/translation_repository/base_spec.rb
+- spec/fast_gettext/translation_repository/chain_spec.rb
+- spec/fast_gettext/translation_repository/logger_spec.rb
 - spec/fast_gettext/translation_repository/mo_spec.rb
 - spec/fast_gettext/translation_repository/po_spec.rb
 - spec/fast_gettext/translation_spec.rb
 - spec/fast_gettext_spec.rb
-- spec/locale
-- spec/locale/de
-- spec/locale/de/LC_MESSAGES
 - spec/locale/de/LC_MESSAGES/test.mo
 - spec/locale/de/test.po
-- spec/locale/en
-- spec/locale/en/LC_MESSAGES
 - spec/locale/en/LC_MESSAGES/plural_test.mo
 - spec/locale/en/LC_MESSAGES/test.mo
 - spec/locale/en/plural_test.po
 - spec/locale/en/test.po
 - spec/spec_helper.rb
-- spec/vendor
-- spec/vendor/fake_load_path
 - spec/vendor/fake_load_path/iconv.rb
 - spec/vendor/iconv_spec.rb
 - spec/vendor/string_spec.rb
@@ -72,7 +67,6 @@ has_rdoc: true
 homepage: http://github.com/grosser/fast_gettext
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -95,5 +89,19 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: A simple, fast and threadsafe implementation of GetText
-test_files: []
-
+test_files: 
+- spec/fast_gettext_spec.rb
+- spec/spec_helper.rb
+- spec/fast_gettext/translation_spec.rb
+- spec/fast_gettext/storage_spec.rb
+- spec/fast_gettext/translation_repository/chain_spec.rb
+- spec/fast_gettext/translation_repository/logger_spec.rb
+- spec/fast_gettext/translation_repository/base_spec.rb
+- spec/fast_gettext/translation_repository/po_spec.rb
+- spec/fast_gettext/translation_repository/mo_spec.rb
+- spec/fast_gettext/mo_file_spec.rb
+- spec/aa_unconfigued_spec.rb
+- spec/vendor/iconv_spec.rb
+- spec/vendor/fake_load_path/iconv.rb
+- spec/vendor/string_spec.rb
+- examples/missing_translation_logger.rb