tolk 1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2004-2010 David Heinemeier Hansson
+
+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,60 @@
+Tolk is a Rails 3 engine designed to facilitate the translators doing the dirty work of translating your application to other languages.
+
+* Installation & Setup
+
+To install add the following to your Gemfile:
+
+  gem 'tolk'
+
+To setup just run:
+
+  $ rake tolk:setup
+
+* Usage
+
+Tolk treats I18n.default_locale as the master source of strings to be translated. If you want the master source to be different from I18n.default_locale, you can override it by setting Tolk::Locale.primary_locale_name. Developers are expected to make all the changes to the master locale file ( en.yml by default ) and treat all the other locale.yml files as readonly files.
+
+As tolk stores all the keys and translated strings in the database, you need to ask Tolk to update it's database from the primary yml file :
+
+  $ rake tolk:sync
+  
+The above will fetch all the new keys from en.yml and put them in the database. Additionally, it'll also get rid of the deleted keys from the database and reflect updated translations - if any.
+
+If you already have data in your non primary locale files, you will need to import those to Tolk as a one time thing :
+
+  $ rake tolk:import
+
+Upon visiting http://your_app.com/tolk - you will be presented with different options like creating new locale or providing translations for the existing locales. Once done with translating all the pending strings, you are can write back the new locales to filesystem :
+
+  $ rake tolk:dump_all
+
+This will generate yml files for all non primary locales and put them in #{Rails.root}/config/locales/ directory by default.
+
+You can use the dump_all method defined in Tolk::Locale directly and pass directory path as the argument if you want the generated files to be at a different location :
+
+  $ script/runner "Tolk::Locale.dump_all('/Users/lifo')"
+
+You can even download the yml file using Tolk web interface by appending '.yml' to the locale url. E.g http://your_app.com/tolk/locales/de.yml
+
+* Authentication
+
+If you want to authenticate users who can access Tolk, you need to provide <tt>Tolk::ApplicationController.authenticator</tt> proc. For example :
+
+  # config/initializers/tolk.rb
+  Tolk::ApplicationController.authenticator = proc {
+    authenticate_or_request_with_http_basic do |user_name, password|
+      user_name == 'translator' && password == 'transpass'
+    end
+  }
+
+Authenticator proc will be run from a before filter in controller context.
+
+* Handling blank and non-string values
+
+Tolk speaks YAML for non strings values. If you want to enter a nil values, you could just enter '~'. Similarly, for an Array value, you could enter :
+
+---
+- Sun
+- Mon
+
+And Tolk will take care of generating the appropriate entry in the YAML file.

data/app/controllers/tolk/application_controller.rb

@@ -0,0 +1,17 @@
+module Tolk
+  class ApplicationController < ActionController::Base
+    helper :all
+    protect_from_forgery
+
+    cattr_accessor :authenticator
+    before_filter :authenticate
+
+    def authenticate
+      self.authenticator.bind(self).call if self.authenticator && self.authenticator.respond_to?(:call)
+    end
+
+    def ensure_no_primary_locale
+      redirect_to tolk_locales_path if @locale.primary?
+    end
+  end
+end

data/app/controllers/tolk/locales_controller.rb

@@ -0,0 +1,46 @@
+module Tolk
+  class LocalesController < Tolk::ApplicationController
+    before_filter :find_locale, :only => [:show, :all, :update, :updated]
+    before_filter :ensure_no_primary_locale, :only => [:all, :update, :show, :updated]
+
+    def index
+      @locales = Tolk::Locale.secondary_locales
+    end
+  
+    def show
+      respond_to do |format|
+        format.html do
+          @phrases = @locale.phrases_without_translation(params[:page])
+        end
+        format.atom { @phrases = @locale.phrases_without_translation(params[:page], :per_page => 50) }
+        format.yaml { render :text => @locale.to_hash.ya2yaml(:syck_compatible => true) }
+      end
+    end
+
+    def update
+      @locale.translations_attributes = params[:translations]
+      @locale.save
+      redirect_to request.referrer
+    end
+
+    def all
+      @phrases = @locale.phrases_with_translation(params[:page])
+    end
+
+    def updated
+      @phrases = @locale.phrases_with_updated_translation(params[:page])
+      render :all
+    end
+
+    def create
+      Tolk::Locale.create!(params[:tolk_locale])
+      redirect_to :action => :index
+    end
+
+    private
+
+    def find_locale
+      @locale = Tolk::Locale.find_by_name!(params[:id])
+    end
+  end
+end

