tml 5.1.4 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4a9a78a9ef6974fe0a3fa94d61eff6e3a46cfd4
-  data.tar.gz: c7d7048f4bd19193b965841ebaa2dce4df5a30c1
+  metadata.gz: f9015ca0a3d1822fed10c823c64a1a903cfda847
+  data.tar.gz: 2706039cc562814eabda1d87f962af80238615d2
 SHA512:
-  metadata.gz: 8204a7e9fa2db257d53445beb0ed0dd7ad1c7f207b49ac5c98e8b3d80e86c6849486ff5a7c31c43476551eb8f904f1e4a1a46621bf733c73dbf14d5b70511361
-  data.tar.gz: 7bf3bfb7c10d0b9cb288926ab23c2c5c4af9ade547306afef0164489b54c5ff8b4664cd8aa49ecd096d9458e5c2716d9340f877cbeb5de4df79448e74ad53bf4
+  metadata.gz: 3faa10615d43f63cd29f05d631ce1c2c2da7c142f57b1cb9196031c0619cdc2f12af9262ca17ae89e220310e512e29b0a89e4fb92e0a0859b8d12c34b34fa917
+  data.tar.gz: fb89ecb8a4d7e5a268e5b3523edb61c29e7a7218e7fd4a1162387cd0dd1454468b2af8142ebe37f6670c60428804a08a554b0b1301c331fd72a5835568c294d1

data/lib/tml/api/client.rb

@@ -73,7 +73,7 @@ class Tml::Api::Client < Tml::Base
   end
 
   def get_cache_version
-    execute_request('applications/current/version', {}, {:raw => true})
+    execute_request('projects/current/version', {}, {:raw => true})
   end
 
   def verify_cache_version
@@ -128,12 +128,18 @@ class Tml::Api::Client < Tml::Base
     data
   end
 
+  def live_translations_request?(cache_key)
+    return if cache_key.blank?
+    return unless Tml.session.block_option(:live)
+    cache_key.index('sources') or cache_key.index('keys')
+  end
+
   def enable_cache?(opts)
     return false unless opts[:method] == :get
     return false if opts[:cache_key].nil?
     return false unless Tml.cache.enabled?
+    return false if live_translations_request?(opts[:cache_key])
     return false if Tml.session.inline_mode?
-    return false if Tml.session.block_option(:live) and opts[:cache_key].index('sources')
     true
   end
 
@@ -290,6 +296,8 @@ class Tml::Api::Client < Tml::Base
     #  params = params.merge(param => "##filtered##") if params[param]
     #end
 
+    path = "#{path[0] == '/' ? '' : '/'}#{path}"
+
     if opts[:method] == :post
       Tml.logger.debug("post: #{opts[:host]}#{path}")
     else

data/lib/tml/application.rb

@@ -311,7 +311,7 @@ class Tml::Application < Tml::Base
   end
 
   def api_client
-    @api_client ||= Tml::Api::Client.new(application: self)
+    @api_client ||= Tml.config.api_client_class.new(application: self)
   end
 
   def postoffice

data/lib/tml/config.rb

@@ -80,13 +80,14 @@ module Tml
 
     # Used by Rails and Sinatra extensions
     attr_accessor :current_locale_method, :current_user_method, :translator_options, :i18n_backend
-    attr_accessor :invalidator, :agent
+    attr_accessor :invalidator, :agent, :api_client_class
 
     # 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
@@ -418,7 +419,7 @@ module Tml
     end
 
     def default_day_name(index)
-      "" + default_day_names[index]
+      '' + default_day_names[index]
     end
 
     def default_abbr_day_names

data/lib/tml/decorators/base.rb

@@ -32,25 +32,28 @@
 
 class Tml::Decorators::Base < Tml::Base
 
-  def self.decorator
-    # can alternate based on the format in the config
-    Tml.config.decorator_class.new
+  def self.decorator(options = {})
+    decorator_klass = Tml.config.decorator_class
+    if options[:decorator]
+      decorator_klass = "Tml::Decorators::#{options[:decorator].camelcase}".constantize
+    end
+    decorator_klass.new
   end
 
   def decorate(translated_label, translation_language, target_language, translation_key, options = {})
-    raise Tml::Exception.new('Must be implemented by the extending class')
+    translated_label
   end
 
   def decorate_language_case(language_case, rule, original, transformed, options = {})
-    raise Tml::Exception.new('Must be implemented by the extending class')
+    transformed
   end
 
   def decorate_token(token, value, options = {})
-    raise Tml::Exception.new('Must be implemented by the extending class')
+    value
   end
 
   def decorate_element(token, value, options = {})
-    raise Tml::Exception.new('Must be implemented by the extending class')
+    value
   end
 
   def inline_mode?

data/lib/tml/decorators/default.rb

@@ -32,20 +32,4 @@
 
 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
-
-  def decorate_token(token, value, options = {})
-    value
-  end
-
-  def decorate_element(token, value, options = {})
-    value
-  end
-
 end

data/lib/tml/decorators/json.rb

@@ -0,0 +1,69 @@
+# 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::Json < 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}")
+
+    data = {
+        original: {
+            label: translation_key.label,
+            locale: translation_key.locale
+        },
+        translation: {
+            label: translated_label,
+            locale: translation_language.locale,
+        },
+        options: options,
+        target_locale: target_language.locale
+    }
+
+    if options[:locked]
+      data[:status] = 'locked'
+    elsif translation_language == translation_key.language
+      if options[:pending]
+        data[:status] = 'pending'
+      else
+        data[:status] = 'not_translated'
+      end
+    elsif translation_language == target_language
+      data[:status] = 'translated'
+    else
+      data[:status] = 'fallback'
+    end
+
+    data
+  end
+
+
+end

