tr8n_core 4.0.17 → 4.2

data/lib/tr8n/base.rb

@@ -58,7 +58,7 @@ class Tr8n::Base
     method_name = meth.to_s
     method_suffix = method_name[-1, 1]
     method_key = method_name.to_sym
-    if ['=', '?'].include?(method_suffix)
+    if %w(= ?).include?(method_suffix)
       method_key = method_name[0..-2].to_sym 
     end
 

data/lib/tr8n/cache.rb

@@ -32,7 +32,11 @@
 
 module Tr8n
 
-  CACHE_VERSION_KEY = "__tr8n_version__"
+  CACHE_VERSION_KEY = '__tr8n_version__'
+
+  def self.memory
+    @memory ||= Tr8n::CacheAdapters::Memory.new
+  end
 
   def self.cache
     @cache ||= begin
@@ -49,6 +53,8 @@ module Tr8n
   class Cache
 
     def version
+      Tr8n.config.cache[:version] ||= 1
+
       @version ||= begin
         v = fetch(CACHE_VERSION_KEY) do
           {'version' => Tr8n.config.cache[:version]}
@@ -56,6 +62,8 @@ module Tr8n
         v['version']
       end
 
+      @version ||= Tr8n.config.cache[:version]
+
       if Tr8n.config.cache[:version] > @version
         update_version(Tr8n.config.cache[:version])
         @version = Tr8n.config.cache[:version]
@@ -86,6 +94,10 @@ module Tr8n
     end
 
     def read_only?
+      false
+    end
+
+    def segmented?
       true
     end
 

data/lib/tr8n/cache_adapters/file.rb

@@ -33,27 +33,30 @@
 class Tr8n::CacheAdapters::File < Tr8n::Cache
 
   def self.cache_path
-    "#{Tr8n.config.cache[:path]}/files/current"
-  end
-
-  def self.file_name(key)
-    "#{key.gsub(/[\.\/]/, '-')}.json"
+    "#{Tr8n.config.cache[:path]}/#{Tr8n.config.cache[:version]}"
   end
 
   def self.file_path(key)
-    "#{cache_path}/#{file_name(key)}"
+    File.join(cache_path, "#{key}.json")
   end
 
   def cache_name
-    "file"
+    'file'
+  end
+
+  def segmented?
+    return true if Tr8n.config.cache[:segmented].nil?
+    Tr8n.config.cache[:segmented]
   end
 
   def fetch(key, opts = {})
+    info("Fetching key: #{key}")
+
     path = self.class.file_path(key)
 
     if File.exists?(path)
       info("Cache hit: #{key}")
-      return File.read(path)
+      return JSON.parse(File.read(path))
     end
 
     info("Cache miss: #{key}")
@@ -64,11 +67,11 @@ class Tr8n::CacheAdapters::File < Tr8n::Cache
   end
 
   def store(key, data, opts = {})
-    warn("This is a readonly cache")
+    warn('This is a readonly cache')
   end
 
   def delete(key, opts = {})
-    warn("This is a readonly cache")
+    warn('This is a readonly cache')
   end
 
   def exist?(key, opts = {})
@@ -76,7 +79,11 @@ class Tr8n::CacheAdapters::File < Tr8n::Cache
   end
 
   def clear(opts = {})
-    warn("This is a readonly cache")
+    warn('This is a readonly cache')
+  end
+
+  def read_only?
+    true
   end
 
 end

data/lib/tr8n/cache_adapters/memcache.rb

@@ -64,7 +64,7 @@ class Tr8n::CacheAdapters::Memcache < Tr8n::Cache
 
     data
   rescue Exception => ex
-    warn("Failed to retrieve data: #{ex.message}")
+    warn("Failed to retrieve data: #{key}")
     return nil unless block_given?
     yield
   end
@@ -75,7 +75,7 @@ class Tr8n::CacheAdapters::Memcache < Tr8n::Cache
     @cache.set(versioned_key(key, opts), data, ttl)
     data
   rescue Exception => ex
-    warn("Failed to store data: #{ex.message}")
+    warn("Failed to store data: #{key}")
     data
   end
 
@@ -84,7 +84,7 @@ class Tr8n::CacheAdapters::Memcache < Tr8n::Cache
     @cache.delete(versioned_key(key, opts))
     key
   rescue Exception => ex
-    warn("Failed to delete data: #{ex.message}")
+    warn("Failed to delete data: #{key}")
     key
   end
 
@@ -92,13 +92,13 @@ class Tr8n::CacheAdapters::Memcache < Tr8n::Cache
     data = @cache.get(versioned_key(key, opts))
     not data.nil?
   rescue Exception => ex
-    warn("Failed to check if key exists: #{ex.message}")
+    warn("Failed to check if key exists: #{key}")
     false
   end
 
   def clear(opts = {})
     info("Cache clear")
   rescue Exception => ex