data/app/controllers/tolk/searches_controller.rb

@@ -0,0 +1,15 @@
+module Tolk
+  class SearchesController < Tolk::ApplicationController
+    before_filter :find_locale
+  
+    def show
+      @phrases = @locale.search_phrases(params[:q], params[:scope].to_sym, params[:page])
+    end
+
+    private
+
+    def find_locale
+      @locale = Tolk::Locale.find_by_name!(params[:locale])
+    end
+  end
+end

data/app/helpers/tolk/application_helper.rb

@@ -0,0 +1,33 @@
+module Tolk
+  module ApplicationHelper
+    def format_i18n_value(value)
+      h(yaml_value(value)).gsub(/\n/, '<br />')
+    end
+
+    def format_i18n_text_area_value(value)
+      yaml_value(value)
+    end
+
+    def yaml_value(value)
+      if value.present?
+        unless value.is_a?(String)
+          value = value.respond_to?(:ya2yaml) ? value.ya2yaml(:syck_compatible => true) : value.to_yaml
+        end
+      end
+      
+      value
+    end
+
+    def tolk_locale_selection
+      existing_locale_names = Tolk::Locale.all.map(&:name)
+
+      pairs = Tolk::Locale::MAPPING.to_a.map(&:reverse).sort_by(&:first)
+      pairs.reject {|pair| existing_locale_names.include?(pair.last) }
+    end
+
+    def scope_selector_for(locale)
+      select_tag 'scope', options_for_select([[Tolk::Locale.primary_locale.language_name, "origin"],
+                                              [locale.language_name, "target"]], params[:scope])
+    end
+  end
+end

data/app/models/tolk/locale.rb

