tr8n 3.0.2

data/app/models/tr8n/integration/ru/russian_gender_list_rule.rb

@@ -0,0 +1,60 @@
+#--
+# 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::RussianGenderListRule < Tr8n::GenderListRule
+
+  # params: [object, one element male, one element female, one element unknown, at least two elements]
+  # {user_list | one element male, one element female, one element unknown, at least two elements}
+
+  # TODO: finish implementation
+  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  
+
+end

data/app/models/tr8n/integration/ru/russian_numeric_rule.rb

@@ -0,0 +1,64 @@
+#--
+# 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.
+#++
+
+# This is an example of how you could implement the transform 
+# function for the default transform_tokens 
+# if your default site language is Russian
+
+class Tr8n::RussianNumericRule < Tr8n::NumericRule
+
+  # FORM: [object, (ends in 1, but not in 11), (ends in 2, 3, 4 and is not 12, 13, 14), (ends in 0, 5, 6, 7, 8, 9, 11, 12, 13, 14)]
+  # {count | собака, собаки, собак}
+  # {count | сообщение, сообщения, сообщений}
+  def self.transform(*args)
+    if args.size != 4
+      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
+
+    string_value = object_value.to_s
+
+    if string_value.last == "1" and string_value != "11"
+      return args[1]
+    elsif ['2', '3', '4'].include?(string_value.last) and not ['12', '13', '14'].include?(string_value)
+      return args[2]
+    end
+    
+    args[3]
+  end
+  
+  # params: [singular form, plural form1, plural form2]
+  def self.default_transform(*args)
+    if args.size != 3
+      raise Tr8n::Exception.new("Invalid transform arguments for number token")
+    end
+    
+    args[2]
+  end  
+  
+end

data/app/models/tr8n/ip_location.rb

@@ -0,0 +1,74 @@
+#--
+# 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::IpLocation < ActiveRecord::Base
+  set_table_name :tr8n_ip_locations
+
+  def self.no_country_clause
+    %q{COALESCE(country, 'ZZZ') = 'ZZZ'}
+  end
+
+  def self.find_by_ip(ip)
+    ip = case ip
+      when String
+        Tr8n::IpAddress.new(ip).to_i
+      else
+        ip.to_i
+    end
+    first(:conditions => ['low <= ? AND ? <= high', ip, ip]) || new.freeze
+  rescue ArgumentError
+    puts "Invalid ip: #{ip}" unless Rails.env.test?
+    new.freeze
+  end
+
+  def blank?
+    new_record? || 'ZZZ' == cntry
+  end
+
+  def self.import_from_file(file, opts=nil)
+    opts ||= {:verbose => false}
+    puts "Deleting old records..." if opts[:verbose]
+    delete_all
+    puts "Done." if opts[:verbose]
+
+    puts "Importing new records..." if opts[:verbose]
+    file = File.open(file) if file.is_a?(String)
+    file.each_line do |line|
+      next if line =~ /^\s*\#|^\s*$/
+      line.chomp!.tr!('"\'','')
+      values = line.split(',')
+      create!(
+        :low      =>  values[0],
+        :high     =>  values[1],
+        :registry =>  values[2],
+        :assigned =>  Time.at(values[3].to_i),
+        :ctry     =>  values[4],
+        :cntry    =>  values[5],
+        :country  =>  Iconv.conv('UTF-8', 'ISO_8859-1', values[6])
+      )
+      $stdout << '.' if opts[:verbose]
+    end
+    puts "Done." if opts[:verbose]
+  end
+  
+end

data/app/models/tr8n/ip_location_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::IpLocationFilter < Tr8n::BaseFilter
+
+  def default_order
+    'country'
+  end
+
+  def default_order_type
+    'asc'
+  end
+
+end

data/app/models/tr8n/language.rb

