mack-localization 0.6.0

data/README

@@ -0,0 +1,110 @@
+Mack-Localization
+-----------------------------------------------------------------------------
+
+== Summary
+Mack-Localization gem provides localization support for the Mack Framework.
+Multi-byte support is provided by unicodechars gem.
+
+== Installation #TODO: gem must be uploaded to rubyforge
+sudo gem install mack-localization
+
+== Using The Gem
+
+{Configuration File}
+
+Several of the localization framework settings can be overwritten by the application
+if the application has the localization.yml file.
+
+If you want to configure the localization settings, you will need to add 
+the localization.yml file to your mack framework in [APP_ROOT]/config/localization.
+
+The following settings are configurable:
+    'base_directory'
+    This will tell the framework where to start looking for the content file.
+    The root of the content files is configurable, but the file structure in that
+    folder is assumed.  The framework will assume the following file structure in the
+    content folder:
+        [CONTENT_ROOT]/views/...
+
+    'base_language'
+    This will tell the framework what is the default supported language
+    
+    'supported_languages'
+    This provides the list languages that the application support. For each
+    language specified in this list, please make sure that there is a corresponding
+    content file provided.  
+    
+    'char_encoding'
+    This tells the framework what is the default character encoding it should be using.
+    NOTE: this feature is not yet implemented.
+    
+    'dynamic_translation'
+    If this feature is set, then when a request for translated string cannot be found in
+    the language file, the system will perform a dynamic lookup to translation service,
+    and cache the content for future uses.  This feature is yet to be implemented
+    
+    'content_expiry'
+    This will tell the framework how long it should wait before expiring the cached content.
+    
+The following is an example of the localization.yml file:
+    base_language: 'fr'
+
+    supported_languages: 
+      - bp
+      - en
+      - fr
+      - it
+      - es
+      - de
+
+    char_encoding: 'utf-8'
+
+    dynamic_translation: true
+
+    content_expiry: 10
+
+{Convenience Routines provided by the framework}
+
+The following is the list of globally accessible convenient methods provided to all application using this framework:
+    'l10n_config'
+    Let the application access to the configuration of the localization framework.
+    Accessing this will give you the set values of read from localization.yml file
+    
+    'l10n_translator'
+    Let the application access to the translator instance.
+    
+    '10n_formatter'
+    Let the application access the formatter instance.
+    
+The following is the list of convenient methods provided to all application as view helpers:
+    'l10n_gets(key, view_sym, lang)'
+    Get the string for a specific key in a view with the specified language
+    
+    'l10n_getimg(key, view_sym, lang)'
+    Get the image path mapped to the specified key in the specified language and view
+    
+    'l10n_date(time, type, lang)'
+    Format the date using the specified type (:short, :medium, :long)
+    
+    'l10n_currency(amt, lang)'
+    Apply currency format to the given amount in the specified language.
+    
+The third utility is programming the view code in a view/language context:
+
+l10n_context(view_sym, lang) do |ctx|
+    ...HTML...
+    <%= ctx.gets(key) %>
+    ..........
+end
+
+== Contact
+Please mail bugs, suggestions, and patches to darsono.sutedja@gmail.com
+
+== Copyright Notices
+Copyright (c) 2008 Darsono Sutedja
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/localization/configuration.rb

@@ -0,0 +1,40 @@
+
+#
+# Mack Localization's main configuration.
+# When loaded it will try to load localization.yml file from
+# {config_dir}/localization/ inside the application directory.
+# If the file doesn't exist then it will just load default configuration.
+#
+module Mack
+  module Localization # :nodoc:
+    module Configuration
+
+      unless self.const_defined?("L10N_DEFAULTS")
+        L10N_DEFAULTS = {
+          "base_language"       => "en",
+          "supported_languages"  => %w{bp en fr it de es},
+          "char_encoding"       => 'us-ascii',
+          "dynamic_translation" => false,
+          "base_directory"      => File.join(Mack.root, "app", "lang"),
+          "content_expiry"      => 3600
+        }
+      end
+      
+      app_config.load_hash(L10N_DEFAULTS, "l10n_defaults")
+      path = File.join(Mack.root, "config" , "localization", "localization.yml")
+      if File.exists?(path)
+        app_config.load_file(path)
+      end
+    end 
+  end
+end
+
+class Object  
+  
+  #
+  # Give access to the mack l10n config object from anywhere inside the application
+  #
+  def l10n_config
+    app_config
+  end
+end

