translate-rails3 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.

data/README

@@ -0,0 +1,62 @@
+Translate
+=========
+
+This plugin provides a web interface for translating Rails I18n texts (requires Rails 3.0 or higher) from one locale to another. The plugin has been tested only with the simple I18n backend that ships with Rails. I18n texts are read from and written to YAML files under config/locales.
+
+To translate to a new locale you need to add a YAML file for that locale that contains the locale as the top key and at least one translation.
+
+Please note that there are certain I18n keys that map to Array objects rather than strings and those are currently not dealt with by the translation UI. This means that Rails built in keys such as date.day_names need to be translated manually directly in the YAML file.
+
+To get the translation UI to write the YAML files in UTF8 you need to install the ya2yaml gem.
+
+The translation UI finds all I18n keys by extracting them from I18n lookups in your application source code. In addition it adds all :en and default locale keys from the I18n backend.
+
+- Updated: Each string in the UI now has an "Auto Translate" link which will send the original text to Google Translate and will input the returned translation into the form field for further clean up and review prior to saving.
+
+
+Rake Tasks
+=========
+
+In addition to the web UI this plugin adds the following rake tasks:
+
+translate:untranslated
+translate:missing
+translate:remove_obsolete_keys
+translate:merge_keys
+translate:google
+translate:changed
+
+The missing task shows you any I18n keys in your code that do not have translations in the YAML file for your default locale, i.e. config/locales/sv.yml.
+
+The merge_keys task is supposed to be used in conjunction with Sven Fuch's Rails I18n TextMate bundle (http://github.com/svenfuchs/rails-i18n/tree/master). Texts and keys extracted with the TextMate bundle end up in the temporary file log/translations.yml. When you run the merge_keys rake task the keys are moved over to the corresponding I18n locale file, i.e. config/locales/sv.yml. The merge_keys task also checks for overwrites of existing keys by warning you that one of your extracted keys already exists with a different translation.
+
+The google task is used for auto translating from one locale to another using Google Translate.
+
+The changed rake task can show you between one YAML file to another which keys have had their texts changed.
+
+Installation
+=========
+
+Add to your Gemfile:
+
+    gem 'translate-rails3', :require => 'translate', :group => :development
+
+Now visit /translate in your web browser to start translating.
+
+Dependencies
+=========
+
+- Rails 2.2 or higher
+- The ya2yaml gem if you want your YAML files written in UTF8 encoding.
+
+Authors
+=========
+
+- Peter Marklund (programming)
+- Joakim Westerlund (web design)
+- Milan Novota (initial Rails 3 support)
+- Roman Shterenzon (Rails 3 cleanup and gem packaging)
+
+Many thanks to http://newsdesk.se for sponsoring the development of this plugin.
+
+Copyright (c) 2009 Peter Marklund, released under the MIT license

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--color --format progress']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'translate-rails3'
+    gem.summary = %Q{Newsdesk translate plugin for Rails 3}
+    gem.description = <<EOF
+This plugin provides a web interface for translating Rails I18n texts
+(requires Rails 3.0 or higher) from one locale to another.
+The plugin has been tested only with the simple I18n backend that ships
+with Rails.
+I18n texts are read from and written to YAML files under config/locales.
+
+This gem is a fork of the original https://github.com/mynewsdesk/translate
+and also includes work from this fork: https://github.com/milann/translate
+EOF
+    gem.email = 'romanbsd@yahoo.com'
+    gem.homepage = 'https://github.com/romanbsd/translate'
+    gem.authors = ['Peter Marklund', 'Milan Novota', 'Roman Shterenzon']
+    gem.add_dependency 'ya2yaml', '~> 0.30' # For UTF-8 support in YAML
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/translate_controller.rb

