tml 4.3.1

data/lib/tml/tokens/transform.rb

@@ -0,0 +1,223 @@
+# 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.
+#++
+
+####################################################################### 
+# 
+# Transform Token Form
+#
+# {count:number || one: message, many: messages} 
+# {count:number || one: сообщение, few: сообщения, many: сообщений, other: много сообщений}   in other case the number is not displayed#
+#
+# {count | message}   - will not include {count}, resulting in "messages" with implied {count}
+# {count | message, messages} 
+#
+# {count:number | message, messages} 
+#
+# {user:gender | he, she, he/she}
+#
+# {user:gender | male: he, female: she, other: he/she}
+#
+# {now:date | did, does, will do}
+# {users:list | all male, all female, mixed genders}
+#
+# {count || message, messages}  - will include count:  "5 messages" 
+# 
+####################################################################### 
+
+class Tml::Tokens::Transform < Tml::Tokens::Data
+  attr_reader :pipe_separator, :piped_params
+
+  def self.expression
+    /(\{[^_:|][\w]*(:[\w]+)*(::[\w]+)*\s*\|\|?[^{^}]+\})/
+  end
+
+  def parse_elements
+    name_without_parens = @full_name[1..-2]
+    name_without_pipes = name_without_parens.split('|').first.strip
+    name_without_case_keys = name_without_pipes.split('::').first.strip
+
+    @short_name = name_without_pipes.split(':').first.strip
+    @case_keys = name_without_pipes.scan(/(::\w+)/).flatten.uniq.collect{|c| c.gsub('::', '')}
+    @context_keys = name_without_case_keys.scan(/(:\w+)/).flatten.uniq.collect{|c| c.gsub(':', '')}
+
+    @pipe_separator = (full_name.index("||") ? "||" : "|")
+    @piped_params = name_without_parens.split(pipe_separator).last.split(",").collect{|param| param.strip}
+  end
+
+  def displayed_in_translation?
+    pipe_separator == "||"
+  end
+
+  def implied?
+    not displayed_in_translation?
+  end
+
+  def prepare_label_for_suggestion(label, index, language)
+    context = context_for_language(language)
+    values = generate_value_map(piped_params, context)
+
+    label.gsub(full_name, values[context.default_rule] || values.values.first)
+  end
+
+  # token:      {count|| one: message, many: messages}
+  # results in: {"one": "message", "many": "messages"}
+  #
+  # token:      {count|| message}
+  # transform:  [{"one": "{$0}", "other": "{$0::plural}"}, {"one": "{$0}", "other": "{$1}"}]
+  # results in: {"one": "message", "other": "messages"}
+  #
+  # token:      {count|| message, messages}
+  # transform:  [{"one": "{$0}", "other": "{$0::plural}"}, {"one": "{$0}", "other": "{$1}"}]
+  # results in: {"one": "message", "other": "messages"}
+  #
+  # token:      {user| Dorogoi, Dorogaya}
+  # transform:  ["unsupported", {"male": "{$0}", "female": "{$1}", "other": "{$0}/{$1}"}]
+  # results in: {"male": "Dorogoi", "female": "Dorogaya", "other": "Dorogoi/Dorogaya"}
+  #
+  # token:      {actors:|| likes, like}
+  # transform:  ["unsupported", {"one": "{$0}", "other": "{$1}"}]
+  # results in: {"one": "likes", "other": "like"}
+  def generate_value_map(params, context)
+    values = {}
+
+    if params.first.index(':')
+      params.each do |p|
+        nv = p.split(':')
+        values[nv.first.strip] = nv.last.strip
+      end
+      return values
+    end
+
+    unless context.token_mapping
+      error("The token context #{context.keyword} does not support transformation for unnamed params: #{full_name}")
+      return nil
+    end
+
+    token_mapping = context.token_mapping
+
+    # "unsupported"
+    if token_mapping.is_a?(String)
+      error("The token mapping #{token_mapping} does not support #{params.size} params: #{full_name}")
+      return nil
+    end
+
+    # ["unsupported", "unsupported", {}]
+    if token_mapping.is_a?(Array)
+      if params.size > token_mapping.size
+        error("The token mapping #{token_mapping} does not support #{params.size} params: #{full_name}")
+        return nil
+      end
+      token_mapping = token_mapping[params.size-1]
+      if token_mapping.is_a?(String)
+        error("The token mapping #{token_mapping} does not support #{params.size} params: #{full_name}")
+        return nil
+      end
+    end
+
+    # {}
+    token_mapping.each do |key, value|
+      values[key] = value
+      value.scan(/({\$\d(::\w+)*})/).each do |matches|
+        token = matches.first
+        parts = token[1..-2].split('::')
+        index = parts.first.gsub('$', '').to_i
+
+        if params.size < index
+          error("The index inside #{context.token_mapping} is out of bound: #{full_name}")
+          return nil
+        end
+
+        # apply settings cases
+        value = params[index]
+        if language_cases_enabled?
+          parts[1..-1].each do |case_key|
+            lcase = context.language.case_by_keyword(case_key)
+            unless lcase
+              error("Language case #{case_key} for context #{context.keyword} is not defined: #{full_name}")
+              return nil
+            end
+            value = lcase.apply(value)
+          end
+        end
+        values[key] = values[key].gsub(token, value)
+      end
+    end
+
+    values
+  end
+
+  def substitute(label, context, language, options = {})
+    object = self.class.token_object(context, key)
+
+    unless object
+      return error("Missing value for a token \"#{key}\" in \"#{label}\"", false)
+    end
+
+    if piped_params.empty?
+      return error("Piped params may not be empty for token \"#{key}\" in \"#{label}\"", false)
+    end
+
+    language_context = context_for_language(language)
+
+    unless language_context
+      return error("Unknown context for a token: #{full_name} in #{language.locale}", false)
+    end
+
+    piped_values = generate_value_map(piped_params, language_context)
+
+    unless piped_values
+      return error("Failed to generate value map for: #{full_name} in #{language.locale}", false)
+    end
+
+    rule = language_context.find_matching_rule(object)
+    return label unless rule
+
+    value = piped_values[rule.keyword]
+    if value.nil? and language_context.fallback_rule
+      value = piped_values[language_context.fallback_rule.keyword]
+    end
+
+    return label unless value
+
+    substitution_value = []
+    if displayed_in_translation?
+      substitution_value << token_value(Tml::Utils.hash_value(context, key), language, options)
+      substitution_value << ' '
+    else
+      value = value.gsub("##{short_name}#", token_value(Tml::Utils.hash_value(context, key), language, options))
+    end
+    substitution_value << value
+
+    label.gsub(full_name, substitution_value.join(''))
+  end
+  
+end

