thedarkone-i18n 0.1.4 → 0.2.0

data/lib/i18n/backend/cache.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+# This module allows you to easily cache all responses from the backend - thus
+# speeding up the I18n aspects of your application quite a bit.
+#
+# To enable caching you can simply include the Cache module to the Simple
+# backend - or whatever other backend you are using:
+#
+#  I18n::Backend::Simple.send(:include, I18n::Backend::Cache)
+#
+# You will also need to set a cache store implementation that you want to use:
+#
+#  I18n.cache_store = ActiveSupport::Cache.lookup_store(:memory_store)
+#
+# You can use any cache implementation you want that provides the same API as
+# ActiveSupport::Cache (only the methods #fetch and #write are being used).
+#
+# The cache_key implementation assumes that you only pass values to
+# I18n.translate that return a valid key from #hash (see
+# http://www.ruby-doc.org/core/classes/Object.html#M000337).
+module I18n
+  class << self
+    @@cache_store = nil
+    @@cache_namespace = nil
+
+    def cache_store
+      @@cache_store
+    end
+
+    def cache_store=(store)
+      @@cache_store = store
+    end
+
+    def cache_namespace
+      @@cache_namespace
+    end
+
+    def cache_namespace=(namespace)
+      @@cache_namespace = namespace
+    end
+
+    def perform_caching?
+      !cache_store.nil?
+    end
+  end
+
+  module Backend
+    module Cache
+      def translate(*args)
+        I18n.perform_caching? ? fetch(*args) { super } : super
+      end
+
+      protected
+
+        def fetch(*args, &block)
+          result = I18n.cache_store.fetch(cache_key(*args), &block)
+          raise result if result.is_a?(Exception)
+          result
+        rescue MissingTranslationData => exception
+          I18n.cache_store.write(cache_key(*args), exception)
+          raise exception
+        end
+
+        def cache_key(*args)
+          # this assumes that only simple, native Ruby values are passed to I18n.translate
+          keys = ['i18n', I18n.cache_namespace, args.hash]
+          keys.compact.join('-')
+        end
+    end
+  end
+end

data/lib/i18n/backend/chain.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+module I18n
+  module Backend
+    # Backend that chains multiple other backends and checks each of them when
+    # a translation needs to be looked up. This is useful when you want to use
+    # standard translations with a Simple backend but store custom application
+    # translations in a database or other backends.
+    #
+    # To use the Chain backend instantiate it and set it to the I18n module.
+    # You can add chained backends through the initializer or backends
+    # accessor:
+    #
+    #   # preserves the existing Simple backend set to I18n.backend
+    #   I18n.backend = I18n::Backend::Chain.new(I18n::Backend::ActiveRecord.new, I18n.backend)
+    #
+    # The implementation assumes that all backends added to the Chain implement
+    # a lookup method with the same API as Simple backend does.
+    class Chain < Base
+      attr_accessor :backends
+
+      def initialize(*backends)
+        self.backends = backends
+      end
+
+      def reload!
+        backends.each { |backend| backend.reload! }
+      end
+
+      def store_translations(locale, data)
+        backends.first.store_translations(locale, data)
+      end
+
+      def available_locales
+        backends.map { |backend| backend.available_locales }.flatten.uniq
+      end
+
+      def localize(locale, object, format = :default, options = {})
+        backends.each do |backend|
+          begin
+            result = backend.localize(locale, object, format, options) and return result
+          rescue MissingTranslationData
+          end
+        end or nil
+      end
+
+      protected
+
+        def lookup(locale, key, scope = [], separator = nil)
+          return unless key
+          result = {}
+          backends.each do |backend|
+            entry = backend.lookup(locale, key, scope, separator)
+            if entry.is_a?(Hash)
+              result.merge!(entry)
+            elsif !entry.nil?
+              return entry
+            end
+          end
+          result.empty? ? nil : result
+        end
+    end
+  end
+end

data/lib/i18n/backend/fallbacks.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'i18n/locale/fallbacks'
+
+# I18n locale fallbacks are useful when you want your application to use
+# translations from other locales when translations for the current locale are
+# missing. E.g. you might want to use :en translations when translations in
+# your applications main locale :de are missing.
+#
+# To enable locale fallbacks you can simply include the Fallbacks module to 
+# the Simple backend - or whatever other backend you are using:
+#
+#   I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+module I18n
+  @@fallbacks = nil
+
+  class << self
+    # Returns the current fallbacks implementation. Defaults to +I18n::Locale::Fallbacks+.
+    def fallbacks
+      @@fallbacks ||= I18n::Locale::Fallbacks.new
+    end
+
+    # Sets the current fallbacks implementation. Use this to set a different fallbacks implementation.
+    def fallbacks=(fallbacks)
+      @@fallbacks = fallbacks
+    end
+  end
+
+  module Backend
+    module Fallbacks
+      # Overwrites the Base backend translate method so that it will try each
+      # locale given by I18n.fallbacks for the given locale. E.g. for the
+      # locale :"de-DE" it might try the locales :"de-DE", :de and :en
+      # (depends on the fallbacks implementation) until it finds a result with
+      # the given options. If it does not find any result for any of the
+      # locales it will then raise a MissingTranslationData exception as
+      # usual.
+      #
+      # The default option takes precedence over fallback locales, i.e. it
+      # will first evaluate a given default option before falling back to
+      # another locale.
+      def translate(locale, key, options = {})
+        I18n.fallbacks[locale].each do |fallback|
+          begin
+            result = super(fallback, key, options) and return result
+          rescue I18n::MissingTranslationData
+          end
+        end
+        raise(I18n::MissingTranslationData.new(locale, key, options))
+      end
+    end
+  end
+end

