tr8n 3.1.8 → 3.2.0

data/app/models/tr8n/language_case.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_case_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_case_rule.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_case_rule_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_case_value_map.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_case_value_map_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_forum_abuse_report.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_forum_abuse_report_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_forum_message.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_forum_message_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_forum_topic.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_forum_topic_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_metric.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_metric_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_rule.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_rule_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_user.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/language_user_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/list_rule.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/monthly_language_metric.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/numeric_rule.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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
@@ -52,8 +52,13 @@ class Tr8n::NumericRule < Tr8n::LanguageRule
     token.send(Tr8n::Config.rules_engine[:numeric_rule][:object_method])
   end
 
-  def number_token_value(token)
-    self.class.number_token_value(token)
+  def self.sanitize_values(values)
+    return [] unless values
+    values.split(",").collect{|val| val.strip} 
+  end
+
+  def self.humanize_values(values)
+    sanitize_values(values).join(", ")
   end
 
   # FORM: [object, singular, plural]
@@ -89,30 +94,7 @@ class Tr8n::NumericRule < Tr8n::LanguageRule
     args[0].pluralize
   end  
   
-  def evaluate(token)
-    token_value = number_token_value(token)  
-    return false unless token_value
-    
-    result1 = evaluate_partial_rule(token_value.to_s, definition[:part1].to_sym, sanitize_values(definition[:value1]))
-    return result1 unless definition[:multipart].to_s == "true"
-    
-    result2 = evaluate_partial_rule(token_value.to_s, definition[:part2].to_sym, sanitize_values(definition[:value2]))
-    return (result1 or result2) if definition[:operator] == "or"
-    return (result1 and result2)
-    
-    false
-  end
-
-  def sanitize_values(values)
-    return [] unless values
-    values.split(",").collect{|val| val.strip} 
-  end
-
-  def humanize_values(values)
-    sanitize_values(values).join(", ")
-  end
-
-  def evaluate_partial_rule(token_value, name, values)
+  def self.evaluate_rule_fragment(token_value, name, values)
     if name == :is
       return true if values.include?(token_value)
       return false
@@ -140,6 +122,32 @@ class Tr8n::NumericRule < Tr8n::LanguageRule
     false
   end
 
+  def evaluate(token)
+    token_value = number_token_value(token)  
+    return false unless token_value
+    
+    result1 = self.class.evaluate_rule_fragment(token_value.to_s, definition[:part1].to_sym, sanitize_values(definition[:value1]))
+    return result1 unless definition[:multipart].to_s == "true"
+    
+    result2 = self.class.evaluate_rule_fragment(token_value.to_s, definition[:part2].to_sym, sanitize_values(definition[:value2]))
+    return (result1 or result2) if definition[:operator] == "or"
+    return (result1 and result2)
+    
+    false
+  end
+
+  def number_token_value(token)
+    self.class.number_token_value(token)
+  end
+
+  def sanitize_values(values)
+    self.class.sanitize_values(values)
+  end
+
+  def humanize_values(values)
+    self.class.humanize_values(values)
+  end
+
   def to_hash
     { :type => self.class.dependency, 
       :multipart => definition[:multipart], :operator => definition[:operator],  
@@ -148,7 +156,6 @@ class Tr8n::NumericRule < Tr8n::LanguageRule
     }
   end
 
-
   # used to describe a context of a given translation
   def description
     rule_desc = describe_partial_rule(definition[:part1].to_sym, definition[:value1])

data/app/models/tr8n/sync_log.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/sync_log_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/total_language_metric.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/translation.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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
@@ -307,7 +307,8 @@ class Tr8n::Translation < ActiveRecord::Base
     results = self.where("language_id = ?", language.id)
     
     # ensure that only allowed translations are visible
-    results = results.where("translation_key_id in (select id from tr8n_translation_keys where level <= ?)", Tr8n::Config.current_translator.level) 
+    allowed_level = Tr8n::Config.current_user_is_translator? ? Tr8n::Config.current_translator.level : 0
+    results = results.where("translation_key_id in (select id from tr8n_translation_keys where level <= ?)", allowed_level) 
     
     results = results.where("label like ?", "%#{params[:search]}%") unless params[:search].blank?
   
@@ -320,7 +321,7 @@ class Tr8n::Translation < ActiveRecord::Base
     end
     
     if params[:submitted_by] == "me"
-      results = results.where("translator_id = ?", Tr8n::Config.current_translator.id)
+      results = results.where("translator_id = ?", Tr8n::Config.current_user_is_translator? ? Tr8n::Config.current_translator.id : 0)
     end
     
     if params[:submitted_on] == "today"

data/app/models/tr8n/translation_domain.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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
@@ -34,15 +34,23 @@ class Tr8n::TranslationDomain < ActiveRecord::Base
   alias :key_sources  :translation_key_sources
   alias :keys         :translation_keys
   
