rails-i18nterface 0.1.0

data/config/routes.rb

@@ -0,0 +1,7 @@
+RailsI18nterface::Engine.routes.draw do
+  root :to => 'translate#index'
+
+  put '/translate' => 'translate#update'
+  get '/reload' => 'translate#reload', :as => 'translate_reload'
+  get '/export' => 'translate#export', :as => 'translate_export'
+end

data/db/migrate/20110921112044_create_translations.rb

@@ -0,0 +1,18 @@
+class CreateTranslations < ActiveRecord::Migration
+  def self.up
+    create_table :translations do |t|
+      t.string :locale
+      t.string :key
+      t.text   :value
+      t.text   :interpolations
+      t.boolean :is_proc, :default => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :translations
+  end
+end
+

data/lib/rails-i18nterface.rb

@@ -0,0 +1,8 @@
+require "rails-i18nterface/engine"
+require "rails-i18nterface/file"
+require "rails-i18nterface/keys"
+require "rails-i18nterface/log"
+require "rails-i18nterface/storage"
+
+module RailsI18nterface
+end

data/lib/rails-i18nterface/engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+
+module RailsI18nterface
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsI18nterface
+  end
+end

data/lib/rails-i18nterface/file.rb

@@ -0,0 +1,35 @@
+require 'fileutils'
+
+class RailsI18nterface::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(self.class.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/rails-i18nterface/keys.rb

@@ -0,0 +1,192 @@
+#require 'pathname'
+
+class RailsI18nterface::Keys
+  # Allows keys extracted from lookups in files to be cached
+  def self.files
+    @@files ||= new.files
+  end
+
+  def self.names
+    @@names || new.names
+  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 names
+    @names ||= build_namespaces
+  end
+  alias_method :to_tree, :names
+
+  def keys
+    files.keys
+  end
+  alias_method :to_a, :keys
+
+  def i18n_keys(locale)
+    I18n.backend.send(:init_translations) unless I18n.backend.initialized?
+    self.class.to_shallow_hash(I18n.backend.send(:translations)[locale.to_sym]).keys.sort
+  end
+
+  def untranslated_keys
+    self.class.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 = RailsI18nterface::Storage.file_paths(locale).inject({}) do |keys, path|
+      keys = keys.deep_merge(RailsI18nterface::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|
+      begin#hack to avoid UTF-8 error
+        IO.read(file).scan(i18n_lookup_pattern).flatten.map(&:to_sym).each do |key|
+          path = Pathname.new(File.expand_path(file)).relative_path_from(Pathname.new(Rails.root)).to_s
+          #puts path
+          if key[0] == '.'
+            key = guess_namespace(path) + key.to_s
+          end
+          #puts key
+          #puts
+          files[key] ||= []
+          files[key] << path if !files[key].include?(path)
+        end
+      rescue Exception => e
+        puts e.inspect
+        puts e.backtrace
+        puts "bug in Translation plugin, please debug, informations :"
+        puts file.inspect
+        puts i18n_lookup_pattern.inspect
+      end
+      files
+    end
+  end
+
+  def guess_namespace(path)
+    parts = path.split(/\//)
+    case parts[0]
+    when 'app'
+      parts.shift
+      if parts[0] == 'views'
+        parts.shift
+        parts[-1].gsub!(/\.(erb|haml|slim)$/,'')
+      end
+    end
+    parts.join('.')
+  end
+
+  def build_namespaces
+    i18n_keys
+  end
+
+  def i18n_lookup_pattern
+    /\b(?:I18n\.t|I18n\.translate|t)(?:\s|\():?(?:'|")(\.?[a-z0-9_\.]+)(?:'|")/
+  end
+
+  def files_to_scan
+    Dir.glob(File.join(RailsI18nterface::Storage.root_dir, "{app,config,lib}", "**","*.{rb,erb,haml,slim,rhtml}")) +
+      Dir.glob(File.join(RailsI18nterface::Storage.root_dir, "{public,app/assets}", "javascripts", "**","*.{js,coffee}"))
+  end
+end

data/lib/rails-i18nterface/log.rb

@@ -0,0 +1,35 @@
+class RailsI18nterface::Log
+  attr_accessor :from_locale, :to_locale, :keys
+
+  def initialize(from_locale, to_locale, keys)
+    self.from_locale = from_locale
+    self.to_locale = to_locale
+    self.keys = keys
+  end
+
+  def write_to_file
+    current_texts = File.exists?(file_path) ? file.read : {}
+    current_texts.merge!(from_texts)
+    file.write(current_texts)
+  end
+
+  def read
+    file.read
+  end
+
+  private
+  def file
+    @file ||= RailsI18nterface::File.new(file_path)
+  end
+
+  def from_texts
+    RailsI18nterface::File.deep_stringify_keys(RailsI18nterface::Keys.to_deep_hash(keys.inject({}) do |hash, key|
+      hash[key] = I18n.backend.send(:lookup, from_locale, key)
+      hash
+    end))
+  end
+
+  def file_path
+    File.join(Rails.root, "config", "locales", "log", "from_#{from_locale}_to_#{to_locale}.yml")
+  end
+end

data/lib/rails-i18nterface/storage.rb

@@ -0,0 +1,29 @@
+class RailsI18nterface::Storage
+  attr_accessor :locale
+
+  def initialize(locale)
+    self.locale = locale.to_sym
+  end
+
+  def write_to_file
+    RailsI18nterface::File.new(file_path).write(keys)
+  end
+
+  def self.file_paths(locale)
+    Dir.glob(File.join(root_dir, "config", "locales", "**","#{locale}.yml"))
+  end
+
+  def self.root_dir
+    Rails.root
+  end
+
+  private
+
+  def keys
+    {locale => I18n.backend.send(:translations)[locale]}
+  end
+
+  def file_path
+    File.join(self.class.root_dir, "config", "locales", "#{locale}.yml")
+  end
+end

data/lib/rails-i18nterface/version.rb

@@ -0,0 +1,3 @@
+module RailsI18nterface
+  VERSION = "0.1.0"
+end

data/lib/tasks/rails-i18nterface.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :translate do
+#   # Task goes here
+# end

data/spec/controllers/translate_controller_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe RailsI18nterface::TranslateController do
+  describe "index" do
+    before(:each) do
+      controller.stub!(:per_page).and_return(1)
+      I18n.backend.stub!(:translations).and_return(i18n_translations)
+      I18n.backend.instance_eval { @initialized = true }
+      keys = mock(:keys)
+      keys.stub!(:i18n_keys).and_return(['vendor.foobar'])
+      RailsI18nterface::Keys.should_receive(:new).and_return(keys)
+      RailsI18nterface::Keys.should_receive(:files).and_return(files)
+      I18n.stub!(:valid_locales).and_return([:en, :sv])
+      I18n.stub!(:default_locale).and_return(:sv)
+    end
+
+    it "shows sorted paginated keys from the translate from locale and extracted keys by default" do
+      get_page :index, use_route: 'rails-i18nterface'
+      assigns(:from_locale).should == :sv
+      assigns(:to_locale).should == :en
+      assigns(:files).should == files
+      assigns(:keys).sort.should == ['articles.new.page_title', 'home.page_title', 'vendor.foobar']
+      assigns(:paginated_keys).should == ['articles.new.page_title']
+    end
+
+    it "can be paginated with the page param" do
+      get_page :index, :page => 2, use_route: 'rails-i18nterface'
+      assigns(:files).should == files
+      assigns(:paginated_keys).should == ['home.page_title']
+    end
+
+    it "accepts a key_pattern param with key_type=starts_with" do
+      get_page :index, :key_pattern => 'articles', :key_type => 'starts_with', use_route: 'rails-i18nterface'
+      assigns(:files).should == files
+      assigns(:paginated_keys).should == ['articles.new.page_title']
+      assigns(:total_entries).should == 1
+    end
+
+    it "accepts a key_pattern param with key_type=contains" do
+      get_page :index, :key_pattern => 'page_', :key_type => 'contains', use_route: 'rails-i18nterface'
+      assigns(:files).should == files
+      assigns(:total_entries).should == 2
+      assigns(:paginated_keys).should == ['articles.new.page_title']
+    end
+
+    it "accepts a filter=untranslated param" do
+      get_page :index, :filter => 'untranslated', use_route: 'rails-i18nterface'
+      assigns(:total_entries).should == 2
+      assigns(:paginated_keys).should == ['articles.new.page_title']
+    end
+
+    it "accepts a filter=translated param" do
+      get_page :index, :filter => 'translated', use_route: 'rails-i18nterface'
+      assigns(:total_entries).should == 1
+      assigns(:paginated_keys).should == ['vendor.foobar']
+    end
+
+    it "accepts a filter=changed param" do
+      log = mock(:log)
+      old_translations = {:home => {:page_title => "Skapar ny artikel"}}
+      log.should_receive(:read).and_return(RailsI18nterface::File.deep_stringify_keys(old_translations))
+      RailsI18nterface::Log.should_receive(:new).with(:sv, :en, {}).and_return(log)
+      get_page :index, :filter => 'changed', use_route: 'rails-i18nterface'
+      assigns(:total_entries).should == 1
+      assigns(:keys).should == ["home.page_title"]
+    end
+
+    def i18n_translations
+      HashWithIndifferentAccess.new({
+        :en => {
+          :vendor => {
+            :foobar => "Foo Baar"
+          }
+        },
+        :sv => {
+          :articles => {
+            :new => {
+              :page_title => "Skapa ny artikel"
+            }
+          },
+          :home => {
+            :page_title => "Valkommen till I18n"
+          },
+          :vendor => {
+            :foobar => "Fobar"
+          }
+        }
+      })
+    end
+
+    def files
+      HashWithIndifferentAccess.new({
+        :'home.page_title' => ["app/views/home/index.rhtml"],
+        :'general.back' => ["app/views/articles/new.rhtml", "app/views/categories/new.rhtml"],
+        :'articles.new.page_title' => ["app/views/articles/new.rhtml"]
+      })
+    end
+  end
+
+  describe "translate" do
+    it "should store translations to I18n backend and then write them to a YAML file" do
+      session[:from_locale] = :sv
+      session[:to_locale] = :en
+      translations = {
+        :articles => {
+          :new => {
+            :title => "New Article"
+          }
+        },
+        :category => "Category"
+      }
+      key_param = {'articles.new.title' => "New Article", "category" => "Category"}
+      #I18n.backend.should_receive(:store_translations).with(:en, translations)
+      storage = mock(:storage)
+      storage.should_receive(:write_to_file)
+      RailsI18nterface::Storage.should_receive(:new).with(:en).and_return(storage)
+      log = mock(:log)
+      log.should_receive(:write_to_file)
+      RailsI18nterface::Log.should_receive(:new).with(:sv, :en, key_param.keys).and_return(log)
+      RailsI18nterface::Storage.stub!(:root_dir).and_return(i18n_files_dir)
+      put :update, key: key_param, version: 1, use_route: 'rails-i18nterface'
+      response.should be_redirect
+    end
+  end
+
+  def get_page(*args)
+    get(*args, use_route: 'rails-i18nterface')
+    response.should be_success
+  end
+
+  def i18n_files_dir
+    File.expand_path(File.join("..", "..", "..", "spec", "internal"), __FILE__)
+  end
+
+end