tr8n 3.1.5 → 3.1.6

data/lib/tr8n/cache.rb

@@ -23,10 +23,17 @@
 
 module Tr8n
   class Cache
+    
+    def self.cache_store_params
+      [Tr8n::Config.cache_store].flatten
+    end
+    
     def self.cache
+      return nil unless enabled?
+      
       @cache ||= begin
         if Tr8n::Config.cache_adapter == 'ActiveSupport::Cache'
-          store_params = [Tr8n::Config.cache_store].flatten
+          store_params = cache_store_params
           store_params[0] = store_params[0].to_sym
           ActiveSupport::Cache.lookup_store(*store_params)
         else
@@ -38,22 +45,116 @@ module Tr8n
     def self.enabled?
       Tr8n::Config.enable_caching?
     end
-  
+
+    def self.disabled?
+      not enabled?
+    end
+    
+    def self.version
+      Tr8n::Config.cache_version
+    end
+    
     def self.versioned_key(key)
-      "#{Tr8n::Config.cache_version}_#{key}"
+      "#{version}_#{key}"
     end
-  
-    def self.fetch(key, options = {})
+
+    def self.memory_store?
+      cache_store_params.first == 'memory_store'
+    end
+    
+    #################################################################
+    # Cache Adapter Methods
+    #################################################################
+    def self.fetch(key, opts = {})
       return yield unless enabled?
-      cache.fetch(versioned_key(key), options) do 
+      
+      # pp "fetch #{key}"
+      
+      cache.fetch(versioned_key(key), opts) do 
         yield
       end
     end
 
-    def self.delete(key, options = nil)
+    def self.delete(key, opts = nil)
       return unless enabled?
-      cache.delete(versioned_key(key), options)
+
+      # pp "delete #{key}"
+
+      cache.delete(versioned_key(key), opts)
+    end
+    
+    def self.exist?(name, opts = nil)
+      return unless enabled?
+      cache.exists?(name, opts)
+    end
+
+    def self.clear(opts = nil)
+      return unless enabled?
+      cache.clear(opts)
+    end
+
+    def self.cleanup(opts = nil)
+      return unless enabled?
+      cache.cleanup(opts)
+    end
+
+    def self.increment(name, amount = 1, opts = nil)
+      return unless enabled?
+      cache.increment(name, amount, opts)
+    end
+
+    def self.decrement(name, amount = 1, opts = nil)
+      return unless enabled?
+      cache.decrement(name, amount, opts)
     end
   
+    #################################################################
+    # Cache Source Methods
+    #################################################################
+    
+    # For local cache, the source+language = updated_at must always be present
+    # These keys cannot expire, or refreshing of the resources will never take place
+    def self.sources_timestamps
+      @sources_timestamps ||= {}
+    end
+    
+    def self.last_updated_at(translation_source_language)
+      sources_timestamps[translation_source_language.id] ||= 365.days.ago
+    end
+
+    def self.invalidate_source(source_name, language = Tr8n::Config.current_language)
+      return if disabled? or language.default? 
+      
+      # only memory store needs this kind of reloading
+      # memcached and other stores will expire shared keys 
+      return unless memory_store?
+      
+      # pp [:memory_times, sources_timestamps]
+      
+      translation_source = Tr8n::TranslationSource.find_or_create(source_name)
+
+      # this is the only record that will never be cached and will always be loaded from the database
+      translation_source_language = Tr8n::TranslationSourceLanguage.find_or_create(translation_source, language)
+
+      if last_updated_at(translation_source_language) < translation_source_language.updated_at
+        keys = Tr8n::TranslationKey.where(["id in (select translation_key_id from #{Tr8n::TranslationKeySource.table_name} where translation_source_id = ?) and updated_at > ?", 
+                                          translation_source.id, last_updated_at(translation_source_language)])
+                                          
+        # pp "****************************** Found #{keys.count} outdated keys for this language"                                  
+        keys.each do |key|
+          key.clear_translations_cache_for_language(language)
+        end
+        
+        sources_timestamps[translation_source_language.id] = translation_source_language.updated_at
+      end
+    end
+    
+    def self.cache_key_source(translation_key, source_name)
+      source_name ||= Tr8n::Config.current_source || 'Undefined'
+      translation_source = Tr8n::TranslationSource.find_or_create(source_name)
+      key_source = Tr8n::TranslationKeySource.find_or_create(translation_key, translation_source)
+      key_source
+    end
+    
   end
 end

data/lib/tr8n/config.rb

@@ -31,16 +31,21 @@ module Tr8n
   
     # initializes language, user and translator
     # the variables are kept in a thread safe form throughout the request
