tr8n_core 4.0.1 → 4.0.2

data/lib/tr8n/config.rb

@@ -1,5 +1,7 @@
+#!ruby19
+# encoding: utf-8
 #--
-# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+# Copyright (c) 2014 Michael Berkovich, tr8nhub.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -23,268 +25,320 @@
 
 module Tr8n
 
+  class << self
+    attr_accessor :config
+  end
+
+  # Initializes default config
+
   def self.config
     @config ||= Tr8n::Config.new
   end
 
-  # config class can be set
-  def self.config=(config)
-    @config = config
+  # Allows you to configure Tr8n
+  #
+  # Tr8n.configure do |config|
+  #    config.application = {:key => "", :secret => ""}
+  #
+  # end
+  #
+
+  def self.configure
+    yield(self.config)
+  end
+
+  # Allows you to create a block to perform something on adjusted config settings
+  # Once the block exists, the config will be reset back to what it was before:
+  #
+  #  Tr8n.with_config_settings do |config|
+  #     config.format = :text
+  #
+  #     Do something....
+  #
+  #  end
+  #
+
+  def with_config_settings
+    old_config = @config.dup
+    yield(@config)
+    @config = old_config
   end
 
   # Acts as a global singleton that holds all Tr8n configuration
   # The class can be extended with a different implementation, as long as the interface is supported
-  class Config < Tr8n::Base
-    thread_safe_attributes :application, :current_user, :current_language, :current_translator, :current_source, :current_component
-    thread_safe_attributes :block_options
+  class Config
+    # Configuration Attributes
+    attr_accessor :enabled, :default_locale, :default_level, :format, :application, :context_rules, :logger, :cache, :default_tokens, :localization
 
-    def root
-      @root ||= File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
-    end
+    # Used by Rails and Sinatra extensions
+    attr_accessor :current_locale_method, :current_user_method
 
-    def env
-      'defaults'
-    end
+    # Used for IRB only
+    attr_accessor :submit_missing_keys_realtime
 
-    def defaults
-      @defaults ||= Tr8n::Utils.load_yaml("#{root}/config/config.yml", env)
-    end
+    def initialize
+      @enabled = true
+      @default_locale = 'en-US'
+      @default_level  = 0
+      @format = :html
 
-    def enabled?
-      hash_value(defaults, "enabled")
-    end
+      # if running from IRB, make it default to TRUE
+      @submit_missing_keys_realtime = (['irb', 'pry'].include?($0 || ''))
 
-    def disabled?
-      not enabled?
-    end
+      @current_locale_method = :current_locale
+      @current_user_method = :current_user
 
-    #########################################################
-    ## Application
-    #########################################################
-
-    def host
-      hash_value(defaults, "application.host")
-    end
+      @application = {
+        :host     => 'http://localhost:3000',
+        :key      => 'default',
+        :secret   => '12345',
+      }
 
-    def app_key
-      hash_value(defaults, "application.key")
-    end
+      @context_rules = {
+        :number => {
+          :variables => {
+          }
+        },
+        :gender => {
+          :variables => {
+              "@gender" => "gender",
+          }
+        },
+        :genders => {
+          :variables => {
+            "@genders" => lambda{|list| list.collect do |u|
+              u.is_a?(Hash) ? (u["gender"] || u[:gender]) : u.gender
+            end
+            },
+            "@size" => lambda{|list| list.size}
+          }
+        },
+        :date => {
+          :variables => {
+          }
+        },
+        :time => {
+          :variables => {
+          }
+        },
+        :list => {
+          :variables => {
+            "@count" => lambda{|list| list.size}
+          }
+        },
+      }
 
-    def app_secret
-      hash_value(defaults, "application.secret")
-    end
+      @logger  = {
+        :enabled  => false,
+        :path     => './log/tr8n.log',
+        :level    => 'debug'
+      }
 
-    def init_application
-      Tr8n::Application.init(host, app_key, app_secret)
-      self.current_source = "/tr8n/core"
-    end
+      @cache = {
+        :enabled  => false,
+        :host     => 'localhost:11211',
+        :adapter  => 'memcache',
+        :version  => 1,
+        :timeout  => 3600
+      }
 
