grosser-fast_gettext 0.2.4 → 0.2.5

data/README.markdown

@@ -1,6 +1,6 @@
 FastGettext
 ===========
-GetText but fast + simple + threadsave!
+GetText but 4 times faster, simple, clean namespace (7 vs 34) and threadsave!
 
 Setup
 =====
@@ -16,7 +16,7 @@ Choose text domain, and locale for translation
     FastGettext.locale = 'de'
 
 Start translating
-    include FastGettext
+    include FastGettext::Translation
     _('Car') == 'Auto'
     _('not-found') == 'not-found'
     s_('Namespace|no-found') == 'not-found'
@@ -24,24 +24,34 @@ Start translating
 
 Speed
 =====
-FastGettext
-    small:
-    1.000000   0.130000   1.130000 (  1.132578)
-    mapped: 8620K    writeable/private: 5588K    shared: 28K
+50_000 translations:
+Ideal: (primitive Hash lookup)
+    small translation file:
+    1.100000   0.180000   1.280000 (  1.287230)
+    mapped: 5832K    writeable/private: 3016K    shared: 28K
+
+    large translation file:
+    1.150000   0.150000   1.300000 (  1.296114)
+    mapped: 5832K    writeable/private: 3016K    shared: 28K
+
+FastGettext:
+    small translation file:
+    3.980000   0.430000   4.410000 (  4.407260)
+    mapped: 5852K    writeable/private: 3036K    shared: 28K
 
-    large:
-    1.060000   0.100000   1.160000 (  1.163962)
-    mapped: 8620K    writeable/private: 5588K    shared: 28K
+    large translation file:
+    4.070000   0.450000   4.520000 (  4.515585)
+    mapped: 5972K    writeable/private: 3156K    shared: 28K
 
+GetText:
+    small translation file:
+    16.280000   1.340000  17.620000 ( 17.630391)
+    mapped: 8976K    writeable/private: 5944K    shared: 28K
 
-GetText
-    small:
-    3.220000   0.260000   3.480000 (  3.478093)
-    mapped: 9036K    writeable/private: 6004K    shared: 28K
+    large translation file:
+    16.590000   1.430000  18.020000 ( 18.042926)
+    mapped: 9024K    writeable/private: 5992K    shared: 28K
 
-    large:
-    3.280000   0.230000   3.510000 (  3.511891)
-    mapped: 9156K    writeable/private: 6124K    shared: 28K
 
 
 Thread Safety and Rails
@@ -59,7 +69,7 @@ then e.g. controllers, so set them inside your application_controller.
 
     #application_controller.rb
     class ApplicationController ...
-      include FastGettext
+      include FastGettext::Translation
       before_filter :set_locale
       def set_locale
         FastGettext.available_locales = ['de','en',...]
@@ -69,7 +79,7 @@ then e.g. controllers, so set them inside your application_controller.
 
     #application_helper.rb
     module ApplicationHelper
