grosser-fast_gettext 0.1.0

data/README.markdown

@@ -0,0 +1,61 @@
+FastGettext
+===========
+GetText but fast + simple + threadsave!
+
+Setup
+=====
+    sudo gem install grosser-fast_gettext -s http://gems.github.com/
+
+Tell Gettext where your mo-files lie:
+    #e.g. for locale/de/LC_MESSAGES/my_app.mo
+    FastGettext.add_text_domain('my_app',:path=>'locale')
+
+Choose text domain, and locale for translation
+    FastGettext.text_domain = 'my_app'
+    FastGettext.locale = 'de'
+
+Start translating
+    include FastGettext
+    _('Car') == 'Auto'
+    _('not-found') == 'not-found'
+    s_('Namespace|no-found') == 'not-found'
+    n_('Axis','Axis',3) == 'Achsen' #German plural of Axis
+
+Thread-safety
+=============
+locale/text_domain/available_locales are not shared between threads.  
+But text_domains is, so that found translations can be reused.
+
+Speed
+=====
+FastGettext
+    small:
+    1.000000   0.130000   1.130000 (  1.132578)
+    mapped: 8620K    writeable/private: 5588K    shared: 28K
+
+    large:
+    1.060000   0.100000   1.160000 (  1.163962)
+    mapped: 8620K    writeable/private: 5588K    shared: 28K
+
+
+GetText
+    small:
+    3.220000   0.260000   3.480000 (  3.478093)
+    mapped: 9036K    writeable/private: 6004K    shared: 28K
+
+    large:
+    3.280000   0.230000   3.510000 (  3.511891)
+    mapped: 9156K    writeable/private: 6124K    shared: 28K
+
+
+Updating translations
+=====================
+ATM you have to use the [original GetText](http://github.com/mutoh/gettext) to create and manage your po/mo-files.
+
+Author
+======
+Mofile parsing from Masao Mutoh, see vender/README
+
+Michael Grosser  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...  

data/VERSION.yml

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

data/lib/fast_gettext.rb

@@ -0,0 +1,59 @@
+require 'fast_gettext/mo_file'
+require 'fast_gettext/storage'
+
+module FastGettext
+  include FastGettext::Storage
+  
+  extend self
+  def self.included(mod)  #:nodoc:
+    mod.extend self
+  end
+
+  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
+    end
+  end
+
+  def add_text_domain(name,options)
+    self.text_domains ||= {}
+    domain = self.text_domains[name] = {:path=>options.delete(:path),:mo_files=>{}}
+    
+    # parse all .mo files with the right name, that sit in locale/LC_MESSAGES folders
+    Dir[File.join(domain[:path],'*')].each do |locale_folder|
+      next unless File.basename(locale_folder) =~ LOCALE_REX
+      mo_file = File.join(locale_folder,'LC_MESSAGES',"#{name}.mo")
+      next unless File.exist? mo_file
+      locale = File.basename(locale_folder)
+      domain[:mo_files][locale] = MoFile.new(mo_file)
+    end
+    domain
+  end
+  
+  private
+
+  def current_mo
+    mo = text_domains[text_domain][:mo_files][locale] rescue nil
+    mo || {}
+  end
+end

data/lib/fast_gettext/mo_file.rb

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__),'..','..','vendor','mofile')
+module FastGettext
+  class MoFile
+    PLURAL_SEPERATOR = "\000"
+
+    def initialize(file)
+      @data = GetText::MOFile.open(file, "UTF-8")
+      make_singular_and_plural_available
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    def plural(singular,plural,count)
+      translations = plural_translations(singular,plural)
+
+      if count > 1
+        translations[1] || self[plural]
+      else
+        translations[0] || self[singular]
+      end
+    end
+
+    private
+
+    #(if plural==singular, prefer singular)
+    def make_singular_and_plural_available
+      @data.each do |key,translation|
+        next unless key.include? PLURAL_SEPERATOR
+        singular, plural = split_plurals(key)
+        translation = split_plurals(translation)
+        @data[singular] ||= translation[0]
+        @data[plural] ||= translation[1]
+      end
+    end
+
+    def split_plurals(singular_plural)
+      singular_plural.split(PLURAL_SEPERATOR,2)
+    end
+
+    # Car, Cars => [Auto,Autos] or []
+    def plural_translations(singular,plural)
+      plurals = self[singular+PLURAL_SEPERATOR+plural]
+      if plurals then split_plurals(plurals) else [] end
+    end
+  end
+end