-    def default_locale
-      return application.default_locale if application
-      hash_value(defaults, "default_locale")
-    end
+      @default_tokens = {
+        :html => {
+          :data => {
+            :ndash  =>  "&ndash;",       # –
+            :mdash  =>  "&mdash;",       # —
+            :iexcl  =>  "&iexcl;",       # ¡
+            :iquest =>  "&iquest;",      # ¿
+            :quot   =>  "&quot;",        # "
+            :ldquo  =>  "&ldquo;",       # “
+            :rdquo  =>  "&rdquo;",       # ”
+            :lsquo  =>  "&lsquo;",       # ‘
+            :rsquo  =>  "&rsquo;",       # ’
+            :laquo  =>  "&laquo;",       # «
+            :raquo  =>  "&raquo;",       # »
+            :nbsp   =>  "&nbsp;",        # space
+            :lsaquo =>  "&lsaquo;",      # ‹
+            :rsaquo =>  "&rsaquo;",      # ›
+            :br     =>  "<br/>",         # line break
+            :lbrace =>  "{",
+            :rbrace =>  "}",
+            :trade  =>  "&trade;",       # TM
+          },
+          :decoration => {
+            :strong =>  "<strong>{$0}</strong>",
+            :bold   =>  "<strong>{$0}</strong>",
+            :b      =>  "<strong>{$0}</strong>",
+            :em     =>  "<em>{$0}</em>",
+            :italic =>  "<i>{$0}</i>",
+            :i      =>  "<i>{$0}</i>",
+            :link   =>  "<a href='{$href}'>{$0}</a>",
+            :br     =>  "<br>{$0}",
+            :strike =>  "<strike>{$0}</strike>",
+            :div    =>  "<div id='{$id}' class='{$class}' style='{$style}'>{$0}</div>",
+            :span   =>  "<span id='{$id}' class='{$class}' style='{$style}'>{$0}</span>",
+            :h1     =>  "<h1>{$0}</h1>",
+            :h2     =>  "<h2>{$0}</h2>",
+            :h3     =>  "<h3>{$0}</h3>",
+          }
+        },
+        :text => {
+          :data => {
+            :ndash  =>  "–",
+            :mdash  =>  "-",
+            :iexcl  =>  "¡",
+            :iquest =>  "¿",
+            :quot   =>  '"',
+            :ldquo  =>  "“",
+            :rdquo  =>  "”",
+            :lsquo  =>  "‘",
+            :rsquo  =>  "’",
+            :laquo  =>  "«",
+            :raquo  =>  "»",
+            :nbsp   =>  " ",
+            :lsaquo =>  "‹",
+            :rsaquo =>  "›",
+            :br     =>  "\n",
+            :lbrace =>  "{",
+            :rbrace =>  "}",
+            :trade  =>  "™",
+          },
+          :decoration => {
+            :strong =>  "{$0}",
+            :bold   =>  "{$0}",
+            :b      =>  "{$0}",
+            :em     =>  "{$0}",
+            :italic =>  "{$0}",
+            :i      =>  "{$0}",
+            :link   =>  "{$0}:{$1}",
+            :br     =>  "\n{$0}",
+            :strike =>  "{$0}",
+            :div    =>  "{$0}",
+            :span   =>  "{$0}",
+            :h1     =>  "{$0}",
+            :h2     =>  "{$0}",
+            :h3     =>  "{$0}",
+          }
+        }
+      }
 
-    def default_language
-      return Tr8n::Language.new(:locale => default_locale, :default => true) if disabled?
-      application.language(default_locale)
+      @localization = {
+        :default_day_names        =>  ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"],
+        :default_abbr_day_names   =>  ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"],
+        :default_month_names      =>  ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"],
+        :default_abbr_month_names =>  ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"],
+        :custom_date_formats      =>  {
+          :default                => '%m/%d/%Y',            # 07/4/2008
+          :short_numeric          => '%m/%d',               # 07/4
+          :short_numeric_year     => '%m/%d/%y',            # 07/4/08
+          :long_numeric           => '%m/%d/%Y',            # 07/4/2008
+          :verbose                => '%A, %B %d, %Y',       # Friday, July  4, 2008
+          :monthname              => '%B %d',               # July 4
+          :monthname_year         => '%B %d, %Y',           # July 4, 2008
+          :monthname_abbr         => '%b %d',               # Jul 4
+          :monthname_abbr_year    => '%b %d, %Y',           # Jul 4, 2008
+          :date_time              => '%m/%d/%Y at %H:%M',   # 01/03/1010 at 5:30
+        },
+        :token_mapping => {
+          "%a" => "{short_week_day_name}",
+          "%A" => "{week_day_name}",
+          "%b" => "{short_month_name}",
+          "%B" => "{month_name}",
+          "%p" => "{am_pm}",
+          "%d" => "{days}",
+          "%e" => "{day_of_month}",
+          "%j" => "{year_days}",
+          "%m" => "{months}",
+          "%W" => "{week_num}",
+          "%w" => "{week_days}",
+          "%y" => "{short_years}",
+          "%Y" => "{years}",
+          "%l" => "{trimed_hour}",
+          "%H" => "{full_hours}",
+          "%I" => "{short_hours}",
+          "%M" => "{minutes}",
+          "%S" => "{seconds}",
+          "%s" => "{since_epoch}"
+        }
+      }
     end
 
