tr8n 3.0.2

data/app/models/tr8n/language_rule.rb

@@ -0,0 +1,117 @@
+#--
+# 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::LanguageRule < ActiveRecord::Base
+  set_table_name :tr8n_language_rules
+  after_save      :clear_cache
+  after_destroy   :clear_cache
+
+  belongs_to :language, :class_name => "Tr8n::Language"   
+  belongs_to :translator, :class_name => "Tr8n::Translator"   
+  
+  serialize :definition
+
+  def definition
+    @indifferent_def ||= HashWithIndifferentAccess.new(super)
+  end
+
+  def self.by_id(rule_id)
+    Tr8n::Cache.fetch("language_rule_#{rule_id}") do 
+      find_by_id(rule_id)
+    end
+  end
+  
+  def self.for(language)
+    find(:all, :conditions => ["language_id = ?", language.id])
+  end
+  
+  def self.options
+    @options ||= Tr8n::Config.language_rule_classes.collect{|kls| [kls.dependency_label, kls.name]}
+  end
+
+  def self.suffixes
+    []  
+  end
+  
+  def self.dependant?(token)
+    token.dependency == dependency or suffixes.include?(token.suffix)
+  end
+
+  def self.dependency
+    raise Tr8n::Exception.new("This method must be implemented in the extending rule") 
+  end
+  
+  def self.dependency_label
+    dependency
+  end
+
+  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
+
+  def evaluate(token_value)
+    raise Tr8n::Exception.new("This method must be implemented in the extending rule") 
+  end
+  
+  def description
+    raise Tr8n::Exception.new("This method must be implemented in the extending rule") 
+  end
+  
+  def token_description
+    raise Tr8n::Exception.new("This method must be implemented in the extending rule") 
+  end
+  
+  def self.transformable?
+    true
+  end
+  
+  def save_with_log!(new_translator)
+    if self.id
+      if changed?
+        self.translator = new_translator
+        translator.updated_language_rule!(self)
+      end
+    else  
+      self.translator = new_translator
+      translator.added_language_rule!(self)
+    end
+
+    save  
+  end
+  
+  def destroy_with_log!(new_translator)
+    new_translator.deleted_language_rule!(self)
+    
+    destroy
+  end
+
+  def clear_cache
+    Tr8n::Cache.delete("language_rule_#{id}")
+  end
+
+end

data/app/models/tr8n/language_rule_filter.rb

@@ -0,0 +1,45 @@
+#--
+# 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::LanguageRuleFilter < Tr8n::BaseFilter
+  
+  def inner_joins
+    [["Tr8n::Language", :language_id], ["Tr8n::Translator", :translator_id]]
+  end
+
+  def definition
+    defs = super  
+    defs[:type][:is] = :list
+    defs[:type][:is_not] = :list
+    defs
+  end
+  
+  def value_options_for(criteria_key)
+    if criteria_key == :type
+      return Tr8n::Config.language_rule_classes.collect{|cls| cls.name.split('::').last}
+    end
+
+    return super
+  end
+
+end

data/app/models/tr8n/language_user.rb

@@ -0,0 +1,61 @@
+#--
+# 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::LanguageUser < ActiveRecord::Base
+  set_table_name :tr8n_language_users
+  
+  belongs_to :user, :class_name => Tr8n::Config.user_class_name, :foreign_key => :user_id
+  belongs_to :language, :class_name => "Tr8n::Language"
+  belongs_to :translator, :class_name => "Tr8n::Translator"
+  
+  # this object can belong to both the user and the translator
+  # users may choose to switch to a language without becoming translators
+  # once user becomes a translator, this record will be associated with both for ease of use
+  # when users get promoted, they are automatically get associated with a language and marked as translators
+  
+  def self.find_or_create(user, language)
+    lu = find(:first, :conditions => ["user_id = ? and language_id = ?", user.id, language.id])
+    lu || create(:user_id => user.id, :language_id => language.id)
+  end
+
+  def self.check_default_language_for(user)
+     find_or_create(user, Tr8n::Config.default_language)
+  end
+
+  def self.languages_for(user)
+    return [] unless user.id
+    check_default_language_for(user)
+    find(:all, :conditions => ["user_id = ?", user.id], :order => "updated_at desc")
+  end
+
+  def self.create_or_touch(user, language)
+    return unless user.id
+    lu = Tr8n::LanguageUser.find_or_create(user, language)
+    lu.update_attributes(:updated_at => Time.now)
+    lu
+  end
+  
+  def translator?
+    translator != nil
+  end
+end