+  def self.cache_key(domain_name)
+    "translation_domain_#{domain_name}"
+  end
+
+  def cache_key
+    self.class.cache_key(name)
+  end
+  
   def self.find_or_create(url = nil)
     domain_name = URI.parse(url || 'localhost').host || 'localhost'
-    Tr8n::Cache.fetch("translation_domain_#{domain_name}") do 
+    Tr8n::Cache.fetch(cache_key(domain_name)) do 
       find_by_name(domain_name) || create(:name => domain_name)
     end  
   end
   
   def clear_cache
-    Tr8n::Cache.delete("translation_domain_#{name}")
+    Tr8n::Cache.delete(cache_key)
   end
   
 end

data/app/models/tr8n/translation_domain_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/translation_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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/app/models/tr8n/translation_key.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
+# 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
@@ -41,10 +41,19 @@ class Tr8n::TranslationKey < ActiveRecord::Base
   alias :domains      :translation_domains
   alias :comments     :translation_key_comments
   
+
+  def self.cache_key(key_hash)
+    "translation_key_#{key_hash}"
+  end
+
+  def cache_key
+    self.class.cache_key(key)
+  end
+
   def self.find_or_create(label, desc = "", options = {})
     key = generate_key(label, desc).to_s
     
-    tkey = Tr8n::Cache.fetch("translation_key_#{key}") do 
+    tkey = Tr8n::Cache.fetch(cache_key(key)) do 
       existing_key = where(:key => key).first
       
       unless existing_key
@@ -61,31 +70,23 @@ class Tr8n::TranslationKey < ActiveRecord::Base
       end
       locale = options[:locale] || Tr8n::Config.block_options[:default_locale] || Tr8n::Config.default_locale
       
-      existing_key ||= begin
-        new_tkey = create(:key => key.to_s, 
-                          :label => label, 
-                          :description => desc, 
-                          :locale => locale,
-                          :level => level,
-                          :admin => Tr8n::Config.block_options[:admin])
-
-        unless options[:source].blank?
-          # at the time of creation - mark the first source of the key
-          Tr8n::TranslationKeySource.find_or_create(new_tkey, Tr8n::TranslationSource.find_or_create(options[:source], options[:url]))
-        end  
-        new_tkey
-      end  
+      existing_key ||= create(:key => key.to_s, 
+                              :label => label, 
+                              :description => desc, 
+                              :locale => locale,
+                              :level => level,
+                              :admin => Tr8n::Config.block_options[:admin])
 
       # for backwards compatibility only
       mark_as_admin(existing_key, options)
       update_default_locale(existing_key, options)
       
       # mark each key as verified - but only if caching is enabled
+      # verification is used to cleanup unused keys
       existing_key.update_attributes(:verified_at => Time.now) if Tr8n::Config.enable_caching?
       existing_key
     end
     
-    # for detailed tracking of all sources and caller stack - only needed for debugging - expensive
     track_source(tkey, options)  
     tkey  
   end
@@ -106,20 +107,31 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     tkey.update_attributes(:locale => key_locale)
   end
 
-  # used to create associations between the translation keys and source
-  # primarely used for the site map and only needs to be enabled 
-  # for a short period of time on a single machine
-  def self.track_source(tkey, options)
-    # return unless Tr8n::Config.enable_key_source_tracking? 
-    # return if options[:source].blank?
+  # creates associations between the translation keys and sources
+  # used for the site map and javascript support
+  def self.track_source(translation_key, options)
 
-    key_source = Tr8n::Cache.cache_key_source(tkey, options[:source] || Tr8n::Config.block_options[:source])
-    
-    return unless Tr8n::Config.enable_key_caller_tracking?
+    # key source tracking or client sdk must be enabled for this to work
+    return unless Tr8n::Config.enable_key_source_tracking? or Tr8n::Config.enable_client_sdk?
+
+    # source can be passed into an individual key, or as a block or fall back on the controller/action
+    source = options[:source] || Tr8n::Config.block_options[:source] || Tr8n::Config.current_source
+
+    # should never be blank
+    return if source.blank?
+
+    # each page or component is identified by a translation source
+    translation_source = Tr8n::TranslationSource.find_or_create(source, options[:url])
+
+    # each key is associated with one or more sources
+    translation_key_source = Tr8n::TranslationKeySource.find_or_create(translation_key, translation_source)
+
+    # for debugging purposes only - this will track the actual location of the key in the source
+    return unless Tr8n::Config.enable_key_caller_tracking?    
     options[:caller] ||= caller
     options[:caller_key] = options[:caller].is_a?(Array) ? options[:caller].join(", ") : options[:caller].to_s
     options[:caller_key] = generate_key(options[:caller_key])
-    key_source.update_details!(options)
+    translation_key_source.update_details!(options)
   end
   
   def self.generate_key(label, desc = "")