-    def self.init(locale, site_current_user)
-      Thread.current[:tr8n_current_language]   = Tr8n::Language.for(locale) || default_language
+    def self.init(site_current_locale, site_current_user = nil, site_current_source = nil)
+      Thread.current[:tr8n_current_language]   = Tr8n::Language.for(site_current_locale) || default_language
       Thread.current[:tr8n_current_user]       = site_current_user
       Thread.current[:tr8n_current_translator] = Tr8n::Translator.for(site_current_user)
+      Thread.current[:tr8n_current_source]     = site_current_source
       Thread.current[:tr8n_block_options]      = {}
     end
   
     def self.current_user
       Thread.current[:tr8n_current_user]
     end
+
+    def self.current_source
+      Thread.current[:tr8n_current_source]
+    end
   
     def self.current_language
       Thread.current[:tr8n_current_language] ||= default_language
@@ -82,6 +87,7 @@ module Tr8n
       Thread.current[:tr8n_current_user] = nil
       Thread.current[:tr8n_current_translator] = nil
       Thread.current[:tr8n_block_options]  = nil
+      Thread.current[:tr8n_current_source] = nil
     end
 
     def self.models
@@ -89,7 +95,7 @@ module Tr8n
          Tr8n::LanguageRule, Tr8n::LanguageUser, Tr8n::Language, Tr8n::LanguageMetric,
          Tr8n::LanguageCase, Tr8n::LanguageCaseValueMap, Tr8n::LanguageCaseRule,
          Tr8n::TranslationKey, Tr8n::TranslationKeySource, Tr8n::TranslationKeyComment, Tr8n::TranslationKeyLock,
-         Tr8n::TranslationSource, Tr8n::TranslationDomain,
+         Tr8n::TranslationSource, Tr8n::TranslationDomain, Tr8n::TranslationSourceLanguage,
          Tr8n::Translation, Tr8n::TranslationVote,
          Tr8n::Translator, Tr8n::TranslatorLog, Tr8n::TranslatorMetric, 
          Tr8n::TranslatorFollowing, Tr8n::TranslatorReport, 
@@ -152,7 +158,7 @@ module Tr8n
 
     def self.load_yml(file_path, for_env = env)
       yml = YAML.load_file("#{root}#{file_path}")
-      yml = yml[for_env] unless for_env.nil?
+      yml = yml['defaults'].rmerge(yml[for_env] || {}) unless for_env.nil?
       HashWithIndifferentAccess.new(yml)
     end
   
@@ -232,6 +238,10 @@ module Tr8n
       config[:enable_google_suggestions]
     end
 
+    def self.google_api_key
+      config[:google_api_key]
+    end
+
     def self.enable_glossary_hints?
       config[:enable_glossary_hints]
     end

data/lib/tr8n/extensions/action_controller_extension.rb

@@ -62,35 +62,44 @@ module Tr8n
           request.remote_ip
         end
       end
+      
+      def tr8n_init_current_source
+        "#{self.class.name.underscore.gsub("_controller", "")}/#{self.action_name}"
+      rescue
+        self.class.name
+      end
 
-      def init_tr8n
-        tr8n_current_locale = nil
-        begin
-          tr8n_current_locale = eval(Tr8n::Config.current_locale_method)
-        rescue
-          # fallback to the default session based locale implementation
-          # choose the first language from the accepted languages header
-          session[:locale] = tr8n_user_preffered_locale unless session[:locale]
-          session[:locale] = params[:locale] if params[:locale]
-          tr8n_current_locale = session[:locale]
-        end
-        
-        tr8n_current_user = nil
-        if Tr8n::Config.site_user_info_enabled? 
-          begin
-            tr8n_current_user = eval(Tr8n::Config.current_user_method)
-            tr8n_current_user = nil if tr8n_current_user.class.name != Tr8n::Config.user_class_name
-          rescue
-            tr8n_current_user = Tr8n::Translator.new
-            Tr8n::Logger.error("Site user integration is enabled, but #{Tr8n::Config.current_user_method} method is not defined")
-          end
-        else
-          tr8n_current_user = Tr8n::Translator.find_by_id(session[:tr8n_translator_id]) if session[:tr8n_translator_id]
-          tr8n_current_user = Tr8n::Translator.new unless tr8n_current_user
+      def tr8n_init_current_locale
+        eval(Tr8n::Config.current_locale_method)
+      rescue
+        # fallback to the default session based locale implementation
+        # choose the first language from the accepted languages header
+        session[:locale] = tr8n_user_preffered_locale unless session[:locale]
+        session[:locale] = params[:locale] if params[:locale]
+        session[:locale]
+      end
+
+      def tr8n_init_current_user
+        unless Tr8n::Config.site_user_info_enabled? # deprecated - the site should run a standalone translation engine with a bridge
+          user = Tr8n::Translator.find_by_id(session[:tr8n_translator_id]) if session[:tr8n_translator_id]
+          user ||= Tr8n::Translator.new
+          return user
         end