data/lib/localization/content_cache.rb

@@ -0,0 +1,12 @@
+module Mack
+  module Localization # :nodoc:
+    class ContentCache < Cachetastic::Caches::Base
+    end
+  end
+end
+
+class Object
+  def l10n_cache
+    Mack::Localization::ContentCache
+  end
+end

data/lib/localization/errors.rb

@@ -0,0 +1,80 @@
+module Mack
+  module Localization # :nodoc:
+    module Errors # :nodoc:
+      
+      #
+      # Raise this error when caller specified unsupported language.
+      # Supported language is defined in configuration as an array of language codes.
+      #
+      class UnsupportedLanguage < StandardError
+        def initialize(lang)
+          super("Locale: #{lang} is not currently supported.")
+        end
+      end
+      
+      #
+      # Raise this error when caller specified an unsupported char encoding.
+      # This feature is not currently supported yet.
+      #
+      class UnsupportedEncoding < StandardError
+        def initialize(encoding)
+          super("Encoding: #{encoding} is not currently supported")
+        end
+      end
+
+      #
+      # Raise this error if the method called is not yet implemented
+      #
+      class UnsupportedFeature < StandardError
+        def initialize(feature)
+          super("Feature: #{feature} is currently unsupported")
+        end
+      end
+      
+      # 
+      # Raise this error when the user is trying to get a string using an invalid key
+      #
+      class UnknownStringKey < StandardError
+        def initialize(key)
+          super("Key: #{key} cannot be found in the language files")
+        end
+      end
+      
+      #
+      # Raise this error when the formatter cannot find the engine for the given language
+      #
+      class FormatEngineNotFound < StandardError
+        def initialize(lang)
+          super("Format engine not found for '#{lang}'")
+        end
+      end
+      
+      #
+      # Raise this error when the user is calling method that doesn't exist (similar to NoMethodError)
+      #
+      class InvalidMethodName < StandardError
+        def initialize(method_name)
+          super("Unknown method: #{method_name}")
+        end
+      end
+      
+      class InvalidArgument < StandardError
+        def initialize(param_name)
+          super("Invalid argument passed into method: param_name")
+        end
+      end
+      
+      #
+      # Raise this error when the configuration file is not properly setup
+      #
+      class InvalidConfiguration < StandardError
+      end
+      
+      #
+      # Raise this error if a language file is missing
+      #
+      class LanguageFileNotFound < StandardError
+      end
+    end
+  end
+end

data/lib/localization/format_engine/df_engines/base.rb

@@ -0,0 +1,41 @@
+module Mack
+  module Localization # :nodoc:
+    module DateFormatEngine # :nodoc:
+      class Base
+        
+        def format(time = Time.now, type = :long)
+          day          = time.day
+          day_of_week  = time.wday
+          day_of_month = time.mday
+          month        = time.month
+          year         = time.year
+
+          raise Mack::Localization::Errors::InvalidArgument.new(type) if date_format_template(type).nil?
+          
+          template = date_format_template(type).dup
+          template.gsub!("mm", "%02d" % month.to_s)
+          template.gsub!("MM", months(type)[month-1])
+          template.gsub!("dd", "%02d" % day.to_s)
+          template.gsub!("yyyy", year.to_s)
+          template.gsub!("DD", days_of_week(type)[day_of_week-1])
+          
+          return template
+        end
+
+        protected 
+        def date_format_template(type)
+          raise "Unimplemented: date_format(type)"
+        end
+
+        def days_of_week(type)
+          raise "Unimplemented: days_of_week(type)"
+        end
+
+        def months(type)
+          raise "Unimplemented: month(type)"
+        end
+
+      end
+    end
+  end
+end

data/lib/localization/format_engine/df_engines/bp.rb