@@ -130,7 +142,7 @@ class Tr8n::TranslationKey < ActiveRecord::Base
 
   def reset_key!
     # remove old key from cache
-    Tr8n::Cache.delete("translation_key_#{key}")
+    Tr8n::Cache.delete(cache_key)
     self.update_attributes(:key => self.class.generate_key(label, description))
   end
   
@@ -213,11 +225,14 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     not locked?(language)
   end
 
-  def followed?(translator = Tr8n::Config.current_translator)
+  def followed?(translator = nil)
+    translator ||= (Tr8n::Config.current_user_is_translator? ? Tr8n::Config.current_translator : nil)
+    return false unless translator
     Tr8n::TranslatorFollowing.following_for(translator, self)
   end
     
   def add_translation(label, rules = nil, language = Tr8n::Config.current_language, translator = Tr8n::Config.current_translator)
+    raise Tr8n::Exception.new("The translator is blocked and cannot submit translations") if translator.blocked?
     raise Tr8n::Exception.new("The sentence contains dirty words") unless language.clean_sentence?(label)
     translation = Tr8n::Translation.create(:translation_key => self, :language => language, :translator => translator, :label => label, :rules => rules)
     translation.vote!(translator, 1)
@@ -441,7 +456,7 @@ class Tr8n::TranslationKey < ActiveRecord::Base
   def default_decoration(language = Tr8n::Config.current_language, options = {})
     return label if Tr8n::Config.current_user_is_guest?
     return label unless Tr8n::Config.current_user_is_translator?
-    return label unless translator_permitted_to_translate?
+    return label unless can_be_translated?
     return label if locked?(language)
 
     classes = ['tr8n_translatable']
@@ -463,8 +478,23 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     super
   end
   
-  def translator_permitted_to_translate?(translator = Tr8n::Config.current_translator)
-    translator.level >= level
+  def can_be_translated?(translator = nil)
+    return false if locked?
+    translator ||= (Tr8n::Config.current_user_is_translator? ? Tr8n::Config.current_translator : nil)
+    translator_level = translator ? translator.level : 0
+    translator_level >= level
+  end
+
+  def can_be_locked?(translator = nil)
+    translator ||= (Tr8n::Config.current_user_is_translator? ? Tr8n::Config.current_translator : nil)
+    return false unless translator
+    translator.admin? or translator.manager?
+  end
+
+  def can_be_unlocked?(translator = nil)
+    translator ||= (Tr8n::Config.current_user_is_translator? ? Tr8n::Config.current_translator : nil)
+    return false unless translator
+    translator.admin? or translator.manager?
   end
   
   def decorate_translation(language, translated_label, translated = true, options = {})
@@ -472,7 +502,7 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     return translated_label if Tr8n::Config.current_user_is_guest?
     return translated_label unless Tr8n::Config.current_user_is_translator?
     return translated_label unless Tr8n::Config.current_translator.enable_inline_translations?
-    return translated_label unless translator_permitted_to_translate?
+    return translated_label unless can_be_translated?
     return translated_label if locked?(language)
     return translated_label if self.language == language
 
@@ -522,8 +552,15 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     end
   end
   
+  def touch_sources
+    sources.each do |source|
+      source.touch
+    end
+  end
+
   def clear_cache
-    Tr8n::Cache.delete("translation_key_#{key}")
+    Tr8n::Cache.delete(cache_key)
+    touch_sources
   end
 
   ###############################################################
@@ -643,7 +680,7 @@ class Tr8n::TranslationKey < ActiveRecord::Base
   end
   
   def self.for_params(params)
-    results = self.where("tr8n_translation_keys.locale <> ? and (level is null or level <= ?)", Tr8n::Config.current_language.locale, Tr8n::Config.current_translator.level)
+    results = self.where("tr8n_translation_keys.locale <> ? and (level is null or level <= ?)", Tr8n::Config.current_language.locale, Tr8n::Config.current_user_is_translator? ? Tr8n::Config.current_translator.level : 0)
     
     if Tr8n::Config.enable_caching?
       results = results.where("verified_at is not null")
@@ -669,7 +706,7 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     elsif params[:phrase_type] == "without"
       results = results.where("tr8n_translation_keys.id not in (select tr8n_translations.translation_key_id from tr8n_translations where tr8n_translations.language_id = ?)", Tr8n::Config.current_language.id)
       
-    elsif params[:phrase_type] == "followed"
+    elsif params[:phrase_type] == "followed" and Tr8n::Config.current_user_is_translator?
       results = results.where("tr8n_translation_keys.id in (select tr8n_translator_following.object_id from tr8n_translator_following where tr8n_translator_following.translator_id = ? and tr8n_translator_following.object_type = ?)", Tr8n::Config.current_translator.id, 'Tr8n::TranslationKey')
     end