tr8n_core 4.0.1

data/lib/tr8n/tokens/decoration_tokenizer.rb

@@ -0,0 +1,200 @@
+#--
+# 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.
+#++
+
+#######################################################################
+#
+# Decoration Token Forms:
+#
+# [link: click here]
+# or
+# [link] click here [/link]
+#
+# Decoration Tokens Allow Nesting:
+#
+# [link: {count} {_messages}]
+# [link: {count||message}]
+# [link: {count||person, people}]
+# [link: {user.name}]
+#
+#######################################################################
+module Tr8n
+  module Tokens
+    class DecorationTokenizer
+
+      attr_reader :tokens, :fragments, :context, :text, :opts
+
+      RESERVED_TOKEN       = 'tr8n'
+
+      RE_SHORT_TOKEN_START = '\[[\w]*:'
+      RE_SHORT_TOKEN_END   = '\]'
+      RE_LONG_TOKEN_START  = '\[[\w]*\]'
+      RE_LONG_TOKEN_END    = '\[\/[\w]*\]'
+      RE_TEXT              = '[^\[\]]+' #'[\w\s!.:{}\(\)\|,?]*'
+
+      def initialize(text, context = {}, opts = {})
+        @text = "[#{RESERVED_TOKEN}]#{text}[/#{RESERVED_TOKEN}]"
+        @context = context
+        @opts = opts
+        tokenize
+      end
+
+      def tokenize
+        re = [RE_SHORT_TOKEN_START,
+              RE_SHORT_TOKEN_END,
+              RE_LONG_TOKEN_START,
+              RE_LONG_TOKEN_END,
+              RE_TEXT].join('|')
+        @fragments = text.scan(/#{re}/)
+        @tokens = []
+      end
+
+      def parse
+        return @text unless fragments
+        token = fragments.shift
+
+        if token.match(/#{RE_SHORT_TOKEN_START}/)
+          return parse_tree(token.gsub(/[\[:]/, ''), :short)
+        end
+
+        if token.match(/#{RE_LONG_TOKEN_START}/)
+          return parse_tree(token.gsub(/[\[\]]/, ''), :long)
+        end
+
+        token.to_s
+      end
+
+      def parse_tree(name, type = :short)
+        tree = [name]
+        @tokens << name unless (@tokens.include?(name) or name == RESERVED_TOKEN)
+
+        if type == :short
+          first = true
+          until fragments.first.nil? or fragments.first.match(/#{RE_SHORT_TOKEN_END}/)
+            value = parse
+            if first and value.is_a?(String)
+              value = value.lstrip
+              first = false
+            end
+            tree << value
+          end
+        elsif type == :long
+          until fragments.first.nil? or fragments.first.match(/#{RE_LONG_TOKEN_END}/)
+            tree << parse
+          end
+        end
+
+        fragments.shift
+        tree
+      end
+
+      def default_decoration(token_name, token_value)
+        default_decoration = Tr8n.config.default_token_value(token_name, :decoration)
+        unless default_decoration
+          raise Tr8n::Exception.new("Invalid decoration token value #{token_name}")
+        end
+
+        default_decoration = default_decoration.clone
+        decoration_token_values = context[token_name.to_sym] || context[token_name.to_s] || []
+
+        if decoration_token_values.is_a?(Array)
+          params = [token_value, decoration_token_values].flatten
+          params.each_with_index do |param, index|
+            default_decoration.gsub!("{$#{index}}", param.to_s)
+          end
+
+          # clean all the rest of the {$num} params, if any
+          param_index = params.size
+          while default_decoration.index("{$#{param_index}}")
+            default_decoration.gsub!("{$#{param_index}}", "")
+            param_index += 1
+          end
+
+          return default_decoration
+        end
+
+        if decoration_token_values.is_a?(Hash)
+          default_decoration.gsub!("{$0}", token_value.to_s)
+
+          decoration_token_values.keys.each do |key|
+            default_decoration.gsub!("{$#{key}}", decoration_token_values[key].to_s)
+          end
+
+          return default_decoration
+        end
+
+        raise Tr8n::Exception.new("Don't know how to process decoration token value")
+      end
+
+      def allowed_token?(token)
+        return true if opts[:allowed_tokens].nil?
+        opts[:allowed_tokens].include?(token)
+      end
+
+      def apply(token, value)
+        return value if token == RESERVED_TOKEN
+        return value unless allowed_token?(token)
+
+        method = context[token.to_sym] || context[token.to_s]
+
+        if method
+          if method.is_a?(Proc)
+            return method.call(value)
+          end
+
+          if method.is_a?(Array) or method.is_a?(Hash)
+            return default_decoration(token, value)
+          end
+
+          if method.is_a?(String)
+            return method.to_s.gsub("{$0}", value)
+          end
+
+          raise Tr8n::Exception.new("Invalid decoration token value")
+        end
+
+        if Tr8n.config.default_token_value(token, :decoration)
+          return default_decoration(token, value)
+        end
+
+        raise Tr8n::Exception.new("Missing decoration token value")
+      end
+
+      def evaluate(expr)
+        unless expr.is_a?(Array)
+          return expr
+        end
+
+        token = expr[0]
+        args = expr.drop(1)
+        value = args.map { |a| self.evaluate(a) }.join('')
+
+        apply(token, value)
+      end
+
+      def substitute
+        evaluate(parse)
+      end
+
+    end
+  end
+end

data/lib/tr8n/tokens/hidden.rb

@@ -0,0 +1,48 @@
+#--
+# 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.
+#++
+
+####################################################################### 
+# 
+# Hidden Token Forms:
+#
+# {_he_she} 
+# {_posted__items}
+#
+#  '_' escaped as '/'
+#  '__' escaped as '__'
+# 
+# Hidden tokens cannot have rules and are there for default language
+# substitutions only
+#
+####################################################################### 
+
+class Tr8n::Tokens::Hidden < Tr8n::Tokens::Data
+  def self.expression
+    /(\{_[\w]+\})/
+  end
+
+  def allowed_in_translation?
+    false
+  end
+
+end

data/lib/tr8n/tokens/method.rb

@@ -0,0 +1,52 @@
+#--
+# 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.
+#++
+
+####################################################################### 
+# 
+# Method Token Forms
+#
+# {user.name}  
+# {user.name:gender}
+# 
+####################################################################### 
+
+class Tr8n::Tokens::Method < Tr8n::Tokens::Data
+  def self.expression
+    /(\{[^_:.][\w]*(\.[\w]+)(:[\w]+)*(::[\w]+)*\})/
+  end
+
+  def object_name
+    @object_name ||= short_name.split(".").first
+  end
+
+  def object_method_name
+    @object_method_name ||= short_name.split(".").last
+  end
+
+  def substitute(label, context, language, options = {})
+    object = hash_value(context, object_name)
+    raise Tr8n::Exception.new("Missing value for a token: #{full_name}") unless object
+    object_value = sanitize(object, object.send(object_method_name), options.merge(:sanitize_values => true), language)
+    label.gsub(full_name, object_value)
+  end
+end

data/lib/tr8n/tokens/transform.rb

@@ -0,0 +1,191 @@
+#--
+# 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.
+#++
+
+####################################################################### 
+# 
+# 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 Tr8n::Tokens::Transform < Tr8n::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
+
+  # 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(object, 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
+      raise Tr8n::Exception.new("The token context #{context.keyword} does not support transformation for unnamed params: #{full_name}")
+    end
+
+    token_mapping = context.token_mapping
+
+    # "unsupported"
+    if token_mapping.is_a?(String)
+      raise Tr8n::Exception.new("The token mapping #{token_mapping} does not support #{params.size} params: #{full_name}")
+    end
+
+    # ["unsupported", "unsupported", {}]
+    if token_mapping.is_a?(Array)
+      if params.size > token_mapping.size
+        raise Tr8n::Exception.new("The token mapping #{token_mapping} does not support #{params.size} params: #{full_name}")
+      end
+      token_mapping = token_mapping[params.size-1]
+      if token_mapping.is_a?(String)
+        raise Tr8n::Exception.new("The token mapping #{token_mapping} does not support #{params.size} params: #{full_name}")
+      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
+          raise Tr8n::Exception.new("The index inside #{context.token_mapping} is out of bound: #{full_name}")
+        end
+
+        # apply settings cases
+        value = params[index]
+        if Tr8n.config.application.feature_enabled?(:language_cases)
+          parts[1..-1].each do |case_key|
+            lcase = context.language.language_case_by_keyword(case_key)
+            unless lcase
+              raise Tr8n::Exception.new("Language case #{case_key} for context #{context.keyword} is not defined: #{full_name}")
+            end
+            value = lcase.apply(value, object)
+          end
+        end
+        values[key] = values[key].gsub(token, value)
+      end
+    end
+
+    values
+  end
+
+  def substitute(label, context, language, options = {})
+    object = Tr8n::Tokens::Data.token_object(context, key)
+
+    unless object
+      raise Tr8n::Exception.new("Missing value for a token: #{full_name}")
+    end
+
+    if piped_params.empty?
+      raise Tr8n::Exception.new("Piped params may not be empty: #{full_name}")
+    end
+
+    language_context = context_for_language(language)
+
+    piped_values = generate_value_map(object, piped_params, language_context)
+
+    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(hash_value(context, key), options, language)
+      substitution_value << " "
+    end
+    substitution_value << value
+
+    label.gsub(full_name, substitution_value.join(""))
+  end
+  
+end

data/lib/tr8n/translation.rb

@@ -0,0 +1,104 @@
+#--
+# 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::Translation < Tr8n::Base
+  belongs_to :translation_key, :language
+  attributes :locale, :label, :context, :precedence
+
+  def initialize(attrs = {})
+    super
+
+    if locale
+      self.language = self.translation_key.application.language(locale)
+    end
+
+    calculate_precedence
+  end
+
+  # switches to a new translation key
+  def set_translation_key(tkey)
+    self.translation_key = tkey
+    self.language = tkey.application.language(locale)
+  end
+
+  def has_context_rules?
+    context and context.any?
+  end
+
+  #
+  # the precedence is based on the number of fallback rules in the context.
+  # a fallback rule is indicated by the keyword "other"
+  # the more "others" are used the lower the precedence will be
+  #
+  # 0 indicates the highest precedence
+  #
+  def calculate_precedence
+    self.precedence = 0
+    return unless has_context_rules?
+
+    context.values.each do |rules|
+      rules.values.each do |rule_key|
+        self.precedence += 1 if rule_key == "other"
+      end
+    end
+  end
+
+  #{
+  #    "count" => [{"type" => "number", "key" => "one"}],
+  #    "user" => ["type" => "gender", "key" => "male"]
+  #}
+  #{
+  #    "count" => [{"number":"one"}],
+  #    "user" => [{"gender":"male"}]
+  #}
+  # checks if the translation is valid for the given tokens
+  def matches_rules?(token_values)
+    return true unless has_context_rules?
+
+    context.each do |token_name, rules|
+      token_object = Tr8n::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
+
+  #######################################################################################################
+  ##  Cache Methods
+  #######################################################################################################
+
+  def to_cache_hash
+    to_hash(:label, :context)
+  end
+
+end