tr8n 3.0.2

data/app/models/tr8n/language_case.rb

@@ -0,0 +1,141 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich
+#
+# 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::LanguageCase < ActiveRecord::Base
+  set_table_name :tr8n_language_cases
+  after_save :clear_cache
+  after_destroy :clear_cache
+
+  belongs_to :language, :class_name => "Tr8n::Language"   
+  belongs_to :translator, :class_name => "Tr8n::Translator"   
+  has_many   :language_case_rules, :class_name => "Tr8n::LanguageCaseRule", :order => 'position asc', :dependent => :destroy
+  
+  serialize :definition
+  
+  def self.by_id(case_id)
+    Tr8n::Cache.fetch("language_case_#{case_id}") do 
+      find_by_id(case_id)
+    end
+  end
+  
+  def self.by_language(language)
+    find(:all, :conditions => ["language_id = ?", language.id])
+  end
+
+  def rules
+    return language_case_rules if id.blank?
+    
+    Tr8n::Cache.fetch("language_case_rules_#{id}") do 
+      language_case_rules
+    end
+  end
+
+  def save_with_log!(new_translator)
+    if self.id
+      if changed?
+        self.translator = new_translator
+        translator.updated_language_case!(self)
+      end
+    else  
+      self.translator = new_translator
+      translator.added_language_case!(self)
+    end
+
+    save  
+  end
+  
+  def destroy_with_log!(new_translator)
+    new_translator.deleted_language_case!(self)
+    
+    destroy
+  end
+
+  def apply(object, value, options)
+    html_tag_expression = /<\/?[^>]*>/
+    html_tokens = value.scan(html_tag_expression).uniq
+    sanitized_value = value.gsub(html_tag_expression, "")
+    
+    if application == 'phrase'
+      words = [sanitized_value]
+    else  
+      words = sanitized_value.split(" ").uniq
+    end
+    
+    # replace html tokens with temporary placeholders
+    html_tokens.each_with_index do |html_token, index|
+      value = value.gsub(html_token, "{$#{index}}")
+    end
+    
+#    pp words
+    words.each do |word|
+      lcvm = Tr8n::LanguageCaseValueMap.by_language_and_keyword(language, word)
+      
+      if lcvm
+        # first see if there is an exception for the value
+        map_case_value = lcvm.value_for(object, keyword)
+        case_value = map_case_value unless map_case_value.blank?
+      else
+        # try evaluating the rules
+        case_rule = evaluate_rules(object, word)
+#        pp case_rule, word
+        case_value = case_rule.apply(word) if case_rule  
+      end
+
+      value = value.gsub(word, decorate_language_case(word, case_value || word, case_rule, options))
+    end
+    
+    # replace back the temporary placeholders with the html tokens  
+    html_tokens.each_with_index do |html_token, index|
+      value = value.gsub("{$#{index}}", html_token)
+    end
+     
+    value
+  end
+
+  def evaluate_rules(object, value)
+    rules.each do |rule|
+      return rule if rule.evaluate(object, value)
+    end
+    nil
+  end
+
+  def decorate_language_case(case_map_key, case_value, case_rule, options = {})
+    return case_value if options[:skip_decorations]
+    return case_value if language.default?
+    return case_value if Tr8n::Config.current_user_is_guest?
+    return case_value unless Tr8n::Config.current_user_is_translator?
+    return case_value unless Tr8n::Config.current_translator.enable_inline_translations?
+    
+    "<span class='tr8n_language_case' case_id='#{id}' rule_id='#{case_rule ? case_rule.id : ''}' case_key='#{case_map_key.gsub("'", "\'")}'>#{case_value}</span>"
+  end
+
+  def self.application_options
+    [["every word", "words"], ["entire phrase", "phrase"]]
+  end
+
+  def clear_cache
+    Tr8n::Cache.delete("language_case_#{id}")
+    Tr8n::Cache.delete("language_case_rules_#{id}") 
+  end
+
+end

