tml 4.3.1

data/lib/tml/language.rb

@@ -0,0 +1,175 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2015 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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 Tml::Language < Tml::Base
+  belongs_to  :application
+  attributes  :locale, :name, :english_name, :native_name, :right_to_left, :flag_url
+  has_many    :contexts, :cases
+
+  def self.cache_key(locale)
+    File.join(locale, 'language')
+  end
+
+  def fetch
+    update_attributes(application.api_client.get("language/#{locale}", {}, {:cache_key => self.class.cache_key(locale)}))
+  rescue Tml::Exception => ex
+    Tml.logger.error("Failed to load language: #{ex}")
+    self
+  end
+
+  def update_attributes(attrs)
+    super
+
+    self.attributes[:contexts] = {}
+    if hash_value(attrs, :contexts)
+      hash_value(attrs, :contexts).each do |key, context|
+        self.attributes[:contexts][key] = Tml::LanguageContext.new(context.merge(:keyword => key, :language => self))
+      end
+    end
+
+    self.attributes[:cases] = {}
+    if hash_value(attrs, :cases)
+      hash_value(attrs, :cases).each do |key, lcase|
+        self.attributes[:cases][key] = Tml::LanguageCase.new(lcase.merge(:keyword => key, :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 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] || Tml.session.block_options[:source] || Tml.session.current_source || 'undefined').to_s
+  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 = {})
+    params = Tml::Utils.normalize_tr_params(label, description, tokens, options)
+    return params[:label] if params[:label].tml_translated?
+
+    translation_key = Tml::TranslationKey.new({
+      :application  => application,
+      :label        => params[:label],
+      :description  => params[:description],
+      :locale       => hash_value(params[:options], :locale) || hash_value(Tml.session.block_options, :locale) || Tml.config.default_locale,
+      :level        => hash_value(params[:options], :level) || hash_value(Tml.session.block_options, :level) || Tml.config.default_level,
+      :translations => []
+    })
+
+    #Tml.logger.info("Translating " + params[:label] + " from: " + translation_key.locale.inspect + " to " + locale.inspect)
+
+    params[:tokens] ||= {}
+    params[:tokens][:viewing_user] ||= Tml.session.current_user
+
+    if Tml.config.disabled? or self.locale == translation_key.locale
+      return translation_key.substitute_tokens(
+        params[:label],
+        params[:tokens],
+        self,
+        params[:options]
+      ).tml_translated
+    end
+
+    cached_translations = application.cached_translations(locale, translation_key.key)
+    if cached_translations
+      translation_key.set_translations(locale, cached_translations)
+      return translation_key.translate(self, params[:tokens], params[:options]).tml_translated
+    end
+
+    source_key = current_source(options)
+
+    if Tml.cache.segmented? or Tml.session.inline_mode?
+      source = application.source(source_key, locale)
+      cached_translations = source.cached_translations(locale, translation_key.key)
+    else
+      cached_translations = application.fetch_translations(locale)[translation_key.key]
+    end
+
+    if cached_translations
+      translation_key.set_translations(locale, cached_translations)
+    else
+      application.register_missing_key(source_key, translation_key)
+    end
+
+    translation_key.translate(self, params[:tokens], params[:options]).tml_translated
+  end
+  alias :tr :translate
+
+end

data/lib/tml/language_case.rb

@@ -0,0 +1,105 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2015 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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 Tml::LanguageCase < Tml::Base
+  belongs_to  :language
+  attributes  :id, :keyword, :latin_name, :native_name, :description, :application
+  has_many    :rules
+
+  TR8N_HTML_TAGS_REGEX = /<\/?[^>]*>/
+
+  def initialize(attrs = {})
+    super
+    self.attributes[:rules] = []
+    if hash_value(attrs, :rules)
+      self.attributes[:rules] = hash_value(attrs, :rules).collect{ |rule| Tml::LanguageCaseRule.new(rule.merge(:language_case => self)) }
+    end
+  end
+
+  def find_matching_rule(value, object = nil)
+    rules.each do |rule|
+      return rule if rule.evaluate(value, object)
+    end
+    nil
+  end
+
+  #######################################################################################################
+  ##  Evaluation Methods
+  #######################################################################################################
+
+  def apply(value, object = nil, options = {})
+    value = value.to_s
+
+    decorator = Tml::Decorators::Base.decorator
+
+    options = options.merge(:skip_decorations => true) if value.index('not_translated')
+
+    html_tokens = value.scan(TR8N_HTML_TAGS_REGEX).uniq
+    sanitized_value = value.gsub(TR8N_HTML_TAGS_REGEX, '')
+
+    if application.to_s == 'phrase'
+      words = [sanitized_value]
+    else
+      words = sanitized_value.split(/[\s\/\\]/).uniq
+    end
+
+    # replace html tokens with temporary placeholders {$h1}
+    html_tokens.each_with_index do |html_token, index|
+      value = value.gsub(html_token, "{$h#{index}}")
+    end
+
+    # replace words with temporary placeholders {$w1}
+    words.each_with_index do |word, index|
+      value = value.gsub(word, "{$w#{index}}")
+    end
+
+    transformed_words = []
+    words.each do |word|
+      case_rule = find_matching_rule(word, object)
+      case_value = case_rule ? case_rule.apply(word) : word
+      transformed_words << decorator.decorate_language_case(self, case_rule, word, case_value, options)
+    end
+
+    # replace back the temporary placeholders with the html tokens
+    transformed_words.each_with_index do |word, index|
+      value = value.gsub("{$w#{index}}", word)
+    end
+
+    # replace back the temporary placeholders with the html tokens
+    html_tokens.each_with_index do |html_token, index|
+      value = value.gsub("{$h#{index}}", html_token)
+    end
+
+    value
+  end
+
+end