@@ -0,0 +1,42 @@
+module Mack
+  module Localization # :nodoc:
+    module DateFormatEngine # :nodoc:
+      class BP < Base
+        
+        def date_format_template(type)
+          hash = ivar_cache("df_hash") do
+            df_hash = {
+              :df_short    => "dd/mm/yyyy",
+              :df_medium   => "DD, dd MM, yyyy",
+              :df_long     => "DD, dd MM, yyyy"
+            }
+          end
+          return hash["df_#{type}".to_sym]
+        end
+        
+        def days_of_week(type)
+          hash = ivar_cache("dow_hash") do 
+            dow_hash = {
+              :dow_short   => %w{S T Q Q S S D},
+              :dow_medium  => %w{Seg Ter Qua Qui Sex Sáb Dom},
+              :dow_long    => %w{Segunda Terça Quarta Quinta Sexta Sábado Domingo}
+            }
+          end
+          return hash["dow_#{type}".to_sym]
+        end
+        
+        def months(type)
+          hash = ivar_cache("m_hash") do 
+            m_hash = {
+              :month_short => %w{Jan Fev Mar Abr Mai Jun Jul Ago Set Out Nov Dez},
+              :month_medium => %w{Jan Fev Mar Abr Mai Jun Jul Ago Set Out Nov Dez},
+              :month_long  => %w{Janeiro Fevereiro Março Abril Maio Junho Julho Agosto Setembro Outubro Novembro Dezembro}
+            }
+          end
+          return hash["month_#{type}".to_sym]
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/df_engines/de.rb

@@ -0,0 +1,42 @@
+module Mack
+  module Localization # :nodoc:
+    module DateFormatEngine # :nodoc:
+      class DE < Base
+        
+        def date_format_template(type)
+          hash = ivar_cache("df_hash") do
+            df_hash = {
+              :df_short    => "dd/mm/yyyy",
+              :df_medium   => "DD, dd MM, yyyy",
+              :df_long     => "DD, dd MM, yyyy"
+            }
+          end
+          return hash["df_#{type}".to_sym]
+        end
+        
+        def days_of_week(type)
+          hash = ivar_cache("dow_hash") do 
+            dow_hash = {
+              :dow_short   => %w{M D M D F S S},
+              :dow_medium   => %w{Mon Die Mit Don Fre Sam Son},
+              :dow_long    => %w{Montag Dienstag Mittwoch Donnerstag Freitag Samstag Sonntag},
+            }
+          end
+          return hash["dow_#{type}".to_sym]
+        end
+        
+        def months(type)
+          hash = ivar_cache("m_hash") do 
+            m_hash = {
+              :month_short => %w{Jan Feb Mär Apr Mai Jun Jul Aug Sep Okt Nov Dez},
+              :month_medium => %w{Jan Feb Mär Apr Mai Jun Jul Aug Sep Okt Nov Dez},
+              :month_long  => %w{Januar Februar März April Mai Juni Juli August September Oktober November Dezember}
+            }
+          end
+          return hash["month_#{type}".to_sym]
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/df_engines/en.rb

@@ -0,0 +1,43 @@
+module Mack
+  module Localization # :nodoc:
+    module DateFormatEngine # :nodoc:
+      class EN < Base
+        
+        def date_format_template(type)
+          hash = ivar_cache("df_hash") do
+            df_hash = {
+              :df_short    => "mm/dd/yyyy",
+              :df_medium   => "DD, MM dd, yyyy",
+              :df_long     => "DD, MM dd, yyyy"
+            }
+          end
+          
+          return hash["df_#{type}".to_sym]
+        end
+        
+        def days_of_week(type)
+          hash = ivar_cache("dow_hash") do 
+            dow_hash = {
+              :dow_short => %w{M T W T F S S},
+              :dow_medium => %w{Mon Tue wed Thu Fri Sat Sun},
+              :dow_long => %w{Monday Tuesday Wednesday Thursday Friday Saturday Sunday}
+            }
+          end
+          return hash["dow_#{type}".to_sym]
+        end
+        
+        def months(type)
+          hash = ivar_cache("m_hash") do 
+            m_hash = {
+              :month_short => %w{Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec},
+              :month_medium => %w{Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec},
+              :month_long  => %w{January February March April May June July August September October November December}
+            }
+          end
+          return hash["month_#{type}".to_sym]
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/df_engines/es.rb

