grosser-fast_gettext 0.4.7 → 0.4.8

data/README.markdown

@@ -2,57 +2,66 @@ FastGettext
 ===========
 GetText but 3.5 x faster, 560 x less memory, simple, clean namespace (7 vs 34) and threadsave!  
 
-It supports multiple backends (atm: .mo files, .po files, ActiveRecord, Chain) and can easily be extended.
+It supports multiple backends (atm: .mo files, .po files, Database(ActiveRecor + any other), Chain, Loggers) and can easily be extended.
 
 [Example Rails application](https://github.com/grosser/gettext_i18n_rails_example)
 
 Setup
 =====
+### 1. Install
     sudo gem install grosser-fast_gettext -s http://gems.github.com/
 
 Or from source:
     git clone git://github.com/grosser/fast_gettext.git
     cd fast_gettext && rake install
 
-Choose text domain and locale for translation
+### 2. Add a translation repository
+
+#### From mo files (traditional/default)
+    FastGettext.add_text_domain('my_app',:path=>'locale')
+
+#### po files (less maintenacnce than mo)
+    FastGettext.add_text_domain('my_app',:path=>'locale', :type=>:po)
+
+#### Database (odern/scaleable)
+    include FastGettext::TranslationRepository::Db.require_models #load and include default models
+    FastGettext.add_text_domain('my_app', :type=>:db, :model=>TranslationKey)
+
+### 3. Choose text domain and locale for translation
+Do this once in every Thread. (e.g. Rails -> ApplicationController)
     FastGettext.text_domain = 'my_app'
     FastGettext.available_locales = ['de','en','fr','en_US','en_UK'] # only allow these locales to be set (optional)
     FastGettext.locale = 'de'
 
-Start translating
+### 4. Start translating
     include FastGettext::Translation
     _('Car') == 'Auto'
     _('not-found') == 'not-found'
     s_('Namespace|no-found') == 'not-found'
     n_('Axis','Axis',3) == 'Achsen' #German plural of Axis
 
-Disable translation errors(like no text domain setup) while doing e.g. console session / testing
-    FastGettext.silence_errors
-
-Translations
+Managing translations
 ============
-### Default: .mo-files
+### 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
-    #add :type=>:po and it will read directly from po files (not recommended for production since po-parsing can crash!)
     FastGettext.add_text_domain('my_app',:path=>'locale')
 
-ATM you have to use the [original GetText](http://github.com/mutoh/gettext) to create and manage your po/mo-files.
-I already started work on a po/mo parser & reader that is easier to use, contributions welcome @ [pomo](http://github.com/grosser/pomo)
+Use the [original GetText](http://github.com/mutoh/gettext) to create and manage po/mo-files.
+(Work on a po/mo parser & reader that is easier to use has started, contributions welcome @ [pomo](http://github.com/grosser/pomo) )
 
 ###Database
 !!!new/only short time in production, please report back any ideas/suggestions you have!!!  
-Easy to maintain especially with many translations and multiple locales.  
 [Example migration for ActiveRecord](http://github.com/grosser/fast_gettext/blob/master/examples/db/migration.rb)  
-This is usable with any model DataMapper/Sequel or any other(non-database) backend, the only thing you need to do is respond to the self.translation(key, locale) call.
 The default plural seperator is `||||` but you may overwrite it (or suggest a better one..).
-    include FastGettext::TranslationRepository::Db.require_models #load and include default models
-    FastGettext.add_text_domain('my_app', :type=>:db, :model=>TranslationKey)
 
+This is usable with any model DataMapper/Sequel or any other(non-database) backend, the only thing you need to do is respond to the self.translation(key, locale) call.
 If you want to use your own models, have a look at the [default models](http://github.com/grosser/fast_gettext/tree/master/lib/fast_gettext/translation_repository/db_models) to see what you want/need to implement.
 
+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  
@@ -73,18 +82,16 @@ small translation file <-> large translation file
     ActiveSupport I18n::Backend::Simple :
     21.770000s / 10100K <->
 
-Thread Safety and Rails
+Rails
 =======================
-Parsed `text_domains` are not stored thread-save, so that they can be added inside the `environment.rb`,
-and do not need to be readded for every thread (parsing takes time...).
-
-###Rails
-Try the [gettext_i18n_rails plugin](http://github.com/grosser/gettext_i18n_rails), it simplifies the setup.
+Try the [gettext_i18n_rails plugin](http://github.com/grosser/gettext_i18n_rails), it simplifies the setup.  
+Try the [translation_db_engine](http://github.com/grosser/translation_db_engine), to manage your translations in a db.
 
-Setting `available_locales`,`text_domain` or `locale` will not work inside the `evironment.rb`, since it runs in a different thread
-then e.g. controllers, so set them inside your application_controller.  
+Setting `available_locales`,`text_domain` or `locale` will not work inside the `evironment.rb`,
+since it runs in a different thread then e.g. controllers, so set them inside your application_controller.
 
     #environment.rb after initializers
+    Object.send(:include,FastGettext::Translation)
     FastGettext.add_text_domain('accounting',:path=>'locale')
     FastGettext.add_text_domain('frontend',:path=>'locale')
     ...
@@ -99,11 +106,6 @@ then e.g. controllers, so set them inside your application_controller.
         session[:locale] = I18n.locale = FastGettext.set_locale(params[:locale] || session[:locale] || request.env['HTTP_ACCEPT_LANGUAGE'] || 'en')
       end
 
-    #application_helper.rb
-    module ApplicationHelper
-      include FastGettext::Translation
-      ...
-
 Advanced features
 =================
 ###Abnormal pluralisation
@@ -156,8 +158,9 @@ FAQ
 
 TODO
 ====
+ - add caching to untranslateable calls
+ - break with gettext naming-tradition, convert msgid => key, msgstr => translation
  - some cleanup required, repositories should not have locale
- - DbModel::TranslationKey responds_to? :available_locales should be false when it is not defined, maybe testing bug
  - use `default_locale=(x)` internally, atm the default is available_locales.first || 'en'
  - use `default_text_domain=(x)` internally, atm default is nil...
 

data/VERSION.yml

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

data/lib/fast_gettext/storage.rb

@@ -6,7 +6,7 @@ module FastGettext
   module Storage
     class NoTextDomainConfigured < RuntimeError
       def to_s
-        "Current textdomain (#{FastGettext.text_domain.inspect}) was not added, use FastGettext.add_text_domain!"
+        "Current textdomain (#{FastGettext.text_domain.inspect}) was not added, use FastGettext.add_text_domain !"
       end
     end
 
@@ -67,6 +67,13 @@ module FastGettext
       translation_repositories[text_domain] || raise(NoTextDomainConfigured)
     end
 
+    def key_exist?(key)
+      false
+      translation = current_repository[key]
+      current_cache[key] ||= translation
+      !!translation
+    end
+
     def locale
       _locale || ( default_locale || (available_locales||[]).first || 'en' )
     end

data/lib/fast_gettext/translation.rb

@@ -38,11 +38,11 @@ module FastGettext
 
     #translate, but discard namespace if nothing was found
     # Car|Tire -> Tire if no translation could be found
-    def s_(translate,seperator=nil)
-      if translation = FastGettext.current_repository[translate]
+    def s_(key,seperator=nil)
+      if translation = FastGettext.current_cache[key] || FastGettext.current_repository[key]
         translation
       else
-        translate.split(seperator||NAMESPACE_SEPERATOR).last
+        key.split(seperator||NAMESPACE_SEPERATOR).last
       end
     end
 

data/spec/fast_gettext/storage_spec.rb

@@ -214,6 +214,31 @@ describe 'Storage' do
     end
   end
 
+  describe :key_exist? do
+    it "does not find default keys" do
+      _('abcde')
+      key_exist?('abcde').should be_false
+    end
+
+    it "finds using the current repository" do
+      should_receive(:current_repository).and_return 'xxx'=>'1'
+      key_exist?('xxx').should == true
+    end
+
+    it "sets the current cache with a found result" do
+      should_receive(:current_repository).and_return 'xxx'=>'1'
+      key_exist?('xxx')
+      current_cache['xxx'].should == '1'
+    end
+
+    it "does not overwrite an existing cache value" do
+      current_cache['xxx']='xxx'
+      should_receive(:current_repository).and_return 'xxx'=>'1'
+      key_exist?('xxx')
+      current_cache['xxx'].should == 'xxx'
+    end
+  end
+
   describe NoTextDomainConfigured do
     it "shows what to do" do
       NoTextDomainConfigured.new.to_s.should =~ /FastGettext\.add_text_domain/

data/spec/fast_gettext/translation_spec.rb

@@ -96,6 +96,21 @@ describe FastGettext::Translation do
   end
 
   describe :caching do
+    describe :cache_hit do
+      before do
+        FastGettext.translation_repositories.replace({})
+        current_cache['xxx'] = '1'
+      end
+
+      it "uses the cache when translating with _" do
+        _('xxx').should == '1'
+      end
+
+      it "uses the cache when translating with s_" do
+        s_('xxx').should == '1'
+      end
+    end
+
     it "caches different locales seperatly" do
       FastGettext.locale = 'en'
       _('car').should == 'car'

data/spec/vendor/string_spec.rb

@@ -3,8 +3,18 @@ require File.join(current_folder,'..','spec_helper')
 
 #just to make sure we did not mess up while copying...
 describe String do
-  it "substitudes using % + Hash" do
-    "x%{name}y" %{:name=>'a'}.should == 'xay'
+  it "does not translate twice" do
+    ("%{a} %{b}" % {:a=>'%{b}',:b=>'c'}).should == '%{b} c'
+  end
+
+  describe "old % style replacement" do
+    it "substitudes using % + Hash" do
+      "x%{name}y" %{:name=>'a'}.should == 'xay'
+    end
+
+    it "does not substitute after %%" do
+      ("%%{num} oops" % {:num => 1}).should == '%{num} oops'
+    end
   end
 
   describe 'old sprintf style' do
@@ -22,6 +32,10 @@ describe String do
   end
 
   describe 'ruby 1.9 style %< replacement' do
+    it "does not substitute after %%" do
+      ("%%<num> oops" % {:num => 1}).should == '%<num> oops'
+    end
+
     it "subsitutes %<something>d" do
       ("x%<hello>dy" % {:hello=>1}).should == 'x1y'
     end
@@ -29,7 +43,5 @@ describe String do
     it "substitutes #b" do
       ("%<num>#b" % {:num => 1}).should == "0b1"
     end
-
-
   end
 end

data/vendor/string.rb

@@ -15,6 +15,12 @@ rescue ArgumentError
   class String
     alias :_fast_gettext_old_format_m :% # :nodoc:
 
+    PERCENT_MATCH_RE = Regexp.union(
+      /%%/,
+      /%\{(\w+)\}/,
+      /%<(\w+)>(.*?\d*\.?\d*[bBdiouxXeEfgGcps])/
+    )
+
     # call-seq:
     #  %(hash)
     #
@@ -28,17 +34,17 @@ rescue ArgumentError
     def %(args)
       if args.kind_of? Hash
         ret = dup
-        # %{something} type
-        args.each {|key, value| ret.gsub!(/\%\{#{key}\}/, value.to_s)}
-
-        # %<..>d type
-        args.each {|key, value|
-          ret.gsub!(/\%<#{key}>([ #\+-0\*]?\d*\.?\d*[bBdiouxXeEfgGcps])/){
-            sprintf("%#{$1}", value)
-          }
-        }
-        ret.gsub(/%%/, "%")
-        ret
+        ret.gsub!(PERCENT_MATCH_RE) do |match|
+          if match == '%%'
+            '%'
+          elsif $1
+            key = $1.to_sym
+            args.has_key?(key) ? args[key] : match
+          elsif $2
+            key = $2.to_sym
+            args.has_key?(key) ? sprintf("%#{$3}", args[key]) : match
+          end
+        end
       else
         ret = gsub(/%([{<])/, '%%\1')
         ret._fast_gettext_old_format_m(args)

metadata

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