tr8n 3.0.2 → 3.0.3

data/Gemfile

@@ -4,31 +4,5 @@ gem 'rails', '~> 3.0.0'
 gem 'will_paginate', "~> 3.0.pre2"
 gem 'will_filter', "~> 3.0.0" 
 
-# Bundle edge Rails instead:
-# gem 'rails', :git => 'git://github.com/rails/rails.git'
-
-#gem 'sqlite3'
+gem 'sqlite3'
 #gem 'will_filter', :path => '../will_filter'
-
-# Use unicorn as the web server
-# gem 'unicorn'
-
-# Deploy with Capistrano
-# gem 'capistrano'
-
-# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
-# gem 'ruby-debug'
-# gem 'ruby-debug19', :require => 'ruby-debug'
-
-# Bundle the extra gems:
-# gem 'bj'
-# gem 'nokogiri'
-# gem 'sqlite3-ruby', :require => 'sqlite3'
-# gem 'aws-s3', :require => 'aws/s3'
-
-# Bundle gems for the local environment. Make sure to
-# put test-only gems in this group so their generators
-# and rake tasks are available in development mode:
-# group :development, :test do
-#   gem 'webrat'
-# end

data/Gemfile.lock

@@ -64,8 +64,8 @@ GEM
     treetop (1.4.9)
       polyglot (>= 0.3.1)
     tzinfo (0.3.27)
-    will_filter (1.0.1)
-      rails (= 3.0.7)
+    will_filter (3.0.0)
+      rails (~> 3.0.0)
       will_paginate (~> 3.0.pre2)
     will_paginate (3.0.pre2)
 
@@ -73,7 +73,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  rails (= 3.0.7)
+  rails (~> 3.0.0)
   sqlite3
-  will_filter (= 1.0.1)
+  will_filter (~> 3.0.0)
   will_paginate (~> 3.0.pre2)

data/README.rdoc

@@ -1,12 +1,12 @@
 = Welcome to Tr8n Translation Engine
 
-Tr8n Translation Engine is a Rails engine plugin that provides a framework for crowd-source translations and management of any internationalized text 
-throughout any Rails based application. The power of the engine comes from its simple and friendly user interface that allows site users 
-to rapidly translate the site into hundreds of languages. The flexible and robust rules engine that powers Tr8n allows for any combination 
-of language specific rules in any translatable sentence. Users themselves can provide information on what sentences depend on gender rules, 
-number rules or other rules supported by the engine. The language specific rules can be registered and managed for any language in 
-the advanced user interface. The engine provides a set of powerful admin tools that allow admins to manage any aspect of the engine; 
-enabling and disabling its features and monitoring translation process.
+Tr8n Translation Engine is a Rails Engine Gem that provides a framework for crowd-sourced translation and management of any content 
+for any Rails based application. The power of the engine comes from its simple and friendly user interface that allows site users 
+to rapidly translate the site into hundreds of languages. The flexible and robust rules engine that powers tr8n allows for any combination 
+of language specific rules in any translatable sentence. Users can provide information on what sentences depend on gender rules, 
+number rules or other rules configured for each language. The language specific context and case rules can be registered and managed for any language in 
+the advanced user interface. The engine provides a set of powerful administration tools that allow admins to manage any aspect of the engine; 
+enabling and disabling its features and monitoring translation progress.
 
 The Tr8n engine itself is based on a very robust and flexible pluggable architecture where rule types and the syntax of the "tr" tokens 
 can be configured or extended for any application deployment.
@@ -17,7 +17,7 @@ Geni Inc, http://www.geni.com
 
 Yammer Inc, http://www.yammer.com 
 
-You can visit their web sites and see how it is being used. If your company is using Tr8n, please let me know and i will add you to the list.
+You can visit their web sites and see how it is being used. If your company is using Tr8n, please let me know and you will be added to the list.
 
 = Documentation
 
@@ -79,6 +79,22 @@ Live Tr8n sample application is running here:
 
 http://bit.ly/e9QhFY 
 