@@ -0,0 +1,165 @@
+class TranslateController < ActionController::Base
+  # It seems users with active_record_store may get a "no :secret given" error if we don't disable csrf protection,
+  skip_before_filter :verify_authenticity_token
+
+  prepend_view_path(File.join(File.dirname(__FILE__), "..", "views"))
+  layout 'translate'
+
+  before_filter :init_translations
+  before_filter :set_locale
+  
+  def index
+    initialize_keys
+    filter_by_key_pattern
+    filter_by_text_pattern
+    filter_by_translated_or_changed
+    sort_keys
+    paginate_keys
+    @total_entries = @keys.size
+  end
+  
+  def translate
+    I18n.backend.store_translations(@to_locale, Translate::Keys.to_deep_hash(params[:key]))
+    Translate::Storage.new(@to_locale).write_to_file
+    Translate::Log.new(@from_locale, @to_locale, params[:key].keys).write_to_file
+    force_init_translations # Force reload from YAML file
+    flash[:notice] = "Translations stored"
+    redirect_to params.slice(:filter, :sort_by, :key_type, :key_pattern, :text_type, :text_pattern).merge({:action => :index})
+  end
+
+  def reload
+    Translate::Keys.files = nil
+    redirect_to :action => 'index'
+  end
+  
+  private
+  def initialize_keys
+    @files = Translate::Keys.files
+    @keys = (@files.keys.map(&:to_s) + Translate::Keys.new.i18n_keys(@from_locale)).uniq    
+    @keys.reject! do |key|
+      from_text = lookup(@from_locale, key)
+      # When translating from one language to another, make sure there is a text to translate from.
+      # Always exclude non string translation objects as we don't support editing them in the UI.
+      (@from_locale != @to_locale && !from_text.present?) || (from_text.present? && !from_text.is_a?(String))      
+    end
+  end
+
+  def lookup(locale, key)
+    I18n.backend.send(:lookup, locale, key)
+  end
+  helper_method :lookup
+  
+  def filter_by_translated_or_changed
+    params[:filter] ||= 'all'
+    return if params[:filter] == 'all'
+    @keys.reject! do |key|
+      case params[:filter]
+      when 'untranslated'
+        lookup(@to_locale, key).present?
+      when 'translated'
+        lookup(@to_locale, key).blank?
+      when 'changed'
+        old_from_text(key).blank? || lookup(@from_locale, key) == old_from_text(key)
+      else
+        raise "Unknown filter '#{params[:filter]}'"
+      end
+    end
+  end
+  
+  def filter_by_key_pattern
+    return if params[:key_pattern].blank?
+    @keys.reject! do |key|
+      case params[:key_type]
+      when "starts_with"
+        !key.starts_with?(params[:key_pattern])
+      when "contains"
+        key.index(params[:key_pattern]).nil?
+      else
+        raise "Unknown key_type '#{params[:key_type]}'"
+      end
+    end
+  end
+
+  def filter_by_text_pattern
+    return if params[:text_pattern].blank?
+    @keys.reject! do |key|
+      case params[:text_type]
+      when 'contains'
+        !lookup(@from_locale, key).present? || !lookup(@from_locale, key).to_s.downcase.index(params[:text_pattern].downcase)
+      when 'equals'
+        !lookup(@from_locale, key).present? || lookup(@from_locale, key).to_s.downcase != params[:text_pattern].downcase
+      else
+        raise "Unknown text_type '#{params[:text_type]}'"
+      end
+    end
+  end
+
+  def sort_keys
+    params[:sort_by] ||= "key"
+    case params[:sort_by]
+    when "key"
+      @keys.sort!
+    when "text"
+      @keys.sort! do |key1, key2|
+        if lookup(@from_locale, key1).present? && lookup(@from_locale, key2).present?
+          lookup(@from_locale, key1).to_s.downcase <=> lookup(@from_locale, key2).to_s.downcase
+        elsif lookup(@from_locale, key1).present?
+          -1
+        else
+          1
+        end
+      end
+    else
+      raise "Unknown sort_by '#{params[:sort_by]}'"
+    end
+  end
+  
+  def paginate_keys
+    params[:page] ||= 1
+    @paginated_keys = @keys[offset, per_page]
+  end
+
+  def offset
+    (params[:page].to_i - 1) * per_page
+  end
+  
+  def per_page
+    50
+  end
+  helper_method :per_page
+  
+  def init_translations
+    I18n.backend.send(:init_translations) unless I18n.backend.initialized?    
+  end
+
+  def force_init_translations
+    I18n.backend.send(:init_translations)
+  end
+  
+  def default_locale
+    I18n.default_locale
+  end
+  
+  def set_locale
+    session[:from_locale] ||= default_locale
+    session[:to_locale] ||= :en
+    session[:from_locale] = params[:from_locale] if params[:from_locale].present?
+    session[:to_locale] = params[:to_locale] if params[:to_locale].present?
+    @from_locale = session[:from_locale].to_sym
+    @to_locale = session[:to_locale].to_sym
+  end
+  
+  def old_from_text(key)
+    return @old_from_text[key] if @old_from_text && @old_from_text[key]
+    @old_from_text = {}
+    text = key.split(".").inject(log_hash) do |hash, k|
+      hash ? hash[k] : nil
+    end
+    @old_from_text[key] = text
+  end
+  helper_method :old_from_text
+  
+  def log_hash
+    @log_hash ||= Translate::Log.new(@from_locale, @to_locale, {}).read
+  end
+end

