mongo_translatable 0.1.0

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongo_translatable"
+    gem.summary = %Q{MongoDB backed Rails specific I18n model localization meant to tie-in to existing ActiveRecord models}
+    gem.description = %Q{Rails specific I18n model localization meant to tie-in to existing ActiveRecord models, ala Globalize2, backed by MongoDB rather than an RDBMS. May include UI elements, too.}
+    gem.email = "walter@katipo.co.nz"
+    gem.homepage = "http://github.com/kete/mongo_translatable"
+    gem.authors = ["Walter McGinnis", "Kieran Pilkington", "Breccan McLeod-Lundy"]
+    gem.add_dependency "mongo_mapper", ">= 0.7.3"
+    gem.add_dependency "activerecord", "2.3.5"
+    gem.add_development_dependency "shoulda", ">= 2.10.3"
+    gem.add_development_dependency "factory_girl", "= 1.2.3"
+    gem.add_development_dependency "webrat", ">= 0.5.3"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  puts "This gem includes a full rails app for running tests (and staging development not yet extracted to the gem proper). Run tests there by changing to test/full_[RAIlS_VERSION_#_with_underscores]_app_with_tests and doing 'rake test'."
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongo_translatable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/app/controllers/translations_controller.rb

@@ -0,0 +1,150 @@
+class TranslationsController < ApplicationController
+  # Prevents the following error from showing up, common in Rails engines
+  # A copy of ApplicationController has been removed from the module tree but is still active!
+  unloadable
+
+  before_filter :set_translatable_key_and_class
+  # just being picky about contextual naming for clarity in variable's purpose
+  before_filter :get_translatable, :only => [:new, :create]
+  before_filter :get_translated, :except => [:new, :create]
+  before_filter :get_translation, :except => [:new, :index, :create]
+
+  # GET /translations
+  # GET /translations.xml
+  def index
+    @translations = @translated.translations
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @translations }
+    end
+  end
+
+  # GET /translations/1
+  # GET /translations/1.xml
+  def show
+    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 = @translatable.translate(:locale => (params[:to_locale] || I18n.locale.to_s))
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.js { render :layout => false } # needs to come after html for IE to work
+      format.xml  { render :xml => @translation }
+    end
+  end
+
+  # GET /translations/1/edit
+  def edit
+    @translation = @translated.translation_for(params[:id]) || @translatable_class::Translation.find(params[:id])
+  end
+
+  # POST /translations
+  # POST /translations.xml
+  def create
+    translation_params = params[:translation] || params[@translatable_params_name + '_translation']
+    @translation = @translatable.translate(translation_params)
+
+    respond_to do |format|
+      if @translation.save
+        flash[:notice] = t('translations.controllers.created')
+        # we redirect to translated object in the new translated version
+        # assumes controller name is tableized version of class
+        format.html { redirect_to url_for_translated }
+        # TODO: adjust :location accordingly for being a nested route
+        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
+    respond_to do |format|
+      translation_params = params[:translation] || params[@translatable_params_name + '_translation']
+      if @translation.update_attributes(translation_params)
+        flash[:notice] = t('translations.controllers.updated')
+        format.html { redirect_to url_for_translated }
+        format.xml  { head :ok }
+      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
+    return_to = params[:return_to_translated].present? && params[:return_to_translated] ? url_for_translated : { :action =>:index }
+    @translation.destroy
+
+    respond_to do |format|
+      flash[:notice] = t('translations.controllers.deleted')
+      format.html { redirect_to return_to }
+      format.xml  { head :ok }
+    end
+  end
+
+  protected
+  # accepts translation.locale or translation.id for lookup
+  # translation.locale should be unique within the scope of @translated
+  def get_translation
+    @translation = @translated.translation_for(params[:id]) || @translatable_class::Translation.find(params[:id])
+  end
+
+  %w{translatable translated}.each do |term|
+    define_method("get_" + term) do
+      value = @translatable_class.find(params[@translatable_key])
+
+      # handle case of editing translation from another locale than original
+      if value.locale != value.original_locale &&
+          params[:controller] == 'translations' &&
+          params[:action] == 'edit'
+        
+        starting_locale = I18n.locale
+      
+        I18n.locale = value.original_locale
+
+        value.reload
+
+        I18n.locale = starting_locale
+      end
+
+      instance_variable_set("@" + term, value)
+    end
+  end
+
+  # assuming nested routing, this should return exactly one params key
+  # and its matching class
+  def set_translatable_key_and_class
+    translatable_keys = params.keys.select { |key| key.to_s.include?('_id') }
+
+    translatable_keys.each do |key|
+      key = key.to_s
+      if key != 'translation_id' && request
+        key_singular = key.sub('_id', '')
+
+        # make sure this is found in the request url
+        # thus making this a nested route
+        # assumes plural version for controller name
+        if request.path.split('/').include?(key_singular.pluralize)
+          @translatable_class = key_singular.camelize.constantize
+          @translatable_key = key.to_sym
+          @translatable_params_name = key_singular
+          break
+        end
+      end
+    end
+  end
+end

data/app/helpers/translations_helper.rb