+= Tr8n Screenshots
+
+Below are a few screenshots of what tr8n looks like:
+
+http://wiki.tr8n.org/images/b/b7/Tr8n_screenshot_1.png
+
+http://wiki.tr8n.org/images/5/55/Tr8n_screenshot_2.png
+
+http://wiki.tr8n.org/images/3/3c/Tr8n_screenshot_3.png
+
+http://wiki.tr8n.org/images/7/7b/Tr8n_screenshot_4.png
+
+http://wiki.tr8n.org/images/9/91/Tr8n_screenshot_5.png
+
+http://wiki.tr8n.org/images/8/8b/Tr8n_screenshot_6.png
+
 = External Links
 
 Yammer in Translation

data/VERSION

@@ -1 +1 @@
-3.0.2
+3.0.3

data/app/controllers/tr8n/home_controller.rb

@@ -29,22 +29,10 @@ class Tr8n::HomeController < ApplicationController
     
   end
 
-  def tokens
-        
-  end
-
-  def rules
-        
-  end
-  
   def license
     
   end
   
-  def docs
-    
-  end
-  
   def credits
     
   end

data/app/helpers/application_helper.rb

@@ -22,6 +22,5 @@
 #++
 
 module ApplicationHelper
-  include Tr8n::HelperMethods
  
 end

data/app/models/tr8n/language.rb

@@ -218,6 +218,10 @@ class Tr8n::Language < ActiveRecord::Base
     @rule_classes ||= rules.collect{|r| r.class}.uniq
   end
 
+  def rule_class_names  
+    @rule_class_names ||= rule_classes.collect{|r| r.name}
+  end
+
   def dependencies  
     @dependencies ||= rule_classes.collect{|r| r.dependency}.uniq
   end

data/app/models/tr8n/translation.rb

@@ -125,7 +125,7 @@ class Tr8n::Translation < ActiveRecord::Base
       rules.each do |rule|
         context_rules << "<strong>#{rule[:token]}</strong> #{rule[:rule].description}" 
       end
-      context_rules.join(" and ")
+      context_rules.join(" and ").html_safe
     end
   end
 

data/app/models/tr8n/translation_key.rb

@@ -159,13 +159,13 @@ class Tr8n::TranslationKey < ActiveRecord::Base
   def language_rules_dependant_tokens(language = Tr8n::Config.current_language)
     toks = []
     included_token_hash = {}
-    
+
     data_tokens.each do |token|
       next unless token.dependant?
       next if included_token_hash[token.name]
       
       token.language_rules.each do |rule_class|
-        if language.rule_classes.include?(rule_class)
+        if language.rule_class_names.include?(rule_class.name)
           toks << token
           included_token_hash[token.name] = token
         end
@@ -307,16 +307,16 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     find(:first, :offset => rand(count - 1))
   end
 
-  # returns back grouped by context
+  # returns back grouped by context - used by API
   def find_all_valid_translations(translations)
     if translations.empty?
-      return {:key => self.key, :label => self.label, :original => true}
+      return {:id => self.id, :key => self.key, :label => self.label, :original => true}
     end
     
     # if the first translation does not depend on any of the context rules
     # use it... we don't care about the rest of the rules.
     if translations.first.rules_hash.blank?
-      return {:key => self.key, :label => translations.first.label}
+      return {:id => self.id, :key => self.key, :label => translations.first.label}
     end
     
     # build a context hash for every kind of context rules combinations
@@ -336,7 +336,7 @@ class Tr8n::TranslationKey < ActiveRecord::Base
 
     # always add the default one at the end, so if none of the rules matched, use the english one
     valid_translations << {:label => self.label} unless context_hash_matches[""]
-    {:key => self.key, :labels => valid_translations}
+    {:id => self.id, :key => self.key, :labels => valid_translations}
   end
 
   def find_first_valid_translation(language, token_values)
@@ -450,7 +450,7 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     end
 
     html = "<tr8n class='#{classes.join(' ')}' translation_key_id='#{id}'>"
-    html << label
+    html << sanitized_label
     html << "</tr8n>"
     html.html_safe    
   end

data/app/views/tr8n/admin/clientsdk/index.html.erb

