grosser-fast_gettext 0.4.8 → 0.4.9

data/README.markdown

@@ -6,6 +6,7 @@ It supports multiple backends (atm: .mo files, .po files, Database(ActiveRecor +
 
 [Example Rails application](https://github.com/grosser/gettext_i18n_rails_example)
 
+
 Setup
 =====
 ### 1. Install
@@ -17,13 +18,14 @@ Or from source:
 
 ### 2. Add a translation repository
 
-#### From mo files (traditional/default)
+From mo files (traditional/default)
     FastGettext.add_text_domain('my_app',:path=>'locale')
 
-#### po files (less maintenacnce than mo)
+Or po files (less maintenacnce than mo)
     FastGettext.add_text_domain('my_app',:path=>'locale', :type=>:po)
 
-#### Database (odern/scaleable)
+Or database (scaleable, great for many locales/translators)
+    require "fast_gettext/translation_repository/db"
     include FastGettext::TranslationRepository::Db.require_models #load and include default models
     FastGettext.add_text_domain('my_app', :type=>:db, :model=>TranslationKey)
 
@@ -40,13 +42,13 @@ Do this once in every Thread. (e.g. Rails -> ApplicationController)
     s_('Namespace|no-found') == 'not-found'
     n_('Axis','Axis',3) == 'Achsen' #German plural of Axis
 
+
 Managing translations
 ============
 ### mo/po-files
 Generate .po or .mo files using GetText parser (example tasks at [gettext_i18n_rails](http://github.com/grosser/gettext_i18n_rails))
 
-Tell Gettext where your .mo or .po files lie:
-    #e.g. for locale/de/my_app.po and locale/de/LC_MESSAGES/my_app.mo
+Tell Gettext where your .mo or .po files lie, e.g. for locale/de/my_app.po and locale/de/LC_MESSAGES/my_app.mo
     FastGettext.add_text_domain('my_app',:path=>'locale')
 
 Use the [original GetText](http://github.com/mutoh/gettext) to create and manage po/mo-files.
@@ -62,6 +64,7 @@ If you want to use your own models, have a look at the [default models](http://g
 
 To manage translations via a Web GUI, use a [Rails application and the translation_db_engine](http://github.com/grosser/translation_db_engine)
 
+
 Performance
 ===========
 50_000 translations speed / memory  
@@ -82,6 +85,7 @@ small translation file <-> large translation file
     ActiveSupport I18n::Backend::Simple :
     21.770000s / 10100K <->
 
+
 Rails
 =======================
 Try the [gettext_i18n_rails plugin](http://github.com/grosser/gettext_i18n_rails), it simplifies the setup.  
@@ -106,6 +110,7 @@ since it runs in a different thread then e.g. controllers, so set them inside yo
         session[:locale] = I18n.locale = FastGettext.set_locale(params[:locale] || session[:locale] || request.env['HTTP_ACCEPT_LANGUAGE'] || 'en')
       end
 
+
 Advanced features
 =================
 ###Abnormal pluralisation
@@ -121,7 +126,7 @@ If the simple rule of "first `availble_locale` or 'en'" is not suficcient for yo
 
 ###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 msgid, the next is asked and so forth.
+the first cannot translate a given key, the next is asked and so forth.
     repos = [
       FastGettext::TranslationRepository.build('new', :path=>'....'),
       FastGettext::TranslationRepository.build('old', :path=>'....')
@@ -132,11 +137,11 @@ the first cannot translate a given msgid, the next is asked and so forth.
 When you want to know which keys could not be translated or were 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::TranslationRepository.build('logger', :type=>:logger, :callback=>lamda{|key_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.
+Unfound may not always mean missing, if you chose not to translate a word because the key is a good translation, it will appear nevertheless.
 A lambda or anything that responds to `call` will do as callback. A good starting point may be `examples/missing_translations_logger.rb`.
 
 ###Plugins
@@ -146,23 +151,22 @@ Write your own TranslationRepository!
     module FastGettext
       module TranslationRepository
         class Wtf
-          define initialize(name,options), [key], plural(*msgids) and
+          define initialize(name,options), [key], plural(*keys) and
           either inherit from TranslationRepository::Base or define available_locales and pluralisation_rule
         end
       end
     end
 
+
 FAQ
 ===
  - [Problems with ActiveRecord messages?](http://wiki.github.com/grosser/fast_gettext/activerecord)
 
+
 TODO
 ====
- - add caching to untranslateable calls
- - break with gettext naming-tradition, convert msgid => key, msgstr => translation
- - some cleanup required, repositories should not have locale
- - use `default_locale=(x)` internally, atm the default is available_locales.first || 'en'
- - use `default_text_domain=(x)` internally, atm default is nil...
+ - YML backend that reads ActiveSupport::I18n files
+ - any ideas ? :D
 
 Author
 ======

data/VERSION.yml

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

data/lib/fast_gettext/storage.rb

@@ -68,10 +68,20 @@ module FastGettext
     end
 
     def key_exist?(key)
-      false
-      translation = current_repository[key]
-      current_cache[key] ||= translation
-      !!translation
+      !!(cached_find key)
+    end
+
+    def cached_find(key)
+      translation = current_cache[key]
+      return translation if translation or translation == false #found or was not found before
+      current_cache[key] = current_repository[key] || false
+    end
+
+    def cached_plural_find(*keys)
+      key = '||||' + keys * '||||'
+      translation = current_cache[key]
+      return translation if translation or translation == false #found or was not found before
+      current_cache[key] = current_repository.plural(*keys) || false
     end
 
     def locale

data/lib/fast_gettext/translation.rb

@@ -17,33 +17,27 @@ module FastGettext
       klas.extend self
     end
 
-    def _(translate)
-      found = FastGettext.current_cache[translate] and return found
-      FastGettext.current_cache[translate] = FastGettext.current_repository[translate] || translate
+    def _(key)
+      FastGettext.cached_find(key) or 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_(*msgids)
-      count = msgids.pop
-      repo = FastGettext.current_repository
-
-      translations = repo.plural(*msgids)
+    def n_(*keys)
+      count = keys.pop
+      translations = FastGettext.cached_plural_find *keys
       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
+      translations[selected] || keys[selected] || keys.last
     end
 
     #translate, but discard namespace if nothing was found
     # Car|Tire -> Tire if no translation could be found
     def s_(key,seperator=nil)
-      if translation = FastGettext.current_cache[key] || FastGettext.current_repository[key]
-        translation
-      else
-        key.split(seperator||NAMESPACE_SEPERATOR).last
-      end
+      translation = FastGettext.cached_find(key) and return translation
+      key.split(seperator||NAMESPACE_SEPERATOR).last
     end
 
     #tell gettext: this string need translation (will be found during parsing)
@@ -52,8 +46,8 @@ module FastGettext
     end
 
     #tell gettext: this string need translation (will be found during parsing)
-    def Nn_(*msgids)
-      msgids
+    def Nn_(*keys)
+      keys
     end
   end
 end

data/lib/fast_gettext/translation_repository/base.rb

@@ -4,8 +4,6 @@ module FastGettext
     #  - base for all repositories
     #  - fallback as empty repository, that cannot translate anything but does not crash
     class Base
-      attr_accessor :locale
-
       def initialize(name,options={})
         @name = name
         @options = options
@@ -23,8 +21,8 @@ module FastGettext
         current_translations[key]
       end
 
-      def plural(*msgids)
-        current_translations.plural(*msgids)
+      def plural(*keys)
+        current_translations.plural(*keys)
       end
 
       protected

data/lib/fast_gettext/translation_repository/chain.rb

@@ -31,9 +31,9 @@ module FastGettext
         nil
       end
 
-      def plural(*msgids)
+      def plural(*keys)
         chain.each do |c|
-          result = c.plural(*msgids)
+          result = c.plural(*keys)
           return result unless result.compact.empty?
         end
         []

data/lib/fast_gettext/translation_repository/logger.rb

@@ -18,8 +18,8 @@ module FastGettext
         nil
       end
 
-      def plural(*msgids)
-        callback.call(msgids)
+      def plural(*keys)
+        callback.call(keys)
         []
       end
     end

data/spec/fast_gettext/storage_spec.rb

@@ -180,7 +180,10 @@ 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._('abc')
+      FastGettext._('unfound')
       FastGettext.locale = 'en'
     end
 
@@ -198,19 +201,24 @@ describe 'Storage' do
       FastGettext.locale = 'de'
       FastGettext.text_domain = nil
       FastGettext.default_text_domain = 'xxx'
-      FastGettext.current_cache['abc'].should == 'abc'
+      FastGettext.current_cache['abc'].should == 'old'
     end
 
     it "cache is restored through setting of default_locale" do
       FastGettext.send(:_locale=,nil)#reset locale to nil
       FastGettext.default_locale = 'de'
       FastGettext.locale.should == 'de'
-      FastGettext.current_cache['abc'].should == 'abc'
+      FastGettext.current_cache['abc'].should == 'old'
     end
 
     it "stores a translation permanently" do
       FastGettext.locale = 'de'
-      FastGettext.current_cache['abc'].should == 'abc'
+      FastGettext.current_cache['abc'].should == 'old'
+    end
+
+    it "stores a unfound translation permanently" do
+      FastGettext.locale = 'de'
+      FastGettext.current_cache['unfound'].should == false
     end
   end
 
@@ -221,8 +229,8 @@ describe 'Storage' do
     end
 
     it "finds using the current repository" do
-      should_receive(:current_repository).and_return 'xxx'=>'1'
-      key_exist?('xxx').should == true
+      should_receive(:current_repository).and_return '1234'=>'1'
+      key_exist?('1234').should == true
     end
 
     it "sets the current cache with a found result" do
@@ -233,7 +241,7 @@ describe 'Storage' do
 
     it "does not overwrite an existing cache value" do
       current_cache['xxx']='xxx'
-      should_receive(:current_repository).and_return 'xxx'=>'1'
+      stub!(:current_repository).and_return 'xxx'=>'1'
       key_exist?('xxx')
       current_cache['xxx'].should == 'xxx'
     end

data/spec/fast_gettext/translation_repository/base_spec.rb

@@ -6,15 +6,16 @@ describe 'FastGettext::TranslationRepository::Base' do
   before do
     @rep = FastGettext::TranslationRepository::Base.new('x')
   end
+
   it "can be built" do
     @rep.available_locales.should == []
   end
+
   it "cannot translate" do
-    @rep.locale = 'de'
     @rep['car'].should == nil
   end
+
   it "cannot pluralize" do
-    @rep.locale = 'de'
     @rep.plural('Axis','Axis').should == ['Axis','Axis']
   end
 end

data/spec/fast_gettext/translation_spec.rb

@@ -27,7 +27,7 @@ describe FastGettext::Translation do
     it "translates simple text" do
       _('car').should == 'Auto'
     end
-    it "returns msgid if not translation was found" do
+    it "returns key if not translation was found" do
       _('NOT|FOUND').should == 'NOT|FOUND'
     end
   end
@@ -60,12 +60,12 @@ describe FastGettext::Translation do
       end
     end
     
-    it "returns the appropriate msgid if no translation was found" do
+    it "returns the appropriate key if no translation was found" do
       n_('NOTFOUND','NOTFOUNDs',1).should == 'NOTFOUND'
       n_('NOTFOUND','NOTFOUNDs',2).should == 'NOTFOUNDs'
     end
 
-    it "returns the last msgid when no translation was found and msgids where to short" do
+    it "returns the last key when no translation was found and keys where to short" do
       FastGettext.pluralisation_rule = lambda{|x|4}
       n_('Apple','Apples',2).should == 'Apples'
     end
@@ -75,7 +75,7 @@ describe FastGettext::Translation do
     it "translates simple text" do
       _('car').should == 'Auto'
     end
-    it "returns cleaned msgid if a translation was not found" do
+    it "returns cleaned key if a translation was not found" do
       s_("XXX|not found").should == "not found"
     end
     it "can use a custom seperator" do
@@ -84,13 +84,13 @@ describe FastGettext::Translation do
   end
 
   describe :N_ do
-    it "returns the msgid" do
+    it "returns the key" do
       N_('XXXXX').should == 'XXXXX'
     end
   end
 
   describe :Nn_ do
-    it "returns the msgids as array" do
+    it "returns the keys as array" do
       Nn_('X','Y').should == ['X','Y']
     end
   end
@@ -99,7 +99,12 @@ describe FastGettext::Translation do
     describe :cache_hit do
       before do
         FastGettext.translation_repositories.replace({})
+        #singular cache keys
         current_cache['xxx'] = '1'
+
+        #plural cache keys
+        current_cache['||||xxx'] = ['1','2']
+        current_cache['||||xxx||||yyy'] = ['1','2']
       end
 
       it "uses the cache when translating with _" do
@@ -109,6 +114,14 @@ describe FastGettext::Translation do
       it "uses the cache when translating with s_" do
         s_('xxx').should == '1'
       end
+
+      it "uses the cache when translating with n_" do
+        n_('xxx','yyy',1).should == '1'
+      end
+
+      it "uses the cache when translating with n_ and single argument" do
+        n_('xxx',1).should == '1'
+      end
     end
 
     it "caches different locales seperatly" do

data/vendor/string.rb

@@ -30,7 +30,7 @@ rescue ArgumentError
     #     with field type such as d(decimal), f(float), ...
     #     "%<age>d, %<weight>.1f" % {:age => 10, :weight => 43.4} == "10 43.4"
     # This is the recommanded way for Ruby-GetText
-    # because the translators can understand the meanings of the msgids easily.
+    # because the translators can understand the meanings of the keys easily.
     def %(args)
       if args.kind_of? Hash
         ret = dup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grosser-fast_gettext
 version: !ruby/object:Gem::Version 
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-10 00:00:00 -07:00
+date: 2009-05-15 00:00:00 -07:00
 default_executable: 
 dependencies: []