Module: Tr8n::ActionViewExtension::InstanceMethods

Defined in:
lib/tr8n/extensions/action_view_extension.rb

Instance Method Summary collapse

Instance Method Details

#tr(label, desc = "", tokens = {}, options = {}) ⇒ Object

translation functions



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 116

def tr(label, desc = "", tokens = {}, options = {})
  return label if label.tr8n_translated?

  if desc.is_a?(Hash)
    options = desc
    tokens  = options[:tokens] || {}
    desc    = options[:context] || ""
  end

  options.merge!(:caller => caller)
  options.merge!(:url => request.url)
  options.merge!(:host => request.env['HTTP_HOST'])

  unless Tr8n::Config.enabled?
    return Tr8n::TranslationKey.substitute_tokens(label, tokens, options)
  end

  Tr8n::Config.current_language.translate(label, desc, tokens, options)
end

#tr8n_breadcrumb_tag(source = nil, opts = {}) ⇒ Object 



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 325

def tr8n_breadcrumb_tag(source = nil, opts = {})
  source ||= "#{controller.class.name.underscore.gsub("_controller", "")}/#{controller.action_name}" 
  section = Tr8n::SiteMap.section_for_source(source)
  return "" unless section
  opts[:separator] ||= " >> "
  opts[:min_elements] ||= 1
  opts[:skip_root] ||= opts[:skip_root].nil? ? false : opts[:skip_root]

  links = section.parents.collect{|node| link_to(node.title(params), node.link(params))}
  return "" if links.size <= opts[:min_elements]

  links.delete(links.first) if opts[:skip_root]
  links.unshift(link_to(opts[:root].first, opts[:root].last)) if opts[:root]

  html = "<div id='tr8n_breadcrumb' class='tr8n_breadcrumb'>"
  html << links.join(opts[:separator])
  html << '</div>'    
  html.html_safe
end

#tr8n_button_tag(label, function, opts = {}) ⇒ Object 



387
388
389
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 387

def tr8n_button_tag(label, function, opts = {})
  link_to_function("<span>#{label}</span>".html_safe, function, :class => "tr8n_grey_button tr8n_pcb")    
end

#tr8n_client_sdk_scripts_tag(opts = {}) ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 235

def tr8n_client_sdk_scripts_tag(opts = {})
  opts[:default_source] ||= "application"
  opts[:scheduler_interval] ||= 5000

  opts[:enable_inline_translations] = (Tr8n::Config.current_user_is_translator? and Tr8n::Config.current_translator.enable_inline_translations? and (not Tr8n::Config.current_language.default?))
  opts[:default_decorations]        = Tr8n::Config.default_decoration_tokens
  opts[:default_tokens]             = Tr8n::Config.default_data_tokens
  opts[:rules]                      = { 
    :number => Tr8n::Config.rules_engine[:numeric_rule],      :gender => Tr8n::Config.rules_engine[:gender_rule],
    :list   => Tr8n::Config.rules_engine[:gender_list_rule],  :date   => Tr8n::Config.rules_engine[:date_rule]
  }

  html = [javascript_include_tag("/tr8n/javascripts/tr8n_client_sdk.js")]
  html << "<script>"
  html << "function initializeTr8nProxy() {"
  html << "    tr8nProxy = new Tr8n.Proxy(#{opts.to_json});"
    #    html << "   Tr8n.Utils.addEvent(window, 'load', function() {"
    #    html << "       tr8nProxy = new Tr8n.Proxy(#{opts.to_json});"
    #    html << "    });"
  html << "}"
  html << "initializeTr8nProxy();"
  html << "</script>"
  html.join("\n").html_safe
end

#tr8n_client_sdk_tag(opts = {}) ⇒ Object

Creates an instance of tr8nProxy object



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 77

