translate-rails3 0.1.0

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

@@ -0,0 +1,24 @@
+<% 
+  # Expects locals:
+  #
+  # total_entries
+  # per_page
+
+  n_pages = total_entries/per_page + (total_entries % per_page > 0 ? 1 : 0)
+  current_page = (params[:page] || 1).to_i
+%>
+
+<% if n_pages > 1 %>
+<h2>Pages:</h2>
+<div class="clearfix">
+	<ul class="paging">
+	  <% (1..n_pages).each do |page_number| %>
+	    <% if current_page == page_number %>
+	      <li class="selected"><%= link_to(page_number, params.merge(:page => page_number), :title => "Page #{page_number}" ) %></li>
+	    <% else %>
+	      <li><%= link_to(page_number, params.merge(:page => page_number), :title => "Page #{page_number}") %></li>
+	    <% end %>
+	  <% end %>
+	</ul>
+</div>
+<% end %>

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

@@ -0,0 +1,114 @@
+<%
+  @page_title = "Translate"
+  show_filters = ["all", "untranslated", "translated"]
+  show_filters << "changed" if @from_locale != @to_locale
+%>
+
+<fieldset>
+	<legend>Search filter</legend>
+	<div id="show-sort">
+		<p>
+		 <label>Show:</label> <%=  raw simple_filter(show_filters) %>
+		</p>
+		<p>
+		 <label>Sort by:</label> <%= raw simple_filter(["key", "text"], 'sort_by') %>
+		</p>
+	</div>
+  <%= form_tag(params, :method => :get) do %>
+  <div id="languages">
+   <p>
+     <%= hidden_field_tag(:filter, params[:filter]) %>
+     <%= hidden_field_tag(:sort_by, params[:sort_by]) %>
+     <label>Translate from</label>
+     <%= select_tag(:from_locale, options_for_select(I18n.available_locales, @from_locale.to_sym)) %> <span>to</span>
+     <%= select_tag(:to_locale, options_for_select(I18n.available_locales, @to_locale.to_sym)) %>
+     <%= submit_tag "Display" %>
+   </p>
+  </div>
+  <div id="filter-pattern">
+  <p>
+     <label for="key_pattern_value">Key</label>
+     <%= select_tag(:key_type, options_for_select([["contains", 'contains'], ["starts with", 'starts_with']], params[:key_type])) %>
+     <%= text_field_tag(:key_pattern, params[:key_pattern], :size => 50, :id => "key_pattern_value", :class => "text-default") %>
+   </p>
+   <p>
+     <label for="text_pattern_value">Text</label>
+     <%= select_tag(:text_type, options_for_select(['contains', 'equals'], params[:text_type])) %>
+     <%= text_field_tag(:text_pattern, params[:text_pattern], :size => 50, :id => "text_pattern_value", :class => "text-default") %>	     
+   </p>
+   <p>
+    <%= submit_tag "Search" %>
+    <%= link_to "clear", params.merge({:text_pattern => nil, :key_pattern => nil}) %>
+    </p>
+  </div>
+  <% end %>
+	<p class="hits">
+	  Found <strong><%= @total_entries %></strong> messages
+	</p>
+	<p>
+	 <%= link_to "Reload messages", translate_reload_path %>
+	</p>
+</fieldset>
+
+
+<div class="paging">
+  <%= render :partial => 'pagination', :locals => {:total_entries => @total_entries, :per_page => per_page} %>
+</div>
+
+<% if @total_entries > 0 %>
+<%= form_tag(translate_path) do %>
+  <div>
+      <%= hidden_field_tag(:filter, params[:filter], :id => "hid_filter") %>
+      <%= hidden_field_tag(:sort_by, params[:sort_by], :id => "hid_sort_by") %>
+      <%= hidden_field_tag(:key_type, params[:key_type], :id => "hid_key_type") %>
+      <%= hidden_field_tag(:key_pattern, params[:key_pattern], :id => "hid_key_pattern") %>
+      <%= hidden_field_tag(:text_type, params[:text_type], :id => "hid_text_type") %>
+      <%= hidden_field_tag(:text_pattern, params[:text_pattern], :id => "hid_text_pattern") %>
+  </div>
+  <div class="translations">
+	  <h2>Translations from <%= @from_locale %> to <%= @to_locale %></h2>
+    <p class="translate">
+	    <%= submit_tag "Save Translations" %>
+	  </p>
+	  <% @paginated_keys.each do |key| 
+	      from_text = lookup(@from_locale, key)
+	      to_text = lookup(@to_locale, key)
+	      line_size = 100
+	      n_lines = n_lines(from_text, line_size)
+	      field_name = "key[#{key}]"
+    %>
+	  <div class="translation">    
+		<% if from_text.present? %>
+		  <p class="translation-text">
+				<%= simple_format(h(from_text)) %>
+			</p>
+		<% end %>
+		<p class="edit-form">
+		<% if n_lines > 1 %>
+			<%= text_area_tag(field_name, to_text, :size => "#{line_size}x#{n_lines}", :id => key) %>
+		<% else %>
+			<%= text_field_tag(field_name, to_text, :size => line_size, :id => key) %>
+		<% end %>
+		</p>
+		<p>
+		  <em>
+			  <%= link_to_function 'Auto Translate', "getGoogleTranslation('#{key}', \"#{escape_javascript(from_text)}\", '#{@from_locale}', '#{@to_locale}')", :style => 'padding: 0; margin: 0;' %>
+			  <br/>
+			  <strong>Key:</strong><%=h key %><br/>
+			  <% if @files[key] %>
+				  <strong>File:</strong><%= @files[key].join("<br/>") %>
+			    <% end %>
+			</em>
+		</p>
+	</div>  
+<% end %>
+  <p class="translate">
+    <%= submit_tag "Save Translations" %>
+	</p>
+</div>
+<% end %>
+<% end %>
+
+<div class="paging">
+  <%= render :partial => 'pagination', :locals => {:total_entries => @total_entries, :per_page => per_page} %>
+</div>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  match 'translate' => 'translate#index', :as => :translate_list
+  match 'translate/translate' => 'translate#translate', :as => :translate
+  match 'translate/reload' => 'translate#reload', :as => :translate_reload
+end if Rails.env.development?