@@ -1,7 +1,5 @@
 <%= render :partial => "/tr8n/admin/common/header" %>
 
-<%=tr8n_client_sdk_scripts_tag %>
-
 <div class="section_title">
   <span style="font-size:12px; color:grey; float:right; padding-top:5px;">
     <strong>Make sure that key source tracking is enabled!</strong> And try not to register useless phrases in production.
@@ -34,7 +32,7 @@
 			     <%=link_to_function("<span>Translate Label</span>".html_safe, "translate();", :class => "tr8n_grey_button tr8n_pcb") %>
 
 	         <div style="margin-top:15px; padding:2px; text-align:center; border: 1px dotted #ccc;">
-              <%=link_to_function("<span>View Examples</span>".html_safe, "tr8nLightbox.show('/tr8n/admin/clientsdk/lb_samples', {height:450});", :class => "tr8n_grey_button tr8n_pcb", :style=>"width:200px;") %><br>
+              <%=link_to_function("<span>View Examples</span>".html_safe, "tr8nLightbox.show('/tr8n/admin/clientsdk/lb_samples', {height:550});", :class => "tr8n_grey_button tr8n_pcb", :style=>"width:200px;") %><br>
               <%=link_to("<span>View Phrases</span>".html_safe, "/tr8n/phrases/index?section_key=clientsdk", :target => "_phrases", :class => "tr8n_grey_button tr8n_pcb", :style=>"width:200px;") %><br>
               <%=link_to_function("<span>Load Translations</span>".html_safe, "reloadTranslations();", :class => "tr8n_grey_button tr8n_pcb", :style=>"width:200px;") %><br>
               <%=link_to_function("<span>Clear Results</span>".html_safe, "clearResults();", :class => "tr8n_grey_button tr8n_pcb", :style=>"width:200px;") %><br>
@@ -55,6 +53,8 @@
     <tr>
       <td colspan="2" style="padding:2px;">
         <div style="font-weight:bold; padding-top:10px;">Translation <span style='color:grey'>- translated label with substituted tokens</span></div>
+        <div id="result_html" style="background:#F9F8F7; height:40px; overflow:auto; border:1px dotted #ccc; padding:10px;"></div>
+        <div style="font-weight:bold; padding-top:10px; color:grey;">Raw HTML:</div>
         <%=text_area_tag(:result, "", :style => "width:99%; background:#F9F8F7;", :readonly => true)%>     
       </td>
     </tr>
@@ -65,20 +65,19 @@
 <div id="debugger" class="section_box colored" style="font-size:10px; border:1px solid black; height:230px; overflow:auto; padding: 2px;">
 </div>
 
+<%=tr8n_translations_js_tag(:sources => ["clientsdk_examples"], :id => :tr8n_clientsdk_translations) %>
+<%=tr8n_client_sdk_scripts_tag(
+    :default_source             => "clientsdk_examples",
+    :debugger_element_id        => "debugger",
+    :translations_element_id    => "tr8n_clientsdk_translations",
+    :scheduler_interval         =>  5000
+) %>
+            
 <script>
-  var tr8nProxy = new Tr8n.Proxy({
-    "debugger": "debugger",
-    "source": "clientsdk",
-    "decorations": {"bold": "<strong>{$0}</strong>", "italic": "<i>{$0}</i>", "link": "<a href='{$href}'>{$0}</a>"},
-    "rules": {"number":{"token_suffixes":["count", "num"]}, 
-              "gender":{"token_suffixes":["user", "profile", "actor", "target"]},
-              "list":{"token_suffixes":["list"]}, "date":{"token_suffixes":["date"]}
-    }
-  });
-
   function clearResults() {
 		Tr8n.element('debugger').innerHTML = '';
 		Tr8n.element('result').value = '';
+    Tr8n.element('result_html').innerHTML = '';
 	}
 	
   function reloadTranslations() {
@@ -100,6 +99,7 @@
     }
     
     Tr8n.element('result').value = tr8nProxy.tr(Tr8n.value('label'), '', tokens);