def tr8n_client_sdk_tag(opts = {})
  opts[:default_source]           ||= tr8n_default_client_source
  opts[:scheduler_interval]       ||= Tr8n::Config.default_client_interval

  opts[:enable_inline_translations] = (Tr8n::Config.current_user_is_translator? and Tr8n::Config.current_translator.enable_inline_translations? and (not Tr8n::Config.current_language.default?))
  opts[:default_decorations]        = Tr8n::Config.default_decoration_tokens
  opts[:default_tokens]             = Tr8n::Config.default_data_tokens

  opts[:rules]                      = { 
    :number => Tr8n::Config.rules_engine[:numeric_rule],      :gender => Tr8n::Config.rules_engine[:gender_rule],
    :list   => Tr8n::Config.rules_engine[:gender_list_rule],  :date   => Tr8n::Config.rules_engine[:date_rule]
  }

  client_var_name = opts[:client_var_name] || :tr8nProxy

  html = []
  # html << [javascript_include_tag("tr8n/tr8n_client_sdk.js")]
  html << "<script>"
  html << "  var #{client_var_name} = new Tr8n.Proxy(#{opts.to_json});"
  html << "  function reloadTranslations() { "
  html << "    #{client_var_name}.initTranslations(true); "
  html << "  } "
  html << "  function tr(label, description, tokens, options) { "
  html << "    return #{client_var_name}.tr(label, description, tokens, options); "
  html << "  } "
  html << "  function trl(label, description, tokens, options) { "
  html << "    return #{client_var_name}.trl(label, description, tokens, options); "
  html << "  } "

  # TODO: check if TML is enabled
  html << "  Tr8n.Utils.addEvent(window, 'load', function() { "
  html << "    #{client_var_name}.initTml(); "                               
  html << "  }) "                              

  html << "</script>"
  html.join("\n").html_safe
end

#tr8n_default_client_source ⇒ Object 



30
31
32
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 30

def tr8n_default_client_source
  "#{params[:controller]}/#{params[:action]}/JS"
end

#tr8n_dir_attribute_tag ⇒ Object 



156
157
158
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 156

def tr8n_dir_attribute_tag
  "dir='<%=Tr8n::Config.current_language.dir%>'".html_safe
end

#tr8n_flashes_tag(opts = {}) ⇒ Object 



227
228
229
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 227

def tr8n_flashes_tag(opts = {})
  render(:partial => '/tr8n/common/flashes', :locals => {:opts => opts})    
end

#tr8n_help_icon_tag(filename = "index") ⇒ Object 



279
280
281
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 279

def tr8n_help_icon_tag(filename = "index")
  link_to(image_tag("tr8n/help.png", :style => "border:0px; vertical-align:middle;", :title => trl("Help")), {:controller => "/tr8n/help", :action => filename}, :target => "_new").html_safe
end

#tr8n_help_link(text, opts = {}) ⇒ Object 



283
284
285
286
287
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 283

def tr8n_help_link(text, opts = {})
  filename = opts[:filename].nil? ? text.downcase.gsub(' ', '_') : opts[:filename] 
  classname = "tr8n_selected" if filename == controller.action_name
  link_to(text, { :controller => "/tr8n/help", :action => filename }, :class => classname).html_safe
end

#tr8n_language_flag_tag(lang = Tr8n::Config.current_language, opts = {}) ⇒ Object 



167
168
169
170
171
172
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 167

def tr8n_language_flag_tag(lang = Tr8n::Config.current_language, opts = {})
  return "" unless Tr8n::Config.enable_language_flags?
  html = image_tag("tr8n/flags/#{lang.flag}.png", :style => "vertical-align:middle;", :title => lang.native_name)
  html << "&nbsp;".html_safe 
  html.html_safe
end

#tr8n_language_name_tag(lang = Tr8n::Config.current_language, opts = {}) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 174

def tr8n_language_name_tag(lang = Tr8n::Config.current_language, opts = {})
  show_flag = opts[:flag].nil? ? true : opts[:flag]
  name_type = opts[:name].nil? ? :full : opts[:name] # :full, :native, :english, :locale
  linked = opts[:linked].nil? ? true : opts[:linked] 

  html = "<span style='white-space: nowrap'>"
  html << tr8n_language_flag_tag(lang, opts) if show_flag

  name = case name_type
    when :native  then lang.native_name
    when :english then lang.english_name
    when :locale  then lang.locale
    else lang.full_name
  end

  if linked
    html << link_to(name.html_safe, "/tr8n/language/switch?locale=#{lang.locale}&language_action=switch_language&source_url=#{CGI.escape(opts[:source_url]||'')}")
  else    
    html << name
  end

  html << "</span>"
  html.html_safe
end

#tr8n_language_selector_tag(opts = {}) ⇒ Object 



199
200
201
202
203
204
205
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 199

def tr8n_language_selector_tag(opts = {})
  opts[:lightbox] ||= false
  opts[:style] ||= "color:#1166bb;"
  opts[:show_arrow] ||= true
  opts[:arrow_style] ||= "font-size:8px;"
  render(:partial => '/tr8n/common/language_selector', :locals => {:opts => opts})    
end

#tr8n_language_strip_tag(opts = {}) ⇒ Object 



207
208
209
210
211
212
213
214
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 207

def tr8n_language_strip_tag(opts = {})
  opts[:flag] = opts[:flag].nil? ? false : opts[:flag]
  opts[:name] = opts[:name].nil? ? :native : opts[:name] 
  opts[:linked] = opts[:linked].nil? ? true : opts[:linked] 
  opts[:javascript] = opts[:javascript].nil? ? false : opts[:javascript] 

  render(:partial => '/tr8n/common/language_strip', :locals => {:opts => opts})    
