fast_gettext 0.4.16

data/benchmark/misc/threadsave.rb

@@ -0,0 +1,21 @@
+require 'benchmark'
+BASELINE = 0
+def test
+  result = Benchmark.measure {1_000_000.times{ yield }}
+  result.to_s.strip.split(' ').first.to_f - BASELINE
+end
+
+BASELINE = (test{})
+Thread.current[:library_name]={}
+other = "x"
+puts "Ruby #{VERSION}"
+
+puts "generic:"
+puts "  Symbol: #{test{Thread.current[:library_name][:just_a_symbol]}}s"
+puts "  String concat: #{test{Thread.current["xxxxxx"<<other.to_s]}}s"
+puts "  String add: #{test{Thread.current["xxxxxx"+other.to_s]}}s"
+puts "  String insert: #{test{Thread.current["xxxxxx#{other}"]}}s"
+
+puts "single:"
+puts "  Symbol: #{test{Thread.current[:long_unique_symbol]}}s"
+puts "  String: #{test{Thread.current["xxxxxx"]}}s"

data/benchmark/namespace/fast_gettext.rb

@@ -0,0 +1,15 @@
+#Iconv will not be defined, unless it is found -> normalize test results for users that have Iconv/those who do not have it
+begin;require 'iconv';rescue;LoadError;end
+initial = methods.count + Module.constants.count
+
+#FastGettext
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__),'..','..','lib')
+require 'fast_gettext'
+FastGettext.locale = 'de'
+FastGettext.add_text_domain 'test', :path=>'spec/locale'
+FastGettext.text_domain = 'test'
+include FastGettext::Translation
+raise unless _('car')=='Auto'
+
+puts "FastGettext"
+puts methods.count + Module.constants.count - initial

data/benchmark/namespace/original.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+initial = methods.count + Module.constants.count
+
+#GetText
+gem 'gettext', '>=2.0.0'
+require 'gettext'
+GetText.locale = 'de'
+GetText.bindtextdomain('test',:path=>'spec/locale')
+include GetText
+raise unless _('car') == 'Auto'
+
+
+puts "GetText"
+puts methods.count + Module.constants.count - initial

data/benchmark/original.rb

@@ -0,0 +1,15 @@
+require 'benchmark/base'
+
+gem 'gettext', '>=2.0.0'
+require 'gettext'
+include GetText
+
+self.locale = 'de'
+
+puts "GetText #{GetText::VERSION}:"
+bindtextdomain('test',:path=>locale_folder('test'))
+results_test{_('car') == 'Auto'}
+
+#i cannot add the large file, since its an internal applications mo file
+bindtextdomain('large',:path=>locale_folder('large'))
+results_large

data/examples/db/migration.rb

@@ -0,0 +1,22 @@
+class CreateTranslationTables < ActiveRecord::Migration
+  def self.up
+    create_table :translation_keys do |t|
+      t.string :key, :unique=>true, :null=>false
+      t.timestamps
+    end
+    add_index :translation_keys, :key #I am not sure if this helps....
+
+    create_table :translation_texts do |t|
+      t.text :text
+      t.string :locale
+      t.integer :translation_key_id, :null=>false
+      t.timestamps
+    end
+    add_index :translation_texts, :translation_key_id
+  end
+
+  def self.down
+    drop_table :translation_keys
+    drop_table :translation_texts
+  end
+end

data/examples/missing_translation_logger.rb

@@ -0,0 +1,13 @@
+class MissingTranslationLogger
+  def call(unfound)
+    logger.warn "#{FastGettext.locale}: #{unfound}" unless FastGettext.locale == 'en'
+  end
+
+  private
+
+  def logger
+    return @logger if @logger
+    require 'logger'
+    @logger = Logger.new("log/unfound_translations", 2, 5*(1024**2))#max 2x 5mb logfile
+  end
+end

data/fast_gettext.gemspec