data/lib/tml/language_case_rule.rb

@@ -0,0 +1,76 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2015 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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 Tml::LanguageCaseRule < Tml::Base
+  belongs_to  :language_case
+  attributes  :id, :description, :examples, :conditions, :conditions_expression, :operations, :operations_expression
+
+  def conditions_expression
+    self.attributes[:conditions_expression] ||= Tml::RulesEngine::Parser.new(self.conditions).parse
+  end
+
+  def operations_expression
+    self.attributes[:operations_expression] ||= Tml::RulesEngine::Parser.new(self.operations).parse
+  end
+
+  def gender_variables(object)
+    return {} unless self.conditions.index('@gender')
+    return {'@gender' => 'unknown'} unless object
+    context = language_case.language.context_by_keyword(:gender)
+    return {'@gender' => 'unknown'} unless context
+    context.vars(object)
+  end
+
+  def evaluate(value, object = nil)
+    return false if conditions.nil?
+
+    re = Tml::RulesEngine::Evaluator.new
+    re.evaluate(['let', '@value', value])
+
+    gender_variables(object).each do |key, value|
+      re.evaluate(['let', key, value])
+    end
+
+    re.evaluate(conditions_expression)
+  end
+
+  def apply(value)
+    value = value.to_s
+    return value if operations.nil?
+
+    re = Tml::RulesEngine::Evaluator.new
+    re.evaluate(['let', '@value', value])
+
+    re.evaluate(operations_expression)
+  end
+
+end

data/lib/tml/language_context.rb

@@ -0,0 +1,117 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2015 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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 Tml::LanguageContext < Tml::Base
+  belongs_to  :language
+  attributes  :keyword, :description, :default_key, :token_expression, :variables, :token_mapping
+  has_many    :keys, :rules
+
+  def initialize(attrs = {})
+    super
+
+    self.attributes[:rules] = {}
+    if hash_value(attrs, :rules)
+      hash_value(attrs, :rules).each do |key, rule|
+        self.attributes[:rules][key] = Tml::LanguageContextRule.new(rule.merge(
+         :keyword => key,
+         :language_context => self
+        ))
+      end
+    end
+  end
+
+  def config
+    context_rules = Tml.config.context_rules
+    hash_value(context_rules, self.keyword.to_sym) || {}
+  end
+
+  def token_expression
+    @token_expression ||= begin
+      exp = self.attributes[:token_expression]
+      exp = Regexp.new(exp[1..-2])
+      exp
+    end
+  end
+
+  def applies_to_token?(token)
+    token_expression.match(token) != nil
+  end
+
+  def fallback_rule
+    @fallback_rule ||= rules.values.detect{|rule| rule.fallback?}
+  end
+
+  # prepare variables for evaluation
+  def vars(obj)
+    vars = {}
+
+    variables.each do |key|
+      method = hash_value(config, "variables.#{key}")
+      unless method
+        vars[key] = obj
+        next
+      end
+
+      if method.is_a?(String)
+        if obj.is_a?(Hash)
+          object = hash_value(obj, 'object') || obj
+          if object.is_a?(Hash)
+            vars[key] = hash_value(object, method, :whole => true)
+          else
+            vars[key] = object.send(method)
+          end
+        elsif obj.is_a?(String)
+          vars[key] = obj
+        else
+          vars[key] = obj.send(method)
+        end
+      elsif method.is_a?(Proc)
+        vars[key] = method.call(obj)
+      else
+        vars[key] = obj
+      end
+
+      vars[key] = vars[key].to_s if vars[key].is_a?(Symbol)
+    end
+    vars
+  end
+
+  def find_matching_rule(obj)
+    token_vars = vars(obj)
+    rules.values.each do |rule|
+      next if rule.fallback?
+      return rule if rule.evaluate(token_vars)
+    end
+    fallback_rule
+  end
+
+end