data/init.rb

@@ -0,0 +1 @@
+require 'translate'

data/lib/tasks/translate.rake

@@ -0,0 +1,178 @@
+require 'yaml'
+
+class Hash
+  def deep_merge(other)
+    # deep_merge by Stefan Rusterholz, see http://www.ruby-forum.com/topic/142809
+    merger = proc { |key, v1, v2| (Hash === v1 && Hash === v2) ? v1.merge(v2, &merger) : v2 }
+    merge(other, &merger)
+  end
+
+  def set(keys, value)
+    key = keys.shift
+    if keys.empty?
+      self[key] = value
+    else
+      self[key] ||= {}
+      self[key].set keys, value
+    end
+  end
+
+  if ENV['SORT']
+    # copy of ruby's to_yaml method, prepending sort.
+    # before each so we get an ordered yaml file
+    def to_yaml( opts = {} )
+      YAML::quick_emit( self, opts ) do |out|
+        out.map( taguri, to_yaml_style ) do |map|
+          sort.each do |k, v| #<- Adding sort.
+            map.add( k, v )
+          end
+        end
+      end
+    end
+  end
+end
+
+namespace :translate do
+  desc "Show untranslated keys for locale LOCALE"
+  task :untranslated => :environment do
+    from_locale = I18n.default_locale
+    untranslated = Translate::Keys.new.untranslated_keys
+
+    messages = []
+    untranslated.each do |locale, keys|
+      keys.each do |key|
+        from_text = I18n.backend.send(:lookup, from_locale, key)
+        messages << "#{locale}.#{key} (#{from_locale}.#{key}='#{from_text}')"
+      end
+    end
+      
+    if messages.present?
+      messages.each { |m| puts m }
+    else
+      puts "No untranslated keys"
+    end
+  end
+  
+  desc "Show I18n keys that are missing in the config/locales/default_locale.yml YAML file"
+  task :missing => :environment do
+    missing = Translate::Keys.new.missing_keys.inject([]) do |keys, (key, filename)|
+      keys << "#{key} in \t  #{filename} is missing"
+    end
+    puts missing.present? ? missing.join("\n") : "No missing translations in the default locale file"
+  end
+
+  desc "Remove all translation texts that are no longer present in the locale they were translated from"
+  task :remove_obsolete_keys => :environment do
+    I18n.backend.send(:init_translations)
+    master_locale = ENV['LOCALE'] || I18n.default_locale
+    Translate::Keys.translated_locales.each do |locale|
+      texts = {}
+      Translate::Keys.new.i18n_keys(locale).each do |key|
+        if I18n.backend.send(:lookup, master_locale, key).to_s.present?
+          texts[key] = I18n.backend.send(:lookup, locale, key)
+        end
+      end
+      I18n.backend.send(:translations)[locale] = nil # Clear out all current translations
+      I18n.backend.store_translations(locale, Translate::Keys.to_deep_hash(texts))
+      Translate::Storage.new(locale).write_to_file      
+    end
+  end
+
+  desc "Merge I18n keys from log/translations.yml into config/locales/*.yml (for use with the Rails I18n TextMate bundle)"
+  task :merge_keys => :environment do
+    I18n.backend.send(:init_translations)
+    new_translations = YAML::load(IO.read(File.join(Rails.root, "log", "translations.yml")))
+    raise("Can only merge in translations in single locale") if new_translations.keys.size > 1
+    locale = new_translations.keys.first
+
+    overwrites = false
+    Translate::Keys.to_shallow_hash(new_translations[locale]).keys.each do |key|
+      new_text = key.split(".").inject(new_translations[locale]) { |hash, sub_key| hash[sub_key] }
+      existing_text = I18n.backend.send(:lookup, locale.to_sym, key)
+      if existing_text && new_text != existing_text        
+        puts "ERROR: key #{key} already exists with text '#{existing_text.inspect}' and would be overwritten by new text '#{new_text}'. " +
+          "Set environment variable OVERWRITE=1 if you really want to do this."
+        overwrites = true
+      end
+    end
+
+    if !overwrites || ENV['OVERWRITE']
+      I18n.backend.store_translations(locale, new_translations[locale])
+      Translate::Storage.new(locale).write_to_file
+    end
+  end
+  
+  desc "Apply Google translate to auto translate all texts in locale ENV['FROM'] to locale ENV['TO']"
+  task :google => :environment do
+    raise "Please specify FROM and TO locales as environment variables" if ENV['FROM'].blank? || ENV['TO'].blank?
+
+    # Depends on httparty gem
+    # http://www.robbyonrails.com/articles/2009/03/16/httparty-goes-foreign
+    class GoogleApi
+      include HTTParty
+      base_uri 'ajax.googleapis.com'
+      def self.translate(string, to, from)
+        tries = 0
+        begin
+          get("/ajax/services/language/translate",
+            :query => {:langpair => "#{from}|#{to}", :q => string, :v => 1.0},
+            :format => :json)
+        rescue 
+          tries += 1
+          puts("SLEEPING - retrying in 5...")
+          sleep(5)
+          retry if tries < 10
+        end
+      end
+    end
+
+    I18n.backend.send(:init_translations)
+
+    start_at = Time.now
+    translations = {}
+    Translate::Keys.new.i18n_keys(ENV['FROM']).each do |key|
+      from_text = I18n.backend.send(:lookup, ENV['FROM'], key).to_s
+      to_text = I18n.backend.send(:lookup, ENV['TO'], key)
+      if !from_text.blank? && to_text.blank?
+        print "#{key}: '#{from_text[0, 40]}' => "
+        if !translations[from_text]
+          response = GoogleApi.translate(from_text, ENV['TO'], ENV['FROM'])
+          translations[from_text] = response["responseData"] && response["responseData"]["translatedText"]
+        end
+        if !(translation = translations[from_text]).blank?
+          translation.gsub!(/\(\(([a-z_.]+)\)\)/i, '{{\1}}')
+          # Google translate sometimes replaces {{foobar}} with (()) foobar. We skip these
+          if translation !~ /\(\(\)\)/
+            puts "'#{translation[0, 40]}'"
+            I18n.backend.store_translations(ENV['TO'].to_sym, Translate::Keys.to_deep_hash({key => translation}))
+          else
+            puts "SKIPPING since interpolations were messed up: '#{translation[0,40]}'"
+          end
+        else
+          puts "NO TRANSLATION - #{response.inspect}"
+        end
+      end
+    end
+    
+    puts "\nTime elapsed: #{(((Time.now - start_at) / 60) * 10).to_i / 10.to_f} minutes"    
+    Translate::Storage.new(ENV['TO'].to_sym).write_to_file
+  end
+
+  desc "List keys that have changed I18n texts between YAML file ENV['FROM_FILE'] and YAML file ENV['TO_FILE']. Set ENV['VERBOSE'] to see changes"
+  task :changed => :environment do
+    from_hash = Translate::Keys.to_shallow_hash(Translate::File.new(ENV['FROM_FILE']).read)
+    to_hash = Translate::Keys.to_shallow_hash(Translate::File.new(ENV['TO_FILE']).read)
+    from_hash.each do |key, from_value|
+      if (to_value = to_hash[key]) && to_value != from_value
+        key_without_locale = key[/^[^.]+\.(.+)$/, 1]
+        if ENV['VERBOSE']
+          puts "KEY: #{key_without_locale}"
+          puts "FROM VALUE: '#{from_value}'"
+          puts "TO VALUE: '#{to_value}'"
+        else
+          puts key_without_locale
+        end
+      end      
+    end
+  end
+end