end

#tr8n_language_table_tag(opts = {}) ⇒ Object 



216
217
218
219
220
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 216

def tr8n_language_table_tag(opts = {})
  opts[:cols] = opts[:cols].nil? ? 4 : opts[:cols]
  opts[:col_size] = opts[:col_size].nil? ? "300px" : opts[:col_size]
  render(:partial => '/tr8n/common/language_table', :locals => {:opts => opts.merge(:name => :english)})    
end

#tr8n_options_for_select(options, selected = nil, description = nil, lang = Tr8n::Config.current_language) ⇒ Object 



141
142
143
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 141

def tr8n_options_for_select(options, selected = nil, description = nil, lang = Tr8n::Config.current_language)
  options_for_select(options.tro(description), selected)
end

#tr8n_paginator_tag(collection, options) ⇒ Object 



391
392
393
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 391

def tr8n_paginator_tag(collection, options)  
  render :partial => "/tr8n/common/paginator", :locals => {:collection => collection, :options => options}
end

#tr8n_phrases_link_tag(search = "", phrase_type = :without, phrase_status = :any) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 145

def tr8n_phrases_link_tag(search = "", phrase_type = :without, phrase_status = :any)
  return unless Tr8n::Config.enabled?
  return if Tr8n::Config.current_language.default?
  return unless Tr8n::Config.open_registration_mode? or Tr8n::Config.current_user_is_translator?
  return unless Tr8n::Config.current_translator.enable_inline_translations?

  link_to(image_tag("tr8n/translate_icn.gif", :style => "vertical-align:middle; border: 0px;", :title => search), 
         :controller => "/tr8n/phrases", :action => :index, 
         :search => search, :phrase_type => phrase_type, :phrase_status => phrase_status).html_safe
end

#tr8n_scripts_tag(opts = {}) ⇒ Object 



231
232
233
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 231

def tr8n_scripts_tag(opts = {})
  render(:partial => '/tr8n/common/scripts', :locals => {:opts => opts})    
end

#tr8n_select_month(date, options = {}, html_options = {}) ⇒ Object 



371
372
373
374
375
376
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 371

def tr8n_select_month(date, options = {}, html_options = {})
  month_names = options[:use_short_month] ? Tr8n::Config.default_abbr_month_names : Tr8n::Config.default_month_names
  select_month(date, options.merge(
    :use_month_names => month_names.collect{|month_name| Tr8n::Language.translate(month_name, options[:description] || "Month name")} 
  ), html_options)
end

#tr8n_sitemap(sections, splitters, options = {}) ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 311

def tr8n_sitemap(sections, splitters, options = {})
  html = ""
  html << "<table style='width:100%'>"
  html << "<tr>"
  splitters.each do |splitter| 
    html << "<td style='vertical-align:top; width:" << (100 / splitters.size).to_s << "%;'>"
    html << generate_sitemap(sections[splitter.first..splitter.last], options)      
    html << "</td>"
  end 
  html << "</tr>"
  html << "</table>"
  html.html_safe
end

#tr8n_spinner_tag(id = "spinner", label = nil, cls = 'spinner') ⇒ Object 



289
290
291
292
293
294
295
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 289

def (id = "spinner", label = nil, cls='spinner')
  html = "<div id='#{id}' class='#{cls}' style='display:none'>"
  html << image_tag("tr8n/spinner.gif", :style => "vertical-align:middle;")
  html << " #{trl(label)}" if label
  html << "</div>"
  html.html_safe
end

#tr8n_splash_screen_tag ⇒ Object 



160
161
162
163
164
165
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 160

def tr8n_splash_screen_tag
  html = "<div id='tr8n_splash_screen' style='display:none'>"
  html << (render :partial => Tr8n::Config.splash_screen)
  html << "</div>"
  html.html_safe
end

#tr8n_toggler_tag(content_id, label = "", open = true) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 297

def tr8n_toggler_tag(content_id, label = "", open = true)
  html = "<span id='#{content_id}_open' "
  html << "style='display:none'" unless open
  html << ">"
  html << link_to_function("#{image_tag("tr8n/arrow_down.gif", :style=>'text-align:center; vertical-align:middle')} #{label}".html_safe, "Tr8n.Effects.hide('#{content_id}_open'); Tr8n.Effects.show('#{content_id}_closed'); Tr8n.Effects.blindUp('#{content_id}');", :style=> "text-decoration:none")
  html << "</span>" 
  html << "<span id='#{content_id}_closed' "
  html << "style='display:none'" if open
  html << ">"
  html << link_to_function("#{image_tag("tr8n/arrow_right.gif", :style=>'text-align:center; vertical-align:middle')} #{label}".html_safe, "Tr8n.Effects.show('#{content_id}_open'); Tr8n.Effects.hide('#{content_id}_closed'); Tr8n.Effects.blindDown('#{content_id}');", :style=> "text-decoration:none")
  html << "</span>" 
  html.html_safe