data/lib/fast_gettext/storage.rb

@@ -0,0 +1,24 @@
+module FastGettext
+  module Storage
+    [:locale,:text_domain,:available_locales].each do |method|
+      key = "FastGettext.#{method}"
+      define_method method do
+        Thread.current[key]
+      end
+      define_method "#{method}=" do |value|
+        Thread.current[key] = value
+      end
+    end
+
+    #NOT THREADSAFE, for speed/caching
+    @@text_domains = {}
+    
+    def text_domains
+      @@text_domains
+    end
+
+    def text_domains=(value)
+      @@text_domains=value
+    end
+  end
+end

data/spec/fast_gettext/mo_file_spec.rb

@@ -0,0 +1,25 @@
+current_folder = File.dirname(__FILE__)
+require File.join(current_folder,'..','spec_helper')
+
+include FastGettext
+de_file = File.join(current_folder,'..','locale','de','LC_MESSAGES','test.mo')
+de = MoFile.new(de_file)
+
+describe MoFile do
+  before :all do
+    File.exist?(de_file).should == true
+  end
+  it "parses a file" do
+    de['car'].should == 'Auto'
+  end
+  it "stores untranslated values as nil" do
+    de['Car|Model'].should == nil
+  end
+  it "finds pluralized values" do
+    de.plural('Axis','Axis',1).should == 'Achse' #singular
+    de.plural('Axis','Axis',2).should == 'Achsen' #plurals
+  end
+  it "can access plurals through []" do
+    de['Axis'].should == 'Achse' #singular
+  end
+end

data/spec/fast_gettext/storage_spec.rb

@@ -0,0 +1,29 @@
+current_folder = File.dirname(__FILE__)
+require File.join(current_folder,'..','spec_helper')
+
+include FastGettext::Storage
+
+describe Storage do
+  def thread_save(method)
+    send("#{method}=",1)
+
+    # mess around with other threads
+    threads = []
+    100.times do |i|
+      threads << Thread.new {send("#{method}=",i)}
+    end
+    threads.each(&:join)
+    
+    send(method) == 1
+  end
+
+  [:locale, :available_locales, :text_domain].each do |method|
+    it "stores #{method} thread-save" do
+      thread_save(:locale).should == true
+    end
+  end
+
+  it "does not store text_domains thread-save" do
+    thread_save(:text_domains).should == false
+  end
+end

data/spec/fast_gettext_spec.rb

@@ -0,0 +1,43 @@
+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']
+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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# ---- requirements
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+require 'fast_gettext'
+
+# ---- bugfix
+#`exit?': undefined method `run?' for Test::Unit:Module (NoMethodError)
+#can be solved with require test/unit but this will result in extra test-output
+module Test
+  module Unit
+    def self.run?
+      true
+    end
+  end
+end
+
+# ---- Helpers
+def pending_it(text,&block)
+  it text do
+    pending(&block)
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: grosser-fast_gettext
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-19 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- README.markdown
+- lib/fast_gettext.rb
+- lib/fast_gettext
+- lib/fast_gettext/storage.rb
+- lib/fast_gettext/mo_file.rb
+- spec/fast_gettext_spec.rb
+- spec/spec_helper.rb
+- spec/locale
+- spec/locale/en
+- spec/locale/en/LC_MESSAGES
+- spec/locale/en/LC_MESSAGES/test.mo
+- spec/locale/de
+- spec/locale/de/LC_MESSAGES
+- spec/locale/de/LC_MESSAGES/test.mo
+- spec/fast_gettext
+- spec/fast_gettext/storage_spec.rb
+- spec/fast_gettext/mo_file_spec.rb
+has_rdoc: true
+homepage: http://github.com/grosser/fast_gettext
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simple, fast and threadsafe implementation of GetText
+test_files: []
+