Class: Tr8n::LanguageCase

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/tr8n/language_case.rb

Overview

– Copyright © 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 “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. ++

– Tr8n::LanguageCase Schema Information

Table name: tr8n_language_cases

id               INTEGER         not null, primary key
language_id      integer         not null
translator_id    integer         
keyword          varchar(255)    
latin_name       varchar(255)    
native_name      varchar(255)    
description      text            
application      varchar(255)    
created_at       datetime        
updated_at       datetime

Indexes

index_tr8n_language_cases_on_language_id_and_keyword          (language_id, keyword) 
index_tr8n_language_cases_on_language_id_and_translator_id    (language_id, translator_id) 
index_tr8n_language_cases_on_language_id                      (language_id)

++

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.application_options ⇒ Object 



170
171
172
 
# File 'app/models/tr8n/language_case.rb', line 170

def self.application_options
  [["every word", "words"], ["entire phrase", "phrase"]]
end

.by_id(case_id) ⇒ Object 



76
77
78
79
80
 
# File 'app/models/tr8n/language_case.rb', line 76

def self.by_id(case_id)
  Tr8n::Cache.fetch("language_case_#{case_id}") do 
    find_by_id(case_id)
  end
end

.by_keyword(keyword, language = Tr8n::Config.current_language) ⇒ Object 



70
71
72
73
74
 
# File 'app/models/tr8n/language_case.rb', line 70

def self.by_keyword(keyword, language = Tr8n::Config.current_language)
  Tr8n::Cache.fetch(cache_key(language.locale, keyword)) do 
    where(:language_id => language.id, :keyword => keyword).first
  end
end

.cache_key(locale, keyword) ⇒ Object 



62
63
64
 
# File 'app/models/tr8n/language_case.rb', line 62

def self.cache_key(locale, keyword)
  "language_case_#{locale}_#{keyword}"
end

Instance Method Details

#add_rule(definition, opts = {}) ⇒ Object 



82
83
84
85
86
87
88
 
# File 'app/models/tr8n/language_case.rb', line 82

def add_rule(definition, opts = {})
  opts[:position] ||= language_case_rules.count
  opts[:translator] ||= Tr8n::Config.current_translator
  Tr8n::LanguageCaseRule.create(:language_case => self,           :language => language, 
                                :translator => opts[:translator], :position => opts[:position], 
                                :definition => definition)
end

#apply(object, value, options = {}) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'app/models/tr8n/language_case.rb', line 118

def apply(object, value, options = {})
  value = value.to_s
  # pp value
  
  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
      map_case_value = lcvm.value_for(object, keyword)
      case_value = map_case_value unless map_case_value.blank?
    else
      case_rule = rules.detect{|rule| rule.evaluate(object, 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

#cache_key ⇒ Object 



66
67
68
 
# File 'app/models/tr8n/language_case.rb', line 66

def cache_key
  self.class.cache_key(language.locale, keyword)
end

#clear_cache ⇒ Object 



174
175
176
177
 
# File 'app/models/tr8n/language_case.rb', line 174

def clear_cache
  Tr8n::Cache.delete("language_case_#{id}")
  Tr8n::Cache.delete("language_case_rules_#{id}") 
end

#decorate_language_case(case_map_key, case_value, case_rule, options = {}) ⇒ Object 



160
161
162
163
164
165
166
167
168
 
# File 'app/models/tr8n/language_case.rb', line 160

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

#destroy_with_log!(new_translator) ⇒ Object 



112
113
114
115
116
 
# File 'app/models/tr8n/language_case.rb', line 112

def destroy_with_log!(new_translator)
  new_translator.deleted_language_case!(self)
  
  destroy
end

#rules ⇒ Object 



90
91
92
93
94
95
96
 
# File 'app/models/tr8n/language_case.rb', line 90

def rules
  return language_case_rules if id.blank?
  
  Tr8n::Cache.fetch("language_case_rules_#{id}") do 
    language_case_rules
  end
end

#save_with_log!(new_translator) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'app/models/tr8n/language_case.rb', line 98

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