Class: Tr8n::Translation

Inherits:
Base
  • Object
show all
Defined in:
lib/tr8n/translation.rb

Overview

– Copyright © 2014 Michael Berkovich, TranslationExchange.com

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. ++

Instance Attribute Summary

Attributes inherited from Base

#attributes

Instance Method Summary collapse

Methods inherited from Base

attributes, belongs_to, has_many, hash_value, #hash_value, #method_missing, #to_hash, #update_attributes

Constructor Details

#initialize(attrs = {}) ⇒ Translation

Returns a new instance of Translation.



29
30
31
32
33
34
35
36
37
 
# File 'lib/tr8n/translation.rb', line 29

def initialize(attrs = {})
  super

  if locale
    self.language = self.translation_key.application.language(locale)
  end

  calculate_precedence
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Tr8n::Base

Instance Method Details

#calculate_precedence ⇒ Object

the precedence is based on the number of fallback rules in the context. a fallback rule is indicated by the keyword “other” the more “others” are used the lower the precedence will be

0 indicates the highest precedence

deprecated - this is now done by the service



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/tr8n/translation.rb', line 57

def calculate_precedence
  self.precedence = 0
  return unless has_context_rules?

  context.values.each do |rules|
    rules.values.each do |rule_key|
      self.precedence += 1 if rule_key == "other"
    end
  end
end

#has_context_rules? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/tr8n/translation.rb', line 45

def has_context_rules?
  context and context.any?
end

#matches_rules?(token_values) ⇒ Boolean

checks if the translation is valid for the given tokens 

"count" => {"number":"one",
"user" => "gender":"male"

}

Returns:

  • (Boolean) 


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/tr8n/translation.rb', line 73

def matches_rules?(token_values)
  return true unless has_context_rules?

  context.each do |token_name, rules|
    token_object = Tr8n::Tokens::Data.token_object(token_values, token_name)
    return false unless token_object

    rules.each do |context_key, rule_key|
      next if rule_key == "other"

      context = language.context_by_keyword(context_key)
      return false unless context

      rule = context.find_matching_rule(token_object)
      return false if rule.nil? or rule.keyword != rule_key
    end
  end
  
  true
end

#set_translation_key(tkey) ⇒ Object

switches to a new translation key



40
41
42
43
 
# File 'lib/tr8n/translation.rb', line 40

def set_translation_key(tkey)
  self.translation_key = tkey
  self.language = tkey.application.language(locale)
end

#to_cache_hash ⇒ Object

Cache Methods



98
99
100
 
# File 'lib/tr8n/translation.rb', line 98

def to_cache_hash
  to_hash(:locale, :label, :context, :precedence)
end