+          
+        user = eval(Tr8n::Config.current_user_method)
+        user = nil if user.class.name != Tr8n::Config.user_class_name
+        user
+      rescue
+        Tr8n::Logger.error("Site user integration is enabled, but #{Tr8n::Config.current_user_method} method is not defined")
+        Tr8n::Translator.new
+      end
 
+      def init_tr8n
         # initialize request thread variables
-        Tr8n::Config.init(tr8n_current_locale, tr8n_current_user)
+        Tr8n::Config.init(tr8n_init_current_locale, tr8n_init_current_user, tr8n_init_current_source)
+        
+        # invalidate source for the current page
+        Tr8n::Cache.invalidate_source(Tr8n::Config.current_source)
 
         # track user's last ip address  
         if Tr8n::Config.enable_country_tracking? and Tr8n::Config.current_user_is_translator?
@@ -112,20 +121,9 @@ module Tr8n
           desc    = options[:desc] || ""
         end
 
-        begin
-          url     = request.url
-          host    = request.env['HTTP_HOST']
-          source  = "#{controller.class.name.underscore.gsub("_controller", "")}/#{controller.action_name}"
-        rescue
-          source = self.class.name
-          url = nil
-          host = 'localhost'
-        end
-
-        options.merge!(:source => source) unless options[:source]
         options.merge!(:caller => caller)
-        options.merge!(:url => url)
-        options.merge!(:host => host)
+        options.merge!(:url => request.url)
+        options.merge!(:host => request.env['HTTP_HOST'])
 
         unless Tr8n::Config.enabled?
           return Tr8n::TranslationKey.substitute_tokens(label, tokens, options)

data/lib/tr8n/extensions/action_view_extension.rb

@@ -64,20 +64,9 @@ module Tr8n
           desc    = options[:context] || ""
         end
 
-        begin
-          url     = request.url
-          host    = request.env['HTTP_HOST']
-          source  = "#{controller.class.name.underscore.gsub("_controller", "")}/#{controller.action_name}"
-        rescue
-          source = self.class.name
-          url = nil
-          host = 'localhost'
-        end
-
-        options.merge!(:source => source) unless options[:source]
         options.merge!(:caller => caller)
-        options.merge!(:url => url)
-        options.merge!(:host => host)
+        options.merge!(:url => request.url)
+        options.merge!(:host => request.env['HTTP_HOST'])
 
         unless Tr8n::Config.enabled?
           return Tr8n::TranslationKey.substitute_tokens(label, tokens, options)
@@ -140,10 +129,7 @@ module Tr8n
         end
 
         if linked
-          html << link_to(name.html_safe, :controller => "/tr8n/language", 
-                  :action => :switch, :language_action => :switch_language, 
-                  :locale => lang.locale,
-                  :source_url => opts[:source_url])
+          html << link_to(name.html_safe, "/tr8n/language/switch?locale=#{lang.locale}&language_action=switch_language&source_url=#{CGI.escape(opts[:source_url]||'')}")
         else    
           html << name
         end

data/lib/tr8n/extensions/date_extension.rb

@@ -65,7 +65,6 @@ class Date
       end
     end
 
-#    options.merge!(:skip_decorations => true) if options[:skip_decorations].blank?
     language.tr(label, nil, tokens, options)
   end
   alias :tr :translate  

data/lib/tr8n/extensions/hash_extension.rb

@@ -57,4 +57,70 @@ class Hash
     @tr8n_translated
   end
 
+  # 
+  # = 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/tr8n/extensions/string_extension.rb

@@ -33,7 +33,7 @@ class String
   end
 
   def trl(desc = "", tokens = {}, options = {}, language = Tr8n::Config.current_language)
-    translate(desc, tokens, options.merge!(:skip_decorations => true), language)
+    translate(desc, tokens, options.merge(:skip_decorations => true), language)
   end
 
   def tr8n_translated

data/lib/tr8n/extensions/time_extension.rb

@@ -72,7 +72,6 @@ class Time
       end
     end
   
-#    options.merge!(:skip_decorations => true) if options[:skip_decorations].blank?
     language.tr(label, nil, tokens, options)
   end
   alias :tr :translate

data/lib/tr8n/version.rb

@@ -1,3 +1,3 @@
 module Tr8n
-  VERSION = "3.1.5"
+  VERSION = "3.1.6"
 end

data/local/tr8n_server/app/views/layouts/_footer.html.erb

@@ -1,6 +1,6 @@
 	<div class="page_ft module quiet">
 	  <ul class="flt_r right_horiz_list">