data/lib/i18n/backend/fast.rb

@@ -1,9 +1,9 @@
+require 'i18n/backend/fast/interpolation_compiler'
+
 module I18n
   module Backend
-    class Fast < Simple
-
-      # append any your custom pluralization keys to the constant
-      PLURALIZATION_KEYS = [:zero, :one, :other]
+    class Fast < Base
+      SEPARATOR_ESCAPE_CHAR = "\001"
 
       def reset_flattened_translations!
         @flattened_translations = nil
@@ -22,28 +22,45 @@ module I18n
         super
         reset_flattened_translations!
       end
-
+      
+      def translate(locale, key, opts = nil)
+        raise InvalidLocale.new(locale) unless locale
+        return key.map { |k| translate(locale, k, opts) } if key.is_a?(Array)
+        
+        if opts
+          count = opts[:count]
+          scope = opts[:scope]
+          
+          if entry = lookup(locale, key, scope, opts[:separator]) || ((default = opts.delete(:default)) && default(locale, key, default, opts))
+            entry = resolve(locale, key, entry, opts)
+            entry = pluralize(locale, entry, count) if count
+            entry = interpolate(locale, entry, opts)
+            entry
+          end
+        else
+          resolve(locale, key, lookup(locale, key), opts)
+        end || raise(I18n::MissingTranslationData.new(locale, key, opts))
+      end
+      
       protected
-        # {:a=>'a', :b=>{:c=>'c', :d=>'d', :f=>{:x=>'x'}}} => {:"b.c"=>"c", :"b.f.x"=>"x", :"b.d"=>"d", :a=>"a"}
+        # flatten_hash({:a=>'a', :b=>{:c=>'c', :d=>'d', :f=>{:x=>'x'}}}) 
+        # # => {:a=>'a', :b=>{:c=>'c', :d=>'d', :f=>{:x=>'x'}}, :"b.f" => {:x=>"x"}, :"b.c"=>"c", :"b.f.x"=>"x", :"b.d"=>"d"}
         def flatten_hash(h, nested_stack = [], flattened_h = {})
           h.each_pair do |k, v|
-            new_nested_stack = nested_stack + [k]
-
-            if v.kind_of?(Hash)
-              # short circuit pluralization hashes
-              flattened_h[nested_stack_to_flat_key(new_nested_stack)] = v if (v.keys & PLURALIZATION_KEYS).any?
-
-              flatten_hash(v, new_nested_stack, flattened_h)
-            else
-              flattened_h[nested_stack_to_flat_key(new_nested_stack)] = PluralizationCompiler.compile_if_an_interpolation(v)
-            end
+            new_nested_stack = nested_stack + [escape_default_separator(k)]
+            flattened_h[nested_stack_to_flat_key(new_nested_stack)] = InterpolationCompiler.compile_if_an_interpolation(v)
+            flatten_hash(v, new_nested_stack, flattened_h) if v.kind_of?(Hash)
           end
 
           flattened_h
         end
+        
+        def escape_default_separator(key)
+          key.to_s.tr(I18n.default_separator, SEPARATOR_ESCAPE_CHAR)
+        end
 
         def nested_stack_to_flat_key(nested_stack)
-          nested_stack.join('.').to_sym
+          nested_stack.join(I18n.default_separator).to_sym
         end
 
         def flatten_translations(translations)
@@ -53,14 +70,28 @@ module I18n
             flattened_h
           end
         end
-
-        def interpolate(string, values)
-          string.respond_to?(:i18n_interpolate) ? string.i18n_interpolate(values) : string
+        
+        def interpolate(locale, string, values)
+          if string.respond_to?(:i18n_interpolate)
+            string.i18n_interpolate(values)
+          elsif values
+            super
+          else
+            string
+          end
         end
 
-        def lookup(locale, key, scope = nil)
+        def lookup(locale, key, scope = nil, separator = nil)
           init_translations unless @initialized
-          flattened_translations[locale.to_sym][(scope ? "#{Array(scope).join('.')}.#{key}" : key).to_sym] rescue nil
+          if separator
+            key   = cleanup_non_standard_separator(key, separator)
+            scope = Array(scope).map{|k| cleanup_non_standard_separator(k, separator)} if scope
+          end
+          flattened_translations[locale.to_sym][(scope ? (Array(scope) + [key]).join(I18n.default_separator) : key).to_sym] rescue nil
+        end
+        
+        def cleanup_non_standard_separator(key, user_separator)
+          escape_default_separator(key).tr(user_separator, I18n.default_separator)
         end
     end
   end

