thedarkone-i18n 0.1.4 → 0.2.0

data/lib/i18n/backend/lazy_reloading.rb

@@ -0,0 +1,60 @@
+# Speeds up the reload! method (usefull in development mode) by first making sure
+# the locale files have actually changed (this is done using their last mtime).
+# Usage:
+# 
+#   I18n::Backend::Simple.send(:include, I18n::Backend::LazyReloading)
+
+module I18n
+  module Backend
+    module LazyReloading
+      def reload!
+        flush_translations if stale?
+      end
+      
+    protected
+      def init_translations
+        load_translations(*load_paths)
+        @initialized = true
+      end
+      
+      def load_paths
+        I18n.load_path.flatten
+      end
+
+      def flush_translations
+        @initialized  = false
+        @translations = nil
+        @file_mtimes  = {}
+      end
+      
+      def file_mtimes
+        @file_mtimes ||= {}
+      end
+      
+      def load_file(filename)
+        super
+        record_mtime_of(filename)
+      end
+      
+      def record_mtime_of(filename)
+        file_mtimes[filename] = File.mtime(filename)
+      end
+
+      def stale_translation_file?(filename)
+        (mtime = file_mtimes[filename]).nil? || !File.file?(filename) || mtime < File.mtime(filename)
+      end
+
+      def stale?
+        translation_path_removed? || translation_file_updated_or_added?
+      end
+
+      def translation_path_removed?
+        (file_mtimes.keys - load_paths).any?
+      end
+
+      def translation_file_updated_or_added?
+        load_paths.any? {|path| stale_translation_file?(path)}
+      end
+    end
+  end
+end

data/lib/i18n/backend/pluralization.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+# 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 specific pluralizations you can simply include the
+# Pluralization module to the Simple backend - or whatever other backend you
+# are using.
+#
+#   I18n::Backend::Simple.send(:include, I18n::Backend::Pluralization)
+#
+# You also need to make sure to provide pluralization algorithms to the 
+# backend, i.e. include them to your I18n.load_path accordingly.
+module I18n
+  module Backend
+    module Pluralization
+      # Overwrites the Base backend translate method so that it will check the
+      # translation meta data space (:i18n) for locale specific pluralizers
+      # and use them to pluralize the given entry.
+      #
+      # Pluralizers are expected to respond to #call(entry, count) and return
+      # a pluralization key. Valid keys depend on the translation data hash
+      # (entry) but it is generally recommended to follow CLDR's style, i.e.
+      # return one of the keys :zero, :one, :few, :many, :other.
+      #
+      # The :zero key is always picked directly when count equals 0 AND the
+      # translation data has the key :zero. This way translators are free to
+      # either pick a special :zero translation even for languages where the
+      # pluralizer does not return a :zero key.
+      def pluralize(locale, entry, count)
+        return entry unless entry.is_a?(Hash) and count
+
+        pluralizer = pluralizer(locale)
+        if pluralizer.respond_to?(:call)
+          key = count == 0 && entry.has_key?(:zero) ? :zero : pluralizer.call(count)
+          raise InvalidPluralizationData.new(entry, count) unless entry.has_key?(key)
+          entry[key]
+        else
+          super
+        end
+      end
+
+      protected
+
+        def pluralizers
+          @pluralizers ||= {}
+        end
+
+        def pluralizer(locale)
+          pluralizers[locale] ||= lookup(locale, :"i18n.pluralize")
+        end
+    end
+  end
+end

data/lib/i18n/backend/simple.rb

@@ -1,246 +1,23 @@
-require 'yaml'
+# encoding: utf-8
+
+require 'i18n/backend/base'
+
+# Stub class for the Simple backend. The actual implementation is provided by
+# the backend Base class. This makes it easier to extend the Simple backend's
+# behaviour by including modules. E.g.:
+#
+# module I18n::Backend::Pluralization
+#   def pluralize(*args)
+#     # extended pluralization logic
+#     super
+#   end
+# end
+#
+# I18n::Backend::Simple.send(:include, I18n::Backend::Pluralization)
 
 module I18n
   module Backend