data/app/models/tr8n/language_case_filter.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich
+#
+# 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::LanguageCaseFilter < Tr8n::BaseFilter
+
+  def inner_joins
+    [["Tr8n::Language", :language_id], ["Tr8n::Translator", :translator_id]]
+  end
+
+end

data/app/models/tr8n/language_case_rule.rb

@@ -0,0 +1,187 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich
+#
+# 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::LanguageCaseRule < ActiveRecord::Base
+  set_table_name :tr8n_language_case_rules
+
+  belongs_to :language_case,  :class_name => "Tr8n::LanguageCase"   
+  belongs_to :language,       :class_name => "Tr8n::Language"   
+  belongs_to :translator,     :class_name => "Tr8n::Translator"   
+  
+  serialize :definition
+  
+  def self.by_id(id)
+    Tr8n::Cache.fetch("language_case_rule_#{id}") do 
+      find_by_id(id)
+    end
+  end
+  
+  def self.gender_options
+    [["not applicable", "none"], ["unknown", "unknown"], ["male", "male"], ["female", "female"]]
+  end
+  
+  def self.condition_options(with_if = false)
+    opts = [["starts with", "starts_with"], ["does not start with", "does_not_start_with"], 
+     ["ends in", "ends_in"], ["does not end in", "does_not_end_in"],
+     ["is", "is"], ["is not", "is_not"]]
+    return opts unless with_if
+    opts.each do |opt|
+      opt[0] = "if #{opt[0]}"
+    end
+    opts
+  end
+
+  def self.operation_options
+    [["replace with", "replace"], ["prepand", "prepand"], ["append", "append"]]
+  end
+
+  def self.operator_options
+    [["and", "and"], ["or", "or"]]
+  end
+
+  def evaluate(object, value)
+    if definition["gender"] != "none"
+      object_gender = Tr8n::GenderRule.gender_token_value(object)
+      return false if definition["gender"] == "male"    and object_gender != Tr8n::GenderRule.gender_object_value_for("male")
+      return false if definition["gender"] == "female"  and object_gender != Tr8n::GenderRule.gender_object_value_for("female")
+      return false if definition["gender"] == "unknown" and object_gender != Tr8n::GenderRule.gender_object_value_for("unknown")
+    end    
+  
+    result1 = evaluate_part(value, 1)
+    if definition["multipart"] == "true"
+      result2 = evaluate_part(value, 2)
+      return false if definition["operator"] == "and" and !(result1 and result2)
+      return false if definition["operator"] == "or"  and !(result1 or result2)
+    end  
+    
+    return result1
+  end
+  
+  def evaluate_part(token_value, index)
+    values = sanitize_values(definition["value#{index}"])
+    
+    case definition["part#{index}"]
+      when "starts_with" 
+        values.each do |value|
+          return true if token_value.to_s =~ /^#{value.to_s}/  
+        end
+        return false
+      when "does_not_start_with"         
+        values.each do |value|
+          return false if token_value.to_s =~ /^#{value.to_s}/  
+        end
+        return true
+      when "ends_in"
+        values.each do |value|
+          return true if token_value.to_s =~ /#{value.to_s}$/  
+        end
+        return false
+      when "does_not_end_in"         
+        values.each do |value|
+          return false if token_value.to_s =~ /#{value.to_s}$/  
+        end
+        return true
+      when "is"         
+        return values.include?(token_value)
+      when "is_not"        
+        return !values.include?(token_value)
+    end
+    
+    false
+  end
+  
+  def apply(value)
+    values = sanitize_values(definition["value1"])
+    regex = values.join('|')
+    case definition["operation"]
+      when "replace" 
+        if definition["part1"] == "starts_with"
+          return value.gsub(/\b(#{regex})/, definition["operation_value"])
+        elsif definition["part1"] == "is"
+          return definition["operation_value"]
+        elsif definition["part1"] == "ends_in"
+          return value.gsub(/(#{regex})\b/, definition["operation_value"])
+        end
+      when "prepand" 
+        return "#{definition["operation_value"]}#{value}"
+      when "append"        
+        return "#{value}#{definition["operation_value"]}"
+    end
+    
+    value
+  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 description
+    return "undefined rule" if definition.blank?
+    
+    desc = "If"
+    if definition["gender"] != "none"
+      desc << " subject"
+      if ["male", "female"].include?(definition["gender"])
+        desc << " is a <strong>#{definition["gender"]}</strong>"
+      else  
+        desc << " <strong>has an unknown gender</strong>"
+      end
+    end
+    desc << " and" unless desc == "If"
+    desc << " token value"
+    desc << describe_part(1)
+  
+    if definition["multipart"] == "true"
+      desc << " " << definition["operator"]
+      desc << describe_part(2)
+    end
+    
+    desc << ", then"
+    case definition["operation"]
+      when "replace" then desc << " replace it with"
+      when "prepand" then desc << " prepand the value with"        
+      when "append" then desc << " append the value with"        
+    end
+    desc << " <strong>'" << humanize_values(definition["operation_value"]) << "'</strong> "
+    desc.html_safe
+  end
+  
+  def describe_part(index)
+    desc = ""
+    case definition["part#{index}"]
+      when "starts_with" then desc << " starts with"
+      when "does_not_start_with" then desc << " does not start with"        
+      when "ends_in" then desc << " ends in"        
+      when "does_not_end_in" then desc << " does not end in"        
+      when "is" then desc << " is"        
+      when "is_not" then desc << " is not"        
+    end
+    desc << " <strong>'" << humanize_values(definition["value#{index}"]) << "'</strong>"
+  end
+  
+end

data/app/models/tr8n/language_case_rule_filter.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich
+#
+# 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::LanguageCaseRuleFilter < Tr8n::BaseFilter
+
+  def inner_joins
+    [["Tr8n::Language", :language_id], ["Tr8n::Translator", :translator_id]]
+  end
+
+end

data/app/models/tr8n/language_case_value_map.rb

@@ -0,0 +1,100 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich
+#
+# 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::LanguageCaseValueMap < ActiveRecord::Base
+  set_table_name :tr8n_language_case_value_maps
+  after_save :clear_cache
+  after_destroy :clear_cache
+  
+  belongs_to :language, :class_name => "Tr8n::Language"   
+  belongs_to :translator, :class_name => "Tr8n::Translator"   
+  
+  serialize :map
+  
+  def self.by_language_and_keyword(language, keyword)
+    Tr8n::Cache.fetch("language_case_value_map_#{language.id}_#{keyword}") do 
+      find_by_language_id_and_keyword_and_reported(language.id, keyword, false)
+    end
+  end
+  
+  # add a better way to determine the gender dependency
+  def gender_based?
+    return false unless map
+    map.each do |key, value|
+      return true if value.is_a?(Hash) 
+    end
+    false
+  end
+  
+  def value_for(object, case_key)
+    return unless map
+    
+    # male female definition
+    if map[case_key].is_a?(Hash)
+      object_gender = Tr8n::GenderRule.gender_token_value(object)
+      if object_gender == Tr8n::GenderRule.gender_object_value_for("female")
+        return map[case_key]['female']
+      end
+      return map[case_key]['male']
+    end
+    
+    map[case_key] 
+  end
+
+  def implied_value_for(case_key)
+    return unless map
+    return gender_value_for(case_key, "male") if map[case_key].is_a?(Hash)   
+    map[case_key]
+  end
+  
+  def gender_value_for(case_key, gender)
+    return unless map
+    return map[case_key] unless map[case_key].is_a?(Hash)
+    map[case_key][gender]
+  end
+  
+  def save_with_log!(new_translator)
+#    new_translator.updated_language_case_values!(self)
+
+    self.translator = new_translator
+    save  
+  end
+  
+  def destroy_with_log!(new_translator)
+#    new_translator.deleted_language_case_values!(self)
+    
+    destroy
+  end
+
+  def report_with_log!(new_translator)
+    # new_translator.reported_language_case_values!(self)
+
+    update_attributes(:reported => true)
+    self.translator.update_attributes(:reported => true) 
+  end
+
+  def clear_cache
+    Tr8n::Cache.delete("language_case_value_map_#{language.id}_#{keyword}")
+  end
+
+end