+    Tr8n.element('result_html').innerHTML = Tr8n.element('result').value;
   }
   
   function speedTest() {

data/app/views/tr8n/admin/clientsdk/lb_samples.html.erb

@@ -11,6 +11,7 @@
     {:label => "Some [bold: decoration] stuff!", :tokens => "{'bold': '<strong>{$0}</strong>'}", :alt => "Uses decoration token."},
     {:label => "Using default [bold: decorations]!", :tokens => "", :alt => "Uses decoration token with a fallback default decoration."},
     {:label => "More default [italic: decorations]!", :tokens => "", :alt => "Uses decoration token with a fallback default decoration."},
+    {:label => "Even more [span: default decorations]!", :tokens => "{span: {style:'font-size:18px;font-weight:bold;color:blue;'}}", :alt => "Uses decoration token with a fallback default decoration."},
     {:label => "[link: Click here] is a link default decoration!", :tokens => "{'link':{'href':'http://www.google.com'}}", :alt => "Uses decoration token with a fallback default decoration."},
     {:label => "You have [link: {count|| message, messages}] in your mailbox!", :tokens => "{'link':{'href':'http://www.google.com'}, 'count': 5}", :alt => "Uses decoration and data tokens together."},
   ]

data/app/views/tr8n/common/_scripts.html.erb

@@ -11,14 +11,6 @@
   <% if Tr8n::Config.enable_effects? %>
     <%=javascript_include_tag(Tr8n::Config.effects_library_path) -%>
 	<% end %>
-
-  <% if Tr8n::Config.enable_client_sdk? %>
-    <%=javascript_include_tag("/tr8n/javascripts/tr8n_client_sdk.js") -%>
-		<% tr8n_source = "#{@controller.controller_name}/#{@controller.action_name}" %>
-	  <script type="text/javascript">
-	     // initializeTr8nClientSDK("<%=tr8n_source%>");
-	  </script>
-  <% end %>
 	
   <% if Tr8n::Config.enable_google_suggestions? and Tr8n::Config.current_user_is_translator? %>
     <script type="text/javascript" src="<%=request.ssl? ? 'https' : 'http' %>://www.google.com/jsapi"></script>

data/app/views/tr8n/language/select.html.erb

@@ -58,7 +58,7 @@
 	  	<tr>
 	  		<td style="vertical-align:middle"><%=tr8n_help_icon_tag %></td>
 				<td style="font-size:10px; font-family:arial; vertical-align:middle">&nbsp;
-	        <%=trla("Click this icon to view [link: translation help] in a new window.", "", :link => ["tr8n/help"])%>
+	        <%=trla("Click this icon to view [link: translation help] in a new window.", "", :link => lambda{|value| link_to(value, "tr8n/help")})%>
 				</td>
 	  	</tr>
 	  </table>

data/app/views/tr8n/phrases/_new_comment.html.erb

@@ -16,7 +16,7 @@
         <td></td>
         <td style="color:grey; font-size:12px; padding-top:10px; padding-bottom:10px;">
            <%=tra("Leave your comments here if you would like to discuss translations for this particular phrase.")%>
-           <%=tra("If you would like to discuss translations in general, leave your comments in the [link: language forum].", "", :link => ["/tr8n/forum"])%>
+           <%=tra("If you would like to discuss translations in general, leave your comments in the [link: language forum].", "", :link => lambda{|value| link_to(value, "/tr8n/forum")})%>
         </td>
       </tr>
     </table>

data/config/tr8n/config.yml

@@ -11,7 +11,7 @@
 
 defaults: &defaults
   enable_tr8n:                true      # enables the engine
-  enable_key_source_tracking: false     # builds the site map sources
+  enable_key_source_tracking: false     # builds the site map sources - must be enabled for the API
   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    
@@ -76,8 +76,8 @@ defaults: &defaults
   #############################################################################
   caching:
     enabled:                  false
-    adapter:                  ActiveSupport::Cache
-    store:                    [mem_cache_store, 'localhost:11211']
+    adapter:                  "ActiveSupport::Cache"
+    store:                    ['mem_cache_store', 'localhost:11211']
     version:                  1 # you can change the version to invalidate the cache
 
   #############################################################################