@@ -0,0 +1,42 @@
+module Mack
+  module Localization # :nodoc:
+    module DateFormatEngine # :nodoc:
+      class ES < Base
+        
+        def date_format_template(type)
+          hash = ivar_cache("df_hash") do
+            df_hash = {
+              :df_short    => "dd/mm/yyyy",
+              :df_medium   => "DD, dd MM, yyyy",
+              :df_long     => "DD, dd MM, yyyy"
+            }
+          end
+          return hash["df_#{type}".to_sym]
+        end
+        
+        def days_of_week(type)
+          hash = ivar_cache("dow_hash") do 
+            dow_hash = {
+              :dow_short   => %w{L M M J V S D},
+              :dow_medium  => %w{Lun Mar Mié Jue Vie Sáb Dom},
+              :dow_long    => %w{Lunes Martes Mi\303\251rcoles Jueves Viernes S\303\241bado Domingo}
+            }
+          end
+          return hash["dow_#{type}".to_sym]
+        end
+        
+        def months(type)
+          hash = ivar_cache("m_hash") do 
+            m_hash = {
+              :month_short => %w{Ene Feb Mar Abr May Jun Jul Ago Sep Oct Nov Dic},
+              :month_medium => %w{Ene Feb Mar Abr May Jun Jul Ago Sep Oct Nov Dic},
+              :month_long  => %w{Enero Febrero Marzo Abril Mayo Junio Julio Agosto Septiembre Octubre Noviembre Diciembre}
+            }
+          end
+          return hash["month_#{type}".to_sym]
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/df_engines/fr.rb

@@ -0,0 +1,42 @@
+module Mack
+  module Localization # :nodoc:
+    module DateFormatEngine # :nodoc:
+      class FR < Base
+        
+        def date_format_template(type)
+          hash = ivar_cache("df_hash") do
+            df_hash = {
+              :df_short    => "dd/mm/yyyy",
+              :df_medium   => "DD, dd MM, yyyy",
+              :df_long     => "DD, dd MM, yyyy"
+            }
+          end
+          return hash["df_#{type}".to_sym]
+        end
+        
+        def days_of_week(type)
+          hash = ivar_cache("dow_hash") do 
+            dow_hash = {
+              :dow_short   => %w{L M M J V S D},
+              :dow_medium   => %w{Lun Mar Mer Jeu Ven Sam Dim},
+              :dow_long    => %w{Lundi Mardi Mercredi Jeudi vendredi samedi dimanche},
+            }
+          end
+          return hash["dow_#{type}".to_sym]
+        end
+        
+        def months(type)
+          hash = ivar_cache("m_hash") do 
+            m_hash = {
+              :month_short => %w{Jan Fév Mar Avr Mai Jun Jui Aoû Sep Oct Nov Dec},
+              :month_medium => %w{Jan Fév Mar Avr Mai Jun Jui Aoû Sep Oct Nov Dec},
+              :month_long  => %w{Janvier Février Mars Avril Mai Juin Juillet Août Septembre Octobre Novembre Décembre},
+            }
+          end
+          return hash["month_#{type}".to_sym]
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/df_engines/it.rb

@@ -0,0 +1,42 @@
+module Mack
+  module Localization # :nodoc:
+    module DateFormatEngine # :nodoc:
+      class IT < Base
+        
+        def date_format_template(type)
+          hash = ivar_cache("df_hash") do
+            df_hash = {
+              :df_short    => "dd/mm/yyyy",
+              :df_medium   => "DD, dd MM, yyyy",
+              :df_long     => "DD, dd MM, yyyy"
+            }
+          end
+          return hash["df_#{type}".to_sym]
+        end
+        
+        def days_of_week(type)
+          hash = ivar_cache("dow_hash") do 
+            dow_hash = {
+              :dow_short   => %w{L M M G V S D},
+              :dow_medium  => %w{Lun Mar Mer Gio Ven Sab Dom},
+              :dow_long    => %w{Lunedi Martedì Mercoledì Giovedi Venerdì Sabato Domenica}
+            }
+          end
+          return hash["dow_#{type}".to_sym]
+        end
+        
+        def months(type)
+          hash = ivar_cache("m_hash") do 
+            m_hash = {
+              :month_short => %w{Gen Feb Mar Apr Mag Giu Lug Ago Set Ott Nov Dic},
+              :month_medium => %w{Gen Feb Mar Apr Mag Giu Lug Ago Set Ott Nov Dic},
+              :month_long  => %w{Gennaio Febbraio Marzo Aprile Maggio Giugno Luglio Agosto Settembre Ottobre Novembre Dicembre}
+            }
+          end
+          return hash["month_#{type}".to_sym]
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/engine_registry.rb