-    warn("Failed to clear cache: #{ex.message}")
+    warn("Failed to clear cache: #{key}")
   end
 end

data/lib/tr8n/cache_adapters/memory.rb

@@ -0,0 +1,85 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2014 Michael Berkovich, 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 Tr8n::CacheAdapters::Memory < Tr8n::Cache
+
+  def self.cache
+    @cache ||= {}
+  end
+
+  def self.clear_cache
+    @cache = {}
+  end
+
+  def cache_name
+    'memory'
+  end
+
+  def fetch(key, opts = {})
+    return yield if Tr8n.session.inline_mode?
+    return yield unless Tr8n.cache.read_only?
+
+    data = self.class.cache[key]
+
+    if data
+      info("Cache hit: #{key}")
+      return data
+    end
+
+    info("Cache miss: #{key}")
+
+    return nil unless block_given?
+
+    data = yield
+
+    store(key, data)
+
+    data
+  end
+
+  def store(key, data, opts = {})
+    self.class.cache[key] = data
+  end
+
+  def delete(key, opts = {})
+    self.class.cache[key] = nil
+  end
+
+  def exist?(key, opts = {})
+    not self.class.cache[key].nil?
+  end
+
+  def clear(opts = {})
+    self.class.clear_cache
+  end
+
+end

data/lib/tr8n/component.rb

@@ -35,19 +35,19 @@ class Tr8n::Component < Tr8n::Base
   attributes :key, :name, :description, :state
 
   def sources
-    application.get("component/sources", {:key => key}, {:class => Tr8n::Source, :application => application})
+    application.api_client.get("component/sources", {:key => key}, {:class => Tr8n::Source, :application => application})
   end
 
   def translators
-    application.get("component/translators", {:key => key}, {:class => Tr8n::Translator, :application => application})
+    application.api_client.get("component/translators", {:key => key}, {:class => Tr8n::Translator, :application => application})
   end
 
   def languages
-    application.get("component/languages", {:key => key}, {:class => Tr8n::Language, :application => application})
+    application.api_client.get("component/languages", {:key => key}, {:class => Tr8n::Language, :application => application})
   end
 
   def register_source(source)
-    application.post("component/register_source", {:key => key, :source => source.source})
+    application.api_client.post("component/register_source", {:key => key, :source => source.source})
   end
 
   def restricted?

data/lib/tr8n/config.rb

@@ -85,7 +85,7 @@ module Tr8n
 
     def initialize
       @enabled = true
-      @default_locale = 'en-US'
+      @default_locale = 'en'
       @default_level  = 0
       @format = :html
 
@@ -340,7 +340,7 @@ module Tr8n
     end
 
     def default_application
-      @default_application ||= Tr8n::Application.new(:host => Tr8n::ApiClient::API_HOST)
+      @default_application ||= Tr8n::Application.new(:host => Tr8n::Api::Client::API_HOST)
     end
 
     #########################################################
@@ -383,7 +383,7 @@ module Tr8n
     end
 
     def default_abbr_day_name(index)
-      "" + default_abbr_day_names[index]
+      '' + default_abbr_day_names[index]
     end
 
     def default_month_names
@@ -391,7 +391,7 @@ module Tr8n
     end
 
     def default_month_name(index)
-      "" + default_month_names[index]
+      '' + default_month_names[index]
     end
 
     def default_abbr_month_names
@@ -399,7 +399,7 @@ module Tr8n
     end
 
     def default_abbr_month_name(index)
-      "" + default_abbr_month_names[index]
+      '' + default_abbr_month_names[index]
     end
 
     def default_date_formats

data/lib/tr8n/decorators/base.rb

@@ -38,7 +38,15 @@ class Tr8n::Decorators::Base < Tr8n::Base
   end
 
   def decorate(translated_label, translation_language, target_language, translation_key, options = {})
-    raise Tr8n::Exception.new("Must be implemented by the extending class")
+    raise Tr8n::Exception.new('Must be implemented by the extending class')
   end
 
+  def inline_mode?
+    Tr8n.session.current_translator and Tr8n.session.current_translator.inline?
+  end
+
+  def decorate_language_case(language_case, rule, original, transformed, options = {})
+    raise Tr8n::Exception.new('Must be implemented by the extending class')
+  end
+  
 end

data/lib/tr8n/decorators/default.rb

@@ -35,5 +35,9 @@ class Tr8n::Decorators::Default < Tr8n::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/tr8n/decorators/html.rb

@@ -33,26 +33,21 @@
 class Tr8n::Decorators::Html < Tr8n::Decorators::Base
 
   def decorate(translated_label, translation_language, target_language, translation_key, options = {})
-    # Tr8n.logger.info("Decorating #{translated_label} of #{translation_language.locale} to #{target_language.locale}")
+    #Tr8n.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 Tr8n.session.current_translator and Tr8n.session.current_translator.inline?
+    return translated_label unless inline_mode?
     return translated_label if translation_key.locked? and not Tr8n.session.current_translator.manager?
 