data/app/helpers/translate_helper.rb

@@ -0,0 +1,45 @@
+module TranslateHelper
+  def simple_filter(labels, param_name = 'filter', selected_value = nil)
+    selected_value ||= params[param_name]
+    filter = []
+    labels.each do |item|
+      if item.is_a?(Array)
+        type, label = item
+      else
+        type = label = item
+      end
+      if type.to_s == selected_value.to_s
+        filter << "<i>#{label}</i>"
+      else
+        link_params = params.merge({param_name.to_s => type})
+        link_params.merge!({"page" => nil}) if param_name.to_s != "page"
+        filter << link_to(label, link_params)
+      end
+    end
+    filter.join(" | ")    
+  end
+
+  def n_lines(text, line_size)
+    n_lines = 1
+    if text.present?
+      n_lines = text.split("\n").size
+      if n_lines == 1 && text.length > line_size
+        n_lines = text.length / line_size + 1
+      end
+    end
+    n_lines
+  end
+  
+  def translate_javascript_includes
+    sources = []
+    if File.exists?(File.join(Rails.root, "public", "javascripts", "prototype.js"))
+      sources << "/javascripts/prototype.js"
+    else
+      sources << "http://ajax.googleapis.com/ajax/libs/prototype/1.6.1.0/prototype.js"
+    end
+    sources << "http://www.google.com/jsapi"
+    sources.map do |src|
+      %Q{<script src="#{src}" type="text/javascript"></script>}
+    end.join("\n")
+  end
+end

data/app/views/layouts/translate.html.erb

