tr8n_core 4.0.1

data/lib/tr8n/config.rb

@@ -0,0 +1,291 @@
+#--
+# Copyright (c) 2013 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
+# "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 OR COPYRIGHT HOLDERS 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.
+#++
+
+module Tr8n
+
+  def self.config
+    @config ||= Tr8n::Config.new
+  end
+
+  # config class can be set
+  def self.config=(config)
+    @config = 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
+
+    def root
+      @root ||= File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+    end
+
+    def env
+      'defaults'
+    end
+
+    def defaults
+      @defaults ||= Tr8n::Utils.load_yaml("#{root}/config/config.yml", env)
+    end
+
+    def enabled?
+      hash_value(defaults, "enabled")
+    end
+
+    def disabled?
+      not enabled?
+    end
+
+    #########################################################
+    ## Application
+    #########################################################
+
+    def host
+      hash_value(defaults, "application.host")
+    end
+
+    def app_key
+      hash_value(defaults, "application.key")
+    end
+
+    def app_secret
+      hash_value(defaults, "application.secret")
+    end
+
+    def init_application
+      Tr8n::Application.init(host, app_key, app_secret)
+      self.current_source = "/tr8n/core"
+    end
+
+    def default_locale
+      return application.default_locale if application
+      hash_value(defaults, "default_locale")
+    end
+
+    def default_language
+      return Tr8n::Language.new(:locale => default_locale, :default => true) if disabled?
+      application.language(default_locale)
+    end
+
+    def default_level
+      return application.default_level if application
+      hash_value(defaults, "default_level")
+    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
+    end
+
+    #########################################################
+    ## Logger
+    #########################################################
+
+    def logger_enabled?
+      hash_value(defaults, "logger.enabled")
+    end
+
+    def log_path
+      ".#{hash_value(defaults, "logger.path")}"
+    end
+
+    #########################################################
+    ## Cache
+    #########################################################
+
+    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
+      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
+    end
+
+    #########################################################
+    ## Block Options
+    #########################################################
+
+    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
+    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
+    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
+    end
+
+    #########################################################
+    ## Localization
+    #########################################################
+
+    def localization
+      hash_value(defaults, "localization")
+    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]
+    end
+
+    def default_day_names
+      hash_value(defaults, "localization.default_day_names")
+    end
+
+    def default_abbr_day_names
+      hash_value(defaults, "localization.default_abbr_day_names")
+    end
+
+    def default_month_names
+      hash_value(defaults, "localization.default_month_names")
+    end
+
+    def default_abbr_month_names
+      hash_value(defaults, "localization.default_abbr_month_names")
+    end
+
+    def default_date_formats
+      hash_value(defaults, "localization.custom_date_formats")
+    end
+
+  end
+end

data/lib/tr8n/decorators/base.rb

@@ -0,0 +1,35 @@
+#--
+# Copyright (c) 2013 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
+# "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 OR COPYRIGHT HOLDERS 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.
+#++
+
+class Tr8n::Decorators::Base < Tr8n::Base
+
+  def self.decorator
+    # can alternate based on the format in the config
+    Tr8n.config.decorator_class.new
+  end
+
+  def decorate(translated_label, translation_language, target_language, translation_key, options = {})
+    raise Tr8n::Exception.new("Must be implemented by the extending class")
+  end
+
+end

data/lib/tr8n/decorators/default.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (c) 2013 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
+# "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 OR COPYRIGHT HOLDERS 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.
+#++
+
+class Tr8n::Decorators::Default < Tr8n::Decorators::Base
+
+  def decorate(translated_label, translation_language, target_language, translation_key, options = {})
+    translated_label
+  end
+  
+end

data/lib/tr8n/decorators/html.rb

@@ -0,0 +1,63 @@
+#--
+# Copyright (c) 2013 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
+# "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 OR COPYRIGHT HOLDERS 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.
+#++
+
+class Tr8n::Decorators::Html < Tr8n::Decorators::Base
+
+  def decorate(translated_label, translation_language, target_language, translation_key, options = {})
+    # skip decoration if instructed so
+    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?
+
+    element = 'span'
+    if options[:use_div]
+      element = 'div'
+    end
+
+    if translation_key.id.nil?
+      return "<#{element} class='tr8n_pending'>#{translated_label}</#{element}>"
+    end
+
+    classes = ['tr8n_translatable']
+    
+    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)
+      classes << 'tr8n_locked'
+    elsif translation_language == translation_key.language
+      classes << 'tr8n_not_translated'
+    elsif translation_language == target_language
+      classes << 'tr8n_translated'
+    else
+      classes << 'tr8n_fallback'
+    end
+
+    html = "<#{element} class='#{classes.join(' ')}' data-translation_key_id='#{translation_key.id}'>"
+    html << translated_label
+    html << "</#{element}>"
+    html
+  end  
+
+end

data/lib/tr8n/exception.rb

@@ -0,0 +1,26 @@
+#--
+# Copyright (c) 2013 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
+# "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 OR COPYRIGHT HOLDERS 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.
+#++
+
+class Tr8n::Exception < StandardError
+
+end

data/lib/tr8n/language.rb