-	    <li><%=link_to(tr("Home"), "/tr8n/home", :class => "quiet")%></li>
+	    <li><%=link_to(tr("Home"), "/", :class => "quiet")%></li>
 	    <li><%=link_to(tr("Languages"), "/tr8n/language/table", :class => "quiet")%></li>
 	    <li><%=link_to(tr("Translator Tools"), "/tr8n/dashboard", :class => "quiet")%></li>
 	    <li><%=link_to(tr("Administration Tools"), "/tr8n/admin/language", :class => "quiet")%></li>

data/local/tr8n_server/config/tr8n/config.yml

@@ -9,14 +9,13 @@
 # Alternatively, you can overload any of the methods of Tr8n::Config
 #############################################################################
 
-defaults: &defaults
+defaults:
   enable_tr8n:                true      # enables the engine
   enable_key_source_tracking: false     # builds the site map sources
   enable_key_caller_tracking: false     # tracks all calls to labels with their traces - for debugging only
   
   enable_glossary_hints:      true      # shows glossary in the translator    
   enable_software_keyboard:   true      # shows the soft keyboard icon  
-  enable_google_suggestions:  true      # uses google for suggestions
   enable_keyboard_shortcuts:  true      # adds some keyboard shortcuts like ctrl+shift+s
   enable_dictionary_lookup:   true      # shows dictionary words definitions
   
@@ -34,6 +33,19 @@ defaults: &defaults
   
   enable_country_tracking:    true      # tracks and reports translator countries 
 
+  #############################################################################
+  # Google translation suggestions is now a paid feature by Google.
+  # 
+  # In order to enable this useful feauture, visit:
+  # http://code.google.com/apis/language/translate/overview.html  
+  #
+  # Provide your billing information and register for an API key.
+  # 
+  # Put your API key in the box below.
+  #############################################################################
+  enable_google_suggestions:  false      # uses google for suggestions
+  google_api_key: "YOUR GOOGLE API KEY"  # get this API key from Google.
+  
   #############################################################################
   # Featured languages can be added as a bottom strip bar on all pages using
   #
@@ -67,7 +79,7 @@ defaults: &defaults
   # store:    memory_store        # only for dev or test - single instance
   # store:    file_store          # only for dev or test - single instance
   # store:    drb_store
-  # store:    [mem_cache_store, 'localhost:11211'] # recommended
+  # store:    ['mem_cache_store', 'localhost:11211'] # recommended
   # 
   # If you choose to use memcached, don't forget to add the gem to your Gemfile:
   #
@@ -77,11 +89,13 @@ defaults: &defaults
   #
   # cache_adapter:  YOUR_CACHE_ADAPTER_CLASS
   #
+  # Note: Make sure you enable config.class_caching in your environment file
+  #
   #############################################################################
   caching:
     enabled:                  false
     adapter:                  ActiveSupport::Cache
-    store:                    ['mem_cache_store', 'localhost:11211']
+    store:                    'memory_store'
     version:                  1 # you can change the version to invalidate the cache
 
   #############################################################################
@@ -256,21 +270,11 @@ defaults: &defaults
 # You can overload any feature defined in the defaults for any environment
 #############################################################################
 development:
-  <<: *defaults
-#  enable_key_source_tracking: false
   
 test:
-  <<: *defaults
-#  enable_key_source_tracking: false
       
 qa:
-  <<: *defaults
-#  enable_key_source_tracking: false
 
 stage:
-  <<: *defaults
-#   enable_key_source_tracking: false
 
 production:
-  <<: *defaults
-#  enable_key_source_tracking: false

data/local/tr8n_server/config/tr8n/site/features.yml

@@ -7,7 +7,7 @@
 # environment settings at the bottom of the file
 #############################################################################
 
-defaults: &defaults
+defaults: 
   enabled_features: [dashboard, sitemap, phrases, translations, awards, forum, glossary, help]
   
   dashboard:
@@ -96,16 +96,11 @@ defaults: &defaults
 # You can overload any feature defined in the defaults for any environment
 #############################################################################
 development:
-  <<: *defaults
 
 test:
-  <<: *defaults
       
 qa:
-  <<: *defaults
 
 stage:
-  <<: *defaults
 
 production:
-  <<: *defaults

data/local/tr8n_server/config/tr8n/site/shortcuts.yml

@@ -22,6 +22,10 @@ Ctrl+Shift+C:
   description:  Displays Tr8n credits
   script:       "window.location = '/tr8n/home/credits';"
 
+Ctrl+Shift+T:       
+  description:  Displays Tr8n statistics
+  script:       "Tr8n.Utils.displayStatistics();"
+
 Alt+Shift+D: 
   description:  Opens dashboard
   script:       "window.location = '/tr8n/dashboard';"