@@ -0,0 +1,52 @@
+module Mack
+  module Localization # :nodoc:
+    class FormatEngineRegistry
+      include Singleton
+      
+      def initialize
+        # { 
+        #    :en => {:date => {...}, :num_currency => {...}},
+        #    :fr => ...
+        # }
+        @reg = {}
+      end
+      
+      #
+      # Register a format engine
+      #
+      # params:
+      #   lang - the language of the engine
+      #   type - either l10n_formatter.date_format_registry_key or l10n_formatter.currency_format_registry_key
+      #   overwrite - whether or not to overwrite the formatter if it's already registered. default == false
+      #
+      def register(lang, type, obj, overwrite = false)
+        lang = lang.to_sym
+        type = type.to_sym
+        if @reg[lang].nil?
+          @reg[lang] = {type => obj}
+        else
+          type_reg = @reg[lang]
+          type_reg[type] = obj if type_reg[type].nil? or (overwrite and !type_reg[type].nil?)
+        end
+      end
+      
+      #
+      # Retrieve a registered engine
+      #
+      # params:
+      #   lang - the language
+      #   type - either l10n_formatter.date_format_registry_key or l10n_formatter.currency_format_registry_key
+      #
+      # returns the registered engine, or nil if no engine is registered for that type/lang
+      #
+      def get_engine(lang, type)
+        lang = lang.to_sym
+        type = type.to_sym
+        type_reg = @reg[lang]
+        return nil if type_reg.nil?
+        return type_reg[type]
+      end
+      
+    end
+  end
+end

data/lib/localization/format_engine/nc_engines/base.rb

@@ -0,0 +1,35 @@
+module Mack
+  module Localization # :nodoc:
+    module NumberAndCurrencyFormatEngine # :nodoc:
+      class Base
+        
+        def format_currency(num, lang)
+          currency = "#{unit}#{format_number(num, lang)}"
+          return currency
+        end
+
+        def format_number(num, lang)
+          num_str = "%01.2f" % num
+          parts = num_str.split(".")
+          parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
+          parts.join separator
+        end
+        
+        protected 
+        
+        def delimiter
+          raise "Unimplemented: delimiter"
+        end
+        
+        def unit
+          raise "Unimplemented: unit"
+        end
+        
+        def separator
+          raise "Unimplemented: separator"
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/nc_engines/bp.rb

@@ -0,0 +1,20 @@
+module Mack
+  module Localization # :nodoc:
+    module NumberAndCurrencyFormatEngine # :nodoc:
+      class BP < Base
+        def delimiter
+          return ","
+        end
+        
+        def unit
+          return "R$"
+        end
+        
+        def separator
+          return "."
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/nc_engines/de.rb

@@ -0,0 +1,20 @@
+module Mack
+  module Localization # :nodoc:
+    module NumberAndCurrencyFormatEngine # :nodoc:
+      class DE < Base
+        def delimiter
+          return "."
+        end
+        
+        def unit
+          return "€"
+        end
+        
+        def separator
+          return ","
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/nc_engines/en.rb

@@ -0,0 +1,20 @@
+module Mack
+  module Localization # :nodoc:
+    module NumberAndCurrencyFormatEngine # :nodoc:
+      class EN < Base
+        def delimiter
+          return ","
+        end
+        
+        def unit
+          return "$"
+        end
+        
+        def separator
+          return "."
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/nc_engines/es.rb

@@ -0,0 +1,20 @@
+module Mack
+  module Localization # :nodoc:
+    module NumberAndCurrencyFormatEngine # :nodoc:
+      class ES < Base
+        def delimiter
+          return "."
+        end
+        
+        def unit
+          return "€"
+        end
+        
+        def separator
+          return ","
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/nc_engines/fr.rb

@@ -0,0 +1,20 @@
+module Mack
+  module Localization # :nodoc:
+    module NumberAndCurrencyFormatEngine # :nodoc:
+      class FR < Base
+        def delimiter
+          return " "
+        end
+        
+        def unit
+          return "€"
+        end
+        
+        def separator
+          return ","
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/format_engine/nc_engines/it.rb

@@ -0,0 +1,20 @@
+module Mack
+  module Localization # :nodoc:
+    module NumberAndCurrencyFormatEngine # :nodoc:
+      class IT < Base
+        def delimiter
+          return "."
+        end
+        
+        def unit
+          return "€"
+        end
+        
+        def separator
+          return ","
+        end
+        
+      end
+    end
+  end
+end

data/lib/localization/formatter.rb