-    element = 'tr8n:tr'
-    if options[:use_div]
-      element = 'div'
-    elsif options[:use_span]
-      element = 'span'
-    end
-
-    classes = ['tr8n_translatable']
+    classes = %w(tr8n_translatable)
     
     if translation_key.locked?
       # must be a manager and enabling locking feature
-      return translated_label unless Tr8n.session.current_translator.feature_enabled?(:show_locked_keys)
+      # return translated_label unless Tr8n.session.current_translator.feature_enabled?(:show_locked_keys)
       classes << 'tr8n_locked'
     elsif translation_language == translation_key.language
       classes << 'tr8n_not_translated'
@@ -62,10 +57,46 @@ class Tr8n::Decorators::Html < Tr8n::Decorators::Base
       classes << 'tr8n_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  
+  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'             => 'tr8n_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/tr8n/language.rb

@@ -35,8 +35,12 @@ class Tr8n::Language < Tr8n::Base
   attributes  :locale, :name, :english_name, :native_name, :right_to_left, :flag_url
   has_many    :contexts, :cases
 
+  def self.cache_key(locale)
+    File.join(locale, 'language')
+  end
+
   def fetch
-    update_attributes(application.api_client.get("language", {:locale => locale}, {:cache_key => "#{locale}/language"}))
+    update_attributes(application.api_client.get("language/#{locale}", {}, {:cache_key => self.class.cache_key(locale)}))
   rescue Tr8n::Exception => ex
     Tr8n.logger.error("Failed to load language: #{ex}")
     self
@@ -48,14 +52,14 @@ class Tr8n::Language < Tr8n::Base
     self.attributes[:contexts] = {}
     if hash_value(attrs, :contexts)
       hash_value(attrs, :contexts).each do |key, context|
-        self.attributes[:contexts][key] = Tr8n::LanguageContext.new(context.merge(:language => self))
+        self.attributes[:contexts][key] = Tr8n::LanguageContext.new(context.merge(:keyword => key, :language => self))
       end
     end
 
     self.attributes[:cases] = {}
     if hash_value(attrs, :cases)
       hash_value(attrs, :cases).each do |key, lcase|
-        self.attributes[:cases][key] = Tr8n::LanguageCase.new(lcase.merge(:language => self))
+        self.attributes[:cases][key] = Tr8n::LanguageCase.new(lcase.merge(:keyword => key, :language => self))
       end
     end
   end
@@ -82,7 +86,7 @@ class Tr8n::Language < Tr8n::Base
   end
 
   def dir
-    right_to_left? ? "rtl" : "ltr"
+    right_to_left? ? 'rtl' : 'ltr'
   end
 
   def align(dest)
@@ -96,7 +100,7 @@ class Tr8n::Language < Tr8n::Base
   end
 
   def current_source(options)
-    options[:source] || Tr8n.session.block_options[:source] || Tr8n.session.current_source || 'undefined'
+    (options[:source] || Tr8n.session.block_options[:source] || Tr8n.session.current_source || 'undefined').to_s
   end
 
   #######################################################################################################
@@ -129,7 +133,7 @@ class Tr8n::Language < Tr8n::Base
       :translations => []
     })
 
-    # Tr8n.logger.info("Translating " + params[:label] + " from: " + translation_key.locale.inspect + " to " + locale.inspect)
+    #Tr8n.logger.info("Translating " + params[:label] + " from: " + translation_key.locale.inspect + " to " + locale.inspect)
 
     params[:tokens] ||= {}
     params[:tokens][:viewing_user] ||= Tr8n.session.current_user
@@ -143,22 +147,25 @@ class Tr8n::Language < Tr8n::Base
       ).tr8n_translated
     end
 
-    # should this be done only for testing?
-    cached_key = application.translation_key(translation_key.key)
-    if cached_key
-      return cached_key.translate(self, params[:tokens], params[:options]).tr8n_translated
+    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]).tr8n_translated
     end
 
     source_key = current_source(options)
-    source = application.source(source_key, locale)
 
-    cached_key = source ? source.translation_key(translation_key.key) : nil
-    if cached_key
-      translation_key = cached_key
+    if Tr8n.cache.segmented? or Tr8n.session.inline_mode?
+      source = application.source(source_key, locale)
+      cached_translations = source.cached_translations(locale, translation_key.key)
+    else
+      cached_translations = application.fetch_translations(locale)[translation_key.key]
+    end
+
+    if cached_translations
+      translation_key.set_translations(locale, cached_translations)
     else
       application.register_missing_key(source_key, translation_key)
-      memory_cached_translation_key = application.translation_key(translation_key.key)
-      translation_key = memory_cached_translation_key if memory_cached_translation_key
     end
 
     translation_key.translate(self, params[:tokens], params[:options]).tr8n_translated