-    class Simple
-      INTERPOLATION_RESERVED_KEYS = [:scope, :default]
-      MATCH = /(\\\\)?(\{\{([^\}]+)\}\})/
-      # deep_merge by Stefan Rusterholz, see http://www.ruby-forum.com/topic/142809
-      DEEP_MERGE_PROC = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &DEEP_MERGE_PROC) : v2 }
-
-      # Accepts a list of paths to translation files. Loads translations from
-      # plain Ruby (*.rb) or YAML files (*.yml). See #load_rb and #load_yml
-      # for details.
-      def load_translations(*filenames)
-        filenames.each { |filename| load_file(filename) }
-      end
-
-      # Stores translations for the given locale in memory.
-      # This uses a deep merge for the translations hash, so existing
-      # translations will be overwritten by new ones only at the deepest
-      # level of the hash.
-      def store_translations(locale, data)
-        merge_translations(locale, data)
-      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, scope = opts.values_at(:count, :scope)
-          
-          if entry = lookup(locale, key, scope) || ((default = opts.delete(:default)) && default(locale, default, opts))
-            entry = pluralize(locale, entry, count) if count
-            entry = interpolate(entry, opts)
-            entry
-          end
-        else
-          lookup(locale, key)
-        end || raise(I18n::MissingTranslationData.new(locale, key, opts))
-      end
-
-      # Acts the same as +strftime+, but returns a localized version of the
-      # formatted date string. Takes a key from the date/time formats
-      # translations as a format argument (<em>e.g.</em>, <tt>:short</tt> in <tt>:'date.formats'</tt>).
-      def localize(locale, object, format = :default)
-        raise ArgumentError, "Object must be a Date, DateTime or Time object. #{object.inspect} given." unless object.respond_to?(:strftime)
-
-        format = decide_on_localization_format(locale, object, format)
-
-        # TODO only translate these if the format string is actually present
-        # TODO check which format strings are present, then bulk translate then, then replace them
-        format.gsub!(/%a/, translate(locale, :"date.abbr_day_names")[object.wday])
-        format.gsub!(/%A/, translate(locale, :"date.day_names")[object.wday])
-        format.gsub!(/%b/, translate(locale, :"date.abbr_month_names")[object.mon])
-        format.gsub!(/%B/, translate(locale, :"date.month_names")[object.mon])
-        format.gsub!(/%p/, translate(locale, :"time.#{object.hour < 12 ? :am : :pm}")) if object.respond_to? :hour
-        object.strftime(format)
-      end
-
-      def initialized?
-        @initialized ||= false
-      end
-
-      # Returns an array of locales for which translations are available
-      def available_locales
-        init_translations unless initialized?
-        translations.keys
-      end
-
-      def reload!
-        flush_translations if stale?
-      end
-
-      def stale?
-        translation_path_removed? || translation_file_updated_or_added?
-      end
-
-      protected
-        def init_translations
-          load_translations(*load_paths)
-          @initialized = true
-        end
-
-        def flush_translations
-          @initialized = false
-          @translations = nil
-          @file_mtimes = {}
-        end
-
-        def load_paths
-          I18n.load_path.flatten
-        end
-
-        def translations
-          @translations ||= {}
-        end
-
-        def decide_on_localization_format(locale, object, format)
-          type = object.respond_to?(:sec) ? 'time' : 'date'
-          # TODO raise exception unless format found?
-          lookup(locale, :"#{type}.formats.#{format}") || format.to_s.dup
-        end
-
-        # Looks up a translation from the translations hash. Returns nil if
-        # eiher key is nil, or locale, scope or key do not exist as a key in the
-        # nested translations hash. Splits keys or scopes containing dots
-        # into multiple keys, i.e. <tt>currency.format</tt> is regarded the same as
-        # <tt>%w(currency format)</tt>.
-        def lookup(locale, key, scope = [])
-          return unless key
-          init_translations unless initialized?
-          keys = I18n.send(:normalize_translation_keys, locale, key, scope)
-          keys.inject(translations) do |result, k|
-            if (x = result[k.to_sym]).nil?
-              return nil
-            else
-              x
-            end
-          end
-        end
-        alias lookup_with_count lookup
-
-        # Evaluates a default translation.
-        # If the given default is a String it is used literally. If it is a Symbol
-        # it will be translated with the given options. If it is an Array the first
-        # translation yielded will be returned.
-        #
-        # <em>I.e.</em>, <tt>default(locale, [:foo, 'default'])</tt> will return +default+ if
-        # <tt>translate(locale, :foo)</tt> does not yield a result.
-        def default(locale, default, options = {})
-          case default
-            when String then default
-            when Symbol then translate locale, default, options
-            when Array  then default.each do |obj|
-              result = default(locale, obj, options.dup) and return result
-            end and nil
-          end
-        rescue MissingTranslationData
-          nil
-        end
-
-        # Picks a translation from an array according to English pluralization
-        # rules. It will pick the first translation if count is not equal to 1
-        # and the second translation if it is equal to 1. Other backends can
-        # implement more flexible or complex pluralization rules.
-        def pluralize(locale, entry, count)
-          return entry unless entry.is_a?(Hash) and count
-          # raise InvalidPluralizationData.new(entry, count) unless entry.is_a?(Hash)
-          key = :zero if count == 0 && entry.has_key?(:zero)
-          key ||= count == 1 ? :one : :other
-          raise InvalidPluralizationData.new(entry, count) unless entry.has_key?(key)
-          entry[key]
-        end
-
-        # Interpolates values into a given string.
-        #
-        #   interpolate "file {{file}} opened by \\{{user}}", :file => 'test.txt', :user => 'Mr. X'
-        #   # => "file test.txt opened by {{user}}"
-        #
-        # Note that you have to double escape the <tt>\\</tt> when you want to escape
-        # the <tt>{{...}}</tt> key in a string (once for the string and once for the
-        # interpolation).
-        def interpolate(string, values = {})
-          return string unless string.is_a?(String)
-
-          string.gsub(MATCH) do
-            escaped, pattern, key = $1, $2, $3.to_sym
-
-            if escaped
-              pattern
-            elsif INTERPOLATION_RESERVED_KEYS.include?(key)
-              raise ReservedInterpolationKey.new(key, string)
-            elsif !values.include?(key)
-              raise MissingInterpolationArgument.new(key, string)
-            else
-              values[key].to_s
-            end
-          end
-        end
-
-        # Loads a single translations file by delegating to #load_rb or
-        # #load_yml depending on the file extension and directly merges the
-        # data to the existing translations. Raises I18n::UnknownFileType
-        # for all other file extensions.
-        def load_file(filename)
-          type = File.extname(filename).tr('.', '').downcase
-          raise UnknownFileType.new(type, filename) unless respond_to?(:"load_#{type}")
-          record_mtime_of(filename)
-          data = send :"load_#{type}", filename # TODO raise a meaningful exception if this does not yield a Hash
-          data.each { |locale, d| merge_translations(locale, d) }
-        end
-
-        def record_mtime_of(filename)
-          file_mtimes[filename] = File.mtime(filename)
-        end
-
-        def stale_translation_file?(filename)
-          (mtime = file_mtimes[filename]).nil? || !File.file?(filename) || mtime < File.mtime(filename)
-        end
-
-        def file_mtimes
-          @file_mtimes ||= {}
-        end
-
-        def translation_path_removed?
-          (file_mtimes.keys - load_paths).any?
-        end
-
-        def translation_file_updated_or_added?
-          load_paths.any? {|path| stale_translation_file?(path)}
-        end
-
-        # Loads a plain Ruby translations file. eval'ing the file must yield
-        # a Hash containing translation data with locales as toplevel keys.
-        def load_rb(filename)
-          eval(IO.read(filename), binding, filename)
-        end
-
-        # Loads a YAML translations file. The data must have locales as
-        # toplevel keys.
-        def load_yml(filename)
-          YAML::load(IO.read(filename))
-        end
-
-        # Deep merges the given translations hash with the existing translations
-        # for the given locale
-        def merge_translations(locale, data)
-          locale = locale.to_sym
-          translations[locale] ||= {}
-          data = deep_symbolize_keys(data)
-
-          translations[locale].merge!(data, &DEEP_MERGE_PROC)
-        end
-
-        # Return a new hash with all keys and nested keys converted to symbols.
-        def deep_symbolize_keys(hash)
-          hash.inject({}) do |result, (key, value)|
-            value = deep_symbolize_keys(value) if value.is_a? Hash
-            result[(key.to_sym rescue key) || key] = value
-            result
-          end
-        end
+    class Simple < Base
     end
   end
 end

