tml 4.3.1

data/lib/tml/ext/hash.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 Hash
+  #
+  # = Hash Recursive Merge
+  # 
+  # Merges a Ruby Hash recursively, Also known as deep merge.
+  # Recursive version of Hash#merge and Hash#merge!.
+  # 
+  # Category::    Ruby
+  # Package::     Hash
+  # Author::      Simone Carletti <weppos@weppos.net>
+  # Copyright::   2007-2008 The Authors
+  # License::     MIT License
+  # Link::        http://www.simonecarletti.com/
+  # Source::      http://gist.github.com/gists/6391/
+  
+  #
+  # Recursive version of Hash#merge!
+  # 
+  # Adds the contents of +other_hash+ to +hsh+, 
+  # merging entries in +hsh+ with duplicate keys with those from +other_hash+.
+  # 
+  # Compared with Hash#merge!, this method supports nested hashes.
+  # When both +hsh+ and +other_hash+ contains an entry with the same key,
+  # it merges and returns the values from both arrays.
+  # 
+  #    h1 = {"a" => 100, "b" => 200, "c" => {"c1" => 12, "c2" => 14}}
+  #    h2 = {"b" => 254, "c" => 300, "c" => {"c1" => 16, "c3" => 94}}
+  #    h1.rmerge!(h2)   #=> {"a" => 100, "b" => 254, "c" => {"c1" => 16, "c2" => 14, "c3" => 94}}
+  #    
+  # Simply using Hash#merge! would return
+  # 
+  #    h1.merge!(h2)    #=> {"a" => 100, "b" = >254, "c" => {"c1" => 16, "c3" => 94}}
+  # 
+  def rmerge!(other_hash)
+    merge!(other_hash) do |key, oldval, newval| 
+        oldval.class == self.class ? oldval.rmerge!(newval) : newval
+    end
+  end
+
+  #
+  # Recursive version of Hash#merge
+  # 
+  # Compared with Hash#merge!, this method supports nested hashes.
+  # When both +hsh+ and +other_hash+ contains an entry with the same key,
+  # it merges and returns the values from both arrays.
+  # 
+  # Compared with Hash#merge, this method provides a different approch
+  # for merging nasted hashes.
+  # If the value of a given key is an Hash and both +other_hash+ abd +hsh
+  # includes the same key, the value is merged instead replaced with
+  # +other_hash+ value.
+  # 
+  #    h1 = {"a" => 100, "b" => 200, "c" => {"c1" => 12, "c2" => 14}}
+  #    h2 = {"b" => 254, "c" => 300, "c" => {"c1" => 16, "c3" => 94}}
+  #    h1.rmerge(h2)    #=> {"a" => 100, "b" => 254, "c" => {"c1" => 16, "c2" => 14, "c3" => 94}}
+  #    
+  # Simply using Hash#merge would return
+  # 
+  #    h1.merge(h2)     #=> {"a" => 100, "b" = >254, "c" => {"c1" => 16, "c3" => 94}}
+  # 
+  def rmerge(other_hash)
+    r = {}
+    merge(other_hash)  do |key, oldval, newval| 
+      r[key] = oldval.class == self.class ? oldval.rmerge(newval) : newval
+    end
+  end
+
+end

data/lib/tml/ext/string.rb

@@ -0,0 +1,56 @@
+#--
+# 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 String
+
+  def translate(desc = '', tokens = {}, options = {})
+    Tml.session.target_language.translate(
+        Tml::Utils.normalize_tr_params(self, desc, tokens, options)
+    )
+  end
+
+  def trl(desc = '', tokens = {}, options = {})
+    Tml.session.target_language.translate(
+        Tml::Utils.normalize_tr_params(self, desc, tokens, options.merge(:skip_decorations => true))
+    )
+  end
+
+  def tml_translated
+    return self if frozen?
+    @tml_translated = true
+    self
+  end
+
+  def tml_translated?
+    @tml_translated
+  end
+
+end

data/lib/tml/ext/time.rb

@@ -0,0 +1,89 @@
+#--
+# 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 Time
+
+  def translate(format = :default, options = {})
+    language = Tml.session.target_language
+
+    label = (format.is_a?(String) ? format.clone : Tml.config.default_date_formats[format].clone)
+    symbols = label.scan(/(%\w)/).flatten.uniq
+
+    selected_tokens = []
+    using_tokens = label.index('{')
+
+    if using_tokens
+      selected_tokens = Tml::Tokens::Data.parse(label).collect{ |token| token.name(:parens => true) }
+    else
+      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 '{am_pm}'                then tokens[:am_pm] = language.tr(strftime('%p'), 'Meridian indicator', {}, options)
+        when '{full_hours}'           then tokens[:full_hours] = hour
+        when '{short_hours}'          then tokens[:short_hours] = strftime('%I')
+        when '{trimed_hour}'          then tokens[:trimed_hour] = strftime('%l')
+        when '{minutes}'              then tokens[:minutes] = strftime('%M')
+        when '{seconds}'              then tokens[:seconds] = strftime('%S')
+        when '{since_epoch}'          then tokens[:since_epoch] = strftime('%s')
+        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/generators/cache/base.rb

