i18n_backend_database 0.0.1

data/LICENSE

@@ -0,0 +1,29 @@
+ * Copyright (c) 2008, 2009
+ *  ELC Technologies.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *  This product includes software developed by ELC Technologies
+ * 4. Neither the name of the Company nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.

data/README.textile

@@ -0,0 +1,125 @@
+h1. A Database Backend For Rails I18N
+
+Stores your translations in the database, rather than yaml files.  As you tag items with i18n.t() throughout your code base, all untranslated items are marked and added to the database.  An admin panel is provided so translators can quickly translate untranslated text.  All lookups occur in a cache store of your choice prior to hitting the database.
+
+h2. DISCLAIMER!
+
+* -In implementing this into another project, I realized that the currency support is currently broken.  It basically boils down to the i18n gem accessing some of the Rails i18n yaml's in a different way than others.  In this case, it's requesting a parent key, and expects a hash to be returned containing the children.  This is not baked in the plugin at the moment, and any contributions toward this would be well received.-  Thank you wlorentson!
+
+* The translations_controller is unprotected, and you'll probably want to add some kind of authorization filter to it to make sure the outside world can't access it.
+
+h2. Installation
+
+<pre>
+  <code>
+    script/generate i18n_backend_database       # add migration
+    rake db:migrate                             # migrate
+
+    rake i18n:populate:load_default_locales     # populate default locales
+    rake i18n:populate:from_rails               # populate the locales and translations tables from all Rails Locale YAML files.
+    rake i18n:populate:from_application         # populate the translation tables from translation calls within the application.
+    rake i18n:populate:synchronize_translations # create non-default locale translation records from default locale translations.
+    rake i18n:populate:all                      # run all populate tasks.
+    rake i18n:translate:google                  # translate all untranslated string values using Google Language Translation API.
+  </code>
+</pre>
+
+
+In config/initialisers/i18n.rb
+
+<pre>
+  <code>
+    I18n.backend = I18n::Backend::Database.new # registers the backend
+    I18n.backend.cache_store = :memory_store   # optional: specify an alternate cache store
+    I18n.backend.localize_text_tag = '##'      # optional: specify an alternate localize text tag, the default is ^^
+  </code>
+</pre>
+
+In config/routes.rb to register admin panel routes
+
+<pre>
+  <code>
+    map.from_plugin 'i18n_backend_database'
+  </code>
+</pre>
+
+h2. Use
+
+All non-user generated text provided by the application needs to be wrapped in a call to I18n.t().
+<pre>
+  <code>
+    I18n.t("Hello there!")
+  </code>
+</pre>
+
+Interpolation is handled by passing in key/value pairs as a value to an interpolation tag ( {{ }} ).
+<pre>
+  <code>
+    I18n.t("Hello there {{name}}!", :name => "Dylan")
+  </code>
+</pre><pre>
+  <code>
+    I18n.t("Click {{here}} or {{there}}", :here => "link_to(I18n.t('midnite'), croix_path)", :there => "link_to(I18n.t('staten_island'), wu_path)")
+  </code>
+</pre>
+
+Pluralization is handled by passing in a "count" key value pair, which is a unique interpolation value.
+<pre>
+  <code>
+    I18n.t("You are {{count}} years old", :count => 100)
+  </code>
+</pre>
+
+Links to external documents that need to be translated should be tagged as well.
+<pre>
+  <code>
+    I18n.t('http://www.elctech.com/core')
+    </code>
+  </pre>
+
+All fragment cache view blocks need to have their keys prepended with the current locale.
+<pre>
+  <code>
+    cache("#{I18n.locale}-footer_#{controller.action_name}")
+  </code>
+</pre>
+
+Date/Time localization is handled by using the I18n.l method.  The format used will be :default (see next item for explanation).
+<pre>
+  <code>
+    I18n.l(@user.joined_at)
+  </code>
+</pre>
+
+Date/Time localization can take a format parameter that corresponds to a key in the translations table (the Rails defaults :default, :short, and :long are available).  We could in theory create our own like en.date.formats.espn_default.
+<pre>
+  <code>
+    I18n.l(@user.joined_at, :format => :default)
+    I18n.l(@user.joined_at, :format => :short)
+    I18n.l(@user.joined_at, :format => :espn_default)
+  </code>
+</pre>
+
+Date/Time localization can take a custom format string as well.
+<pre>
+  <code>
+    I18n.l(@user.joined_at, :format => "%B %e, %Y")
+  </code>
+</pre>
+
+Text stored in a database can be localized by tagging the text being stored and then localizing in the view etc.
+<pre>
+  <code>
+    I18n.tlt("is now friends with") => "^^is now friends with^^"
+    I18n.lt("shane ^^is now friends with^^ dylan") => "shane ahora es con amigos dylan"
+  </code>
+</pre>
+
+Images can be translated with the I18n.ta tag
+<pre>
+  <code>
+    <%= image_tag(I18n.ta("logos/elc.gif"), :size => "134x75") %>
+    </code>
+  </pre>
+In this example, for a locale es, there should be an image: public/es/images/logos/elc.gif
+

