tr8n 3.1.8 → 3.2.0

data/lib/generators/tr8n/templates/config/tr8n/config.yml

@@ -36,9 +36,12 @@ defaults:
   
   enable_language_cases:      true      # enables support for language cases
   enable_client_sdk:          false     # allows javascript to use tr8nProxy object
+  enable_browser_cache:       false     # caches translations in the browser
   
   enable_country_tracking:    true      # tracks and reports translator countries 
 
+  enable_translator_tabs:     true      # enables translation tools tabs 
+
   #############################################################################
   # Google translation suggestions is now a paid feature by Google.
   # 
@@ -72,7 +75,9 @@ defaults:
   # translation. If the flag is set to false, then a user must be promoted to
   # be a translator in order to submit or vote on translations.
   #############################################################################
-  open_registration_mode:     true
+  open_registration_mode:           true
+  enable_registration_disclaimer:   false
+  registration_disclaimer_path:     "/tr8n/common/terms_of_service"
 
   #############################################################################
   # Tr8n best run with caching enabled 
@@ -194,6 +199,9 @@ defaults:
     enabled:                  true
     response_encoding:        "json"     # options: xml, json
     allow_key_registration:   true
+    skip_before_filters:      []       # filters from application controller
+    before_filters:           []       # filters from application controller
+    after_filters:            []       # filters from application controller
   
   #############################################################################
   # Translator Roles         - manager level is set at 1000 and anything above

data/lib/generators/tr8n/templates/config/tr8n/site/shortcuts.yml

@@ -8,7 +8,7 @@ Ctrl+Shift+I:
   
 Ctrl+Shift+L:       
   description:  Shows/hides language selector 
-  script:       "tr8nLanguageSelector.toggle();"
+  script:       "tr8nLightbox.show('/tr8n/language/select?lightbox=true', {height:500, width:400});"
   
 Ctrl+Shift+A:       
   description:  Displays all available languages  

data/lib/generators/tr8n/templates/config/tr8n/tokens/decorations.yml

@@ -13,4 +13,7 @@ i:          "<i>{$0}</i>"
 link:       "<a href='{$href}'>{$0}</a>" 
 br:         "<br>{$0}"
 div:        "<div id='{$id}' class='{$class}' style='{$style}'>{$0}</div>"
-span:       "<span id='{$id}' class='{$class}' style='{$style}'>{$0}</span>"
+span:       "<span id='{$id}' class='{$class}' style='{$style}'>{$0}</span>"
+h1:         "<h1>{$0}</h1>"
+h2:         "<h2>{$0}</h2>"
+h3:         "<h3>{$0}</h3>"

data/lib/generators/tr8n/tr8n_generator.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tasks/tr8n.rake

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n.rb

@@ -1,3 +1,26 @@
+#--
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
+#
+# 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.
+#++
+
 require File.join(File.dirname(__FILE__), 'tr8n/railtie')
 require File.join(File.dirname(__FILE__), 'tr8n/engine')
 

data/lib/tr8n/active_dumper.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Justin Balthrop
+# Copyright (c) 2010-2012 Justin Balthrop
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/cache.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -149,12 +149,5 @@ module Tr8n
       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/cache_adapters/memcached.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/config.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -261,6 +261,14 @@ module Tr8n
     def self.open_registration_mode?
       config[:open_registration_mode]
     end
+
+    def self.enable_registration_disclaimer?
+      config[:enable_registration_disclaimer]
+    end
+
+    def self.registration_disclaimer_path
+      config[:registration_disclaimer_path] || "/tr8n/common/terms_of_service"
+    end
   
     def self.enable_fallback_languages?
       config[:enable_fallback_languages]
@@ -282,6 +290,10 @@ module Tr8n
       config[:enable_country_tracking]
     end
   
+    def self.enable_translator_tabs?
+      config[:enable_translator_tabs]
+    end
+
     #########################################################
     # Config Sections
     def self.caching
@@ -744,6 +756,30 @@ module Tr8n
       config[:enable_client_sdk]
     end
 