-    def default_level
-      return application.default_level if application
-      hash_value(defaults, "default_level")
+    def enabled?
+      enabled
     end
 
-    def reset
-      self.application = nil
-      self.current_user = nil
-      self.current_language = nil
-      self.current_translator = nil
-      self.current_source = nil
-      self.current_component = nil
-      self.block_options = nil
+    def disabled?
+      not enabled?
     end
 
     #########################################################
-    ## Logger
+    ## Application
     #########################################################
 
-    def logger_enabled?
-      hash_value(defaults, "logger.enabled")
-    end
-
-    def log_path
-      ".#{hash_value(defaults, "logger.path")}"
-    end
+    #def default_locale
+    #  return Tr8n.session.application.default_locale if Tr8n.session.application
+    #  @default_locale
+    #end
+    #
+    #def default_level
+    #  return Tr8n.session.application.default_level if Tr8n.session.application
+    #  @default_level
+    #end
 
     #########################################################
-    ## Cache
+    ## Decorations
     #########################################################
 
-    def cache_enabled?
-      hash_value(defaults, "cache.enabled")
-    end
-
-    def cache_path
-      "#{root}#{hash_value(defaults, "cache.path")}"
-    end
-
-    def cache_adapter
-      hash_value(defaults, "cache.adapter")
-    end
-
-    def cache_version
-      hash_value(defaults, "cache.version")
-    end
-
-    def cache_host
-      hash_value(defaults, "cache.host")
-    end
-
-    def cache_timeout
-      hash_value(defaults, 'cache.timeout')
-    end
-
-    #########################################################
-    ## Rules Engine
-    #########################################################
-
-    def context_rules
-      @context_rules ||= {
-          "number" => {
-              "variables" => {
-              }
-          },
-          "gender" => {
-              "variables" => {
-                  "@gender" => "gender",
-              }
-          },
-          "genders" => {
-              "variables" => {
-                  "@genders" => lambda{|list| list.collect do |u|
-                      u.is_a?(Hash) ? (u["gender"] || u[:gender]) : u.gender
-                    end
-                  },
-                  "@size" => lambda{|list| list.size}
-              }
-          },
-          "date" => {
-              "variables" => {
-              }
-          },
-          "time" => {
-              "variables" => {
-              }
-          },
-          "list" => {
-              "variables" => {
-                  "@count" => lambda{|list| list.size}
-              }
-          },
-      }
-    end
-
     def decorator_class
+      return Tr8n::Decorators::Html if @format == :html
       Tr8n::Decorators::Default
     end
 
-    def default_data_tokens
-      @default_data_tokens ||= Tr8n::Utils.load_yaml("#{root}/config/tokens/data.yml")
-    end
-
-    def default_decoration_tokens
-      @default_decoration_tokens ||= Tr8n::Utils.load_yaml("#{root}/config/tokens/decorations.yml")
-    end
-
     def default_token_value(token_name, type = :data, format = :html)
-      return default_data_tokens[format.to_s][token_name.to_s] if type.to_sym == :data
-      return default_decoration_tokens[format.to_s][token_name.to_s] if type.to_sym == :decoration
+      default_tokens[format.to_sym][type.to_sym][token_name.to_sym]
     end
 
     #########################################################
-    ## Block Options
+    ## Localization
     #########################################################
 