@@ -0,0 +1,318 @@
+#--
+# 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::Language < ActiveRecord::Base
+  set_table_name :tr8n_languages
+  after_save      :clear_cache
+  after_destroy   :clear_cache
+
+  belongs_to :fallback_language,    :class_name => 'Tr8n::Language', :foreign_key => :fallback_language_id
+  
+  has_many :language_rules,         :class_name => 'Tr8n::LanguageRule',        :dependent => :destroy, :order => "type asc"
+  has_many :language_cases,         :class_name => 'Tr8n::LanguageCase',        :dependent => :destroy, :order => "id asc"
+  has_many :language_users,         :class_name => 'Tr8n::LanguageUser',        :dependent => :destroy
+  has_many :translations,           :class_name => 'Tr8n::Translation',         :dependent => :destroy
+  has_many :translation_key_locks,  :class_name => 'Tr8n::TranslationKeyLock',  :dependent => :destroy
+  has_many :language_metrics,       :class_name => 'Tr8n::LanguageMetric'
+  
+  def self.find_or_create(lcl, english_name)
+    find_by_locale(lcl) || create(:locale => lcl, :english_name => english_name) 
+  end
+  
+  def self.for(locale)
+    return nil if locale.nil?
+    Tr8n::Cache.fetch("language_#{locale}") do 
+      find_by_locale(locale)
+    end
+  end
+
+  def rules
+    Tr8n::Cache.fetch("language_rules_#{id}") do 
+      language_rules
+    end
+  end
+
+  def cases
+    Tr8n::Cache.fetch("language_cases_#{id}") do 
+      language_cases
+    end
+  end
+
+  def reset!
+    reset_language_rules!
+    reset_language_cases!
+  end
+  
+  def reset_language_rules!
+    rules.delete_all
+    Tr8n::Config.language_rule_classes.each do |rule_class|
+      rule_class.default_rules_for(self).each do |definition|
+        rule_class.create(:language => self, :definition => definition)
+      end
+    end
+  end
+  
+  def reset_language_cases!
+    cases.delete_all
+    Tr8n::Config.default_cases_for(locale).each do |lcase|
+# need to fix default lcase rules      
+#      Tr8n::LanguageCase.create(lcase.merge(:language => self))
+    end
+  end
+  
+  def current?
+    self.locale == Tr8n::Config.current_language.locale
+  end
+  
+  def default?
+    self.locale == Tr8n::Config.default_locale
+  end
+  
+  def flag
+    locale
+  end
+  
+  # deprecated
+  def has_rules?
+    rules?
+  end
+
+  def rules?
+    not rules.empty?
+  end
+  
+  def gender_rules?
+    return false unless rules?
+    
+    rules.each do |rule|
+      return true if rule.class.dependency == 'gender'
+    end
+    false
+  end
+
+  def cases?
+    not cases.empty?
+  end
+
+  def case_keyword_maps
+    @case_keyword_maps ||= begin
+      hash = {} 
+      cases.each do |lcase| 
+        hash[lcase.keyword] = lcase
+      end
+      hash
+    end
+  end
+  
+  def suggestible?
+    not google_key.blank?
+  end
+  
+  def case_for(case_keyword)
+    case_keyword_maps[case_keyword]
+  end
+  
+  def valid_case?(case_keyword)
+    case_for(case_keyword) != nil
+  end
+  
+  def full_name
+    return english_name if english_name == native_name
+    "#{english_name} - #{native_name}"
+  end
+
+  def self.options
+    enabled_languages.collect{|lang| [lang.english_name, lang.id.to_s]}
+  end
+  
+  def self.locale_options
+    enabled_languages.collect{|lang| [lang.english_name, lang.locale]}
+  end
+
+  def self.filter_options
+    find(:all, :order => "english_name asc").collect{|lang| [lang.english_name, lang.id.to_s]}
+  end
+  
+  def enable!
+    self.enabled = true
+    save
+  end
+
+  def disable!
+    self.enabled = false
+    save
+  end
+  
+  def disabled?
+    not enabled?
+  end
+  
+  def dir
+    right_to_left? ? "rtl" : "ltr"
+  end
+  
+  def self.enabled_languages
+    Tr8n::Cache.fetch("enabled_languages") do 
+      find(:all, :conditions => ["enabled = ?", true], :order => "english_name asc")
+    end
+  end
+
+  def self.featured_languages
+    Tr8n::Cache.fetch("featured_languages") do 
+      find(:all, :conditions => ["enabled = ? and featured_index is not null and featured_index > 0", true], :order => "featured_index desc")
+    end
+  end
+
+  def self.translate(label, desc = "", tokens = {}, options = {})
+    # raise Tr8n::Exception.new("The label is blank") if label.blank?
+    raise Tr8n::Exception.new("The label is being translated twice") if label.tr8n_translated?
+
+    return Tr8n::TranslationKey.substitute_tokens(label, tokens, options).tr8n_translated unless Tr8n::Config.enabled?
+    return Tr8n::TranslationKey.substitute_tokens(label, tokens, options).tr8n_translated if Tr8n::Config.current_language.default?
+
+    options.delete(:source) unless Tr8n::Config.enable_key_source_tracking?
+    Tr8n::Config.current_language.translate(label, desc, tokens, options).tr8n_translated
+  end
+
+  def translate(label, desc = "", tokens = {}, options = {})
+    # raise Tr8n::Exception.new("The label is blank") if label.blank?
+    raise Tr8n::Exception.new("The label is being translated twice") if label.tr8n_translated?
+
+    return Tr8n::TranslationKey.substitute_tokens(label, tokens, options, self).tr8n_translated unless Tr8n::Config.enabled?
+    return Tr8n::TranslationKey.substitute_tokens(label, tokens, options, self).tr8n_translated if default?
+
+    translation_key = Tr8n::TranslationKey.find_or_create(label, desc, options)
+    translation_key.translate(self, tokens.merge(:viewing_user => Tr8n::Config.current_user), options).tr8n_translated
+  end
+  alias :tr :translate
+
+  def trl(label, desc = "", tokens = {}, options = {})
+    tr(label, desc, tokens, options.merge(:skip_decorations => true))
+  end
+
+  def default_rule
+    @default_rule ||= Tr8n::Config.language_rule_classes.first.new(:language => self, :definition => {})
+  end
+  
+  def rule_classes  
+    @rule_classes ||= rules.collect{|r| r.class}.uniq
+  end
+
+  def dependencies  
+    @dependencies ||= rule_classes.collect{|r| r.dependency}.uniq
+  end
+
+  def default_rules_for(dependency)
+    rules.select{|r| r.class.dependency == dependency}
+  end
+
+  def has_gender_rules?
+    dependencies.include?("gender")
+  end
+
+  def update_daily_metrics_for(metric_date)
+    metric = Tr8n::DailyLanguageMetric.find(:first, :conditions => ["language_id = ? and metric_date = ?", self.id, metric_date])
+    metric ||= Tr8n::DailyLanguageMetric.create(:language_id => self.id, :metric_date => metric_date)
+    metric.update_metrics!
+  end
+
+  def update_monthly_metrics_for(metric_date)
+    metric = Tr8n::MonthlyLanguageMetric.find(:first, :conditions => ["language_id = ? and metric_date = ?", self.id, metric_date])
+    metric ||= Tr8n::MonthlyLanguageMetric.create(:language_id => self.id, :metric_date => metric_date)
+    metric.update_metrics!
+  end
+
+  def total_metric
+    @total_metric ||= begin
+      metric = Tr8n::TotalLanguageMetric.find(:first, :conditions => ["language_id = ?", self.id])
+      metric || Tr8n::TotalLanguageMetric.create(Tr8n::LanguageMetric.default_attributes.merge(:language_id => self.id))
+    end
+  end
+
+  def update_total_metrics
+    total_metric.update_metrics!
+  end
+
+  def prohibited_words
+    return [] if curse_words.blank?
+    @prohibited_words ||= begin
+      wrds = self.curse_words.split(",").collect{|w| w.strip.downcase} 
+      wrds << fallback_language.prohibited_words if fallback_language
+      wrds.flatten.uniq
+    end
+  end
+
+  # you can add -bad_words to override the fallback language rules
+  def accepted_prohibited_words
+    return [] if curse_words.blank?
+    @accepted_prohibited_words ||= begin
+      wrds = self.curse_words.split(",").select{|w| w.first=='-'}
+      wrds << wrds.collect{|w| w.strip.gsub('-', '').downcase}
+      wrds << fallback_language.accepted_prohibited_words if fallback_language
+      wrds.flatten.uniq
+    end
+  end
+  
+  def bad_words
+    @bad_words ||= begin
+      bw = prohibited_words + Tr8n::Config.default_language.prohibited_words
+      bw.flatten.uniq - accepted_prohibited_words
+    end
+  end
+  
+  def clean_sentence?(sentence)
+    return true if sentence.blank?
+
+    # we need to solve the downcase problem - it doesn't work for russian and others
+    sentence = sentence.downcase
+
+    bad_words.each do |w|
+      return false unless sentence.scan(/#{w}/).empty?
+    end
+    
+    true
+  end
+
+  def clear_cache
+    Tr8n::Cache.delete("language_#{locale}")
+    Tr8n::Cache.delete("featured_languages")
+    Tr8n::Cache.delete("enabled_languages")
+  end
+
+  def recently_added_forum_messages
+    @recently_added_forum_messages ||= Tr8n::LanguageForumMessage.find(:all, :conditions => ["language_id = ?", self.id], :order => "created_at desc", :limit => 5)    
+  end
+
+  def recently_added_translations
+    @recently_added_translations ||= Tr8n::Translation.find(:all, :conditions => ["language_id = ?", self.id], :order => "created_at desc", :limit => 5)    
+  end
+
+  def recently_updated_translations
+    @recently_updated_translations ||= Tr8n::Translation.find(:all, :conditions => ["language_id = ?", self.id], :order => "updated_at desc", :limit => 5)    
+  end
+  
+  def recently_updated_votes(translator = Tr8n::Config.current_translator)
+    @recently_updated_votes ||= Tr8n::TranslationVote.find(:all, :conditions => ["translation_id in (select tr8n_translations.id from tr8n_translations where tr8n_translations.language_id = ? and tr8n_translations.translator_id = ?)", self.id, translator.id], :order => "updated_at desc", :limit => 5)    
+  end
+  
+end