data/lib/tml/ext/array.rb

@@ -83,4 +83,14 @@ class Array
     result.tml_translated
   end
 
+  def tml_translated
+    return self if frozen?
+    @tml_translated = true
+    self
+  end
+
+  def tml_translated?
+    @tml_translated
+  end
+
 end

data/lib/tml/ext/hash.rb

@@ -96,4 +96,14 @@ class Hash
     end
   end
 
+  def tml_translated
+    return self if frozen?
+    @tml_translated = true
+    self
+  end
+
+  def tml_translated?
+    @tml_translated
+  end
+
 end

data/lib/tml/language.rb

@@ -54,7 +54,6 @@ class Tml::Language < Tml::Base
     self
   end
 
-
   def update_attributes(attrs)
     super
 
@@ -142,7 +141,7 @@ class Tml::Language < Tml::Base
       :translations => []
     })
 
-    # Tml.logger.info("Translating " + params[:label] + " from: " + translation_key.locale.inspect + " to " + locale.inspect)
+    # Tml.logger.info("Translating #{params[:label]} from: #{translation_key.locale.inspect} to #{locale.inspect}")
 
     params[:tokens] ||= {}
     params[:tokens][:viewing_user] ||= Tml.session.current_user
@@ -156,16 +155,24 @@ class Tml::Language < Tml::Base
       ).tml_translated
     end
 
+    # if translations have already been cached in the application, use them
     cached_translations = application.cached_translations(locale, translation_key.key)
     if cached_translations
       translation_key.set_translations(locale, cached_translations)
       return translation_key.translate(self, params[:tokens], params[:options]).tml_translated
     end
 
+    # each key translations will be loaded directly from the API
+    if Tml.session.block_option(:by_key)
+      translation_key.fetch_translations(locale)
+      return translation_key.translate(self, params[:tokens], params[:options]).tml_translated
+    end
+
+    # fetch translations grouped by source
     source_key = current_source(options)
     current_source_path = source_path
 
-    # Dynamic sources are never registered under the parent source
+    # Dynamic sources are never registered under the parent source for fast retrieval
     if Tml.session.block_option(:dynamic)
       current_source_path = source_key
     else

data/lib/tml/translation_key.rb

@@ -88,6 +88,40 @@ class Tml::TranslationKey < Tml::Base
     self
   end
 
+  def self.cache_key(locale, key)
+    File.join(locale, 'keys', key)
+  end
+
+  # update translations in the key
+  def update_translations(locale, data)
+    set_translations(locale, application.cache_translations(
+                               locale,
+                               key,
+                               data.is_a?(Hash) ? data['translations'] : data
+                           ))
+  end
+
+  # fetch translations for a specific translation key
+  def fetch_translations(locale)
+    self.translations ||= {}
+    return if self.translations[locale]
+
+    # Tml.logger.debug("Fetching translations for #{label}")
+
+    results = self.application.api_client.get(
+        "translation_keys/#{self.key}/translations",
+        {:locale => locale, :per_page => 10000},
+        {:cache_key => Tml::TranslationKey.cache_key(locale, self.key)}
+    ) || []
+
+    update_translations(locale, results)
+
+    self
+  rescue Tml::Exception => ex
+    self.translations = {}
+    self
+  end
+
   ###############################################################
   ## Translation Methods
   ###############################################################
@@ -100,12 +134,12 @@ class Tml::TranslationKey < Tml::Base
   def find_first_valid_translation(language, token_values)
     translations = translations_for_language(language)
 
-    translations.sort! { |x,y| x.precedence <=> y.precedence }
+    translations.sort! { |x, y| x.precedence <=> y.precedence }
 
     translations.each do |translation|
       return translation if translation.matches_rules?(token_values)
     end
-    
+
     nil
   end
 
@@ -115,7 +149,7 @@ class Tml::TranslationKey < Tml::Base
     end
 
     translation = find_first_valid_translation(language, token_values)
-    decorator = Tml::Decorators::Base.decorator
+    decorator = Tml::Decorators::Base.decorator(options)
 
     if translation
       options[:locked] = translation.locked
@@ -160,7 +194,7 @@ class Tml::TranslationKey < Tml::Base
 
   # if the translations engine is disabled
   def self.substitute_tokens(label, token_values, language, options = {})
-    return label.to_s if options[:skip_substitution] 
+    return label.to_s if options[:skip_substitution]
     Tml::TranslationKey.new(:label => label.to_s).substitute_tokens(label.to_s, token_values, language, options)
   end
 

data/lib/tml/version.rb

@@ -30,5 +30,5 @@
 #++
 
 module Tml
-  VERSION = '5.1.4'
+  VERSION = '5.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tml
 version: !ruby/object:Gem::Version
-  version: 5.1.4
+  version: 5.2.1
 platform: ruby
 authors:
 - Michael Berkovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -61,6 +61,7 @@ files:
 - lib/tml/decorators/base.rb
 - lib/tml/decorators/default.rb
 - lib/tml/decorators/html.rb
+- lib/tml/decorators/json.rb
 - lib/tml/exception.rb
 - lib/tml/ext/array.rb
 - lib/tml/ext/date.rb