data/lib/i18n/exceptions.rb

@@ -1,3 +1,11 @@
+# encoding: utf-8
+
+class KeyError < IndexError
+  def initialize(message = nil)
+    super(message || "key not found")
+  end
+end unless defined?(KeyError)
+
 module I18n
   class ArgumentError < ::ArgumentError; end
 
@@ -13,7 +21,7 @@ module I18n
     attr_reader :locale, :key, :options
     def initialize(locale, key, options)
       @key, @locale, @options = key, locale, options
-      keys = I18n.send(:normalize_translation_keys, locale, key, options && options[:scope])
+      keys = I18n.send(:normalize_translation_keys, locale, key, options[:scope])
       keys << 'no key' if keys.size < 2
       super "translation missing: #{keys.join(', ')}"
     end
@@ -28,10 +36,10 @@ module I18n
   end
 
   class MissingInterpolationArgument < ArgumentError
-    attr_reader :key, :string
-    def initialize(key, string)
-      @key, @string = key, string
-      super "interpolation argument #{key.inspect} missing in #{string.inspect}"
+    attr_reader :values, :string
+    def initialize(values, string)
+      @values, @string = values, string
+      super "missing interpolation argument in #{string.inspect} (#{values.inspect} given)"
     end
   end
 

data/lib/i18n/gettext.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module I18n
+  module Gettext
+    PLURAL_SEPARATOR  = "\001"
+    CONTEXT_SEPARATOR = "\004"
+
+    @@plural_keys = { :en => [:one, :other] }
+    
+    class << self
+      # returns an array of plural keys for the given locale so that we can
+      # convert from gettext's integer-index based style
+      # TODO move this information to the pluralization module
+      def plural_keys(locale)
+        @@plural_keys[locale] || @@plural_keys[:en]
+      end
+
+      def extract_scope(msgid, separator = nil)
+        scope = msgid.to_s.split(separator || '|')
+        msgid = scope.pop
+        [scope, msgid]
+      end
+    end
+  end
+end