data/data/locales.yml

@@ -0,0 +1,4 @@
+en:
+ name: English
+es:
+ name: Spanish

data/generators/i18n_backend_database/i18n_backend_database_generator.rb

@@ -0,0 +1,8 @@
+class I18nBackendDatabaseGenerator < Rails::Generator::Base
+  def manifest
+    record { |m|
+      m.migration_template "migrate/create_i18n_tables.rb", "db/migrate",
+        :migration_file_name => "create_i18n_tables"
+    }
+  end
+end

data/generators/i18n_backend_database/templates/migrate/create_i18n_tables.rb

@@ -0,0 +1,25 @@
+class CreateI18nTables < ActiveRecord::Migration
+  def self.up
+    create_table :locales do |t|
+      t.string   :code
+      t.string   :name
+    end
+    add_index :locales, :code
+
+    create_table :translations do |t|
+      t.string   :key
+      t.text     :raw_key
+      t.text     :value
+      t.integer  :pluralization_index, :default => 1
+      t.integer  :locale_id
+    end
+    add_index :translations, [:locale_id, :key, :pluralization_index]
+
+  end
+
+  def self.down
+    drop_table :locales
+    drop_table :translations
+    drop_table :asset_translations
+  end
+end

data/init.rb

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

data/lib/controllers/locales_controller.rb

@@ -0,0 +1,86 @@
+class LocalesController < ActionController::Base
+  prepend_view_path(File.join(File.dirname(__FILE__), "..", "views"))
+  # GET /locales
+  # GET /locales.xml
+  def index
+    @locales = Locale.find(:all)
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @locales }
+    end
+  end
+
+  # GET /locales/1
+  # GET /locales/1.xml
+  def show
+    @locale = Locale.find_by_code(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @locale }
+    end
+  end
+
+  # GET /locales/new
+  # GET /locales/new.xml
+  def new
+    @locale = Locale.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @locale }
+    end
+  end
+
+  # GET /locales/1/edit
+  def edit
+    @locale = Locale.find_by_code(params[:id])
+  end
+
+  # POST /locales
+  # POST /locales.xml
+  def create
+    @locale = Locale.new(params[:locale])
+
+    respond_to do |format|
+      if @locale.save
+        flash[:notice] = 'Locale was successfully created.'
+        format.html { redirect_to(@locale) }
+        format.xml  { render :xml => @locale, :status => :created, :location => @locale }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @locale.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /locales/1
+  # PUT /locales/1.xml
+  def update
+    @locale = Locale.find_by_code(params[:id])
+
+    respond_to do |format|
+      if @locale.update_attributes(params[:locale])
+        flash[:notice] = 'Locale was successfully updated.'
+        format.html { redirect_to(@locale) }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @locale.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /locales/1
+  # DELETE /locales/1.xml
+  def destroy
+    @locale = Locale.find_by_code(params[:id])
+    @locale.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(locales_url) }
+      format.xml  { head :ok }
+    end
+  end
+end

data/lib/controllers/translations_controller.rb