data/app/models/tr8n/language_user_filter.rb

@@ -0,0 +1,34 @@
+#--
+# 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::LanguageUserFilter < Tr8n::BaseFilter
+
+  def inner_joins
+    [["Tr8n::Language", :language_id], ["Tr8n::Translator", :translator_id]]
+  end
+
+  def default_filter_if_empty
+    "created_today"
+  end
+
+end

data/app/models/tr8n/list_rule.rb

@@ -0,0 +1,118 @@
+#--
+# 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::ListRule < Tr8n::LanguageRule
+  
+  def self.description
+    "token object may be a list, which"
+  end
+  
+  def self.dependency
+    "list" 
+  end
+
+  def self.suffixes
+    Tr8n::Config.rules_engine[:list_rule][:token_suffixes]
+  end
+
+  def self.default_rules_for(language = Tr8n::Config.current_language)
+    Tr8n::Config.default_list_rules(language.locale)
+  end
+  
+  def self.operator_options
+    [["contains", "contains"]]
+  end
+
+  def self.list_options
+    [["one element", "one_element"], ["at least 2 elements", "at_least_two_elements"]]
+  end
+  
+  def self.list_size_token_value(token)
+    return nil unless token and token.respond_to?(Tr8n::Config.rules_engine[:list_rule][:object_method])
+    token.send(Tr8n::Config.rules_engine[:list_rule][:object_method])
+  end
+
+  def list_size_token_value(token)
+    self.class.list_size_token_value(token)
+  end
+
+  # params: [object, one element, at least two elements]
+  # {user_list | one element, at least two elements}
+  def self.transform(*args)
+    unless args.size == 3
+      raise Tr8n::Exception.new("Invalid transform arguments")
+    end
+    
+    object = args[0]
+    list_size = list_size_token_value(object)
+
+    unless list_size
+      raise Tr8n::Exception.new("Token #{object.class.name} does not respond to #{Tr8n::Config.rules_engine[:gender_list_rule][:object_method]}")
+    end
+    
+    list_size = list_size.to_i
+    
+    return args[1] if list_size == 1
+    return args[2] if list_size >= 2
+    
+    # should we raise an exception here if the list is empty?
+    ""  
+  end  
+  
+  # params: [one element, at least two elements]
+  def self.default_transform(*args)
+    unless args.size == 2
+      raise Tr8n::Exception.new("Invalid transform arguments for list token")
+    end
+    
+    args[1]
+  end  
+  
+  def evaluate(token)
+    return false unless token.kind_of?(Enumerable)
+    
+    list_size = list_size_token_value(token)
+    return false if list_size == nil
+    list_size = list_size.to_i
+
+    case definition[:value]
+      when "one_element" then
+        return true if list_size == 1
+      when "at_least_two_elements" then
+        return true if list_size >= 2
+    end
+    
+    false
+  end
+
+  def to_hash
+    {:type => self.class.dependency, :operator => definition[:operator], :value => definition[:value]}
+  end
+
+  # used to describe a context of a given translation
+  def description
+    return "contains one element"              if "one_element" == definition[:value]
+    return "contains at least two elements"    if "at_least_two_elements" == definition[:value]
+    "has an unknown rule"
+  end
+end

data/app/models/tr8n/monthly_language_metric.rb

@@ -0,0 +1,34 @@
+#--
+# 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::MonthlyLanguageMetric < Tr8n::LanguageMetric
+
+  def update_metrics!
+    attribs = default_attributes
+    attribs.each do |key, value|
+      attribs[key] = Tr8n::DailyLanguageMetric.sum(key, :conditions => ["language_id = ? and metric_date >= ? and metric_date < ?", language_id, metric_date, metric_date + 1.month])
+    end
+    update_attributes(attribs)
+  end
+  
+end

