tr8n 3.0.2

data/lib/application_controller.rb

@@ -0,0 +1,38 @@
+#--
+# 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.
+#++
+
+module Tr8n
+  module ApplicationController
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :init_tr8n
+    end
+
+    module InstanceMethods
+      include Tr8n::ControllerMethods
+    end
+  end
+end
+
+::ActionController::Base.send :include, Tr8n::ApplicationController

data/lib/application_helper.rb

@@ -0,0 +1,336 @@
+#--
+# 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.
+#++
+
+module ApplicationHelper
+  # translation functions
+  def tr(label, desc = "", tokens = {}, options = {})
+    unless desc.nil? or desc.is_a?(String)
+      raise Tr8n::Exception.new("The second parameter of the tr function must be a description")
+    end
+
+    begin
+      url     = request.url
+      host    = request.env['HTTP_HOST']
+      source  = "#{controller.class.name.underscore.gsub("_controller", "")}/#{controller.action_name}"
+    rescue Exception => ex
+      source = self.class.name
+      url = nil
+      host = 'localhost'
+    end
+
+    options.merge!(:source => source) unless options[:source]
+    options.merge!(:caller => caller)
+    options.merge!(:url => url)
+    options.merge!(:host => host)
+
+#     pp [source, options[:source], url]
+    
+    unless Tr8n::Config.enabled?
+      return Tr8n::TranslationKey.substitute_tokens(label, tokens, options)
+    end
+    
+    Tr8n::Config.current_language.translate(label, desc, tokens, options)
+  end
+
+  # for translating labels
+  def trl(label, desc = "", tokens = {}, options = {})
+    tr(label, desc, tokens, options.merge(:skip_decorations => true))
+  end
+    
+  def tr8n_options_for_select(options, selected = nil, description = nil, lang = Tr8n::Config.current_language)
+    options_for_select(options.tro(description), selected)
+  end
+
+  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/images/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
+
+  def tr8n_dir_attribute_tag
+    "dir='<%=Tr8n::Config.current_language.dir%>'".html_safe
+  end
+
+  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
+
+  def tr8n_language_flag_tag(lang = Tr8n::Config.current_language, opts = {})
+    return "" unless Tr8n::Config.enable_language_flags?
+    html = image_tag("/tr8n/images/flags/#{lang.flag}.png", :style => "vertical-align:middle;", :title => lang.native_name)
+    html << "&nbsp;".html_safe 
+    html.html_safe
+  end
+
+  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, :controller => "/tr8n/language", 
+              :action => :switch, :language_action => :switch_language, 
+              :locale => lang.locale,
+              :source_url => opts[:source_url])
+    else    
+      html << name
+    end
+    
+    html << "</span>"
+    html.html_safe
+  end
+
+  def tr8n_language_selector_tag(opts = {})
+    opts[:style] ||= "color:#1166bb;"
+    opts[:show_arrow] ||= true
+    opts[:arrow_style] ||= "font-size:8px;"
+    render(:partial => '/tr8n/common/language_selector', :locals => {:opts => opts})    
+  end
+
+  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
+
+  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
+
+  def tr8n_translator_login_tag(opts = {})
+    opts[:class] ||= 'tr8n_right_horiz_list'
+    render(:partial => '/tr8n/common/translator_login', :locals => {:opts => opts})    
+  end
+
+  def tr8n_flashes_tag(opts = {})
+    render(:partial => '/tr8n/common/flashes', :locals => {:opts => opts})    
+  end
+
+  def tr8n_scripts_tag(opts = {})
+    render(:partial => '/tr8n/common/scripts', :locals => {:opts => opts})    
+  end
+  
+  def tr8n_client_sdk_scripts_tag(opts = {})
+    javascript_include_tag("/tr8n/javascripts/tr8n_client_sdk.js", :locals => {:opts => opts})
+  end
+
+  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/images/rating_star05.png")
+      elsif rank < i * 20 - 10 
+        html << image_tag("/tr8n/images/rating_star0.png")
+      else
+        html << image_tag("/tr8n/images/rating_star1.png")
+      end 
+    end
+    html << "</span>"
+    html.html_safe    
+  end
+  
+  def tr8n_help_icon_tag(filename = "index")
+    link_to(image_tag("/tr8n/images/help.png", :style => "border:0px; vertical-align:middle;", :title => trl("Help")), {:controller => "/tr8n/help", :action => filename}, :target => "_new").html_safe
+  end
+  
+  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
+
+  def tr8n_spinner_tag(id = "spinner", label = nil, cls='spinner')
+    html = "<div id='#{id}' class='#{cls}' style='display:none'>"
+    html << image_tag("/tr8n/images/spinner.gif", :style => "vertical-align:middle;")
+    html << " #{trl(label)}" if label
+    html << "</div>"
+    html.html_safe
+  end
+  
+  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/images/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/images/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  
+  
+  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
+  
+  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
+  
+  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
+
+  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  
+  
+  def tr8n_will_paginate(collection = nil, options = {})
+    will_paginate(collection, options.merge(:previous_label => tr("&laquo; Previous", "Previous entries in a list", {}, options), 
+                                            :next_label => tr("Next &raquo;", "Next entries in a list", {}, options))).html_safe
+  end
+
+  def tr8n_page_entries_info(collection, options = {})
+    entry_name = options[:entry_name] || (collection.empty? ? 'entry' : collection.first.class.name.underscore.sub('_', ' '))
+    
+    if collection.total_pages < 2
+      case collection.size
+        when 0
+          tr("None found", "Paginator no entries message", {}, options)
+        when 1
+          tr("Displaying [bold: 1] #{entry_name}", "Paginator one page message", {}, options)
+        else
+          tr("Displaying [bold: all {count}] #{entry_name.pluralize}", "Paginator all entries message", {:count => collection.size}, options)
+      end
+    else
+      tr("Displaying #{entry_name.pluralize} [bold: {start_num} - {end_num}] of [bold: {total_count}] in total", 
+         "Paginator custom message", {
+            :start_num    => collection.offset + 1,
+            :end_num      => collection.offset + collection.length,
+            :total_count  => collection.total_entries
+         }, options
+      )
+    end
+  end
+
+  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
+
+  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
+
+  def tr8n_button_tag(label, function, opts = {})
+    link_to_function("<span>#{label}</span>".html_safe, function, :class => "tr8n_grey_button tr8n_pcb")    
+  end
+
+private
+
+  def generate_sitemap(sections, options = {})
+    html = "<ul class='section_list'>"
+    sections.each do |section|
+      html << "<li class='section_list_item'>" 
+      html << "<a href='/tr8n/phrases/index?section_key=#{section.key}'>" << tr(section.label, section.description) << "</a>"
+      html << "<a href='" << section.data[:link] << "' target='_new'><img src='/tr8n/images/bullet_go.png' style='border:0px; vertical-align:middle'></a>" if section.data[:link]
+      
+      if section.children.size > 0
+        html << generate_sitemap(section.children, options)
+      end  
+      html << "</li>"
+    end
+    html << "</ul>"
+    html.html_safe
+  end
+end