@@ -0,0 +1,71 @@
+module TranslationsHelper
+  # outputs a display of translatable attributes
+  # internationalized, assumes translation key is made up of the following
+  # @translatable.class.name.tablize (i.e. controller name for routing purposes)
+  # .
+  # form (i.e. template name used by new and edit actions in most cases for forms)
+  # .
+  # the_attribute_name (i.e. what the accessor method name is for attribute in question on the model)
+  # expects @translatable var or @translated var
+  # returns an array with a hash per attribute where the key is the label (internationalized)
+  # and the value for the attribute
+  mattr_accessor :available_locales
+  @@available_locales ||= YAML.load(IO.read(File.join(RAILS_ROOT, 'config/locales.yml')))
+
+  %w{untranslated translated}.each do |term|
+    define_method(term + '_values_with_localized_labels') do
+      set_original
+      raise "No object supplied to translate." if @original.blank?
+      raise "No matching translation available." if term == 'translated' && @translation.blank?
+
+      @original.translatable_attributes.collect do |attribute_key|
+        value = (term == 'untranslated') ? @original.send(attribute_key) : @translation[attribute_key]
+        { :attribute_key => attribute_key,
+          :localized_label => localized_label_for(attribute_key),
+          :value => modify_translation_value(value, @original) }
+      end
+    end
+  end
+
+  # We don't do anything here, just provide it for users to if they need it
+  def modify_translation_value(value, original_object)
+    value
+  end
+
+  def localized_label_for(attribute_key)
+    t(@translatable_class.name.tableize + '.' + 'form' + '.' + attribute_key.to_s)
+  end
+
+  def available_locales_for_options
+    @@available_locales.collect { |key,value| [value,key] }
+  end
+
+  def available_in_locales
+    set_original
+    list = @original.available_in_these_locales.collect do |locale|
+      link_to_unless_current(TranslationsHelper::available_locales[locale], url_for_translated(:locale => locale))
+    end
+    list = '<ul>' + '<li>' + list.join('</li><li>') + '</li>' + '</ul>'
+  end
+
+  def needed_in_locales
+    set_original
+    list = @original.needed_in_these_locales.collect do |locale|
+      link_to(TranslationsHelper::available_locales[locale],
+              :action => :new,
+              :controller => :translations,
+              @translatable_key => @original,
+              :to_locale => locale)
+    end
+    list = '<ul>' + '<li>' + list.join('</li><li>') + '</li>' + '</ul>'
+  end
+
+  def translatable_field_a_text_area?(form, translation_field)
+    form.object.translatable_class.columns_hash[translation_field.to_s].type == :text
+  end
+
+  private
+  def set_original
+    @original ||= @translatable || @translated
+  end
+end

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

@@ -0,0 +1,18 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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><%= controller.controller_name %>: <%= controller.action_name %></title>
+  <%= yield :add_on_scripts_and_links %>
+  <%= javascript_include_tag :defaults %>
+</head>
+<body>
+
+<p style="color: green"><%= flash[:notice] %></p>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/translations/_form.html.erb

@@ -0,0 +1,50 @@
+<% translatable = @translatable.present? ? @translatable : @translated %>
+<h2 style="margin:0 0 10px 0;">
+  <%= I18n.t('translations.form.translate_from_and_to',
+             :from => TranslationsHelper::available_locales[translatable.original_locale],
+             :to => TranslationsHelper::available_locales[h(@translation.locale)]) %>
+</h2>
+
+<%= form.error_messages %>
+<%= form.hidden_field :locale  %>
+<%= hidden_field_tag :version, params[:version] if params[:version] %>
+
+<!-- Use a table instead of floated divs because it gives better results in IE -->
+<table style="width: 98%;">
+  <tr>
+    <th colspan="2" style="width: 48%;">
+      <h3 style="margin:0 0 10px 0;"><%= TranslationsHelper::available_locales[translatable.original_locale] %></h3>
+    </th>
+    <th rowspan="<%= @translatable_class.translatable_attributes.size + 1 %>" style="width:1px; border-left: 1px solid #000; padding: 0; margin: 0"></th>
+    <th colspan="3" style="width: 48%;">
+      <h3 style="margin:0 0 10px 0;"><%= TranslationsHelper::available_locales[@translation.locale] %></h3>
+    </th>
+  </tr>
+
+  <% translatable_attributes = @translatable.present? ? @translatable.translatable_attributes : @translated.translatable_attributes
+     @untranslated_values_with_localized_labels = untranslated_values_with_localized_labels
+     -%>
+  <% translatable_attributes.each do |attribute_key| %>
+    <tr>
+      <% untranslated_value = @untranslated_values_with_localized_labels.find { |l| l[:attribute_key] == attribute_key }
+      locals = { :form => form, :untranslated_value => untranslated_value } %>
+      <%= render 'translatable_value', locals %>
+      <% if untranslated_value[:value].present? -%>
+        <%= render 'translation_field', locals.merge(:attribute_key => attribute_key) %>
+      <% else -%>
+        <td colspan="3" class="translatable_label_and_field" valign="top" style="padding: 5px;">
+	  <%= I18n.t('translations.form.original_has_no_value') -%>
+	</td>
+      <% end -%>
+    </tr>
+  <% end %>
+</table>
+
+<div class="make_translation" style="text-align: center; margin-top: 20px; width: 98%;">
+  <%= form.submit @button_text %>
+</div>
+
+<div class="translate_links" style="margin-top: 20px;">
+  <%= available_in_locales_for(@original, :lightbox => request.xhr?) %>
+  <%= needed_in_locales_for(@original, :lightbox => request.xhr?) %>
+</div>

