tml 5.6.5 → 5.7.1

data/lib/tml/tokens/data.rb

@@ -55,6 +55,7 @@ module Tml
       end
 
       def parse_elements
+        name_without_parens = @full_name.gsub(/^%/, '')[1..-2]
         name_without_parens = @full_name.gsub(/^%/, '')[1..-2]
         name_without_case_keys = name_without_parens.split('::').first.strip
 
@@ -91,6 +92,7 @@ module Tml
 
       # Utility method for errors
       def error(msg, return_token = true)
+        # pp msg
         Tml.logger.error(msg)
         return_token ? full_name : label
       end
@@ -103,7 +105,14 @@ module Tml
 
       def self.token_object(token_values, token_name)
         return nil if token_values.nil?
-        token_object = Tml::Utils.hash_value(token_values, token_name)
+        token_name = token_name.to_s.gsub(':', '')
+
+        if token_values.is_a?(Array)
+          token_object = token_values[token_name.to_i]
+        else
+          token_object = Tml::Utils.hash_value(token_values, token_name)
+        end
+
         return token_object.first if token_object.is_a?(Array)
         if token_object.is_a?(Hash)
           object = Tml::Utils.hash_value(token_object, :object)
@@ -112,6 +121,10 @@ module Tml
         token_object
       end
 
+      def token_object(token_values)
+        self.class.token_object(token_values, short_name)
+      end
+
       ##############################################################################
       #
       # tr("Hello {user_list}!", "", {:user_list => [[user1, user2, user3], :name]}}

data/lib/tml/tokens/decoration.rb

@@ -0,0 +1,112 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2016 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.
+#++
+
+module Tml
+  module Tokens
+    class Decoration
+
+      RESERVED_TOKEN = 'tml'
+      TOKEN_PLACEHOLDER = '{$0}'
+
+      attr_reader :label, :full_name, :short_name, :default_name
+
+      def initialize(label, token)
+        @label = label
+        @full_name = token.to_s
+        @short_name = @full_name
+
+        # removing the numbers at the end - default tokens don't need them
+        @default_name = @short_name.gsub(/(\d)*$/, '')
+      end
+
+      def to_s
+        full_name
+      end
+
+      def default_decoration(token_content, decoration_token_values = nil)
+        default_decoration = Tml.config.default_token_value(default_name, :decoration)
+
+        unless default_decoration
+          return "<#{short_name}>#{token_content}</#{short_name}>"
+        end
+
+        # {$0} always represents the actual content
+        default_decoration = default_decoration.gsub(TOKEN_PLACEHOLDER, token_content.to_s)
+
+        # substitute the token values with hash elements
+        if decoration_token_values.is_a?(Hash)
+          decoration_token_values.each do |key, value|
+            default_decoration = default_decoration.gsub("{$#{key}}", value.to_s)
+          end
+        elsif decoration_token_values.is_a?(Array)
+          decoration_token_values.each_with_index do |value, index|
+            default_decoration = default_decoration.gsub("{$#{index + 1}}", value.to_s)
+          end
+        end
+
+        # remove unused attributes
+        default_decoration.gsub(/\{\$[^}]*\}/, '')
+      end
+
+      def allowed?(allowed_tokens)
+        return true if allowed_tokens.nil?
+        allowed_tokens.include?(short_name)
+      end
+
+      def apply(token_values, token_content, allowed_tokens = nil)
+        return token_content if short_name == RESERVED_TOKEN
+        return token_content unless allowed?(allowed_tokens)
+
+        method = Tml::Utils.hash_value(token_values, short_name)
+
+        if method
+          if method.is_a?(String)
+            return method.to_s.gsub(TOKEN_PLACEHOLDER, token_content)
+          end
+
+          if method.is_a?(Proc)
+            return method.call(token_content)
+          end
+
+          if method.is_a?(Array) || method.is_a?(Hash)
+            return default_decoration(token_content, method)
+          end
+
+          return token_content
+        end
+
+        default_decoration(token_content)
+      end
+
+    end
+  end
+end

data/lib/tml/tokens/map.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2016 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.
+#++
+
+####################################################################### 
+# 
+# Map Token Forms
+#
+# tr("{user} likes this {animal @ dog: dog, cat: cat, bird: bird}", user: "Michael", animal: "dog")
+# tr("{user} likes this {animal @ dog, cat, bird}", user: "Michael", animal: 0)
+#
+####################################################################### 
+
+class Tml::Tokens::Map < Tml::Tokens::Data
+
+  attr_reader :params
+
+  def self.expression
+    /(%?\{{1,2}\s*[\w]+\s*@\s*[^\{\}\|]+\}{1,2})/
+  end
+
+  def parse_elements
+    name_without_parens = @full_name.gsub(/^%/, '')[1..-2]
+    @context_keys = []
+    @case_keys = []
+    @short_name, @params = name_without_parens.split('@')
+    @short_name.strip!
+    @params = @params.split(',').collect{|param| param.strip}
+    if @params.first.index(':')
+      hash = {}
+      @params.each do |param|
+        key, value = param.split(':')
+        hash[key.to_s.strip] = value.to_s.strip
+      end
+      @params = hash
+    end
+  end
+
+  def substitute(label, context, language, options = {})
+    object = self.class.token_object(context, key)
+
+    if object.nil?
+      return error("Missing value for a token \"#{key}\" in \"#{label}\"", false)
+    end
+
+    if params.empty?
+      return error("Params may not be empty for token \"#{key}\" in \"#{label}\"", false)
+    end
+
+    object_value = params[object]
+
+    label.gsub(full_name, decorate(object_value, options))
+  end
+
+end