data/lib/i18n/helpers/gettext.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module I18n
+  module Helpers
+    # Implements classical Gettext style accessors. To use this include the
+    # module to the global namespace or wherever you want to use it.
+    #
+    #   include I18n::Helpers::Gettext
+    module Gettext
+      def _(msgid, options = {})
+        I18n.t(msgid, { :default => msgid, :separator => '|' }.merge(options))
+      end
+
+      def sgettext(msgid, separator = '|')
+        scope, msgid = I18n::Gettext.extract_scope(msgid, separator)
+        I18n.t(msgid, :scope => scope, :default => msgid)
+      end
+
+      def pgettext(msgctxt, msgid, separator = I18n::Gettext::CONTEXT_SEPARATOR)
+        sgettext([msgctxt, msgid].join(separator), separator)
+      end
+
+      def ngettext(msgid, msgid_plural, n = 1)
+        nsgettext(msgid, msgid_plural, n, nil)
+      end
+
+      def nsgettext(msgid, msgid_plural, n = 1, separator = nil)
+        scope, msgid = I18n::Gettext.extract_scope(msgid, separator)
+        default = { :one => msgid, :other => msgid_plural }
+        msgid = [msgid, I18n::Gettext::PLURAL_SEPARATOR, msgid_plural].join
+        I18n.t(msgid, :default => default, :count => n, :scope => scope)
+      end
+    end
+  end
+end