-      include FastGettext
+      include FastGettext::Translation
       ...
 
 Try the [gettext_i18n_rails plugin](http://github.com/grosser/gettext_i18n_rails), it simplifies the setup.

data/VERSION.yml

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

data/lib/fast_gettext.rb

@@ -1,5 +1,6 @@
 require 'fast_gettext/mo_file'
 require 'fast_gettext/storage'
+require 'fast_gettext/translation'
 require File.join(File.dirname(__FILE__),'..','vendor','string')
 
 module FastGettext
@@ -13,39 +14,18 @@ module FastGettext
   LOCALE_REX =  /^[a-z]{2}$|^[a-z]{2}_[A-Z]{2}$/
   NAMESPACE_SEPERATOR = '|'
 
-  def _(translate)
-    current_mo[translate] || translate
-  end
-
-  #translate pluralized
-  def n_(singular,plural,count)
-    if translation = current_mo.plural(singular,plural,count)
-      translation
-    else
-      count > 1 ? plural : singular
-    end
-  end
-
-  #translate, but discard namespace if nothing was found
-  # Car|Tire -> Tire if no translation could be found
-  def s_(translate,seperator=nil)
-    if translation = current_mo[translate]
-      translation
-    else
-      translate.split(seperator||NAMESPACE_SEPERATOR).last
+  # users should not include FastGettext, since this would conterminate their namespace
+  # rather use
+  # FastGettext.locale = ..
+  # FastGettext.text_domain = ..
+  # and
+  # include FastGettext::Translation
+  FastGettext::Translation.public_instance_methods.each do |method|
+    define_method method do |*args|
+      Translation.send(method,*args)
     end
   end
 
-  #tell gettext: this string need translation (will be found during parsing)
-  def N_(translate)
-    translate
-  end
-
-  #tell gettext: this string need translation (will be found during parsing)
-  def Nn_(singular,plural)
-    [singular,plural]
-  end
-
   def add_text_domain(name,options)
     self.text_domains ||= {}
     domain = self.text_domains[name] = {:path=>options.delete(:path),:mo_files=>{}}
@@ -60,12 +40,4 @@ module FastGettext
     end
     domain
   end
-  
-  private
-
-  #TODO geht nicht <-> {}.plural
-  def current_mo
-    mo = text_domains[text_domain][:mo_files][locale] rescue nil
-    mo || {}
-  end
 end

data/lib/fast_gettext/storage.rb

@@ -1,6 +1,6 @@
 module FastGettext
   module Storage
-    [:text_domain,:available_locales].each do |method|
+    [:current_translations,:available_locales].each do |method|
       define_method method do
         thread_store(method)
       end
@@ -9,21 +9,39 @@ module FastGettext
       end
     end
 
+    #global, since re-parsing whole folders takes too much time...
     @@text_domains={}
     def text_domains
       @@text_domains
     end
 
+    def text_domain
+      thread_store(:text_domain)
+    end
+
+    def text_domain=(new_text_domain)
+      write_thread_store(:text_domain,new_text_domain)
+      update_current_translations
+    end
+
     def locale
       thread_store(:locale) || (available_locales||[]).first || 'en'
     end
 
-    def locale=(value)
-      write_thread_store(:locale,value) if not available_locales or available_locales.include?(value)
+    def locale=(new_locale)
+      new_locale = new_locale.to_s
+      if not available_locales or available_locales.include?(new_locale)
+        write_thread_store(:locale,new_locale)
+        update_current_translations
+      end
     end
 
     private
 
+    def update_current_translations
+      self.current_translations = text_domains[text_domain][:mo_files][locale] || {} if text_domains[text_domain]
+    end
+
     def thread_store(key)
       Thread.current["FastGettext.#{key}"]
     end

data/lib/fast_gettext/translation.rb

@@ -0,0 +1,38 @@
+module FastGettext
+  module Translation
+    extend self
+    
+    def _(translate)
+      FastGettext.current_translations[translate] || translate
+    end
+
+    #translate pluralized
+    def n_(singular,plural,count)
+      if translation = FastGettext.current_translations.plural(singular,plural,count)
+        translation
+      else
+        count > 1 ? plural : singular
+      end
+    end
+
+    #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_translations[translate]
+        translation
+      else
+        translate.split(seperator||NAMESPACE_SEPERATOR).last
+      end
+    end
+
+    #tell gettext: this string need translation (will be found during parsing)
+    def N_(translate)
+      translate
+    end
+
+    #tell gettext: this string need translation (will be found during parsing)
+    def Nn_(singular,plural)
+      [singular,plural]
+    end
+  end
+end

data/spec/fast_gettext/storage_spec.rb

@@ -15,7 +15,7 @@ describe Storage do
     send(method) == 'de'
   end
 
-  [:locale, :available_locales, :text_domain].each do |method|
+  [:locale, :available_locales, :text_domain, :current_translations].each do |method|
     it "stores #{method} thread-save" do
       thread_save(method).should == true
     end

data/spec/fast_gettext/translation_spec.rb

@@ -0,0 +1,55 @@
+current_folder = File.dirname(__FILE__)
+require File.join(current_folder,'..','spec_helper')
+
+FastGettext.add_text_domain('test',:path=>File.join(File.dirname(__FILE__),'..','locale'))
+FastGettext.text_domain = 'test'
+FastGettext.available_locales = ['en','de']
+FastGettext.locale = 'de'
+
+include FastGettext::Translation
+
+describe FastGettext::Translation do
+  describe :_ do
+    it "translates simple text" do
+      _('car').should == 'Auto'
+    end
+    it "returns msgid if not translation was found" do
+      _('NOT|FOUND').should == 'NOT|FOUND'
+    end
+  end
+
+  describe :n_ do
+    it "translates pluralized" do
+      n_('Axis','Axis',1).should == 'Achse'
+      n_('Axis','Axis',2).should == 'Achsen'
+    end
+    it "returns the appropriate msgid if no translation was found" do
+      n_('NOTFOUND','NOTFOUNDs',1).should == 'NOTFOUND'
+      n_('NOTFOUND','NOTFOUNDs',2).should == 'NOTFOUNDs'
+    end
+  end
+
+  describe :s_ do
+    it "translates simple text" do
+      _('car').should == 'Auto'
+    end
+    it "returns cleaned msgid if a translation was not found" do
+      s_("XXX|not found").should == "not found"
+    end
+    it "can use a custom seperator" do
+      s_("XXX/not found",'/').should == "not found"
+    end
+  end
+
+  describe :N_ do
+    it "returns the msgid" do
+      N_('XXXXX').should == 'XXXXX'
+    end
+  end
+
+  describe :Nn_ do
+    it "returns the msgids as array" do
+      Nn_('X','Y').should == ['X','Y']
+    end
+  end
+end

data/spec/fast_gettext_spec.rb

@@ -1,6 +1,5 @@
 require File.expand_path("spec_helper", File.dirname(__FILE__))
 
-include FastGettext
 FastGettext.add_text_domain('test',:path=>File.join(File.dirname(__FILE__),'locale'))
 FastGettext.text_domain = 'test'
 FastGettext.available_locales = ['en','de']
@@ -9,47 +8,11 @@ FastGettext.locale = 'de'
 include FastGettext
 
 describe FastGettext do
-  describe :_ do
-    it "translates simple text" do
-      _('car').should == 'Auto'
-    end
-    it "returns msgid if not translation was found" do
-      _('NOT|FOUND').should == 'NOT|FOUND'
-    end
-  end
-
-  describe :n_ do
-    it "translates pluralized" do
-      n_('Axis','Axis',1).should == 'Achse'
-      n_('Axis','Axis',2).should == 'Achsen'
-    end
-    it "returns the appropriate msgid if no translation was found" do
-      n_('NOTFOUND','NOTFOUNDs',1).should == 'NOTFOUND'
-      n_('NOTFOUND','NOTFOUNDs',2).should == 'NOTFOUNDs'
-    end
-  end
-
-  describe :s_ do
-    it "translates simple text" do
-      _('car').should == 'Auto'
-    end
-    it "returns cleaned msgid if a translation was not found" do
-      s_("XXX|not found").should == "not found"
-    end
-    it "can use a custom seperator" do
-      s_("XXX/not found",'/').should == "not found"
-    end
-  end
-
-  describe :N_ do
-    it "returns the msgid" do
-      N_('XXXXX').should == 'XXXXX'
-    end
-  end
-
-  describe :Nn_ do
-    it "returns the msgids as array" do
-      Nn_('X','Y').should == ['X','Y']
-    end
+  it "provides access to FastGettext::Translations methods" do
+    _('car').should == 'Auto'
+    s_("XXX|not found").should == "not found"
+    n_('Axis','Axis',1).should == 'Achse'
+    N_('XXXXX').should == 'XXXXX'
+    Nn_('X','Y').should == ['X','Y']
   end
 end

data/spec/vendor/fake_load_path/iconv.rb

@@ -0,0 +1,2 @@
+#simulate file not found
+raise LoadError

data/spec/vendor/iconv_spec.rb

@@ -0,0 +1,27 @@
+current_folder = File.dirname(__FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", current_folder)
+
+describe 'Iconv' do
+  it "also works when Iconv was not found locally" do
+    #prepare load path
+    $LOAD_PATH.unshift File.join(current_folder,'fake_load_path')
+    test = 1
+    begin
+      require 'iconv'
+    rescue LoadError
+      test = 2
+    end
+    test.should == 2
+
+    #load fast_gettext
+    require 'fast_gettext'
+
+    FastGettext.add_text_domain('test',:path=>File.join(File.dirname(__FILE__),'..','locale'))
+    FastGettext.text_domain = 'test'
+    FastGettext.available_locales = ['en','de']
+    FastGettext.locale = 'de'
+
+    #translate
+    FastGettext._('car').should == 'Auto'
+  end
+end

data/vendor/iconv.rb

@@ -15,8 +15,11 @@
   $Id: iconv.rb,v 1.6 2007/11/08 14:21:22 mutoh Exp $
 =end
 
+#Modifications
+#wrapped inside FastGettext namespace to reduce conflic
+
 begin
-  require 'iconv.so'
+  require 'iconv'
 rescue LoadError
   # Pseudo Iconv class
   # 
@@ -27,73 +30,75 @@ rescue LoadError
   # (1) Ruby/GLib is a module which is provided from Ruby-GNOME2 Project. 
   # You can get binaries for Win32(One-Click Ruby Installer).
   # <URL: http://ruby-gnome2.sourceforge.jp/>
-  class Iconv
-    module Failure; end
-    class InvalidEncoding < ArgumentError;  include Failure; end
-    class IllegalSequence < ArgumentError;  include Failure; end
-    class InvalidCharacter < ArgumentError; include Failure; end
+  module FastGettext
+    class Iconv2
+      module Failure; end
+      class InvalidEncoding < ArgumentError;  include Failure; end
+      class IllegalSequence < ArgumentError;  include Failure; end
+      class InvalidCharacter < ArgumentError; include Failure; end
 
-    if RUBY_PLATFORM =~ /java/
-      def self.conv(to, from, str)
-        raise InvalidCharacter, "the 3rd argument is nil" unless str
-        begin
-          str = java.lang.String.new(str.unpack("C*").to_java(:byte), from)
-          str.getBytes(to).to_ary.pack("C*")
-        rescue java.io.UnsupportedEncodingException
-          raise InvalidEncoding
-        end
-      end
-    else
-      begin
-        require 'glib2'
-      
-        def self.check_glib_version?(major, minor, micro) # :nodoc:
-          (GLib::BINDING_VERSION[0] > major ||
-           (GLib::BINDING_VERSION[0] == major && 
-            GLib::BINDING_VERSION[1] > minor) ||
-           (GLib::BINDING_VERSION[0] == major && 
-            GLib::BINDING_VERSION[1] == minor &&
-            GLib::BINDING_VERSION[2] >= micro))
+      if RUBY_PLATFORM =~ /java/
+        def self.conv(to, from, str)
+          raise InvalidCharacter, "the 3rd argument is nil" unless str
+          begin
+            str = java.lang.String.new(str.unpack("C*").to_java(:byte), from)
+            str.getBytes(to).to_ary.pack("C*")
+          rescue java.io.UnsupportedEncodingException
+            raise InvalidEncoding
+          end
         end
-        
-        if check_glib_version?(0, 11, 0)
-          # This is a function equivalent of Iconv.iconv.
-          # * to: encoding name for destination
-          # * from: encoding name for source
-          # * str: strings to be converted
-          # * Returns: Returns an Array of converted strings.
-          def self.conv(to, from, str)
-            begin
-              GLib.convert(str, to, from)
-            rescue GLib::ConvertError => e
-              case e.code
-              when GLib::ConvertError::NO_CONVERSION
-                raise InvalidEncoding.new(str)
-              when GLib::ConvertError::ILLEGAL_SEQUENCE
+      else
+        begin
+          require 'glib2'
+
+          def self.check_glib_version?(major, minor, micro) # :nodoc:
+            (GLib::BINDING_VERSION[0] > major ||
+             (GLib::BINDING_VERSION[0] == major &&
+              GLib::BINDING_VERSION[1] > minor) ||
+             (GLib::BINDING_VERSION[0] == major &&
+              GLib::BINDING_VERSION[1] == minor &&
+              GLib::BINDING_VERSION[2] >= micro))
+          end
+
+          if check_glib_version?(0, 11, 0)
+            # This is a function equivalent of Iconv.iconv.
+            # * to: encoding name for destination
+            # * from: encoding name for source
+            # * str: strings to be converted
+            # * Returns: Returns an Array of converted strings.
+            def self.conv(to, from, str)
+              begin
+                GLib.convert(str, to, from)
+              rescue GLib::ConvertError => e
+                case e.code
+                when GLib::ConvertError::NO_CONVERSION
+                  raise InvalidEncoding.new(str)
+                when GLib::ConvertError::ILLEGAL_SEQUENCE
+                  raise IllegalSequence.new(str)
+                else
+                  raise InvalidCharacter.new(str)
+                end
+              end
+            end
+          else
+            def self.conv(to, from, str) # :nodoc:
+              begin
+                GLib.convert(str, to, from)
+              rescue
                 raise IllegalSequence.new(str)
-              else
-                raise InvalidCharacter.new(str)
               end
             end
           end
-        else
+        rescue LoadError
           def self.conv(to, from, str) # :nodoc:
-            begin
-              GLib.convert(str, to, from)
-            rescue
-              raise IllegalSequence.new(str)
-            end
+            warn "Iconv was not found." if $DEBUG
+            str
           end
         end
-      rescue LoadError
-        def self.conv(to, from, str) # :nodoc:
-          warn "Iconv was not found." if $DEBUG
-          str
-        end
       end
-    end
-    def self.iconv(to, from, str)
-      conv(to, from, str).split(//)
+      def self.iconv(to, from, str)
+        conv(to, from, str).split(//)
+      end
     end
   end
 end

data/vendor/mofile.rb

@@ -18,6 +18,9 @@
 require 'iconv'
 require 'stringio'
 
+#Modifications:
+#  use Iconv or FastGettext::Icvon
+
 module FastGettext
   module GetText
     class MOFile < Hash
@@ -148,8 +151,9 @@ module FastGettext
           else
             if @output_charset
               begin
-                str = Iconv.conv(@output_charset, @charset, str) if @charset
-              rescue Iconv::Failure
+                iconv = Iconv || FastGettext::Iconv
+                str = iconv.conv(@output_charset, @charset, str) if @charset
+              rescue iconv::Failure
                 if $DEBUG
                   warn "@charset = ", @charset
                   warn"@output_charset = ", @output_charset

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grosser-fast_gettext
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Michael Grosser
@@ -28,6 +28,7 @@ files:
 - vendor/README.rdoc
 - lib/fast_gettext.rb
 - lib/fast_gettext
+- lib/fast_gettext/translation.rb
 - lib/fast_gettext/storage.rb
 - lib/fast_gettext/mo_file.rb
 - spec/fast_gettext_spec.rb
@@ -40,9 +41,13 @@ files:
 - spec/locale/de/LC_MESSAGES
 - spec/locale/de/LC_MESSAGES/test.mo
 - spec/fast_gettext
+- spec/fast_gettext/translation_spec.rb
 - spec/fast_gettext/storage_spec.rb
 - spec/fast_gettext/mo_file_spec.rb
 - spec/vendor
+- spec/vendor/iconv_spec.rb
+- spec/vendor/fake_load_path
+- spec/vendor/fake_load_path/iconv.rb
 - spec/vendor/string_spec.rb
 - VERSION.yml
 - README.markdown