data/lib/core_ext/array.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 Array
+
+  # translates an array of options for a select tag
+  def tro(description = "", options = {}, language = Tr8n::Config.current_language)
+    return [] if empty?
+
+    collect do |opt|
+      if opt.is_a?(Array) and opt.first.is_a?(String) 
+        [opt.first.trl(description, {}, options, language), opt.last]
+      elsif opt.is_a?(String)
+        [opt.trl(description, {}, options, language), opt]
+      else  
+        opt
+      end
+    end
+  end
+
+  # creates a sentence with tr "and" joiner
+  def tr_sentence(options = {}, language = Tr8n::Config.current_language)
+    return "" if empty?
+    return first if size == 1
+
+    result = "#{self[0..-2].join(", ")}"
+    result << " " << "and".translate("List elements joiner", {}, options, language) << " "
+    result << self.last
+  end
+
+  def tr8n_translated
+    return self if frozen?
+    @tr8n_translated = true
+    self
+  end
+
+  def tr8n_translated?
+    @tr8n_translated
+  end
+
+end

data/lib/core_ext/date.rb

@@ -0,0 +1,76 @@
+#--
+# 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 Date
+
+  def with_leading_zero(num, options = {})
+    return (num < 10 ? "0#{num}" : num) if options[:with_leading_zero]
+    num
+  end
+
+  def tensify(past, present, future)
+    current_date = Date.today
+    return past if self < current_date
+    return future if self > current_date
+    present
+  end
+  
+  def translate(format = :default, language = Tr8n::Config.current_language, options = {})
+    label = (format.is_a?(String) ? format.clone : Tr8n::Config.default_date_formats[format].clone)
+    symbols = label.scan(/(%\w)/).flatten.uniq
+
+    selected_tokens = []
+    symbols.each do |symbol|
+      token = Tr8n::Config.strftime_symbol_to_token(symbol)
+      next unless token
+      selected_tokens << token
+      label.gsub!(symbol, token)
+    end
+
+    tokens = {}
+    selected_tokens.each do |token|
+      case token
+        when "{days}"                 then tokens[:days] = with_leading_zero(day, options)
+        when "{year_days}"            then tokens[:year_days] = with_leading_zero(yday, options)
+        when "{months}"               then tokens[:months] = with_leading_zero(month, options)
+        when "{week_num}"             then tokens[:week_num] = wday
+        when "{week_days}"            then tokens[:week_days] = strftime("%w")
+        when "{short_years}"          then tokens[:short_years] = strftime("%y")
+        when "{years}"                then tokens[:years] = year
+        when "{short_week_day_name}"  then tokens[:short_week_day_name] = language.tr(Tr8n::Config.default_abbr_day_names[wday], "Short name for a day of a week", {}, options)
+        when "{week_day_name}"        then tokens[:week_day_name] = language.tr(Tr8n::Config.default_day_names[wday], "Day of a week", {}, options)
+        when "{short_month_name}"     then tokens[:short_month_name] = language.tr(Tr8n::Config.default_abbr_month_names[month - 1], "Short month name", {}, options)
+        when "{month_name}"           then tokens[:month_name] = language.tr(Tr8n::Config.default_month_names[month - 1], "Month name", {}, options)
+        when "{day_of_month}"         then tokens[:day_of_month] = strftime("%e")
+      end
+    end
+
+#    options.merge!(:skip_decorations => true) if options[:skip_decorations].blank?
+    language.tr(label, nil, tokens, options)
+  end
+  alias :tr :translate  
+  
+  def trl(format = :default, language = Tr8n::Config.current_language, options = {})
+    tr(format, language, options.merge!(:skip_decorations => true))
+  end
+end