tml 4.3.1

data/lib/tml/decorators/base.rb

@@ -0,0 +1,52 @@
+# 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::Decorators::Base < Tml::Base
+
+  def self.decorator
+    # can alternate based on the format in the config
+    Tml.config.decorator_class.new
+  end
+
+  def decorate(translated_label, translation_language, target_language, translation_key, options = {})
+    raise Tml::Exception.new('Must be implemented by the extending class')
+  end
+
+  def inline_mode?
+    Tml.session.current_translator and Tml.session.current_translator.inline?
+  end
+
+  def decorate_language_case(language_case, rule, original, transformed, options = {})
+    raise Tml::Exception.new('Must be implemented by the extending class')
+  end
+  
+end

data/lib/tml/decorators/default.rb

@@ -0,0 +1,43 @@
+# 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::Decorators::Default < Tml::Decorators::Base
+
+  def decorate(translated_label, translation_language, target_language, translation_key, options = {})
+    translated_label
+  end
+
+  def decorate_language_case(language_case, rule, original, transformed, options = {})
+    transformed
+  end
+
+end

data/lib/tml/decorators/html.rb

@@ -0,0 +1,102 @@
+# 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::Decorators::Html < Tml::Decorators::Base
+
+  def decorate(translated_label, translation_language, target_language, translation_key, options = {})
+    #Tml.logger.info("Decorating #{translated_label} of #{translation_language.locale} to #{target_language.locale}")
+
+    # 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 inline_mode?
+    return translated_label if translation_key.locked? and not Tml.session.current_translator.manager?
+
+    classes = %w(tml_translatable)
+    
+    if translation_key.locked?
+      # must be a manager and enabling locking feature
+      # return translated_label unless Tml.session.current_translator.feature_enabled?(:show_locked_keys)
+      classes << 'tml_locked'
+    elsif translation_language == translation_key.language
+      classes << 'tml_not_translated'
+    elsif translation_language == target_language
+      classes << 'tml_translated'
+    else
+      classes << 'tml_fallback'
+    end
+
+    element = 'span'
+    element = 'div' if options[:use_div]
+
+    html = "<#{element} class='#{classes.join(' ')}' data-translation_key='#{translation_key.key}' data-target_locale='#{target_language.locale}'>"
+    html << translated_label
+    html << "</#{element}>"
+    html
+  end
+
+  def decorate_language_case(language_case, rule, original, transformed, options = {})
+    return transformed if options[:skip_decorations] or language_case.language.default?
+    return transformed unless inline_mode?
+
+    data = {
+      'keyword'       => language_case.keyword,
+      'language_name' => language_case.language.english_name,
+      'latin_name'    => language_case.latin_name,
+      'native_name'   => language_case.native_name,
+      'conditions'    => (rule ? rule.conditions : ''),
+      'operations'    => (rule ? rule.operations : ''),
+      'original'      => original,
+      'transformed'   => transformed
+    }
+
+    attrs = []
+    {
+      'class'             => 'tml_language_case',
+      'data-locale'       => language_case.language.locale,
+      'data-rule'         => CGI::escape(Base64.encode64(data.to_json).gsub("\n", ''))
+    }.each do |key, value|
+      attrs << "#{key}=\"#{value.to_s.gsub('"', "\"")}\""
+    end
+
+    element = 'span'
+    element = 'div' if options[:use_div]
+
+    html = "<#{element} #{attrs.join(' ')}>"
+    html << transformed
+    html << "</#{element}>"
+    html
+  end
+
+end

data/lib/tml/exception.rb

@@ -0,0 +1,35 @@
+# 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::Exception < StandardError
+
+end

data/lib/tml/ext/array.rb