@@ -86,7 +86,7 @@ defaults: &defaults
   #############################################################################
   logger:
     enabled:                  true
-    log_path:                 log/tr8n.log          # location of the log file
+    log_path:                 "log/tr8n.log"          # location of the log file
     enable_paranoia_mode:     true                  # logs every translator action
 
   #############################################################################
@@ -112,14 +112,14 @@ defaults: &defaults
       class_name:             User                              # class name for the User object type
       current_user_method:    current_user                      # returns current user object
       methods:                                                  # User object methods mapping
-        id:                   id
-        name:                 name                            
-        gender:               gender
-        admin:                admin?
-        guest:                guest?
-        mugshot:              mugshot
-        link:                 link
-        locale:               locale
+        id:                   "id"
+        name:                 "name"                            
+        gender:               "gender"
+        admin:                "admin?"
+        guest:                "guest?"
+        mugshot:              "mugshot"
+        link:                 "link"
+        locale:               "locale"
         
   #############################################################################
   # Rules Engine Settings
@@ -130,33 +130,33 @@ defaults: &defaults
     decoration_token_classes: ["Tr8n::Tokens::DecorationToken"]
     allow_nil_token_values:   true
     numeric_rule:             
-      token_suffixes:         [count, num, age, hours, minutes, years, seconds]
-      object_method:          to_i
+      token_suffixes:         ["count", "num", "age", "hours", "minutes", "years", "seconds"]
+      object_method:          "to_i"
     gender_rule:  
-      token_suffixes:         [user, profile, actor, target, partner, parent, child, sibling, manager]
-      object_method:          gender
+      token_suffixes:         ["user", "profile", "actor", "target", "partner"]
+      object_method:          "gender"
       method_values:  
-        female:               female
-        male:                 male
-        neutral:              neutral
-        unknown:              unknown
+        female:               "female"
+        male:                 "male"
+        neutral:              "neutral"
+        unknown:              "unknown"
     list_rule:                # use list_rule if your site does not support user genders 
-      object_method:          size
-      token_suffixes:         [list]
+      object_method:          "size"
+      token_suffixes:         ["list"]
     gender_list_rule:         # similiar to list rule, but works together with gender rule 
-      object_method:          size
-      token_suffixes:         [list]
+      object_method:          "size"
+      token_suffixes:         ["list"]
     date_rule:                
-      token_suffixes:         [date]
-      object_method:          to_date
+      token_suffixes:         ["date"]
+      object_method:          "to_date"
     value_rule:               
       token_suffixes:         "*"
-      object_method:          to_s
+      object_method:          "to_s"
     
     # minimal rank makes the translation acceptable for subsitution and counts towards the translator rank
     translation_threshold:    1
     
-    viewing_user_token:       viewing_user
+    viewing_user_token:       "viewing_user"
     translation_rank_styles:  
       -1000..-5:              "color:red;font-weight:bold;"
       -4..-1:                 "color:red;"
@@ -168,7 +168,7 @@ defaults: &defaults
   #############################################################################
   api:  
     enabled:                  true
-    response_encoding:        json     # options: xml, json
+    response_encoding:        "json"     # options: xml, json
     allow_key_registration:   true
   
   #############################################################################

data/config/tr8n/tokens/data.yml

@@ -1,6 +1,6 @@
 #############################################################################
 #
-# Tr8n Data Tokens
+# Tr8n Default Data Tokens
 #
 #############################################################################
 

data/config/tr8n/tokens/decorations.yml

@@ -1,6 +1,6 @@
 #############################################################################
 #
-# Tr8n Default Gender Rules
+# Tr8n Default Decoration Tokens
 #
 #############################################################################
 
@@ -10,7 +10,7 @@ b:          "<strong>{$0}</strong>"
 em:         "<em>{$0}</em>"
 italic:     "<i>{$0}</i>"
 i:          "<i>{$0}</i>"
-link:       "<a href='{$1}' style='{$2}'>{$0}</a>" 
-link1:      "<a href='{$1}' style='{$2}'>{$0}</a>"
-link2:      "<a href='{$1}' style='{$2}'>{$0}</a>"
+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>"