data/app/models/tr8n/numeric_rule.rb

@@ -0,0 +1,175 @@
+#--
+# 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::NumericRule < Tr8n::LanguageRule
+
+  def self.description
+    "token object may be a number, which"
+  end
+
+  def self.dependency
+    "number" 
+  end
+
+  def self.suffixes
+    Tr8n::Config.rules_engine[:numeric_rule][:token_suffixes]
+  end
+
+  def self.default_rules_for(language = Tr8n::Config.current_language)
+    Tr8n::Config.default_numeric_rules(language.locale)
+  end
+
+  def self.rule_options
+    [["is", "is"], ["is not", "is_not"], ["ends in", "ends_in"], ["does not end in", "does_not_end_in"]]
+  end
+  
+  def self.operator_options
+    ["and", "or"]
+  end
+
+  def self.number_token_value(token)
+    return nil unless token and token.respond_to?(Tr8n::Config.rules_engine[:numeric_rule][:object_method])
+    token.send(Tr8n::Config.rules_engine[:numeric_rule][:object_method])
+  end
+
+  def number_token_value(token)
+    self.class.number_token_value(token)
+  end
+
+  # FORM: [object, singular, plural]
+  # {count | message}
+  # {count | person, people}
+  def self.transform(*args)
+    unless [2, 3].include?(args.size)
+      raise Tr8n::Exception.new("Invalid transform arguments for number token")
+    end
+    
+    object = args[0]
+    object_value = number_token_value(object)
+    unless object_value
+      raise Tr8n::Exception.new("Token #{object.class.name} does not respond to #{Tr8n::Config.rules_engine[:numeric_rule][:object_method]}")
+    end
+    
+    if object_value == 1
+      return args[1]
+    elsif args.size == 2
+      return args[1].pluralize
+    end
+    
+    args[2]
+  end
+  
+  # params: [singular form, plural form]
+  def self.default_transform(*args)
+    unless [1, 2].include?(args.size)
+      raise Tr8n::Exception.new("Invalid transform arguments for number token")
+    end
+    
+    return args[1] if args.size == 2
+    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)
+    if name == :is
+      return true if values.include?(token_value)
+      return false
+    end
+    
+    if name == :is_not
+      return true unless values.include?(token_value)
+      return false
+    end
+
+    if name == :ends_in
+      values.each do |value|
+        return true if token_value.to_s =~ /#{value.to_s}$/  
+      end
+      return false
+    end
+
+    if name == :does_not_end_in
+      values.each do |value|
+        return false if token_value.to_s =~ /#{value.to_s}$/  
+      end
+      return true
+    end
+    
+    false
+  end
+
+  def to_hash
+    { :type => self.class.dependency, 
+      :multipart => definition[:multipart], :operator => definition[:operator],  
+      :part1 => definition[:part1], :value1 => definition[:value1],
+      :part2 => definition[:part2], :value2 => definition[:value2]
+    }
+  end
+
+
+  # used to describe a context of a given translation
+  def description
+    rule_desc = describe_partial_rule(definition[:part1].to_sym, definition[:value1])
+    return rule_desc unless definition[:multipart].to_s == "true"
+    
+    rule_desc << " " << definition[:operator] << " " 
+    rule_desc << describe_partial_rule(definition[:part2].to_sym, definition[:value2])
+    humanize_description(rule_desc)   
+  end
+  
+  def describe_partial_rule(name, value)
+    return "is #{humanize_values(value)}" if name == :is
+    return "is not #{humanize_values(value)}" if name == :is_not
+    return "ends in #{humanize_values(value)}" if name == :ends_in
+    return "does not end in #{humanize_values(value)}" if name == :does_not_end_in
+
+    "has an unknown rule"
+  end
+  
+  def humanize_description(desc)
+    desc.gsub(" and does not end in", ", but not in")
+  end
+  
+end