@@ -0,0 +1,86 @@
+#--
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.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 Array
+
+  # translates an array of options for a select tag
+  def tro(description = '', options = {})
+    return [] if empty?
+
+    options = options.merge(:skip_decorations => true)
+
+    collect do |opt|
+      if opt.is_a?(Array) and opt.first.is_a?(String) 
+        [opt.first.translate(description, {}, options), opt.last]
+      elsif opt.is_a?(String)
+        [opt.translate(description, {}, options), opt]
+      else  
+        opt
+      end
+    end
+  end
+
+  # translates and joins all elements
+  def translated_and_join(separator = '', description = '', options = {})
+    self.translate(description, options).join(separator).tml_translated
+  end
+
+  # translate array values 
+  def translate(description = '', options = {})
+    return [] if empty?
+
+    collect do |opt|
+      if opt.is_a?(String)
+        opt.translate(description, {}, options)
+      else  
+        opt
+      end
+    end
+  end
+
+  # creates a sentence with tr "and" joiner
+  def translate_sentence(description = '', options = {})
+    return '' if empty?
+    return first if size == 1
+
+    elements = translate(description, options)
+
+    options[:separator] ||= ', '
+    options[:joiner] ||= 'and'
+
+    result = elements[0..-2].join(options[:separator])
+    result << ' ' << options[:joiner].translate('List elements joiner', {}, options) << ' '
+    result << elements.last
+
+    result.tml_translated
+  end
+
+end

data/lib/tml/ext/date.rb

@@ -0,0 +1,99 @@
+#--
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.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 Date
+
+  # The translation of the date can use one of the formats:
+  #
+  # Using the Symbol to pull the default format defined in the config:
+  #
+  #  date.translate(:verbose)
+  #
+  # Using a string with format with native Date elements
+  #
+  #  date.translate("%m/%d/%Y")
+  #
+  # Or using a string with tokens:
+  #
+  #  date.translate("{month_name} {days::ord}")
+  #
+  # The last allows you to use language cases to get something like "on March 1st".
+
+  def translate(format = :default, options = {})
+    language = Tml.session.target_language
+
+    label = (format.is_a?(String) ? format.clone : Tml.config.default_date_formats[format].clone)
+
+    selected_tokens = []
+    using_tokens = label.index('{')
+
+    if using_tokens
+      selected_tokens = Tml::Tokens::Data.parse(label).collect{ |token| token.name(:parens => true) }
+
+    else
+      symbols = label.scan(/(%\w)/).flatten.uniq
+
+      symbols.each do |symbol|
+        token = Tml.config.strftime_symbol_to_token(symbol)
+        next unless token
+        selected_tokens << token
+        label.gsub!(symbol, token)
+      end
+    end
+
+    tokens = {}
+    selected_tokens.each do |token|
+      case token
+        when '{days}'                 then tokens[:days] = options[:with_leading_zero] ? day.with_leading_zero : day.to_s
+        when '{year_days}'            then tokens[:year_days] = options[:with_leading_zero] ? yday.with_leading_zero : yday.to_s
+        when '{months}'               then tokens[:months] = options[:with_leading_zero] ? month.with_leading_zero : month.to_s
+        when '{week_num}'             then tokens[:week_num] = wday
+        when '{week_days}'            then tokens[:week_days] = strftime('%w')
+        when '{short_years}'          then tokens[:short_years] = strftime('%y')
+        when '{years}'                then tokens[:years] = year
+        when '{short_week_day_name}'  then tokens[:short_week_day_name] = language.tr(Tml.config.default_abbr_day_name(wday), 'Short name for a day of a week', {}, options)
+        when '{week_day_name}'        then tokens[:week_day_name] = language.tr(Tml.config.default_day_name(wday), 'Day of a week', {}, options)
+        when '{short_month_name}'     then tokens[:short_month_name] = language.tr(Tml.config.default_abbr_month_name(month - 1), 'Short month name', {}, options)
+        when '{month_name}'           then tokens[:month_name] = language.tr(Tml.config.default_month_name(month - 1), 'Month name', {}, options)
+        when '{day_of_month}'         then tokens[:day_of_month] = strftime('%e')
+        else
+          ''
+      end
+    end
+
+    language.tr(label, nil, tokens, options)
+  end
+  alias :tr :translate  
+  
+  def trl(format = :default, options = {})
+    tr(format, options.merge!(:skip_decorations => true))
+  end
+end

data/lib/tml/ext/fixnum.rb

@@ -0,0 +1,47 @@
+#--
+# Copyright (c) 2015 Translation Exchange Inc. http://translationexchange.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 Fixnum
+
+  def with_leading_zero
+    (to_i < 10 ? "0#{to_s}" : to_s)
+  end
+
+  def translate(desc = '', tokens = {}, options = {})
+    to_s.translate(desc, tokens, options)
+  end
+  alias tr translate
+  
+  def trl(desc = '', tokens = {}, options = {})
+    to_s.trl(desc, tokens, options)
+  end
+
+end