tml 5.2.7 → 5.4.1

data/lib/tml/cache_version.rb

@@ -0,0 +1,135 @@
+# 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
+
+  CACHE_VERSION_KEY = 'current_version'
+
+  class CacheVersion
+
+    attr_accessor :version, :cache
+
+    # Init cache version with cache adapter
+    def initialize(cache)
+      self.cache = cache
+    end
+
+    # reset cache version
+    def reset
+      self.version = nil
+    end
+
+    # updates the current cache version
+    def set(new_version)
+      self.version = new_version
+    end
+
+    # upgrade current version
+    def upgrade
+      cache.store(CACHE_VERSION_KEY, {'version' => 'undefined', 't' => cache_timestamp})
+      reset
+    end
+
+    # validate that current cache version hasn't expired
+    def validate_cache_version(version)
+      return version unless version.is_a?(Hash)
+      return 'undefined' unless version['t'].is_a?(Numeric)
+      return version['version'] if cache.read_only?
+
+      expires_at = version['t'] + version_check_interval
+      if expires_at < Time.now.to_i
+        Tml.logger.debug('Cache version is outdated, needs refresh')
+        'undefined'
+      else
+        delta = expires_at - Time.now.to_i
+        Tml.logger.debug("Cache version is up to date, expires in #{delta}s")
+        version['version']
+      end
+    end
+
+    # fetches the version from the cache
+    def fetch
+      self.version = begin
+        ver = cache.fetch(CACHE_VERSION_KEY) do
+          {'version' => Tml.config.cache[:version] || 'undefined', 't' => cache_timestamp}
+        end
+        validate_cache_version(ver)
+      end
+    end
+
+    # how often should the cache be checked for
+    def version_check_interval
+      Tml.config.cache[:version_check_interval] || 3600
+    end
+
+    # generates cache timestamp based on an interval
+    def cache_timestamp
+      Tml::Utils.interval_timestamp(version_check_interval)
+    end
+
+    # stores the current version back in cache
+    def store(new_version)
+      self.version = new_version
+      cache.store(CACHE_VERSION_KEY, {'version' => new_version, 't' => cache_timestamp})
+    end
+
+    # checks if the version is undefined
+    def undefined?
+      version.nil? or version == 'undefined'
+    end
+
+    # checks if version is defined
+    def defined?
+      not undefined?
+    end
+
+    # checks if the version is valid
+    def valid?
+      not invalid?
+    end
+
+    # checks if the version is invalid
+    def invalid?
+      %w(undefined 0).include?(version.to_s)
+    end
+
+    # returns versioned key with prefix
+    def versioned_key(key, namespace = '')
+      "tml_#{namespace}#{CACHE_VERSION_KEY == key ? '' : "_v#{version}"}_#{key}"
+    end
+
+    # returns string representation of the version
+    def to_s
+      self.version.to_s
+    end
+  end
+end

data/lib/tml/config.rb

@@ -80,20 +80,25 @@ module Tml
 
     # Used by Rails and Sinatra extensions
     attr_accessor :current_locale_method, :current_user_method, :translator_options, :i18n_backend
-    attr_accessor :invalidator, :agent, :api_client_class
+    attr_accessor :invalidator, :agent, :api_client
 
     # Used for IRB only
     attr_accessor :submit_missing_keys_realtime
 
     def initialize
       @enabled = true
-      @api_client_class = Tml::Api::Client
       @default_level  = 0
       @format = :html
       @subdomains = false
       @auto_init = true
       @source_separator = '@:@'
 
+      @api_client = {
+          class: Tml::Api::Client,
+          timeout: 5,
+          open_timeout: 2
+      }
+
       @locale = {
         default:    'en',
         method:     'current_locale',
@@ -196,14 +201,13 @@ module Tml
         },
       }
 
-      @logger  = {
-        :enabled  => false,
-        :path     => './log/tml.log',
-        :level    => 'debug'
-      }
+      @cache = nil
 
-      @cache = {
-        :enabled  => false
+      @logger  = {
+        :enabled        => false,
+        :path           => './log/tml.log',
+        :level          => 'debug',
+        :secure         => true
       }
 
       @default_tokens = {
@@ -356,7 +360,7 @@ module Tml
     end
 
     def cache_enabled?
-      cache[:enabled].nil? || Tml.config.cache[:enabled]
+       not cache.nil?
     end
 
     #########################################################

data/lib/tml/language.rb

@@ -54,6 +54,7 @@ class Tml::Language < Tml::Base
     self
   end
 
+  # update language attributes
   def update_attributes(attrs)
     super
 
@@ -127,7 +128,6 @@ class Tml::Language < Tml::Base
   #   or
   # tr(:label => label, :description => "", :tokens => {}, :options => {})
   ########################################################################################################
-
   def translate(label, description = nil, tokens = {}, options = {})
     params = Tml::Utils.normalize_tr_params(label, description, tokens, options)
     return params[:label] if params[:label].to_s.strip == '' or params[:label].index('tml:label')
@@ -164,8 +164,9 @@ class Tml::Language < Tml::Base
       return translation_key.translate(self, params[:tokens], params[:options]).tml_translated
     end
 
-    # each key translations will be loaded directly from the API
+    # each key translations will be loaded directly from the API, and registered against "manual" source
     if Tml.session.block_option(:by_key)
+      application.register_missing_key(:manual, translation_key)
       translation_key.fetch_translations(locale)
       return translation_key.translate(self, params[:tokens], params[:options]).tml_translated
     end
@@ -181,7 +182,7 @@ class Tml::Language < Tml::Base
       application.verify_source_path(source_key, current_source_path)
     end
 
-    # Tml.logger.debug("#{params[:label]} : #{source_key}")
+    # Tml.logger.debug("#{self.locale} :  #{params[:label]} : #{source_key}")
 
     source = application.source(source_key, locale)
 
@@ -204,6 +205,7 @@ class Tml::Language < Tml::Base
   end
   alias :tr :translate
 
+  # build source path to the block
   def source_path
     sp = []
 

data/lib/tml/language_case.rb

@@ -35,7 +35,7 @@ class Tml::LanguageCase < Tml::Base
   attributes  :id, :keyword, :latin_name, :native_name, :description, :application
   has_many    :rules
 
-  TR8N_HTML_TAGS_REGEX = /<\/?[^>]*>/
+  TML_HTML_TAGS_REGEX = /<\/?[^>]*>/
 
   def initialize(attrs = {})
     super
@@ -63,8 +63,8 @@ class Tml::LanguageCase < Tml::Base
 
     options = options.merge(:skip_decorations => true) if value.index('not_translated')
 
-    html_tokens = value.scan(TR8N_HTML_TAGS_REGEX).uniq
-    sanitized_value = value.gsub(TR8N_HTML_TAGS_REGEX, '')
+    html_tokens = value.scan(TML_HTML_TAGS_REGEX).uniq
+    sanitized_value = value.gsub(TML_HTML_TAGS_REGEX, '')
 
     if application.to_s == 'phrase'
       words = [sanitized_value]