data/app/views/translations/_translatable_value.html.erb

@@ -0,0 +1,17 @@
+<% if translatable_field_a_text_area?(form, untranslated_value[:attribute_key]) %>
+
+  <td colspan="2" class="original_label_and_value" valign="top" style="padding: 5px;">
+    <%= h(untranslated_value[:localized_label]) -%><br />
+    <%= h(untranslated_value[:value]) -%>
+  </td>
+
+<% else %>
+
+  <td class="original_label" valign="top" style="width: 10%; padding: 5px;">
+    <%= h(untranslated_value[:localized_label]) -%>
+  </td>
+  <td class="original_value" valign="top" style="padding: 5px;">
+    <%= h(untranslated_value[:value]) -%>
+  </td>
+
+<% end %>

data/app/views/translations/_translation_field.html.erb

@@ -0,0 +1,34 @@
+<% locals = { :form => form, :untranslated_value => untranslated_value, :attribute_key => attribute_key } %>
+
+<% if translatable_field_a_text_area?(form, attribute_key) %>
+
+  <td colspan="3" class="translatable_label_and_field" valign="top" style="padding: 5px;">
+    <%= form.label attribute_key, localized_label_for(attribute_key) %><br />
+    <%= render 'translation_field_input', locals %>
+  </td>
+
+<% else %>
+
+  <td class="translatable_label" valign="top" style="width: 10%; padding: 5px;">
+    <%= form.label attribute_key, localized_label_for(attribute_key) %>
+  </td>
+  <td class="translatable_value" valign="top" style="padding: 5px;">
+    <%= render 'translation_field_input', locals %>
+  </td>
+  <td class="translatable_auto_translate" valign="top" style='font-size:0.8em;'>
+    <% if MongoTranslatableConfiguration.provide_autotranslate -%>
+
+    <span class="translate_link_span"></span>
+    <% translate_link = link_to('[auto translate]', '#', :title => 'Auto Translate Using Google', :class => 'translate_link') %>
+    <%= javascript_tag("
+    $$('.translate_link_span').last().update(#{::ActiveSupport::JSON.encode(translate_link)});
+    $$('.translate_link').last().observe('click', function(event) {
+      getGoogleTranslation(this.up('tr').down('.translatable_value').down('input').id,
+                           '#{escape_javascript(h(untranslated_value[:value]))}',
+                           '#{I18n.locale}', '#{h(@translation.locale)}');
+      event.stop();
+    });") %>
+     <% end -%>
+  </td>
+
+<% end %>

data/app/views/translations/_translation_field_input.html.erb

@@ -0,0 +1,8 @@
+<%# assign the value of the untranslated field if this record is a new object %>
+<% form.object.send("#{attribute_key}=", untranslated_value[:value]) if form.object.new_record? %>
+
+<% if translatable_field_a_text_area?(form, attribute_key) %>
+  <%= form.text_area attribute_key, :rows => 7, :cols => 35 %>
+<% else %>
+  <%= form.text_field attribute_key %>
+<% end %>

data/app/views/translations/edit.html.erb

@@ -0,0 +1,8 @@
+<% @button_text = t("translations.edit.update") -%>
+
+<% form_for(@translation, :url => { :action => :update,
+@translatable_key => @translated, :id => @translation.locale }) do |f| %>
+
+<%= render :partial => f -%>
+
+<% end %>

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

@@ -0,0 +1,22 @@
+<% type = @translated.class.name.titleize.downcase -%>
+<h2 style="margin:0 0 10px 0;"><%= t("translations.index.title", :type => type) -%></h2>
+
+<ul>
+<% @translations.each do |translation| %>
+  <li>
+    <%= link_to(TranslationsHelper::available_locales[translation.locale], { :action => :show, :id => h(translation.locale) }) -%>
+    [ <%= link_to(t('translations.index.edit').downcase, { :id => h(translation.locale), :action => :edit }) -%> |
+      <%= link_to(t('translations.index.delete').downcase, { :id => h(translation.locale), :action => :destroy },
+                  { :method => :delete, :confirm => t('translations.index.are_you_sure') }) -%> ]
+  </li>
+<% end %>
+</ul>
+
+<ul style="list-style:none; padding:0; margin:0;">
+  <li style="float:left; padding: 0 5px;">
+    <%= link_to(t("translations.index.back", :type => type), url_for_translated) %>
+  </li>
+  <li style="float:left; padding: 0 5px; border-left: 1px solid #000;">
+    <%= link_to(t("translations.index.new"), { :action => :new }) %>
+  </li>
+</ul>