@@ -0,0 +1,246 @@
+module Tolk
+  class Locale < ActiveRecord::Base
+    set_table_name "tolk_locales"
+
+    MAPPING = {
+      'ar'    => 'Arabic',
+      'bs'    => 'Bosnian',
+      'bt'    => 'Bulgarian',
+      'ca'    => 'Catalan',
+      'cz'    => 'Czech',
+      'da'    => 'Danish',
+      'de'    => 'German',
+      'dsb'   => 'Lower Sorbian',
+      'el'    => 'Greek',
+      'en'    => 'English',
+      'es'    => 'Spanish',
+      'et'    => 'Estonian',
+      'fa'    => 'Persian',
+      'fi'    => 'Finnish',
+      'fr'    => 'French',
+      'he'    => 'Hebrew',
+      'hr'    => 'Croatian',
+      'hsb'   => 'Upper Sorbian',
+      'hu'    => 'Hungarian',
+      'id'    => 'Indonesian',
+      'is'    => 'Icelandic',
+      'it'    => 'Italian',
+      'jp'    => 'Japanese',
+      'ko'    => 'Korean',
+      'lo'    => 'Lao',
+      'lt'    => 'Lithuanian',
+      'lv'    => 'Latvian',
+      'mk'    => 'Macedonian',
+      'nl'    => 'Dutch',
+      'no'    => 'Norwegian',
+      'pl'    => 'Polish',
+      'pt-BR' => 'Portuguese (Brazilian)',
+      'pt-PT' => 'Portuguese (Portugal)',
+      'ro'    => 'Romanian',
+      'ru'    => 'Russian',
+      'se'    => 'Swedish',
+      'sk'    => 'Slovak',
+      'sl'    => 'Slovenian',
+      'sr'    => 'Serbian',
+      'sw'    => 'Swahili',
+      'th'    => 'Thai',
+      'tr'    => 'Turkish',
+      'uk'    => 'Ukrainian',
+      'vi'    => 'Vietnamese',
+      'zh'    => 'Chinese'
+    }
+
+    has_many :phrases, :through => :translations, :class_name => 'Tolk::Phrase'
+    has_many :translations, :class_name => 'Tolk::Translation', :dependent => :destroy
+    accepts_nested_attributes_for :translations, :reject_if => proc { |attributes| attributes['text'].blank? }
+    before_validation :remove_invalid_translations_from_target, :on => :update
+
+    cattr_accessor :locales_config_path
+    self.locales_config_path = "#{Rails.root}/config/locales"
+
+    cattr_accessor :primary_locale_name
+    self.primary_locale_name = I18n.default_locale.to_s
+
+    include Tolk::Sync
+    include Tolk::Import
+
+    validates_uniqueness_of :name
+    validates_presence_of :name
+
+    cattr_accessor :special_prefixes
+    self.special_prefixes = ['activerecord.attributes']
+
+    cattr_accessor :special_keys
+    self.special_keys = ['activerecord.models']
+
+    class << self
+      def primary_locale(reload = false)
+        @_primary_locale = nil if reload
+        @_primary_locale ||= begin
+          raise "Primary locale is not set. Please set Locale.primary_locale_name in your application's config file" unless self.primary_locale_name
+          find_or_create_by_name(self.primary_locale_name)
+        end
+      end
+
+      def primary_language_name
+        primary_locale.language_name
+      end
+
+      def secondary_locales
+        all - [primary_locale]
+      end
+
+      def dump_all(to = self.locales_config_path)
+        secondary_locales.each do |locale|
+          File.open("#{to}/#{locale.name}.yml", "w+") do |file|
+            data = locale.to_hash
+            data.respond_to?(:ya2yaml) ? file.write(data.ya2yaml(:syck_compatible => true)) : YAML.dump(locale.to_hash, file)
+          end
+        end
+      end
+
+      def special_key_or_prefix?(prefix, key)
+        self.special_prefixes.include?(prefix) || self.special_keys.include?(key)
+      end
+
+      PLURALIZATION_KEYS = ['zero', 'one', 'two', 'few', 'many', 'other']
+      def pluralization_data?(data)
+        keys = data.keys.map(&:to_s)
+        keys.all? {|k| PLURALIZATION_KEYS.include?(k) }
+      end
+    end
+
+    def has_updated_translations?
+      translations.count(:conditions => {:'tolk_translations.primary_updated' => true}) > 0
+    end
+
+    def phrases_with_translation(page = nil)
+      find_phrases_with_translations(page, :'tolk_translations.primary_updated' => false)
+    end
+
+    def phrases_with_updated_translation(page = nil)
+      find_phrases_with_translations(page, :'tolk_translations.primary_updated' => true)
+    end
+
+    def count_phrases_without_translation
+      existing_ids = self.translations.all(:select => 'tolk_translations.phrase_id').map(&:phrase_id).uniq
+      Tolk::Phrase.count - existing_ids.count
+    end
+
+    def phrases_without_translation(page = nil, options = {})
+      phrases = Tolk::Phrase.scoped(:order => 'tolk_phrases.key ASC')
+
+      existing_ids = self.translations.all(:select => 'tolk_translations.phrase_id').map(&:phrase_id).uniq
+      phrases = phrases.scoped(:conditions => ['tolk_phrases.id NOT IN (?)', existing_ids]) if existing_ids.present?
+
+      result = phrases.paginate({:page => page}.merge(options))
+      Tolk::Phrase.send :preload_associations, result, :translations
+      result
+    end
+
+    def search_phrases(query, scope, page = nil, options = {})
+      return [] unless query.present?
+
+      translations = case scope
+      when :origin
+        Tolk::Locale.primary_locale.translations.containing_text(query)
+      else # :target
+        self.translations.containing_text(query)
+      end
+
+      phrases = Tolk::Phrase.scoped(:order => 'tolk_phrases.key ASC')      
+      phrases = phrases.scoped(:conditions => ['tolk_phrases.id IN(?)', translations.map(&:phrase_id).uniq])
+      phrases.paginate({:page => page}.merge(options))
+    end
+    
+    def search_phrases_without_translation(query, page = nil, options = {})
+      return phrases_without_translation(page, options) unless query.present?
+      
+      phrases = Tolk::Phrase.scoped(:order => 'tolk_phrases.key ASC')
+
+      found_translations_ids = Tolk::Locale.primary_locale.translations.all(:conditions => ["tolk_translations.text LIKE ?", "%#{query}%"], :select => 'tolk_translations.phrase_id').map(&:phrase_id).uniq
+      existing_ids = self.translations.all(:select => 'tolk_translations.phrase_id').map(&:phrase_id).uniq
+      phrases = phrases.scoped(:conditions => ['tolk_phrases.id NOT IN (?) AND tolk_phrases.id IN(?)', existing_ids, found_translations_ids]) if existing_ids.present?
+
+      result = phrases.paginate({:page => page}.merge(options))
+      Tolk::Phrase.send :preload_associations, result, :translations
+      result
+    end
+
+    def to_hash
+      { name => translations.each_with_object({}) do |translation, locale|
+        if translation.phrase.key.include?(".")
+          locale.deep_merge!(unsquish(translation.phrase.key, translation.value))
+        else
+          locale[translation.phrase.key] = translation.value
+        end
+      end }
+    end
+
+    def to_param
+      name.parameterize
+    end
+
+    def primary?
+      name == self.class.primary_locale_name
+    end
+
+    def language_name
+      MAPPING[self.name] || self.name
+    end
+
+    def [](key)
+      if phrase = Tolk::Phrase.find_by_key(key)
+        t = self.translations.find_by_phrase_id(phrase.id)
+        t.text if t
+      end
+    end
+
+    def translations_with_html
+      translations = self.translations.all(:conditions => "tolk_translations.text LIKE '%>%' AND 
+        tolk_translations.text LIKE '%<%' AND tolk_phrases.key NOT LIKE '%_html'", :joins => :phrase)
+      Translation.send :preload_associations, translations, :phrase
+      translations
+    end
+
+    private
+
+    def remove_invalid_translations_from_target
+      self.translations.proxy_target.each do |t|
+        unless t.valid?
+          self.translations.proxy_target.delete(t)
+        else
+          t.updated_at = Time.current # Silly hax to fool autosave into saving the record
+        end
+      end
+
+      true
+    end
+
+    def find_phrases_with_translations(page, conditions = {})
+      result = Tolk::Phrase.paginate(:page => page,
+        :conditions => { :'tolk_translations.locale_id' => self.id }.merge(conditions),
+        :joins => :translations, :order => 'tolk_phrases.key ASC')
+
+      Tolk::Phrase.send :preload_associations, result, :translations
+
+      result.each do |phrase|
+        phrase.translation = phrase.translations.for(self)
+      end
+
+      result
+    end
+
+    def unsquish(string, value)
+      if string.is_a?(String)
+        unsquish(string.split("."), value)
+      elsif string.size == 1
+        { string.first => value }
+      else
+        key  = string[0]
+        rest = string[1..-1]
+        { key => unsquish(rest, value) }
+      end
+    end
+  end
+end

data/app/models/tolk/phrase.rb

@@ -0,0 +1,22 @@
+module Tolk
+  class Phrase < ActiveRecord::Base
+    set_table_name "tolk_phrases"
+
+    validates_uniqueness_of :key
+
+    cattr_accessor :per_page
+    self.per_page = 30
+
+    has_many :translations, :class_name => 'Tolk::Translation', :dependent => :destroy do
+      def primary
+        to_a.detect {|t| t.locale_id == Tolk::Locale.primary_locale.id}
+      end
+
+      def for(locale)
+        to_a.detect {|t| t.locale_id == locale.id}
+      end
+    end
+
+    attr_accessor :translation
+  end
+end