@@ -0,0 +1,118 @@
+module Mack
+  module Localization # :nodoc:
+    class Formatter
+      
+      include Singleton
+      
+      #
+      # Initialize the formatter object.  Out of the box
+      # it will register 5 language supports for both
+      # the date and currency format
+      #
+      def initialize
+        @reg = Mack::Localization::FormatEngineRegistry.instance
+
+        [:en, :bp, :fr, :it, :de, :es].each do |lang|
+          klass = "Mack::Localization::DateFormatEngine::#{lang.to_s.upcase}" 
+          @reg.register(lang, date_format_registry_key, klass.constantize.new)
+        end
+        
+        [:en, :bp, :fr, :it, :de, :es].each do |lang|
+          klass = "Mack::Localization::NumberAndCurrencyFormatEngine::#{lang.to_s.upcase}" 
+          @reg.register(lang, currency_format_registry_key, klass.constantize.new)
+        end
+      end
+      
+      #
+      # Given a time, format according to the specified type (:short, :medium, :long)
+      # and language. 
+      #
+      # params:
+      #   time - the instance of time to be formatted
+      #   type - what's the format? short, medium, or long
+      #   lang - the language
+      # 
+      # returns:
+      #   the multibyte version of the formatted string
+      #
+      # see also:
+      #   l10n_date in view_helpers
+      #
+      # examples:
+      #   time = Time.local(2008, "dec", 1)
+      #   date_format(time, :short, :en) will produce "12/01/2008"
+      #   date_format(time, :medium, :en) will produce "Tue, Dec 01, 2008"
+      #   date_format(time, :long, :en) will produce "Tuesday, December 01, 2008"
+      #
+      def date_format(time, type, lang)
+        engine = @reg.get_engine(lang, date_format_registry_key)
+        raise Mack::Localization::Errors::FormatEngineNotFound.new(lang.to_s) if engine.nil?
+        return u(engine.format(time, type))
+      end
+      
+      # 
+      # Given a number, format it according to the specified language
+      #
+      # params:
+      #   num - the number to be formatted
+      #   lang - the language
+      #
+      # returns:
+      #   the multibyte version of the formatted string
+      #
+      # see also:
+      #   l10n_number in view_helpers
+      #
+      # examples:
+      #   number_format(10000.00, :en) will produce "10,000.00"
+      #
+      def number_format(num, lang)
+        engine = @reg.get_engine(lang, currency_format_registry_key)
+        raise Mack::Localization::Errors::FormatEngineNotFound.new(lang.to_s) if engine.nil?
+        return u(engine.format_number(num, lang))
+      end
+      
+      # 
+      # Given a currency, format it according to the specified language
+      #
+      # params:
+      #   num - the amount of money to be formatted
+      #   lang - the language
+      #
+      # returns:
+      #   the multibyte version of the formatted string
+      #
+      # see also:
+      #   l10n_currency in view_helpers
+      #
+      # examples:
+      #   currency_format(10000.00, :en) will produce "$10,000.00"
+      #
+      def currency_format(num, lang)
+        engine = @reg.get_engine(lang, currency_format_registry_key)
+        raise Mack::Localization::Errors::FormatEngineNotFound.new(lang.to_s) if engine.nil?
+        return u(engine.format_currency(num, lang))
+      end
+      
+      # 
+      # Return the registry key for date formatter
+      #
+      def date_format_registry_key
+        return :date_format
+      end
+      
+      #
+      # Return the registry key for currency formatter
+      #
+      def currency_format_registry_key
+        return :currency_format
+      end
+    end
+  end
+end
+
+class Object
+  def l10n_formatter
+    Mack::Localization::Formatter.instance
+  end
+end

data/lib/localization/helpers/view_helpers/l10n_helpers.rb