@@ -0,0 +1,114 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fast_gettext}
+  s.version = "0.4.16"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2009-10-16}
+  s.email = %q{grosser.michael@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "benchmark/base.rb",
+     "benchmark/baseline.rb",
+     "benchmark/fast_gettext.rb",
+     "benchmark/i18n_simple.rb",
+     "benchmark/ideal.rb",
+     "benchmark/locale/de.yml",
+     "benchmark/locale/de/LC_MESSAGES/large.mo",
+     "benchmark/misc/threadsave.rb",
+     "benchmark/namespace/fast_gettext.rb",
+     "benchmark/namespace/original.rb",
+     "benchmark/original.rb",
+     "examples/db/migration.rb",
+     "examples/missing_translation_logger.rb",
+     "fast_gettext.gemspec",
+     "lib/fast_gettext.rb",
+     "lib/fast_gettext/mo_file.rb",
+     "lib/fast_gettext/po_file.rb",
+     "lib/fast_gettext/storage.rb",
+     "lib/fast_gettext/translation.rb",
+     "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_models/translation_key.rb",
+     "lib/fast_gettext/translation_repository/db_models/translation_text.rb",
+     "lib/fast_gettext/translation_repository/logger.rb",
+     "lib/fast_gettext/translation_repository/mo.rb",
+     "lib/fast_gettext/translation_repository/po.rb",
+     "spec/aa_unconfigued_spec.rb",
+     "spec/fast_gettext/mo_file_spec.rb",
+     "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",
+     "spec/fast_gettext/translation_spec.rb",
+     "spec/fast_gettext_spec.rb",
+     "spec/locale/de/LC_MESSAGES/test.mo",
+     "spec/locale/de/test.po",
+     "spec/locale/en/LC_MESSAGES/plural_test.mo",
+     "spec/locale/en/LC_MESSAGES/test.mo",
+     "spec/locale/en/plural_test.po",
+     "spec/locale/en/test.po",
+     "spec/spec_helper.rb",
+     "spec/vendor/fake_load_path/iconv.rb",
+     "spec/vendor/iconv_spec.rb",
+     "spec/vendor/string_spec.rb",
+     "vendor/README.rdoc",
+     "vendor/empty.mo",
+     "vendor/iconv.rb",
+     "vendor/mofile.rb",
+     "vendor/poparser.rb",
+     "vendor/string.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/fast_gettext}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{fast-gettext}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A simple, fast and threadsafe implementation of GetText}
+  s.test_files = [
+    "spec/fast_gettext_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/fast_gettext/translation_spec.rb",
+     "spec/fast_gettext/storage_spec.rb",
+     "spec/fast_gettext/translation_repository/chain_spec.rb",
+     "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",
+     "spec/vendor/iconv_spec.rb",
+     "spec/vendor/fake_load_path/iconv.rb",
+     "spec/vendor/string_spec.rb",
+     "examples/db/migration.rb",
+     "examples/missing_translation_logger.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/fast_gettext.rb

@@ -0,0 +1,30 @@
+require 'fast_gettext/mo_file'
+require 'fast_gettext/storage'
+require 'fast_gettext/translation'
+require 'fast_gettext/translation_repository'
+require File.join(File.dirname(__FILE__),'..','vendor','string')
+
+module FastGettext
+  include FastGettext::Storage
+  extend self
+
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+  LOCALE_REX =  /^[a-z]{2}$|^[a-z]{2}_[A-Z]{2}$/
+  NAMESPACE_SEPERATOR = '|'
+
+  # 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
+
+  def add_text_domain(name,options)
+    translation_repositories[name] = TranslationRepository.build(name,options)
+  end
+end

data/lib/fast_gettext/mo_file.rb

@@ -0,0 +1,67 @@
+require File.join(File.dirname(__FILE__),'..','..','vendor','mofile')
+module FastGettext
+  # Responsibility:
+  #  - abstract mo files for Mo Repository
+  class MoFile
+    PLURAL_SEPERATOR = "\000"
+
+    # file => path or FastGettext::GetText::MOFile
+    def initialize(file)
+      if file.is_a? FastGettext::GetText::MOFile
+        @data = file
+      else
+        @data = FastGettext::GetText::MOFile.open(file, "UTF-8")
+      end
+      make_singular_and_plural_available
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    #returns the plural forms or all singlgular translations that where found
+    def plural(*msgids)
+      translations = plural_translations(msgids)
+      return translations unless translations.empty?
+      msgids.map{|msgid| self[msgid] || msgid} #try to translate each id
+    end
+
+    def pluralisation_rule
+      #gettext uses 0 as default rule, which would turn off all pluralisation, very clever...
+      #additionally parsing fails when directly accessing po files, so this line was taken from gettext/mofile
+      (@data['']||'').split("\n").each do |line|
+        return lambda{|n|eval($2)} if /^Plural-Forms:\s*nplurals\s*\=\s*(\d*);\s*plural\s*\=\s*([^;]*)\n?/ =~ line
+      end
+      nil
+    end
+
+    def self.empty
+      MoFile.new(File.join(File.dirname(__FILE__),'..','..','vendor','empty.mo'))
+    end
+
+    private
+
+    #(if plural==singular, prefer singular)
+    def make_singular_and_plural_available
+      data = {}
+      @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
+      @data.merge!(data){|key,old,new| old}
+    end
+
+    def split_plurals(singular_plural)
+      singular_plural.split(PLURAL_SEPERATOR)
+    end
+
+    # Car, Cars => [Auto,Autos] or []
+    def plural_translations(msgids)
+      plurals = self[msgids*PLURAL_SEPERATOR]
+      if plurals then split_plurals(plurals) else [] end
+    end
+  end
+end

data/lib/fast_gettext/po_file.rb

@@ -0,0 +1,14 @@
+require 'fast_gettext/mo_file'
+module FastGettext
+  # Responsibility:
+  #  - abstract po files for Po Repository
+  # TODO refactor...
+  class PoFile
+    def self.to_mo_file(file)
+      require File.join(File.dirname(__FILE__),'..','..','vendor','poparser')
+      mo_file = FastGettext::GetText::MOFile.new
+      FastGettext::GetText::PoParser.new.parse(File.read(file),mo_file)
+      MoFile.new(mo_file)
+    end
+  end
+end

data/lib/fast_gettext/storage.rb

@@ -0,0 +1,188 @@
+module FastGettext
+  # Responsibility:
+  #  - store data threadsave
+  #  - provide error messages when repositories are unconfigured
+  #  - accept/reject locales that are set by the user
+  module Storage
+    class NoTextDomainConfigured < RuntimeError
+      def to_s
+        "Current textdomain (#{FastGettext.text_domain.inspect}) was not added, use FastGettext.add_text_domain !"
+      end
+    end
+
+    [:available_locales, :_locale, :text_domain, :pluralisation_rule].each do |method_name|
+      key = "fast_gettext_#{method_name}".to_sym
+      define_method method_name do
+        Thread.current[key]
+      end
+
+      define_method "#{method_name}=" do |value|
+        Thread.current[key]=value
+        update_current_cache
+      end
+    end
+    private :_locale, :_locale=
+
+
+    def available_locales
+      Thread.current[:fast_gettext_available_locales] || default_available_locales
+    end
+
+    # == cattr_accessor :default_available_locales
+    @@default_available_locales = nil
+    def default_available_locales=(avail_locales)
+      @@default_available_locales = avail_locales
+      update_current_cache
+    end
+
+    def default_available_locales
+      @@default_available_locales
+    end
+
+
+    def text_domain
+      Thread.current[:fast_gettext_text_domain] || default_text_domain
+    end
+
+    # == cattr_accessor :default_text_domain
+    @@default_text_domain = nil
+    def default_text_domain=(domain)
+      @@default_text_domain = domain
+      update_current_cache
+    end
+
+    def default_text_domain
+      @@default_text_domain
+    end
+
+
+    def pluralisation_rule
+      Thread.current[:fast_gettext_pluralisation_rule] ||  current_repository.pluralisation_rule || lambda{|i| i!=1}
+    end
+
+    def current_cache
+      Thread.current[:fast_gettext_current_cache] || {}
+    end
+
+    def current_cache=(cache)
+      Thread.current[:fast_gettext_current_cache] = cache
+    end
+
+    #global, since re-parsing whole folders takes too much time...
+    @@translation_repositories={}
+    def translation_repositories
+      @@translation_repositories
+    end
+
+    # used to speedup simple translations, does not work for pluralisation
+    # caches[text_domain][locale][key]=translation
+    @@caches={}
+    def caches
+      @@caches
+    end
+
+    def current_repository
+      translation_repositories[text_domain] || raise(NoTextDomainConfigured)
+    end
+
+    def key_exist?(key)
+      !!(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
+      _locale || ( default_locale || (available_locales||[]).first || 'en' )
+    end
+
+    def locale=(new_locale)
+      new_locale = best_locale_in(new_locale)
+      self._locale = new_locale if new_locale
+    end
+
+    # for chaining: puts set_locale('xx') == 'xx' ? 'applied' : 'rejected'
+    # returns the current locale, not the one that was supplied
+    # like locale=(), whoes behavior cannot be changed
+    def set_locale(new_locale)
+      self.locale = new_locale
+      locale
+    end
+    
+    @@default_locale = nil
+    def default_locale=(new_locale)
+      @@default_locale = best_locale_in(new_locale)
+      update_current_cache
+    end
+
+    def default_locale
+      @@default_locale
+    end
+
+    #Opera: de-DE,de;q=0.9,en;q=0.8
+    #Firefox de-de,de;q=0.8,en-us;q=0.5,en;q=0.3
+    #IE6/7 de
+    #nil if nothing matches
+    def best_locale_in(locales)
+      formatted_sorted_locales(locales).each do |candidate|
+        return candidate if not available_locales
+        return candidate if available_locales.include?(candidate)
+        return candidate[0..1] if available_locales.include?(candidate[0..1])#available locales include a langauge
+      end
+      return nil#nothing found im sorry :P
+    end
+
+    #turn off translation if none was defined to disable all resulting errors
+    def silence_errors
+      require 'fast_gettext/translation_repository/base'
+      translation_repositories[text_domain] = TranslationRepository::Base.new('x')
+    end
+
+    private
+
+    # de-de,DE-CH;q=0.9 -> ['de_DE','de_CH']
+    def formatted_sorted_locales(locales)
+      found = weighted_locales(locales).reject{|x|x.empty?}.sort_by{|l|l.last}.reverse #sort them by weight which is the last entry
+      found.flatten.map{|l| format_locale(l)}
+    end
+
+    #split the locale and seperate it into different languages
+    #de-de,de;q=0.9,en;q=0.8 => [['de-de','de','0.5'], ['en','0.8']]
+    def weighted_locales(locales)
+      locales = locales.to_s.gsub(/\s/,'')
+      found = [[]]
+      locales.split(',').each do |part|
+        if part =~ /;q=/ #contains language and weight ?
+          found.last << part.split(/;q=/)
+          found.last.flatten!
+          found << []
+        else
+          found.last << part
+        end
+      end
+      found
+    end
+
+    #de-de -> de_DE
+    def format_locale(locale)
+      locale.sub(/^([a-zA-Z]{2})[-_]([a-zA-Z]{2})$/){$1.downcase+'_'+$2.upcase}
+    end
+
+    def update_current_cache
+      caches[text_domain] ||= {}
+      caches[text_domain][locale] ||= {}
+      caches[text_domain][locale][""] = false #ignore gettext meta key when translating
+      self.current_cache = caches[text_domain][locale]
+    end
+  end
+end