@@ -0,0 +1,250 @@
+#--
+# Copyright (c) 2013 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
+# "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 OR COPYRIGHT HOLDERS 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.
+#++
+
+class Tr8n::Language < Tr8n::Base
+  belongs_to  :application
+  attributes  :locale, :name, :english_name, :native_name, :right_to_left, :flag_url
+  has_many    :contexts, :cases
+
+  def initialize(attrs = {})
+    super
+
+    self.attributes[:contexts] = {}
+    if hash_value(attrs, :contexts)
+      hash_value(attrs, :contexts).each do |key, context|
+        self.attributes[:contexts][key] = Tr8n::LanguageContext.new(context.merge(:language => self))
+      end
+    end
+
+    self.attributes[:cases] = {}
+    if hash_value(attrs, :cases)
+      hash_value(attrs, :cases).each do |key, lcase|
+        self.attributes[:cases][key] = Tr8n::LanguageCase.new(lcase.merge(:language => self))
+      end
+    end
+  end
+
+  def context_by_keyword(keyword)
+    hash_value(contexts, keyword)
+  end
+
+  def context_by_token_name(token_name)
+    contexts.values.detect{|ctx| ctx.applies_to_token?(token_name)}
+  end
+
+  def language_case_by_keyword(keyword)
+    cases[keyword]
+  end
+
+  def has_definition?
+    contexts.any?
+  end
+
+  def default?
+    return true unless application
+    application.default_locale == locale
+  end
+
+  def dir
+    right_to_left? ? "rtl" : "ltr"
+  end
+
+  def align(dest)
+    return dest unless right_to_left?
+    dest.to_s == 'left' ? 'right' : 'left'
+  end
+
+  def full_name
+    return english_name if english_name == native_name
+    "#{english_name} - #{native_name}"
+  end
+
+  def current_source(options)
+    options[:source] || Tr8n.config.block_options[:source] || Tr8n.config.current_source
+  end
+
+  #######################################################################################################
+  # Translation Methods
+  #
+  # Note - when inline translation mode is enable, cache will not be used and translators will
+  # always hit the live service to get the most recent translations
+  #
+  # Some cache adapters cache by source, others by key. Some are read-only, some are built on the fly.
+  #
+  # There are three ways to call the tr method
+  #
+  # tr(label, description = "", tokens = {}, options = {})
+  # or
+  # tr(label, tokens = {}, options = {})
+  # or
+  # tr(:label => label, :description => "", :tokens => {}, :options => {})
+  ########################################################################################################
+
+  def translate(label, description = nil, tokens = {}, options = {})
+    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
+
+    temp_key = Tr8n::TranslationKey.new({
+        :application  => application,
+        :label        => params[:label],
+        :description  => params[:description],
+        :locale       => key_locale,
+        :level        => key_level,
+        :translations => []
+    })
+
+    #Tr8n.logger.info("Translating " + params[:label] + " from: " + key_locale.inspect + " to " + locale.inspect)
+
+    params[:tokens].merge!(:viewing_user => Tr8n.config.current_user)
+
+    if Tr8n.config.disabled? or locale == key_locale
+      return temp_key.substitute_tokens(params[:label], params[:tokens], self, params[:options]).tr8n_translated
+    end
+
+    translation_key = application.translation_key(temp_key.key)
+    if translation_key
+      return translation_key.translate(self, params[:tokens], params[:options])
+    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?)
+      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]
+  end
+  alias :tr :translate
+
+  def translate_from_cache(translation_key, tokens, options)
+    # In most scenarios translations should be cached by source
+    if Tr8n.cache.cached_by_source?
+      source_key = current_source(options)
+      cache_key = Tr8n::Source.cache_key(source_key, locale);
+      source = Tr8n.cache.fetch(cache_key)
+
+      # if it came from cache, it will be full of translation keys with translations for the locale
+      if source
+        translation_keys = source.translation_keys
+      elsif Tr8n.cache.read_only?
+        translation_keys = {}
+      else
+        # get the source info from the application
+        source = application.source(source_key)
+        translation_keys = source.fetch_translations_for_language(self, options)
+        Tr8n.cache.store(cache_key, source)
+      end
+
+      if translation_keys[translation_key.key]
+        translation_key = translation_keys[translation_key.key]
+        return translation_key.translate(self, tokens, options)
+      end
+
+      translation_key.translations = {locale => []}
+      application.cache_translation_key(translation_key)
+      return translation_key.translate(self, tokens, options)
+    end
+
+    # CDB allows for caching by key
+    cache_key = Tr8n::TranslationKey.cache_key(translation_key.label, translation_key.description, locale)
+    translations = Tr8n.cache.fetch(cache_key)
+
+    if translations.nil?
+      if Tr8n.cache.read_only?
+        translation_key.translations = {locale => []}
+        application.cache_translation_key(translation_key)
+        return translation_key.translate(self, tokens, options)
+      end
+
+      translation_key = translation_key.fetch_translations(self, options)
+      Tr8n.cache.store(cache_key, translation_key.translations(self))
+      return translation_key.translate(self, tokens, options)
+    end
+
+    unless translations.is_a?(Array)
+      translations = [translations]
+    end
+
+    translation_key.translations = {locale => translations}
+    application.cache_translation_key(translation_key)
+    translation_key.translate(self, tokens, options)
+  end
+
+  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
+    else
+      translation_key = translation_key.fetch_translations(self, options)
+    end
+
+    translation_key.translate(self, tokens, options)
+  end
+
+  #######################################################################################################
+  ##  Cache Methods
+  #######################################################################################################
+
+  def self.cache_prefix
+    'l@'
+  end
+
+  def self.cache_key(locale)
+    "#{cache_prefix}_[#{locale}]"
+  end
+
+  def to_cache_hash
+    hash = to_hash(:locale, :name, :english_name, :native_name, :right_to_left, :flag_url)
+    hash[:contexts] = {}
+    contexts.each do |name, value|
+      hash[:contexts][name] = value.to_cache_hash
+    end
+    hash[:cases] = {}
+    cases.each do |name, value|
+      hash[:cases][name] = value.to_cache_hash
+    end
+    hash
+  end
+
+end