-    def block_options
-      (Thread.current[:block_options] ||= []).last || {}
-    end
-
-    def with_block_options(opts)
-      Thread.current[:block_options] ||= []
-      Thread.current[:block_options].push(opts)
-      if block_given?
-        ret = yield
-      end
-      Thread.current[:block_options].pop
-      ret
+    def strftime_symbol_to_token(symbol)
+      localization[:token_mapping][symbol]
     end
 
-    def current_source_from_block_options
-      arr = Thread.current[:block_options] || []
-      arr.reverse.each do |opts|
-        return application.source_by_key(opts[:source]) unless opts[:source].blank?
-      end
-      nil
+    def default_day_names
+      localization[:default_day_names]
     end
 
-    def current_component_from_block_options
-      arr = Thread.current[:block_options] || []
-      arr.reverse.each do |opts|
-        return application.component_by_key(opts[:component]) unless opts[:component].blank?
-      end
-      Tr8n.config.current_component
+    def default_day_name(index)
+      "" + default_day_names[index]
     end
 
-    #########################################################
-    ## Localization
-    #########################################################
-
-    def localization
-      hash_value(defaults, "localization")
+    def default_abbr_day_names
+      localization[:default_abbr_day_names]
     end
 
-    def strftime_symbol_to_token(symbol)
-      {
-          "%a" => "{short_week_day_name}",
-          "%A" => "{week_day_name}",
-          "%b" => "{short_month_name}",
-          "%B" => "{month_name}",
-          "%p" => "{am_pm}",
-          "%d" => "{days}",
-          "%e" => "{day_of_month}",
-          "%j" => "{year_days}",
-          "%m" => "{months}",
-          "%W" => "{week_num}",
-          "%w" => "{week_days}",
-          "%y" => "{short_years}",
-          "%Y" => "{years}",
-          "%l" => "{trimed_hour}",
-          "%H" => "{full_hours}",
-          "%I" => "{short_hours}",
-          "%M" => "{minutes}",
-          "%S" => "{seconds}",
-          "%s" => "{since_epoch}"
-      }[symbol]
+    def default_abbr_day_name(index)
+      "" + default_abbr_day_names[index]
     end
 
-    def default_day_names
-      hash_value(defaults, "localization.default_day_names")
+    def default_month_names
+      localization[:default_month_names]
     end
 
-    def default_abbr_day_names
-      hash_value(defaults, "localization.default_abbr_day_names")
+    def default_month_name(index)
+      "" + default_month_names[index]
     end
 
-    def default_month_names
-      hash_value(defaults, "localization.default_month_names")
+    def default_abbr_month_names
+      localization[:default_abbr_month_names]
     end
 
-    def default_abbr_month_names
-      hash_value(defaults, "localization.default_abbr_month_names")
+    def default_abbr_month_name(index)
+      "" + default_abbr_month_names[index]
     end
 
     def default_date_formats
-      hash_value(defaults, "localization.custom_date_formats")
+      localization[:custom_date_formats]
     end
 
   end

data/lib/tr8n/decorators/base.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+# Copyright (c) 2014 Michael Berkovich, tr8nhub.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/decorators/default.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+# Copyright (c) 2014 Michael Berkovich, tr8nhub.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/decorators/html.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+# Copyright (c) 2014 Michael Berkovich, tr8nhub.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -28,8 +28,8 @@ class Tr8n::Decorators::Html < Tr8n::Decorators::Base
     return translated_label if options[:skip_decorations]
     # if translation key language is the same as target language - skip decorations
     return translated_label if translation_key.language == target_language
-    return translated_label unless Tr8n.config.current_translator and Tr8n.config.current_translator.inline?
-    return translated_label if translation_key.locked? and not Tr8n.config.current_translator.manager?
+    return translated_label unless Tr8n.session.current_translator and Tr8n.session.current_translator.inline?
+    return translated_label if translation_key.locked? and not Tr8n.session.current_translator.manager?
 
     element = 'span'
     if options[:use_div]
@@ -44,7 +44,7 @@ class Tr8n::Decorators::Html < Tr8n::Decorators::Base
     
     if translation_key.locked?
       # must be a manager and enabling locking feature
-      return translated_label unless Tr8n.config.current_translator.feature_enabled?(:show_locked_keys)
+      return translated_label unless Tr8n.session.current_translator.feature_enabled?(:show_locked_keys)
       classes << 'tr8n_locked'
     elsif translation_language == translation_key.language
       classes << 'tr8n_not_translated'