@@ -0,0 +1,359 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+    <title><%= h(@page_title) %></title>
+
+    <%= raw translate_javascript_includes %>
+<script type="text/javascript">
+      google.load("language", "1");
+
+      function getGoogleTranslation(id, text, from_language, to_language) {
+        text = text.replace(/\{\{/, '__').replace(/\}\}/, '__')
+        google.language.translate(text, from_language, to_language, function(result) {
+          if (!result.error) { 
+            result_text = result.translation.unescapeHTML().gsub(/__(.+)__/, function(match){
+              return '{{' + match[1] + '}}';
+            });
+            Form.Element.setValue(id, result_text);
+          }
+        });
+
+    }
+
+    /*
+    prototypeUtils.js from http://jehiah.com/
+    Licensed under Creative Commons.
+    version 1.0 December 20 2005
+
+    Contains:
+    + Form.Element.setValue()
+    + unpackToForm()
+
+    */
+
+    /* Form.Element.setValue("fieldname/id","valueToSet") */
+    Form.Element.setValue = function(element,newValue) {
+        element_id = element;
+        element = $(element);
+        if (!element){element = document.getElementsByName(element_id)[0];}
+        if (!element){return false;}
+        var method = element.tagName.toLowerCase();
+        var parameter = Form.Element.SetSerializers[method](element,newValue);
+    }
+
+    Form.Element.SetSerializers = {
+      input: function(element,newValue) {
+        switch (element.type.toLowerCase()) {
+          case 'submit':
+          case 'hidden':
+          case 'password':
+          case 'text':
+            return Form.Element.SetSerializers.textarea(element,newValue);
+          case 'checkbox':
+          case 'radio':
+            return Form.Element.SetSerializers.inputSelector(element,newValue);
+        }
+        return false;
+      },
+
+      inputSelector: function(element,newValue) {
+        fields = document.getElementsByName(element.name);
+        for (var i=0;i<fields.length;i++){
+          if (fields[i].value == newValue){
+            fields[i].checked = true;
+          }
+        }
+      },
+
+      textarea: function(element,newValue) {
+        element.value = newValue;
+      },
+
+      select: function(element,newValue) {
+        var value = '', opt, index = element.selectedIndex;
+        for (var i=0;i< element.options.length;i++){
+          if (element.options[i].value == newValue){
+            element.selectedIndex = i;
+            return true;
+          }        
+        }
+      }
+    }
+
+    function unpackToForm(data){
+       for (i in data){
+         Form.Element.setValue(i,data[i].toString());
+       }
+    }
+
+</script>
+
+
+<style type="text/css">
+	/*reset.css*/
+	/* v1.0 | 20080212 */
+	html, body, div, span, applet, object, iframe,
+	h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+	a, abbr, acronym, address, big, cite, code,
+	del, dfn, em, font, img, ins, kbd, q, s, samp,
+	small, strike, strong, sub, sup, tt, var,
+	b, u, i, center,
+	dl, dt, dd, ol, ul, li,
+	fieldset, form, label, legend,
+	table, caption, tbody, tfoot, thead, tr, th, td {
+		margin: 0;
+		padding: 0;
+		border: 0;
+		outline: 0;
+		font-size: 100%;
+		vertical-align: baseline;
+		background: transparent;
+	}
+	body {
+		line-height: 1;
+	}
+	ol, ul {
+		list-style: none;
+	}
+	blockquote, q {
+		quotes: none;
+	}
+	blockquote:before, blockquote:after,
+	q:before, q:after {
+		content: '';
+		content: none;
+	}
+
+	/* remember to define focus styles! */
+	:focus {
+		outline: 0;
+	}
+
+	/* remember to highlight inserts somehow! */
+	ins {
+		text-decoration: none;
+	}
+	del {
+		text-decoration: line-through;
+	}
+
+	/* tables still need 'cellspacing="0"' in the markup */
+	table {
+		border-collapse: collapse;
+		border-spacing: 0;
+	}
+	/*clear fix*/
+	.clearfix:after{content:".";display:block;height:0;clear:both;visibility:hidden;}
+	.clearfix{display:inline-block;}
+	html[xmlns] .clearfix {
+	    display: block;
+	}
+	* html .clearfix{height:1%;}
+	/*start layout*/
+	body{
+		background:#fff;
+		color:#333;
+		font-size:75%;
+		font-family:Arial;
+		margin:2em auto;
+		line-height:1.5em;
+	}
+	textarea,input,select{
+		font-family:Arial;
+		font-size:1em;
+	}
+	h1{
+		color:#d46021;
+		font-size:2em;
+		margin-bottom:0.5em;
+	}
+	h2{
+		text-align:left;
+		color:#d46021;
+		font-size:1.3em;
+		padding-left:0;
+	}
+	a{
+		color:#2158C7;
+	}
+	div#container{
+		width:960px;
+		margin:0 auto;
+		font-size:1em;
+	}
+	/*paging*/
+	div.paging{
+		margin-bottom:1em;
+		text-align:left;
+	}
+	div.paging div{
+		border:solid 1px red;
+		margin:1em 1em 0;
+		padding:0.5em;
+		border:solid 1px #d5d6d5;
+		background:#f1f1f1;
+	}
+	ul.paging{
+		display:inline-block;
+	}
+	ul.paging li{
+		display:block;
+		margin:0.2em 0;
+		float:left;
+	}
+	ul.paging li.selected a{
+		color:#fff;
+		background:#2158C7;
+		font-weight:bold;
+		padding:0.5em 0.7em;
+	}
+	ul.paging li a{
+		display:inline-block;
+		line-height:1em;
+		padding:0.5em 0.5em;
+	}
+	/*forms filter*/
+	fieldset{
+		padding:1em;
+		margin:1em;
+		border:solid 2px #d46021;
+	}
+	legend{
+		font-size:1.2em;
+		font-weight:bold;
+		padding:0 1em;
+		padding-bottom:0.5em;
+	}
+	label{
+		font-weight:bold;
+	}
+	fieldset span{padding-right:0.5em;}
+	div#show-sort label,
+	div#languages label,
+	div#filter-pattern label{
+		display:inline-block;
+		width:100px;
+		line-height:2em;
+	}
+	div#show-sort select,
+	div#languages select,
+	div#filter-pattern select{
+		width:120px;
+		margin-right:0.5em;
+	}
+	div#show-sort input.text-default,
+	div#languages input.text-default,
+	div#filter-pattern input.text-default{
+		width:200px;
+	}
+	p.hits{
+		margin-top:1em;
+	}
+	/*translation edit*/
+	div.translations{
+		margin:1em;
+		padding:1em;
+		border:solid 2px #d46021;
+	}
+	div.translations h2{
+		margin-bottom:1em;
+	}
+	p.translate{
+		background:red;
+		border:solid 1px #d5d6d5;
+		background:#f1f1f1;
+		margin:0.5em;
+		padding:0.7em 0.5em 0.5em 1.5em;
+	}
+	div.translation{
+		padding:1em;
+		border-bottom:solid 0.2em #d46021;
+		margin:0 1em 1em 1.6em;
+	}
+	div.translation input, div.translation textarea{
+		width:98%;
+		margin:1em 0;
+		display:inline-block;
+		padding:0.3em;
+	}
+	div.translation textarea{
+		height:50px;
+	}
+	div.translation em strong{
+		color:#333;
+		padding-right:0.5em;
+	}
+	p.translation em{
+		display:block;
+		font-size:0.8333em;
+	}
+	div.translation a{
+		padding:1em;
+	}
+	div.translation input.btnDefault{
+		margin:0 0 1em;
+		width:auto;
+	}
+	.focus-text{
+		font-weight:bold;
+	}
+	div.selected{
+		margin:0 1em 1em 1em;
+		border-left:solid 0.6em #d46021;
+		border-right:solid 0.2em #d46021;
+		border-top:solid 0.2em #d46021;
+		background:#f1f1f1;
+	}
+	.display{display:block !important;}
+	/*feedback*/
+	div#notice, div#error {
+		font-size:1em;
+		margin:1em;
+    padding: 1em;
+  	border: 1px solid red;
+  }
+	div#notice span, div#error span{
+		font-size:1.5em;
+	}
+
+  div#error {
+    background-color: #F3C6CC;
+    color: red;
+  }
+  div#notice {
+    border-color: #72A974;
+    color: #597B5C;
+    background-color: #BCFFBD;
+  }
+    </style>
+	<script type="text/javascript">
+	onload = function (){
+		$$("div.translation input, div.translation textarea").each(function (e){
+			Event.observe(e,'focus', function (elm){
+				this.up(1).down(".translation-text").addClassName("focus-text");
+				this.up(1).addClassName("selected");
+			});
+			Event.observe(e,'blur', function (elm,e){
+				this.up(1).down(".translation-text").removeClassName("focus-text");
+				this.up(1).removeClassName("selected");
+			});
+		});
+	}
+	</script>
+  </head>
+  <body>
+		<div id="container">
+			<% if @page_title -%><h1><%=h @page_title %></h1><% end -%>
+			  <% [:notice, :error].each do |message| %>
+    		  <%if flash[message] %>
+      		<div id="<%= message %>">
+        			<span><%= h(flash[message]) if flash[message] %></span>
+      		</div>
+      		<% end %>
+    		<% end %>
+		<%= yield %>
+    </div>
+  </body>
+</html>