+    def self.enable_browser_cache?
+      config[:enable_browser_cache]
+    end
+
+    def self.default_client_interval
+      5000
+    end
+
+    def self.api_skip_before_filters
+      return [] unless api[:skip_before_filters]
+      @api_skip_before_filters ||= api[:skip_before_filters].collect{|filter| filter.to_sym}
+    end
+
+    def self.api_before_filters
+      return [] unless api[:before_filters]
+      @api_before_filters ||= api[:before_filters].collect{|filter| filter.to_sym}
+    end
+
+    def self.api_after_filters
+      return [] unless api[:after_filters]
+      @api_after_filters ||= api[:after_filters].collect{|filter| filter.to_sym}
+    end
+
+
     #########################################################
     # Sync Process
     #########################################################

data/lib/tr8n/dictionary.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/engine.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -24,5 +24,8 @@
 module Tr8n
   class Engine < Rails::Engine
     isolate_namespace Tr8n
+    config.generators do |g|
+      g.test_framework :rspec, :view_specs => false
+    end
   end
 end

data/lib/tr8n/exception.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/extender.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Justin Balthrop
+# Copyright (c) 2010-2012 Justin Balthrop
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/extensions/action_controller_extension.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -86,9 +86,7 @@ module Tr8n
           return user
         end
           
-        user = eval(Tr8n::Config.current_user_method)
-        user = nil if user.class.name != Tr8n::Config.user_class_name
-        user
+        eval(Tr8n::Config.current_user_method)
       rescue
         Tr8n::Logger.error("Site user integration is enabled, but #{Tr8n::Config.current_user_method} method is not defined")
         Tr8n::Translator.new
@@ -115,6 +113,9 @@ module Tr8n
       # tr(label, {:desc => "", tokens => {},  ...})
       ############################################################
       def tr(label, desc = "", tokens = {}, options = {})
+
+        return label if label.tr8n_translated?
+
         if desc.is_a?(Hash)
           options = desc
           tokens  = options[:tokens] || {}

data/lib/tr8n/extensions/action_view_extension.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -26,38 +26,89 @@ module Tr8n
     extend ActiveSupport::Concern
     module InstanceMethods
       
-      # generates translations json for client sdk
-      def tr8n_translations_js_tag(opts = {})
+
+      def tr8n_default_client_source
+        "#{params[:controller]}/#{params[:action]}/JS"
+      end
+
+      # Creates a hash of translations for a page source(s) or a component(s)
+      def tr8n_translations_cache_tag(opts = {})
         html = []
-        html << "<script>"
 
-        var_name = opts[:id] || :tr8n_translations
+        opts[:translations_element_id] ||= :tr8n_translations
+        opts[:sources] ||= [tr8n_default_client_source]
+        client_sdk_var_name = opts[:client_var_name] || :tr8nProxy
 
-        source_names = opts[:sources] || [opts[:source]]
-        sources = Tr8n::TranslationSource.find(:all, :conditions => ["source in (?)", source_names])
-        source_ids = sources.collect{|source| source.id}
+        if Tr8n::Config.enable_browser_cache?  # translations are loaded through a script
 
-        if source_ids.empty?
-          conditions = ["1=2"]
-        else
-          conditions = ["(id in (select distinct(translation_key_id) from tr8n_translation_key_sources where translation_source_id in (?)))"]
-          conditions << source_ids.uniq
-        end
+          opts[:sources].each do |source_name|
+            source = Tr8n::TranslationSource.find_or_create(source_name, request.url)
+            js_source = "/tr8n/api/v1/language/translate.js?cache=true&sdk_jsvar=#{client_sdk_var_name}&source=#{CGI.escape(source_name)}&t=#{source.updated_at.to_i}"
+            html << "<script type='text/javascript' src='#{js_source}'></script>"
+          end  
 