data/lib/translate.rb

@@ -0,0 +1,8 @@
+module Translate
+  class Engine < Rails::Engine
+  end if defined?(Rails) && Rails::VERSION::MAJOR == 3
+end
+
+Dir[File.join(File.dirname(__FILE__), "translate", "*.rb")].each do |file|
+  require file
+end

data/lib/translate/file.rb

@@ -0,0 +1,35 @@
+require 'fileutils'
+
+class Translate::File
+  attr_accessor :path
+  
+  def initialize(path)
+    self.path = path
+  end
+  
+  def write(keys)
+    FileUtils.mkdir_p File.dirname(path)
+    File.open(path, "w") do |file|
+      file.puts keys_to_yaml(Translate::File.deep_stringify_keys(keys))
+    end    
+  end
+  
+  def read
+    File.exists?(path) ? YAML::load(IO.read(path)) : {}
+  end
+
+  # Stringifying keys for prettier YAML
+  def self.deep_stringify_keys(hash)
+    hash.inject({}) { |result, (key, value)|
+      value = deep_stringify_keys(value) if value.is_a? Hash
+      result[(key.to_s rescue key) || key] = value
+      result
+    }
+  end
+  
+  private
+  def keys_to_yaml(keys)
+    # Using ya2yaml, if available, for UTF8 support
+    keys.respond_to?(:ya2yaml) ? keys.ya2yaml(:escape_as_utf8 => true) : keys.to_yaml
+  end    
+end