data/lib/i18n/backend/fast/interpolation_compiler.rb

@@ -0,0 +1,84 @@
+module I18n
+  module Backend
+    class Fast < Base
+      module InterpolationCompiler
+        extend self
+        
+        TOKENIZER                    = /(\\\{\{[^\}]+\}\}|\{\{[^\}]+\}\})/
+        INTERPOLATION_SYNTAX_PATTERN = /(\\)?(\{\{([^\}]+)\}\})/
+
+        def compile_if_an_interpolation(string)
+          if interpolated_str?(string)
+            string.instance_eval <<-RUBY_EVAL, __FILE__, __LINE__
+              def i18n_interpolate(v = {})
+                "#{compiled_interpolation_body(string)}"
+              end
+            RUBY_EVAL
+          end
+
+          string
+        end
+
+        def interpolated_str?(str)
+          str.kind_of?(String) && str =~ INTERPOLATION_SYNTAX_PATTERN
+        end
+
+        protected
+        # tokenize("foo {{bar}} baz \\{{buz}}") # => ["foo ", "{{bar}}", " baz ", "\\{{buz}}"]
+        def tokenize(str)
+          str.split(TOKENIZER)
+        end
+
+        def compiled_interpolation_body(str)
+          tokenize(str).map do |token|
+            (matchdata = token.match(INTERPOLATION_SYNTAX_PATTERN)) ? handle_interpolation_token(token, matchdata) : escape_plain_str(token)
+          end.join
+        end
+
+        def handle_interpolation_token(interpolation, matchdata)
+          escaped, pattern, key = matchdata.values_at(1, 2, 3)
+          escaped ? pattern : compile_interpolation_token(key.to_sym)
+        end
+
+        def compile_interpolation_token(key)
+          "\#{#{interpolate_or_raise_missing(key)}}"
+        end
+        
+        def interpolate_or_raise_missing(key)
+          escaped_key = escape_key_sym(key)
+          Base::RESERVED_KEYS.include?(key) ? reserved_key(escaped_key) : interpolate_key(escaped_key)
+        end
+        
+        def interpolate_key(key)
+          [direct_key(key), nil_key(key), missing_key(key)].join('||')
+        end
+        
+        def direct_key(key)
+          "((t = v[#{key}]) && t.respond_to?(:call) ? t.call : t)"
+        end
+        
+        def nil_key(key)
+          "(v.has_key?(#{key}) && '')"
+        end
+        
+        def missing_key(key)
+          "raise(MissingInterpolationArgument.new(#{key}, self))"
+        end
+        
+        def reserved_key(key)
+          "raise(ReservedInterpolationKey.new(#{key}, self))"
+        end
+
+        def escape_plain_str(str)
+          str.gsub(/"|\\|#/) {|x| "\\#{x}"}
+        end
+
+        def escape_key_sym(key)
+          # rely on Ruby to do all the hard work :)
+          key.to_sym.inspect
+        end
+
+      end
+    end
+  end
+end

data/lib/i18n/backend/gettext.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+require 'i18n/gettext'
+require File.expand_path(File.dirname(__FILE__) + '/../../../vendor/po_parser.rb')
+
+# Experimental support for using Gettext po files to store translations.
+#
+# To use this you can simply include the module to the Simple backend - or
+# whatever other backend you are using.
+#
+#   I18n::Backend::Simple.send(:include, I18n::Backend::Gettext)
+#
+# Now you should be able to include your Gettext translation (*.po) files to
+# the I18n.load_path so they're loaded to the backend and you can use them as
+# usual:
+#
+#  I18n.load_path += Dir["path/to/locales/*.po"]
+#
+# Following the Gettext convention this implementation expects that your
+# translation files are named by their locales. E.g. the file en.po would
+# contain the translations for the English locale.
+module I18n
+  module Backend
+    module Gettext
+      class PoData < Hash
+        def set_comment(msgid_or_sym, comment)
+          # ignore
+        end
+      end
+
+      protected
+        def load_po(filename)
+          locale = ::File.basename(filename, '.po').to_sym
+          data = normalize(locale, parse(filename))
+          { locale => data }
+        end
+
+        def parse(filename)
+          GetText::PoParser.new.parse(::File.read(filename), PoData.new)
+        end
+
+        def normalize(locale, data)
+          data.inject({}) do |result, (key, value)|
+            key, value = normalize_pluralization(locale, key, value) if key.index("\000")
+            result[key] = value
+            result
+          end
+        end
+
+        def normalize_pluralization(locale, key, value)
+          # FIXME po_parser includes \000 chars that can not be turned into Symbols
+          key = key.dup.gsub("\000", I18n::Gettext::PLURAL_SEPARATOR)
+
+          keys = I18n::Gettext.plural_keys(locale)
+          values = value.split("\000")
+          raise "invalid number of plurals: #{values.size}, keys: #{keys.inspect}" if values.size != keys.size
+
+          result = {}
+          values.each_with_index { |value, ix| result[keys[ix]] = value }
+          [key, result]
+        end
+
+    end
+  end
+end