data/lib/tml/tokens/transform.rb

@@ -68,7 +68,6 @@ class Tml::Tokens::Transform < Tml::Tokens::Data
     @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

data/lib/tml/tokens/x_message/choice.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2016 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.
+#++
+
+####################################################################### 
+# 
+# Choice Token
+#
+# {0} tagged himself/herself in {1,choice,singular#{1,number} {2,map,photo#photo|video#video}|plural#{1,number} {2,map,photo#photos|video#videos}}.
+#
+####################################################################### 
+
+class Tml::Tokens::XMessage::Choice < Tml::Tokens::Data
+
+  attr_accessor :rule_keys
+
+  def initialize(label, opts)
+    @label = label
+    @short_name = opts[:index]
+    @full_name = "{#{@short_name}}"
+    @rule_keys = opts[:styles].collect{|style| style[:key]}
+    @case_keys = []
+    @context_keys = []
+    if @rule_keys.include?('singular') or @rule_keys.include?('plural')
+      @context_keys = ['number']
+    elsif @rule_keys.include?('male') or @rule_keys.include?('female')
+      @context_keys = ['gender']
+    elsif @rule_keys.include?('past') or @rule_keys.include?('present') or @rule_keys.include?('future')
+      @context_keys = ['date']
+    end
+  end
+
+end

data/lib/tml/tokens/x_message/data.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2016 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.
+#++
+
+####################################################################### 
+# 
+# Param Token
+#
+# {0} tagged himself/herself in {1,choice,singular#{1,number} {2,map,photo#photo|video#video}|plural#{1,number} {2,map,photo#photos|video#videos}}.
+# 
+####################################################################### 
+
+class Tml::Tokens::XMessage::Data < Tml::Tokens::Data
+
+  def initialize(label, opts)
+    @label = label
+    @short_name = opts[:index]
+    @full_name = "{#{@short_name}}"
+    @case_keys = []
+    @context_keys = []
+    # if opts[:styles]
+    #   @case_keys = []
+    # end
+  end
+
+end

data/lib/tml/tokens/x_message/decoration.rb

@@ -0,0 +1,101 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2016 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.
+#++
+
+#######################################################################
+#
+# Param Token
+#
+# {0} tagged himself/herself in {1,choice,singular#{1,number} {2,map,photo#photo|video#video}|plural#{1,number} {2,map,photo#photos|video#videos}}.
+#
+#######################################################################
+
+class Tml::Tokens::XMessage::Decoration < Tml::Tokens::Decoration
+
+  DEFAULT_DECORATION_PLACEHOLDER = '{!yield!}'
+
+  # {:index => "2",
+  #  :type => "anchor",
+  #  :styles => ...
+  # }
+  def initialize(label, opts)
+    @label = label
+    @type = opts[:type]
+    @short_name = opts[:index].to_s.gsub(':', '')
+    @full_name = "#{opts[:index]}}"
+    @default_name = @type
+  end
+
+  def token_value(token_object, language)
+    token_object
+  end
+
+  def token_object(token_values)
+    if token_values.is_a?(Array)
+      token_values[@short_name.to_i]
+    else
+      Tml::Utils.hash_value(token_values, @short_name)
+    end
+  end
+
+  def template(method)
+    if method
+      if method.is_a?(String)
+
+        # backwards compatibility to legacy code
+        if @type == 'anchor'
+          return "<a href='#{method}'>#{DEFAULT_DECORATION_PLACEHOLDER}</a>"
+        end
+
+        return method
+      end
+
+      if method.is_a?(Array) or method.is_a?(Hash)
+        return default_decoration(DEFAULT_DECORATION_PLACEHOLDER, method)
+      end
+
+      return DEFAULT_DECORATION_PLACEHOLDER
+    end
+
+    default_decoration(DEFAULT_DECORATION_PLACEHOLDER)
+  end
+
+  def open_tag(method)
+    @template = template(method)
+    # pp label: label, type: @type, template: @template, method: method
+    @template.split(DEFAULT_DECORATION_PLACEHOLDER).first
+  end
+
+  def close_tag
+    @template.split(DEFAULT_DECORATION_PLACEHOLDER).last
+  end
+
+end