@@ -0,0 +1,117 @@
+#--
+# 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 Tml::Generators::Cache::Base
+
+  attr_accessor :started_at, :finished_at
+
+  def log(msg)
+    msg = "#{Time.now.strftime('%Y-%m-%d %H:%M:%S')}: #{msg}"
+    puts msg
+    Tml.logger.debug(msg)
+  end
+
+  def cache_path
+    raise Tml::Exception.new('Must be implemented by the subclass')
+  end
+
+  def cache_version
+    @started_at.strftime('%Y%m%d%H%M%S')
+  end
+
+  def cache(key, data)
+    raise Tml::Exception.new('Must be implemented by the subclass')
+  end
+
+  def execute
+    raise Tml::Exception.new('Must be implemented by the subclass')
+  end
+
+  def run
+    prepare
+    execute
+    finalize
+  end
+
+  def prepare
+    @started_at = Time.now
+    Tml.session.init
+    cache_path
+  end
+
+  def api_client
+    Tml.session.application.api_client
+  end
+
+  def application
+    @application ||= api_client.get('applications/current', {:definition => true})
+  end
+
+  def languages
+    application['languages']
+  end
+
+  def finalize
+    @finished_at = Time.now
+    log("Cache has been stored in #{cache_path}")
+    log("Cache generation took #{@finished_at - @started_at} mls.")
+    log('Done.')
+  end
+
+  def cache_application
+    log('Downloading application...')
+    cache(Tml::Application.cache_key, application)
+    log('Application has been cached.')
+  end
+
+  def cache_languages
+    log('Downloading languages...')
+    unless application['languages']
+      log('No languages are available...')
+      return
+    end
+    languages.each do |lang|
+      language = api_client.get("languages/#{lang['locale']}", :definition => true)
+      cache(Tml::Language.cache_key(language['locale']), language)
+    end
+    log("#{application['languages'].count} languages have been cached.")
+  end
+
+  def symlink_path
+    "#{Tml.config.cache[:path]}/current"
+  end
+
+  def generate_symlink
+    FileUtils.rm(symlink_path) if File.exist?(symlink_path)
+    FileUtils.ln_s(cache_version, symlink_path)
+    log('Symlink has been updated.')
+  end
+end

data/lib/tml/generators/cache/file.rb

@@ -0,0 +1,159 @@
+#--
+# 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 Tml::Generators::Cache::File < Tml::Generators::Cache::Base
+
+  def cache_path
+    @cache_path ||= begin
+      path = "#{Tml.config.cache[:path]}/#{cache_version}"
+      log("Cache will be stored in #{path}")
+      FileUtils.mkdir_p(path)
+      FileUtils.chmod(0777, path)
+      path
+    end
+  end
+
+  def file_path(key)
+    path = key.split('/')
+    if path.count > 1
+      filename = path.pop
+      path = File.join(cache_path, path)
+      FileUtils.mkdir_p(path)
+      File.join(path, "#{filename}.json")
+    else
+      File.join(cache_path, "#{path.first}.json")
+    end
+  end
+
+  def cache(key, data)
+    File.open(file_path(key), 'w') { |file| file.write(JSON.pretty_generate(data)) }
+  end
+
+  def execute
+    cache_application
+    cache_languages
+    cache_translations
+    generate_symlink
+  end
+
+  def cache_translations
+    log('Downloading translations...')
+
+    languages.each do |language|
+      log("Downloading #{language['english_name']} language...")
+
+      if Tml.config.cache[:segmented]
+        api_client.paginate('applications/current/sources') do |source|
+          next unless source['source']
+
+          cache_path = Tml::Source.cache_key(language['locale'], source['source'])
+          log("Downloading #{source['source']} in #{language['locale']} to #{cache_path}...")
+
+          data = api_client.get("sources/#{source['key']}/translations", {:locale => language['locale'], :original => true, :per_page => 1000})
+          cache(cache_path, data)
+        end
+      else
+        cache_path = Tml::Application.translations_cache_key(language['locale'])
+        log("Downloading translations in #{language['locale']} to #{cache_path}...")
+        data = {}
+        api_client.paginate('applications/current/translations', {:locale => language['locale'], :original => true, :per_page => 1000}) do |translations|
+          data.merge!(translations)
+        end
+        cache(cache_path, data)
+      end
+    end
+  end
+
+  def rollback
+    folders = Dir["#{Tml.config.cache[:path]}/*"]
+    folders.delete_if{|e| e.index('current')}.sort!
+
+    if File.exist?(symlink_path)
+      current_dest = File.readlink("#{Tml.config.cache[:path]}/current")
+      current_dest = "#{Tml.config.cache[:path]}/#{current_dest}"
+    else
+      current_dest = 'undefined'
+    end
+
+    index = folders.index(current_dest)
+
+    if index == 0
+      log('There are no earlier cache versions')
+      return
+    end
+
+    if index.nil?
+      new_version_path = folders[folders.size-1]
+    else
+      new_version_path = folders[index-1]
+    end
+
+    new_version_path = new_version_path.split('/').last
+
+    FileUtils.rm(symlink_path) if File.exist?(symlink_path)
+    FileUtils.ln_s(new_version_path, symlink_path)
+
+    log("Cache has been rolled back to version #{new_version_path}.")
+  end
+
+  def rollup
+    folders = Dir["#{Tml.config.cache[:path]}/*"]
+    folders.delete_if{|e| e.index('current')}.sort!
+
+    if File.exist?(symlink_path)
+      current_dest = File.readlink("#{Tml.config.cache[:path]}/current")
+      current_dest = "#{Tml.config.cache[:path]}/#{current_dest}"
+    else
+      current_dest = 'undefined'
+    end
+
+    index = folders.index(current_dest)
+
+    if index == (folders.size - 1)
+      log('You are on the latest version of the cache already. No further versions are available')
+      return
+    end
+
+    if index.nil?
+      new_version_path = folders[0]
+    else
+      new_version_path = folders[index+1]
+    end
+
+    new_version_path = new_version_path.split('/').last
+
+    FileUtils.rm(symlink_path) if File.exist?(symlink_path)
+    FileUtils.ln_s(new_version_path, symlink_path)
+
+    log("Cache has been upgraded to version #{new_version_path}.")
+  end
+
+end