grosser-fast_gettext 0.4.2 → 0.4.3

data/README.markdown

@@ -1,6 +1,8 @@
 FastGettext
 ===========
-GetText but 3.5 x faster, 20 x less memory, simple, clean namespace (7 vs 34) and threadsave!
+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.
 
 [Example Rails application](https://github.com/grosser/gettext_i18n_rails_example)
 
@@ -12,13 +14,6 @@ Or from source:
     git clone git://github.com/grosser/fast_gettext.git
     cd fast_gettext && rake install
 
-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')
-
 Choose text domain and locale for translation
     FastGettext.text_domain = 'my_app'
     FastGettext.available_locales = ['de','en','fr','en_US','en_UK'] # only allow these locales to be set (optional)
@@ -34,28 +29,50 @@ Start translating
 Disable translation errors(like no text domain setup) while doing e.g. console session / testing
     FastGettext.silence_errors
 
+Translations
+============
+### Default: .mo-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)
+
+###Database
+!!!This is very new/alpha-ish atm and surely will change!!!  
+Eesy to maintain especially with many translations and multiple locales.  
+ATM the default implementation is a bit clumsy, it is build so that the model can be substituted by your own. 
+    FastGettext.add_text_domain('my_app', :type=>:db, :model=>TranslationKey)
+    #the model should be the model that represents the keys, you can use FastGettext::TranslationRepository::DB::TranslationKey
+    #the model must have string:key and translations
+    #a Translation must have string:text and string:locale
+
+To get started have a look at the tests in `spec/fast_gettext/translation_repository/db_spec.rb`(includes migrations) or the models
+in `lib/fast_gettext/translation_repository/db/translation_key`.
+
 Performance
 ===========
-50_000 translations speed / memory
-small translation file <-> large translation file
+50_000 translations speed / memory  
+small translation file <-> large translation file  
+(ruby enterprise 1.8.6, your results may vary, try `rake benchmark`)
     Baseline: (doing nothing in a loop)
-    0.240000s / 1196K <->
+    0.250000s / 0K <->
 
     Ideal: (primitive Hash lookup)
-    0.790000s / 1200K <-> 0.760000s / 1200K
+    0.820000s / 4K <-> 0.760000s / 4K
 
     FastGettext:
-    1.360000s / 1200K <-> 1.340000s / 1200K
+    1.360000s / 8K <-> 1.320000s / 8K
 
     GetText 2.0.1:
-    4.810000s / 6.176K <-> 4.770000s / 6.176K
+    4.880000s / 4480K <-> 4.810000s / 4480K
 
     ActiveSupport I18n::Backend::Simple :
-    21.800000s / 11296K <->
-
-
-
-
+    21.770000s / 10100K <->
 
 Thread Safety and Rails
 =======================
@@ -88,11 +105,6 @@ then e.g. controllers, so set them inside your application_controller.
       include FastGettext::Translation
       ...
 
-Updating translations
-=====================
-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)
-
 Advanced features
 =================
 ###Abnormal pluralisation
@@ -127,7 +139,7 @@ Unfound may not always mean missing, if you chose not to translate a word becaus
 A lambda or anything that responds to `call` will do as callback. A good starting point may be `examples/missing_translations_logger.rb`.
 
 ###Plugins
-Want a yml, xml, database version ?
+Want a yml, xml version ?
 Write your own TranslationRepository!
     #fast_gettext/translation_repository/xxx.rb
     module FastGettext
@@ -145,6 +157,8 @@ FAQ
 
 TODO
 ====
+ - some cleanup required, repositories should not have locale
+ - DB::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/Rakefile

@@ -6,6 +6,7 @@ task :default do |t|
 end
 
 task :benchmark do
+  puts "Running on #{RUBY}"
   %w[baseline ideal fast_gettext original i18n_simple].each do |bench|
     puts `ruby benchmark/#{bench}.rb`
     puts ""

data/VERSION.yml

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

data/lib/fast_gettext/translation_repository/db.rb