@@ -0,0 +1,141 @@
+module Mack
+  module ViewHelpers # :nodoc:
+    module L10NHelpers
+      
+      class Context
+        include Mack::ViewHelpers::L10NHelpers
+        
+        def initialize(view_sym, lang)
+          @view_sym = view_sym
+          @lang     = lang
+        end
+        
+        def gets(key)
+          l10n_gets(key, @view_sym, @lang)
+        end
+        
+        def getimg(key)
+          l10n_getimg(key, @view_sym, @lang)
+        end
+        
+        def date(time, type)
+          l10n_date(time, type, @lang)
+        end
+        
+        def number(num)
+          l10n_number(num, @lang)
+        end
+        
+        def currency(amount)
+          l10n_currency(amount, @lang)
+        end
+      end
+      
+      def l10n_context(view_sym, lang = session[:lang] || :en)
+        ctx = Context.new(view_sym, lang)
+        yield ctx
+      end
+      
+      #
+      # View helper method to get the localized string in the given view_sym path and language
+      # using the specified key.
+      #
+      # params:
+      #   key - lookup key
+      #   view_sym - tell the system where to look for the content file
+      #   lang - the language code
+      #
+      # See:
+      #   Mack::Localization::Translator.getimg
+      #
+      # Returns:
+      #   the multibyte version of the localized string
+      #
+      def l10n_gets(key, view_sym = controller.controller_name, lang = session[:lang] || :en)
+        return l10n_translator.gets(view_sym.to_sym, key, lang)
+      end
+      
+      #
+      # View helper method to get the localized image path in the given view_sym path and language
+      # using the specified key.
+      #
+      # params:
+      #   key - lookup key
+      #   view_sym - tell the system where to look for the content file
+      #   lang - the language code
+      #
+      # See:
+      #   Mack::Localization::Translator.getimg
+      #
+      # Returns:
+      #   the multibyte version of the path to the localized image
+      #
+      def l10n_getimg(key, view_sym = controller.controller_name, lang = session[:lang] || :en)
+        return l10n_translator.getimg(view_sym.to_sym, key, lang)
+      end
+
+      #
+      # View helper method to format the specified date based on the given language code
+      #
+      # params:
+      #   time   - the date to be formatted
+      #   type   - :short, :medium, :long
+      #   lang   - language code
+      # 
+      # See:
+      #   Mack::Localization::Formatter.date_format
+      #
+      # Example:
+      #   aTime = Time.local(2008, "jan", 1)
+      #   l10n_date(aTime, :short, :en) produces "Jan 01, 2008"
+      #
+      # Returns:
+      #   the multibyte version of the formatted date
+      #
+      def l10n_date(time, type, lang = session[:lang] || :en)
+        return l10n_formatter.date_format(time, type, lang)
+      end
+      
+      #
+      # View helper method to format the number based on the given language code
+      #
+      # params:
+      #   num  - the number to be formatted
+      #   lang - language code
+      # 
+      # See:
+      #   Mack::Localization::Formatter.number_format
+      #
+      # Example:
+      #   l10n_number(10000, :en) produces "10,000.00"
+      #
+      # Returns:
+      #   the multibyte version of the formatted number
+      #
+      def l10n_number(num, lang = session[:lang] || :en)
+        return l10n_formatter.number_format(num, lang)
+      end
+      
+      #
+      # View helper method to format the currency based on the given language code
+      #
+      # params:
+      #   amount - the amount of money
+      #   lang   - language code
+      # 
+      # See:
+      #   Mack::Localization::Formatter.currency_format
+      #
+      # Example:
+      #   l10n_currency(10000, :en) produces "$10,000.00"
+      #
+      # Returns:
+      #   the multibyte version of the formatted currency
+      #
+      def l10n_currency(amount, lang = session[:lang] || :en)
+        return l10n_formatter.currency_format(amount, lang)
+      end
+      
+    end
+  end
+end

data/lib/localization/translator.rb