data/lib/tml/translation.rb

@@ -0,0 +1,67 @@
+# 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::Translation < Tml::Base
+  belongs_to :translation_key, :language
+  attributes :locale, :label, :context, :precedence
+
+  def has_context_rules?
+    context and context.any?
+  end
+
+  # checks if the translation is valid for the given tokens
+  #{
+  #    "count" => {"number":"one"},
+  #    "user" => {"gender":"male"}
+  #}
+  def matches_rules?(token_values)
+    return true unless has_context_rules?
+
+    context.each do |token_name, rules|
+      token_object = Tml::Tokens::Data.token_object(token_values, token_name)
+      return false unless token_object
+
+      rules.each do |context_key, rule_key|
+        next if rule_key == 'other'
+
+        context = language.context_by_keyword(context_key)
+        return false unless context
+
+        rule = context.find_matching_rule(token_object)
+        return false if rule.nil? or rule.keyword != rule_key
+      end
+    end
+    
+    true
+  end
+
+end

data/lib/tml/translation_key.rb

@@ -0,0 +1,178 @@
+# 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.
+#++
+
+require 'digest/md5'
+
+class Tml::TranslationKey < Tml::Base
+  belongs_to :application, :language
+  attributes :id, :key, :label, :description, :locale, :level, :locked
+  has_many :translations # hashed by language
+
+  def initialize(attrs = {})
+    super
+
+    self.attributes[:key] ||= self.class.generate_key(label, description)
+    self.attributes[:locale] ||= Tml.session.block_options[:locale] || (application ? application.default_locale : Tml.config.default_locale)
+    self.attributes[:language] ||= application ? application.language(locale) : Tml.config.default_language
+    self.attributes[:translations] = {}
+
+    if hash_value(attrs, :translations)
+      hash_value(attrs, :translations).each do |locale, translations|
+        language = application.language(locale)
+
+        self.attributes[:translations][locale] ||= []
+
+        translations.each do |translation_hash|
+          translation = Tml::Translation.new(translation_hash.merge(:translation_key => self, :locale => language.locale))
+          self.attributes[:translations][locale] << translation
+        end
+      end
+    end
+  end
+
+  def self.generate_key(label, desc = '')
+    "#{Digest::MD5.hexdigest("#{label};;;#{desc}")}~"[0..-2].to_s
+  end
+
+  def has_translations_for_language?(language)
+    translations and translations[language.locale] and translations[language.locale].any?
+  end
+
+  def set_translations(locale, translations)
+    translations.each do |translation|
+      translation.locale ||= locale
+      translation.translation_key = self
+      translation.language = self.application.language(translation.locale)
+    end
+    self.translations[locale] = translations
+  end
+
+  # switches to a new application
+  def set_application(app)
+    self.application = app
+    translations.values.each do |locale_translations|
+      locale_translations.each do |translation|
+        translation.translation_key = self
+        translation.language = self.application.language(translation.locale)
+      end
+    end
+    self
+  end
+
+  ###############################################################
+  ## Translation Methods
+  ###############################################################
+
+  def translations_for_language(language)
+    return [] unless self.translations
+    self.translations[language.locale] || []
+  end
+
+  def find_first_valid_translation(language, token_values)
+    translations = translations_for_language(language)
+
+    translations.sort! { |x,y| x.precedence <=> y.precedence }
+
+    translations.each do |translation|
+      return translation if translation.matches_rules?(token_values)
+    end
+    
+    nil
+  end
+
+  def translate(language, token_values = {}, options = {})
+    if Tml.config.disabled? or language.locale == self.locale
+      return substitute_tokens(label, token_values, language, options.merge(:fallback => false))
+    end
+
+    translation = find_first_valid_translation(language, token_values)
+    decorator = Tml::Decorators::Base.decorator
+
+    if translation
+      translated_label = substitute_tokens(translation.label, token_values, translation.language, options)
+      return decorator.decorate(translated_label, translation.language, language, self, options)
+    end
+
+    translated_label = substitute_tokens(label, token_values, self.language, options)
+    decorator.decorate(translated_label, self.language, language, self, options)
+  end
+
+  ###############################################################
+  ## Token Substitution Methods
+  ###############################################################
+
+  # Returns an array of decoration tokens from the translation key
+  def decoration_tokens
+    @decoration_tokens ||= begin
+      dt = Tml::Tokenizers::Decoration.new(label)
+      dt.parse
+      dt.tokens
+    end
+  end
+
+  # Returns an array of data tokens from the translation key
+  def data_tokens
+    @data_tokens ||= begin
+      dt = Tml::Tokenizers::Data.new(label)
+      dt.tokens
+    end
+  end
+
+  def data_tokens_names_map
+    @data_tokens_names_map ||= begin
+      map = {}
+      data_tokens.each do |token|
+        map[token.name] = token
+      end
+      map
+    end
+  end
+
+  # if the translations engine is disabled
+  def self.substitute_tokens(label, token_values, language, options = {})
+    return label.to_s if options[:skip_substitution] 
+    Tml::TranslationKey.new(:label => label.to_s).substitute_tokens(label.to_s, token_values, language, options)
+  end
+
+  def substitute_tokens(translated_label, token_values, language, options = {})
+    if Tml::Tokenizers::Data.required?(translated_label)
+      translated_label = Tml::Tokenizers::Data.new(translated_label, token_values, :allowed_tokens => data_tokens_names_map).substitute(language, options)
+    end
+
+    if Tml::Tokenizers::Decoration.required?(translated_label)
+      translated_label = Tml::Tokenizers::Decoration.new(translated_label, token_values, :allowed_tokens => decoration_tokens).substitute
+    end
+
+    translated_label
+  end
+
+end