@@ -0,0 +1,59 @@
+require 'active_record'
+module FastGettext
+  module TranslationRepository
+    # Responsibility:
+    #  - provide access to translations in database through a database abstraction
+    #
+    #  Options:
+    #   :model => Model that represents your keys
+    #   you can either use the models supplied under db/, extend them or build your own
+    #   only constraints:
+    #     key: find_by_key, translations
+    #     translation: text, locale
+    class DB
+      def initialize(name,options={})
+        @model = options[:model]
+      end
+
+      @@seperator = '||||' # string that seperates multiple plurals
+      def self.seperator=(sep);@@seperator = sep;end
+      def self.seperator;@@seperator;end
+
+      def available_locales
+        if @model.respond_to? :available_locales
+          @model.available_locales
+        else
+          []
+        end
+      end
+
+      def pluralisation_rule
+        if @model.respond_to? :pluralsation_rule
+          @model.pluralsation_rule
+        else
+          nil
+        end
+      end
+
+      def [](key)
+        translation = translation(key) and translation.text
+      end
+
+      def plural(*args)
+        translation = translation(args*self.class.seperator)
+        if translation
+          translation.text.to_s.split(self.class.seperator)
+        else
+          []
+        end
+      end
+
+      protected
+
+      def translation(key)
+        return unless key = @model.find_by_key(key)
+        key.translations.find_by_locale(FastGettext.locale)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+class FastGettext::TranslationRepository::DB::TranslationKey < ActiveRecord::Base
+  has_many :translations, :class_name=>'TranslationText'
+  validates_uniqueness_of :key
+  validates_presence_of :key
+
+  # TODO this should not be necessary, but
+  # TranslationKey.respond_to? :available_locales
+  # returns true even if this is not defined...
+  def self.available_locales
+    []
+  end
+end

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

@@ -0,0 +1,5 @@
+class FastGettext::TranslationRepository::DB::TranslationText < ActiveRecord::Base
+  belongs_to :key, :class_name=>'TranslationKey'
+  validates_presence_of :locale, :text
+  validates_uniqueness_of :locale, :scope=>:translation_key_id
+end

data/spec/fast_gettext/translation_repository/db_spec.rb

@@ -0,0 +1,71 @@
+current_folder = File.dirname(__FILE__)
+require File.join(current_folder,'..','..','spec_helper')
+
+require 'activerecord'
+require 'fast_gettext/translation_repository/db'
+require 'fast_gettext/translation_repository/db/translation_key'
+require 'fast_gettext/translation_repository/db/translation_text'
+
+include FastGettext::TranslationRepository
+
+describe FastGettext::TranslationRepository::DB do
+  before :all do
+    ActiveRecord::Base.establish_connection({
+      :adapter => "sqlite3",
+      :database => ":memory:"
+    })
+
+    #create model table
+    #TODO surpress output ?
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :translation_keys do |t|
+        t.string :key, :unique=>true, :null=>false
+        t.timestamps
+      end
+      create_table :translation_texts do |t|
+        t.string :text, :locale
+        t.integer :translation_key_id, :null=>false
+        t.timestamps
+      end
+    end
+  end
+
+  before do
+    DB::TranslationKey.delete_all
+    DB::TranslationText.delete_all
+    FastGettext.locale = 'de'
+    @rep = FastGettext::TranslationRepository::DB.new('x', :model=>DB::TranslationKey)
+  end
+
+  def create_translation(key, text)
+    translation_key = DB::TranslationKey.create!(:key=>key)
+    DB::TranslationText.create!(:translation_key_id=>translation_key.id, :text=>text, :locale=>'de')
+  end
+  
+  it "can be built" do
+#    pending #this is weird, it responds to :available_locales, but it is not defined...
+    @rep.available_locales.should == []
+  end
+
+  it "has no pluralisation_rule by default" do
+    @rep.pluralisation_rule.should == nil
+  end
+
+  it "cannot translate when no models are present" do
+    @rep['car'].should == nil
+  end
+
+  it "can translate" do
+    create_translation 'car', 'Auto'
+    @rep['car'].should == 'Auto'
+  end
+
+  it "cannot pluralize when no model is present" do
+    @rep.plural('Axis','Axis').should == []
+  end
+
+  it "can pluralize" do
+    create_translation 'Axis||||Axis', 'Achse||||Achsen'
+    @rep.plural('Axis','Axis').should == ['Achse','Achsen']
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grosser-fast_gettext
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-22 00:00:00 -07:00
+date: 2009-04-24 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,9 @@ files:
 - 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/db.rb
+- lib/fast_gettext/translation_repository/db/translation_key.rb
+- lib/fast_gettext/translation_repository/db/translation_text.rb
 - lib/fast_gettext/translation_repository/logger.rb
 - lib/fast_gettext/translation_repository/mo.rb
 - lib/fast_gettext/translation_repository/po.rb
@@ -42,6 +45,7 @@ files:
 - spec/fast_gettext/storage_spec.rb
 - spec/fast_gettext/translation_repository/base_spec.rb
 - spec/fast_gettext/translation_repository/chain_spec.rb
+- spec/fast_gettext/translation_repository/db_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
@@ -98,6 +102,7 @@ test_files:
 - 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/db_spec.rb
 - spec/fast_gettext/translation_repository/mo_spec.rb
 - spec/fast_gettext/mo_file_spec.rb
 - spec/aa_unconfigued_spec.rb