end

#tr8n_translations_cache_tag(opts = {}) ⇒ Object

Creates a hash of translations for a page source(s) or a component(s)



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 35

def tr8n_translations_cache_tag(opts = {})
  html = []

  opts[:translations_element_id] ||= :tr8n_translations
  opts[:sources] ||= [tr8n_default_client_source]
  client_sdk_var_name = opts[:client_var_name] || :tr8nProxy

  if Tr8n::Config.enable_browser_cache?  # translations are loaded through a script

    opts[:sources].each do |source_name|
      source = Tr8n::TranslationSource.find_or_create(source_name, request.url)
      js_source = "/tr8n/api/v1/language/translate.js?cache=true&sdk_jsvar=#{client_sdk_var_name}&source=#{CGI.escape(source_name)}&t=#{source.updated_at.to_i}"
      html << "<script type='text/javascript' src='#{js_source}'></script>"
    end  

  else  # translations are embedded right into the page

    html << "<script>"
    sources = Tr8n::TranslationSource.find(:all, :conditions => ["source in (?)", opts[:sources]])
    source_ids = sources.collect{|source| source.id}

    if source_ids.empty?
      conditions = ["1=2"]
    else
      conditions = ["(id in (select distinct(translation_key_id) from tr8n_translation_key_sources where translation_source_id in (?)))"]
      conditions << source_ids.uniq
    end

    translations = []
    Tr8n::TranslationKey.find(:all, :conditions => conditions).each_with_index do |tkey, index|
      trn = tkey.translate(Tr8n::Config.current_language, {}, {:api => true})
      translations << trn 
    end

    html << "#{client_sdk_var_name}.updateTranslations(#{translations.to_json});"
    html << "</script>"
  end
    
  html.join('').html_safe
end

#tr8n_translator_login_tag(opts = {}) ⇒ Object 



222
223
224
225
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 222

def (opts = {})
  opts[:class] ||= 'tr8n_right_horiz_list'
  render(:partial => '/tr8n/common/translator_login', :locals => {:opts => opts})    
end

#tr8n_translator_rank_tag(translator, rank = nil) ⇒ Object 



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 260

def tr8n_translator_rank_tag(translator, rank = nil)
  return "" unless translator

  rank ||= translator.rank || 0

  html = "<span dir='ltr'>"
  1.upto(5) do |i|
    if rank > i * 20 - 10  and rank < i * 20  
      html << image_tag("tr8n/rating_star05.png")
    elsif rank < i * 20 - 10 
      html << image_tag("tr8n/rating_star0.png")
    else
      html << image_tag("tr8n/rating_star1.png")
    end 
  end
  html << "</span>"
  html.html_safe    
end

#tr8n_user_mugshot_tag(translator, options = {}) ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 355

def tr8n_user_mugshot_tag(translator, options = {})
  if translator and !translator.mugshot.blank?
    img_url = translator.mugshot
  else
    img_url = Tr8n::Config.silhouette_image
  end

  img_tag = "<img src='#{img_url}' style='width:48px'>".html_safe

  if translator and options[:linked]
    link_to(img_tag, translator.link).html_safe
  else  
    img_tag.html_safe
  end
end

#tr8n_user_tag(translator, options = {}) ⇒ Object 



345
346
347
348
349
350
351
352
353
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 345

def tr8n_user_tag(translator, options = {})
  return "Deleted Translator" unless translator

  if options[:linked]
    link_to(translator.name, translator.link).html_safe
  else
    translator.name
  end
end

#tr8n_with_options_tag(opts, &block) ⇒ Object 



378
379
380
381
382
383
384
385
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 378

def tr8n_with_options_tag(opts, &block)
  Thread.current[:tr8n_block_options] = opts
  if block_given?
    ret = capture(&block) 
  end
  Thread.current[:tr8n_block_options] = {}
  ret
end

#trl(label, desc = "", tokens = {}, options = {}) ⇒ Object

for translating labels



137
138
139
 
# File 'lib/tr8n/extensions/action_view_extension.rb', line 137

def trl(label, desc = "", tokens = {}, options = {})
  tr(label, desc, tokens, options.merge(:skip_decorations => true))
end