-        translations = []
-        Tr8n::TranslationKey.find(:all, :conditions => conditions).each_with_index do |tkey, index|
-          trn = tkey.translate(Tr8n::Config.current_language, {}, {:api => true})
-          translations << trn 
+        else  # translations are embedded right into the page
+
+          html << "<script>"
+          sources = Tr8n::TranslationSource.find(:all, :conditions => ["source in (?)", opts[:sources]])
+          source_ids = sources.collect{|source| source.id}
+
+          if source_ids.empty?
+            conditions = ["1=2"]
+          else
+            conditions = ["(id in (select distinct(translation_key_id) from tr8n_translation_key_sources where translation_source_id in (?)))"]
+            conditions << source_ids.uniq
+          end
+
+          translations = []
+          Tr8n::TranslationKey.find(:all, :conditions => conditions).each_with_index do |tkey, index|
+            trn = tkey.translate(Tr8n::Config.current_language, {}, {:api => true})
+            translations << trn 
+          end
+
+          html << "#{client_sdk_var_name}.updateTranslations(#{translations.to_json});"
+          html << "</script>"
         end
+          
+        html.join('').html_safe
+      end
+
+      # Creates an instance of tr8nProxy object
+      def tr8n_client_sdk_tag(opts = {})
+        opts[:default_source]           ||= tr8n_default_client_source
+        opts[:scheduler_interval]       ||= Tr8n::Config.default_client_interval
 
-        html << "var #{var_name} = #{translations.to_json};"
+        opts[:enable_inline_translations] = (Tr8n::Config.current_user_is_translator? and Tr8n::Config.current_translator.enable_inline_translations? and (not Tr8n::Config.current_language.default?))
+        opts[:default_decorations]        = Tr8n::Config.default_decoration_tokens
+        opts[:default_tokens]             = Tr8n::Config.default_data_tokens
 
+        opts[:rules]                      = { 
+          :number => Tr8n::Config.rules_engine[:numeric_rule],      :gender => Tr8n::Config.rules_engine[:gender_rule],
+          :list   => Tr8n::Config.rules_engine[:gender_list_rule],  :date   => Tr8n::Config.rules_engine[:date_rule]
+        }
+
+        client_var_name = opts[:client_var_name] || :tr8nProxy
+
+        html = [javascript_include_tag("tr8n/tr8n_client_sdk.js")]
+        html << "<script>"
+        html << "  var #{client_var_name} = new Tr8n.Proxy(#{opts.to_json});"
+        html << "  function reloadTranslations() { "
+        html << "    #{client_var_name}.initTranslations(true); "
+        html << "  } "
+        html << "  function tr(label, description, tokens, options) { "
+        html << "    return #{client_var_name}.tr(label, description, tokens, options); "
+        html << "  } "
+        html << "  function trl(label, description, tokens, options) { "
+        html << "    return #{client_var_name}.trl(label, description, tokens, options); "
+        html << "  } "
         html << "</script>"
-        html.join('').html_safe
+        html.join("\n").html_safe
       end
 
       # translation functions
       def tr(label, desc = "", tokens = {}, options = {})
+        return label if label.tr8n_translated?
+
         if desc.is_a?(Hash)
           options = desc
           tokens  = options[:tokens] || {}

data/lib/tr8n/extensions/array_extension.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -38,6 +38,19 @@ class Array
     end
   end
 
+  # translate array values 
+  def trl(description = "", options = {}, language = Tr8n::Config.current_language)
+    return [] if empty?
+
+    collect do |opt|
+      if opt.is_a?(String)
+        opt.trl(description, {}, options, language)
+      else  
+        opt
+      end
+    end
+  end
+
   # creates a sentence with tr "and" joiner
   def tr_sentence(options = {}, language = Tr8n::Config.current_language)
     return "" if empty?

data/lib/tr8n/extensions/date_extension.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/extensions/fixnum_extension.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/extensions/hash_extension.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/extensions/string_extension.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/extensions/time_extension.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/tr8n/ip_address.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Scott Steadman, Michael Berkovich
+# Copyright (c) 2010-2012 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the