@@ -0,0 +1,108 @@
+module Mack
+  module Localization # :nodoc:
+    class Translator
+      include Singleton
+      
+      #
+      # Get the localized string for the specified language using the given key in the view_sym namespace.
+      # The view symbol is how the system knows where to locate the content file.
+      # By default the localization of the file is in [app_directory]/lang/views/[view_sym]/content_[lang].yml
+      # 
+      # params:
+      #    view_sym -- which view is the key located in?
+      #    key -- the lookup key
+      #    lang -- the language
+      #
+      # returns:
+      #    the multibyte version of the string
+      #
+      # raise:
+      #    UnsupportedLanguage if the specified language is not defined in the 'supported_languages' array
+      #    UnknownStringKey if the key specified is not defined in the content file
+      #
+      # see also:
+      #    l10n_gets in view_helpers
+      #
+      def gets(view_sym, key, lang)
+        view_name = view_sym.to_s
+        base_lang = l10n_config.base_language
+        base_lang = lang.to_s if !lang.nil?
+        
+        raise UnsupportedLanguage.new(base_lang) if !l10n_config.supported_languages.include?(base_lang)
+        
+        cache_key = "#{view_sym}_#{base_lang}_content"
+        path      = File.join(l10n_config.base_directory, "views", "#{view_name}", "content_#{base_lang}.yml")
+        content_hash = load_content_hash(cache_key, base_lang, path)
+      
+        raise UnknownStringKey.new(key) if content_hash[key] == nil
+        return u(content_hash[key])
+      end
+      
+      def getimg(view_sym, key, lang)
+        raise UnsupportedFeature.new("getimg")
+      end
+      
+      # REVIEW: inflection... should localized inflection use the same inflection engine as the english counterpart?
+      def pluralize(key, lang, num)
+        return u(inflect(key, lang, num, :plural))
+      end
+      
+      def irregular(key, lang, num)
+        return u(inflect(key, lang, num, :irregular))
+      end
+    
+      private
+      
+      def inflect(key, lang, num, type)
+        base_lang = l10n_config.base_language
+        base_lang = lang if !lang.nil?
+        
+        raise UnsupportedLanguage.new(base_lang) if !l10n_config.supported_languages.include?(base_lang)
+        
+        cache_key = "rules_content_#{base_lang}"
+        path      = File.join(l10n_config.base_directory, "rules", "inflection_#{base_lang}.yml")
+        content_hash = load_content_hash(cache_key, base_lang, path)
+        
+        hash = content_hash[type]
+        raise InvalidConfiguration.new if hash.nil?
+        
+        arr = hash[key]
+        raise InvalidConfiguration.new if arr.nil?
+        raise InvalidConfiguration.new if arr.size != 2
+        
+        if num <= 1
+          val = sprintf(arr[0], num)
+        else
+          val = sprintf(arr[1], num)
+        end
+        
+        return val
+      end
+            
+      private 
+      
+      def load_content_hash(cache_key, base_lang, path)
+        # content_hash = l10n_config.send("#{cache_key}")
+        content_hash = l10n_cache.get("#{cache_key}")
+        
+        if content_hash.nil?
+          raise InvalidConfiguration.new if base_lang.nil?
+          raise LanguageFileNotFound.new if !File.exists?(path)
+          
+          data = File.read(path)
+          content_hash = YAML.load(data)
+          l10n_cache.set("#{cache_key}", content_hash, l10n_config.content_expiry)
+        end
+        
+        return content_hash
+      end
+      
+    end
+  end
+end
+
+class Object
+  def l10n_translator
+    Mack::Localization::Translator.instance
+  end
+end

data/lib/mack-localization.rb

@@ -0,0 +1,7 @@
+require 'unicodechars'
+require 'yaml'
+
+dir_globs = Dir.glob(File.join(File.dirname(__FILE__), "localization", "**/*.rb"))
+dir_globs.each do |d|
+  require d
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: mack-localization
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- Darsono Sutedja
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-16 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: unicodechars
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: utf8proc
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.3
+    version: 
+description: Localization support for Mack Framework
+email: Darsono.Sutedja@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/localization/configuration.rb
+- lib/localization/content_cache.rb
+- lib/localization/errors.rb
+- lib/localization/format_engine/df_engines/base.rb
+- lib/localization/format_engine/df_engines/bp.rb
+- lib/localization/format_engine/df_engines/de.rb
+- lib/localization/format_engine/df_engines/en.rb
+- lib/localization/format_engine/df_engines/es.rb
+- lib/localization/format_engine/df_engines/fr.rb
+- lib/localization/format_engine/df_engines/it.rb
+- lib/localization/format_engine/engine_registry.rb
+- lib/localization/format_engine/nc_engines/base.rb
+- lib/localization/format_engine/nc_engines/bp.rb
+- lib/localization/format_engine/nc_engines/de.rb
+- lib/localization/format_engine/nc_engines/en.rb
+- lib/localization/format_engine/nc_engines/es.rb
+- lib/localization/format_engine/nc_engines/fr.rb
+- lib/localization/format_engine/nc_engines/it.rb
+- lib/localization/formatter.rb
+- lib/localization/helpers/view_helpers/l10n_helpers.rb
+- lib/localization/translator.rb
+- lib/mack-localization.rb
+- README
+has_rdoc: true
+homepage: http://www.mackframework.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: magrathea
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Localization support for Mack Framework
+test_files: []
+