data/lib/tr8n/exception.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+# Copyright (c) 2014 Michael Berkovich, tr8nhub.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/language.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+# Copyright (c) 2014 Michael Berkovich, tr8nhub.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -80,7 +80,7 @@ class Tr8n::Language < Tr8n::Base
   end
 
   def current_source(options)
-    options[:source] || Tr8n.config.block_options[:source] || Tr8n.config.current_source
+    options[:source] || Tr8n.session.block_options[:source] || Tr8n.session.current_source || 'undefined'
   end
 
   #######################################################################################################
@@ -104,8 +104,8 @@ class Tr8n::Language < Tr8n::Base
     return label if label.tr8n_translated?
 
     params = Tr8n::Utils.normalize_tr_params(label, description, tokens, options)
-    key_locale = hash_value(params[:options], :locale) || hash_value(Tr8n.config.block_options, :locale) || Tr8n.config.default_locale
-    key_level = hash_value(params[:options], :level) || hash_value(Tr8n.config.block_options, :level) || Tr8n.config.default_level
+    key_locale = hash_value(params[:options], :locale) || hash_value(Tr8n.session.block_options, :locale) || Tr8n.config.default_locale
+    key_level = hash_value(params[:options], :level) || hash_value(Tr8n.session.block_options, :level) || Tr8n.config.default_level
 
     temp_key = Tr8n::TranslationKey.new({
         :application  => application,
@@ -118,7 +118,7 @@ class Tr8n::Language < Tr8n::Base
 
     #Tr8n.logger.info("Translating " + params[:label] + " from: " + key_locale.inspect + " to " + locale.inspect)
 
-    params[:tokens].merge!(:viewing_user => Tr8n.config.current_user)
+    params[:tokens].merge!(:viewing_user => Tr8n.session.current_user)
 
     if Tr8n.config.disabled? or locale == key_locale
       return temp_key.substitute_tokens(params[:label], params[:tokens], self, params[:options]).tr8n_translated
@@ -130,15 +130,15 @@ class Tr8n::Language < Tr8n::Base
     end
 
     # no cache or translator is using inline mode - use service, otherwise load from cache
-    if not Tr8n.config.cache_enabled? or (Tr8n.config.current_translator and Tr8n.config.current_translator.inline?)
+    if not Tr8n.config.cache[:enabled] or (Tr8n.session.current_translator and Tr8n.session.current_translator.inline?)
       return translate_from_service(temp_key, params[:tokens], params[:options]).tr8n_translated  
     end
 
     translate_from_cache(temp_key, params[:tokens], params[:options]).tr8n_translated
-  rescue Exception => ex
-    Tr8n.logger.error("Failed to translate: #{params[:label]} : #{ex.message}")
-    Tr8n.logger.error(ex.backtrace)
-    params[:label]
+  #rescue Exception => ex
+  #  Tr8n.logger.error("Failed to translate: #{params[:label]} : #{ex.message}")
+  #  Tr8n.logger.error(ex.backtrace)
+  #  params[:label]
   end
   alias :tr :translate
 
@@ -199,24 +199,14 @@ class Tr8n::Language < Tr8n::Base
   def translate_from_service(translation_key, tokens, options)
     source_key = current_source(options)
 
-    if source_key
-      source = application.source(source_key)
-      source_translation_keys = source.fetch_translations_for_language(self, options)
-      if source_translation_keys[translation_key.key]
-        translation_key = source_translation_keys[translation_key.key]
-      else
-        application.register_missing_key(translation_key, source)
-      end
-
-      return translation_key.translate(self, tokens, options)
-    end
-
-    # all translations are cached in memory as the second level cache
-    memory_cached_translation_key = application.translation_key(translation_key.key)
-    if memory_cached_translation_key
-      translation_key = memory_cached_translation_key
+    source = application.source(source_key)
+    source_translation_keys = source.fetch_translations_for_language(self, options)
+    if source_translation_keys[translation_key.key]
+      translation_key = source_translation_keys[translation_key.key]
     else
-      translation_key = translation_key.fetch_translations(self, options)
+      application.register_missing_key(translation_key, source)
+      memory_cached_translation_key = application.translation_key(translation_key.key)
+      translation_key = memory_cached_translation_key if memory_cached_translation_key
     end
 
     translation_key.translate(self, tokens, options)