data/lib/translate/keys.rb

@@ -0,0 +1,152 @@
+require 'pathname'
+
+class Translate::Keys
+  # Allows keys extracted from lookups in files to be cached
+  def self.files
+    @@files ||= Translate::Keys.new.files
+  end
+  
+  # Allows flushing of the files cache
+  def self.files=(files)
+    @@files = files
+  end
+  
+  def files
+    @files ||= extract_files
+  end  
+  alias_method :to_hash, :files
+  
+  def keys
+    files.keys
+  end
+  alias_method :to_a, :keys
+
+  def i18n_keys(locale)
+    I18n.backend.send(:init_translations) unless I18n.backend.initialized?
+    Translate::Keys.to_shallow_hash(I18n.backend.send(:translations)[locale.to_sym]).keys.sort
+  end
+
+  def untranslated_keys
+    Translate::Keys.translated_locales.inject({}) do |missing, locale|
+      missing[locale] = i18n_keys(I18n.default_locale).map do |key|
+        I18n.backend.send(:lookup, locale, key).nil? ? key : nil
+      end.compact
+      missing
+    end
+  end
+
+  def missing_keys
+    locale = I18n.default_locale; yaml_keys = {}
+    yaml_keys = Translate::Storage.file_paths(locale).inject({}) do |keys, path|
+      keys = keys.deep_merge(Translate::File.new(path).read[locale.to_s])
+    end
+    files.reject { |key, file| self.class.contains_key?(yaml_keys, key) }
+  end
+
+  def self.translated_locales
+    I18n.available_locales.reject { |locale| [:root, I18n.default_locale.to_sym].include?(locale) }        
+  end
+
+  # Checks if a nested hash contains the keys in dot separated I18n key.
+  #
+  # Example:
+  #
+  # hash = {
+  #   :foo => {
+  #     :bar => {
+  #       :baz => 1
+  #     }
+  #   }
+  # }
+  #
+  # contains_key?("foo", key) # => true
+  # contains_key?("foo.bar", key) # => true
+  # contains_key?("foo.bar.baz", key) # => true
+  # contains_key?("foo.bar.baz.bla", key) # => false
+  #
+  def self.contains_key?(hash, key)
+    keys = key.to_s.split(".")
+    return false if keys.empty?
+    !keys.inject(HashWithIndifferentAccess.new(hash)) do |memo, key|
+      memo.is_a?(Hash) ? memo.try(:[], key) : nil
+    end.nil?
+  end
+  
+  # Convert something like:
+  # 
+  # {
+  #  :pressrelease => {
+  #    :label => {
+  #      :one => "Pressmeddelande"
+  #    }
+  #   }
+  # }
+  # 
+  # to:
+  # 
+  #  {'pressrelease.label.one' => "Pressmeddelande"}
+  #
+  def self.to_shallow_hash(hash)
+    hash.inject({}) do |shallow_hash, (key, value)|
+      if value.is_a?(Hash)
+        to_shallow_hash(value).each do |sub_key, sub_value|
+          shallow_hash[[key, sub_key].join(".")] = sub_value
+        end
+      else
+        shallow_hash[key.to_s] = value
+      end
+      shallow_hash
+    end
+  end
+  
+  # Convert something like:
+  # 
+  #  {'pressrelease.label.one' => "Pressmeddelande"}
+  # 
+  # to:
+  # 
+  # {
+  #  :pressrelease => {
+  #    :label => {
+  #      :one => "Pressmeddelande"
+  #    }
+  #   }
+  # }
+  def self.to_deep_hash(hash)    
+    hash.inject({}) do |deep_hash, (key, value)|
+      keys = key.to_s.split('.').reverse
+      leaf_key = keys.shift
+      key_hash = keys.inject({leaf_key.to_sym => value}) { |hash, key| {key.to_sym => hash} }
+      deep_merge!(deep_hash, key_hash)
+      deep_hash
+    end
+  end
+
+  # deep_merge by Stefan Rusterholz, see http://www.ruby-forum.com/topic/142809
+  def self.deep_merge!(hash1, hash2)
+    merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+    hash1.merge!(hash2, &merger)
+  end
+
+  private
+
+  def extract_files
+    files_to_scan.inject(HashWithIndifferentAccess.new) do |files, file|
+      IO.read(file).scan(i18n_lookup_pattern).flatten.map(&:to_sym).each do |key|
+        files[key] ||= []
+        path = Pathname.new(File.expand_path(file)).relative_path_from(Pathname.new(Rails.root)).to_s
+        files[key] << path if !files[key].include?(path)
+      end
+      files
+    end
+  end
+
+  def i18n_lookup_pattern
+    /\b(?:I18n\.t|I18n\.translate|t)(?:\s|\():?'([a-z0-9_]+.[a-z0-9_.]+)'\)?/
+  end
+
+  def files_to_scan
+    Dir.glob(File.join(Translate::Storage.root_dir, "{app,config,lib}", "**","*.{rb,erb,rhtml}")) +
+      Dir.glob(File.join(Translate::Storage.root_dir, "public", "javascripts", "**","*.js"))
+  end
+end