@@ -0,0 +1,141 @@
+class TranslationsController < ActionController::Base
+  prepend_view_path(File.join(File.dirname(__FILE__), "..", "views"))
+  layout 'translations'
+  before_filter :find_locale
+
+  ## FIXME:  you'll probably want add authorization to this controller!
+
+  # GET /translations
+  # GET /translations.xml
+  def index
+    @translations = @locale.translations.find(:all, :order => "raw_key, pluralization_index")
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @translations }
+    end
+  end
+
+  # GET /translations
+  # GET /translations.xml
+  def translations
+    @locale ||= Locale.default_locale
+    @translation_option = TranslationOption.find(params[:translation_option])
+
+    if @translation_option == TranslationOption.translated
+      @translations = @locale.translations.translated
+    else
+      @translations = @locale.translations.untranslated
+    end
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @translations }
+    end
+  end
+
+  # GET /asset_translations
+  # GET /asset_translations.xml
+  def asset_translations
+    @locale ||= Locale.default_locale
+    @translation_option = TranslationOption.find(params[:translation_option])
+
+    @asset_translations  = I18n.asset_translations
+    @untranslated_assets = I18n.untranslated_assets(@locale.code)
+    @percentage_translated =   (((@asset_translations.size - @untranslated_assets.size).to_f / @asset_translations.size.to_f * 100).round) rescue 0
+
+    if @translation_option == TranslationOption.translated
+      @asset_translations = @asset_translations.reject{|e| @untranslated_assets.include?(e)}
+    else
+      @asset_translations = @untranslated_assets
+    end
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @untranslated_assets }
+    end
+  end
+
+  # GET /translations/1
+  # GET /translations/1.xml
+  def show
+    @translation = @locale.translations.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @translation }
+    end
+  end
+
+  # GET /translations/new
+  # GET /translations/new.xml
+  def new
+    @translation = Translation.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @translation }
+    end
+  end
+
+  # GET /translations/1/edit
+  def edit
+    @translation = @locale.translations.find(params[:id])
+  end
+
+  # POST /translations
+  # POST /translations.xml
+  def create
+    @translation = @locale.translations.build(params[:translation])
+
+    respond_to do |format|
+      if @translation.save
+        flash[:notice] = 'Translation was successfully created.'
+        format.html { redirect_to locale_translation_path(@locale, @translation) }
+        format.xml  { render :xml => @translation, :status => :created, :location => @translation }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @translation.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /translations/1
+  # PUT /translations/1.xml
+  def update
+    @translation  = @locale.translations.find(params[:id])
+    @first_time_translating = @translation.value.nil?
+
+    respond_to do |format|
+      if @translation.update_attributes(params[:translation])
+        format.html do
+          flash[:notice] = 'Translation was successfully updated.'
+          redirect_to locale_translation_path(@locale, @translation)
+        end
+        format.xml  { head :ok }
+        format.js   {}
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @translation.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /translations/1
+  # DELETE /translations/1.xml
+  def destroy
+    @translation = @locale.translations.find(params[:id])
+    @translation.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(locale_translations_url) }
+      format.xml  { head :ok }
+    end
+  end
+
+  private
+
+    def find_locale
+      @locale = Locale.find_by_code(params[:locale_id])
+    end
+end

data/lib/ext/i18n.rb

@@ -0,0 +1,68 @@
+module I18n
+  APP_DIRECTORY = 'app/views'
+
+  class << self
+
+    def locale_segment
+      I18n.locale.to_s == I18n.default_locale.to_s ? "" : "/#{I18n.locale}"
+    end
+    alias :ls :locale_segment
+
+    def localize_text(text, options = {})
+      locale = options[:locale] || I18n.locale
+      backend.localize_text(locale, text)
+    end
+    alias :lt :localize_text
+
+    def tag_localized_text(text)
+      backend.localize_text_tag + text + backend.localize_text_tag
+    end
+    alias :tlt :tag_localized_text
+
+    def translate_asset(asset, options={})
+      locale = options.delete(:locale) || I18n.locale
+      if locale_asset = locale_asset(asset, locale)
+        locale_asset
+      else
+        asset
+      end
+    end
+    alias ta translate_asset
+
+    def untranslated_assets(locale)
+      return [] if locale.to_s == I18n.default_locale.to_s #default locale assets are assumed to exist
+      assets = asset_translations
+      assets.reject! {|asset| locale_asset_exists?(locale, asset) }
+      assets
+    end
+
+    def asset_translations(dir=APP_DIRECTORY)
+      assets = []
+      Dir.glob("#{dir}/*").each do |item|
+        if File.directory?(item)
+          assets += asset_translations(item)
+        else
+          File.readlines(item).each do |l|
+            assets += l.scan(/I18n.ta\(["'](.*?)["']\)/).flatten
+          end
+        end
+      end
+      assets.uniq
+    end
+
+    protected
+
+    def locale_asset_exists?(locale, asset)
+      File.exists?("#{ActionView::Helpers::AssetTagHelper::ASSETS_DIR}/#{locale}#{asset_path(asset)}")
+    end
+
+    def locale_asset(asset, locale)
+      locale_asset_exists?(locale, asset) ? "/#{locale}#{asset_path(asset)}" : nil
+    end
+
+    def asset_path(asset)
+      asset[0] == ?/ ? asset : "/images/#{asset}"
+    end
+
+  end
+end