kete_translatable_content 0.1.0

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "kete_translatable_content"
+    gem.summary = %Q{An add-on to the Kete application to provide content translations.}
+    gem.description = %Q{Kete Translatable Content is a gem that is an add-on for Kete web applications that takes advantage of the mongo_translatable gem functionality. As you would expect, you use it to add the ability to translate content in your Kete web site.}
+    gem.email = "walter@katipo.co.nz"
+    gem.homepage = "http://github.com/kete/kete_translatable_content"
+    gem.authors = ["Walter McGinnis", "Kieran Pilkington", "Breccan McLeod-Lundy"]
+    gem.add_development_dependency "mongo_translatable", ">= 0"
+    gem.files.exclude 'test/kete_test_app'
+    gem.test_files.exclude 'test/kete_test_app'
+    # 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 needs to be tested in the context of a full kete app. See README for details about how to generate and run tests."
+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 = "kete_translatable_content #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/app/views/active_scaffold_overrides/_show.html.erb

@@ -0,0 +1,8 @@
+<% if kete_translatable_content? -%>
+  <div id="translations-links">
+    <%= available_in_locales_for(@record) -%>
+    <%= needed_in_locales_for(@record, :lightbox => true) -%>
+  </div>
+<% end -%>
+
+<%= render :super %>

data/app/views/active_scaffold_overrides/_update_form.html.erb

@@ -0,0 +1,8 @@
+<% if kete_translatable_content? -%>
+  <div id="translations-links">
+    <%= available_in_locales_for(@record) -%>
+    <%= needed_in_locales_for(@record, :lightbox => true) -%>
+  </div>
+<% end -%>
+
+<%= render :super %>

data/app/views/active_scaffold_overrides/list.html.erb

@@ -0,0 +1,5 @@
+<%# ActiveScaffold uses AJAX to load partials, so we need to do these now, on page load %>
+<%= translatable_lightbox_js_and_css %>
+<%= google_auto_translatable_js %>
+
+<%= render :super %>

data/app/views/baskets/_additional_footer_content_fields.html.erb

@@ -0,0 +1,33 @@
+<div class="form-element">
+  <label><%=t 'baskets.appearance.additional_footer_content' %></label>
+  <fieldset>
+   <% if  current_value_of('additional_footer_content') 
+      footer_setting = @basket._configurable_settings.find_by_name('additional_footer_content')
+      -%>
+        <div class="translations-controls">
+          <%= available_in_locales_for(footer_setting) -%>
+          <%= needed_in_locales_for(footer_setting, :lightbox => true) -%>
+        </div>
+    <% end -%>
+    
+    <div class="form-element">
+      <%= text_area 'settings', 'additional_footer_content', :rows => 7, :cols => 30, :class => 'mceEditor', :value => current_value_of('additional_footer_content') -%>
+    </div>
+    <div class="form_example">
+      <%=t 'baskets.appearance.additional_footer_content_security' %>
+      <%=t 'baskets.appearance.additional_footer_content_security_admin' if @site_admin %>
+    </div>
+    <% if @site_admin -%>
+    <div class="form-element">
+      <%= check_box 'settings', 'do_not_sanitize_footer_content', {:checked => (current_value_of('do_not_sanitize_footer_content') == true), :tabindex => '1'}, 'true', 'false' %>
+      <label for="settings_do_not_sanitize_footer_content" class="inline"><%=t 'baskets.appearance.additional_footer_content_exception' %></label><br />
+    </div>
+    <% end -%>
+    <div class="form-element">
+      <%= check_box 'settings', 'replace_existing_footer', {:checked => (current_value_of('replace_existing_footer') == true), :tabindex => '1'}, 'true', 'false' -%>
+      <label for="settings_replace_existing_footer" class="inline"><%=t 'baskets.appearance.additional_footer_content_replace' %></label>
+      <div class="form_example"><%=t 'baskets.appearance.additional_footer_content_replace_example' %></div>
+    </div>
+    
+  </fieldset>
+</div>

data/app/views/baskets/_rss_feed.html.erb

@@ -0,0 +1,42 @@
+<% rss_feed ||= nil %>
+
+<div class="basket_rss_feed">
+   <% if  rss_feed -%>
+     <div class="translations-controls">
+      <%= available_in_locales_for(rss_feed) -%>
+      <%= needed_in_locales_for(rss_feed, :lightbox => true) -%>
+     </div>
+   <% end -%>
+  <table>
+    <tr>
+      <th title="<%= t('baskets.rss_feed.title_description') %>"><%= t('baskets.rss_feed.title') %></th>
+      <td colspan="3">
+        <%= text_field_tag "#{field_name_prefix}[][title]", (rss_feed.title if rss_feed), :size => 45 %>
+        <span class="remove_feed_link_span"></span>
+        <% remove_feed_link = link_to(t('baskets.rss_feed.remove_feed'), '#', :class => 'remove_feed_link') %>
+        <%= javascript_tag("
+        $$('.remove_feed_link_span').last().update(#{::ActiveSupport::JSON.encode(remove_feed_link)});
+        $$('.remove_feed_link').last().observe('click', function(event) {
+          this.up('div.basket_rss_feed').remove(); event.stop();
+        });") %>
+      </td>
+    </tr>
+    <tr>
+      <th title="<%= t('baskets.rss_feed.url_description') %>"><%= t('baskets.rss_feed.url') %></th>
+      <td colspan="3"><%= text_field_tag "#{field_name_prefix}[][url]", (rss_feed.url if rss_feed), :size => 45 %></td>
+    </tr>
+    <tr>
+      <th title="<%= t('baskets.rss_feed.limit_description') %>"><%= t('baskets.rss_feed.limit') %></th>
+      <td>
+        <%= text_field_tag "#{field_name_prefix}[][limit]", (rss_feed.limit if rss_feed), :size => 4 %>
+        (<%= t('baskets.rss_feed.optional') %>)
+      </td>
+
+      <th title="<%= t('baskets.rss_feed.update_frequency_description') %>"><%= t('baskets.rss_feed.update_frequency') %></th>
+      <td>
+        <%= text_field_tag "#{field_name_prefix}[][update_frequency]", (rss_feed.update_frequency if rss_feed), :size => 4 %>
+        (<%= t('baskets.rss_feed.in_minutes') %> - <%= t('baskets.rss_feed.optional') %>)
+      </td>
+    </tr>
+  </table>
+</div>

data/app/views/baskets/_side_bar_html.html.erb

@@ -0,0 +1,19 @@
+<% if  @basket.index_page_extra_side_bar_html.present? -%>
+   <div class="translations-controls">
+     <%= available_in_locales_for(@basket) -%>
+     <%= needed_in_locales_for(@basket, :lightbox => true) -%>
+  </div>
+<% end -%>
+<div class="form-element">
+  <%= form.text_area :index_page_extra_side_bar_html, {:class => "mceEditor", :cols => 120, :rows => 10, :tabindex => '1'} %>
+</div>
+<div class="form_example">
+  <%=t 'baskets.homepage_form.security_warning' %>
+  <%=t 'baskets.homepage_form.security_warning_admin' if @site_admin %>
+</div>
+<% if @site_admin -%>
+<div class="form-element">
+  <%= form.check_box :do_not_sanitize, :tabindex => '1' %>
+  <label for="basket_do_not_sanitize" class="inline"><%=t 'baskets.homepage_form.security_exception_example' %></label><br />
+</div>
+<% end -%>

data/app/views/configure/section.rhtml

@@ -0,0 +1,36 @@
+<div id="<%= h(@section) -%>">
+  <% if flash[:error].present? -%>
+  <div><%=h flash[:error] %></div>
+  <% end -%>
+  <fieldset>
+    <% form_remote_tag :url => { :action => 'update', :section => @section } do %>
+    <% for @setting in @settings -%>
+    <% if @setting.name != 'Is Configured' and (@advanced or !@setting.technically_advanced) -%>
+    <%= error_messages_for :setting %>
+    <div class="form-element">
+      <% if Kete.is_configured? && @setting.takes_translations? -%>
+        <div id="translations-links">
+          <%= available_in_locales_for(@setting) -%>
+          <%= needed_in_locales_for(@setting, :lightbox => false) -%>
+        </div>
+      <% end -%>
+      <label <% if @setting.required_to_be_configured -%>class="required" <% end -%>for="@setting"><%= h(@setting.name) -%>:</label><br />
+      <% fields_for "setting[]" do |f| %>
+      <%= f.text_field :value %>
+      <div class="form_example">
+        <%= @setting.explanation %>
+      </div>
+      <% end -%>
+    </div>
+    <% else -%>
+    <% fields_for "setting[]" do |f| %>
+    <%= f.hidden_field :value %>
+    <% end -%>
+    <% end -%>
+
+    <% end -%>
+    <p><%= submit_tag t('configure.section.save') %>
+    <%= link_to_close_redbox t('configure.section.cancel') if IS_CONFIGURED %></p>
+    <% end -%>
+  </fieldset>
+</div>

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

@@ -0,0 +1 @@
+<%= render :file => 'layouts/application' %>

data/app/views/topics/_content_wrapper_start.rhtml

@@ -0,0 +1,26 @@
+<% style_classes ||= nil -%>
+<div id="content-wrapper" <%= " class=\"#{style_classes}\"" unless style_classes.blank? %>>
+  <% if show_basket_list_naviation_menu? -%>
+  <div id="basket-list-column">
+    <div class="secondary-content-section-wrapper basket-list-column">
+      <div id="basket-list-column-content" class="secondary-content-section">
+        <h2 class="basket-list-headline"><%=t 'topics.content_wrapper_start.baskets' %></h2>
+        <%= render_baskets_as_menu %>
+        <div class="secondary-content-section-footer-wrapper"><div class="secondary-content-section-footer">&nbsp;</div></div>
+      </div>
+    </div>
+  </div>
+  <% end -%>
+  <div id="main-content-wrapper">
+    <div id="main-content-container">
+      <a name="main-content"></a>
+      <% if !%w(configure topics images video audio documents web_links comments).include?(params[:controller]) && kete_translatable_content? && !['appearance', 'homepage_options'].include?(params[:action]) -%>
+        <div id="translate-controls">
+            <%= available_in_locales_for(current_translatable_record) -%>
+            <%= needed_in_locales_for(current_translatable_record, :lightbox => true) -%>
+        </div>
+      <% elsif %w(topics images video audio documents web_links).include?(params[:controller]) && kete_translatable_content? -%>
+        <%= combined_tranlation_links -%>
+      <% end -%>
+
+        

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

@@ -0,0 +1,54 @@
+<% translatable = @translatable.present? ? @translatable : @translated
+   translatable_attributes = translatable.translatable_attributes -%>
+
+<%= I18n.t('translations.form.instructions') if @translation.new_record? -%>
+
+<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_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>
+
+  <% @untranslated_values_with_localized_labels =  untranslated_values_with_localized_labels
+     @old_translation = translatable.translation_for(params[:to_locale]) -%>
+
+  <% 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,36 @@
+<% value = untranslated_value[:value]
+   is_multiple = value.is_a?(Array) ? true : false -%>
+
+<% 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 />
+    <% if [:description,
+       :index_page_extra_side_bar_html].include?(untranslated_value[:attribute_key]) ||
+       (form.object.translatable_class == ConfigurableSetting && form.object.translatable.name == 'additional_footer_content') -%>
+      <%= value = sanitize(value) -%>
+    <% else -%>
+      <% if is_multiple -%>
+        <% values = value.collect { |v| h(v) } -%>
+	<%= values.to_sentence -%>
+      <% else -%>
+        <%= h(value) -%>
+      <% end -%>
+    <% end -%>
+  </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;">
+    <% if is_multiple -%>
+      <% values = value.collect { |v| h(v) } -%>
+      <%= values.to_sentence -%>
+    <% else -%>
+      <%= h(value) -%>
+    <% end -%>
+  </td>
+
+<% end %>

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

@@ -0,0 +1,61 @@
+<% is_multiple = false
+   class_key = form.object.translatable.class.as_foreign_key_sym.to_s.sub('_id', '')
+   multiple_field_name = class_key + '_translation' + "[#{attribute_key}][]"
+   starting_value = nil
+-%>
+
+<%# Override to add the mceEditor class to the textarea tag for certain fields %>
+
+<%# assign the value of the untranslated field if this record is a new object %>
+<% if form.object.new_record?
+     if @old_translation.present?
+       starting_value = @old_translation.send(attribute_key)
+     else
+       starting_value = untranslated_value[:value]
+     end
+     
+     is_multiple = true if starting_value.is_a?(Array)
+
+     form.object.send("#{attribute_key}=", starting_value)
+
+   end 
+-%>
+
+<% if translatable_field_a_text_area?(form, attribute_key) %>
+  <%
+     is_tiny_mce_editor = false
+     dimensions = {:height => 7, :width => 35 }
+     if (ITEM_CLASSES.include?(form.object.translatable_class.name) && attribute_key == :description) ||
+         (form.object.translatable_class == Basket && attribute_key ==  :index_page_extra_side_bar_html) ||
+         (form.object.translatable_class == ConfigurableSetting && form.object.translatable.name == 'additional_footer_content')
+       is_tiny_mce_editor = true
+       dimensions[:height] = 35
+       dimensions[:width] = 40
+     end
+   %>
+
+  <% if is_multiple -%>
+    <%  starting_value.each do |instance_value| -%>
+      <%= text_area_tag multiple_field_name,
+  	  instance_value,
+	  :rows => dimensions[:height], :cols => dimensions[:width], :class => ("mceEditor" if is_tiny_mce_editor) %>
+      <% end -%>
+  <% else -%>
+    <%= form.text_area attribute_key, :rows => dimensions[:height], :cols => dimensions[:width], :class => ("mceEditor" if is_tiny_mce_editor) %>
+  <% end -%>
+
+  <% if request.xhr? && is_tiny_mce_editor && !@tiny_mce_editor_initialized %>
+    <%= tiny_mce_init %>
+    <% @tiny_mce_editor_initialized = true %>
+  <% end %>
+
+<% else %>
+
+  <% if is_multiple -%>
+    <%  starting_value.each do |instance_value| -%>
+      <%= text_field_tag multiple_field_name, instance_value %>
+    <% end -%>
+  <% else -%>
+    <%= form.text_field attribute_key %>
+  <% end -%>
+<% end %>

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

@@ -0,0 +1,12 @@
+<%= render "topics/content_wrapper_start", :style_classes =>"full-width notabs" %>
+
+<table style="width:100%;">
+  <% untranslated_values_with_localized_labels.each do |translatable_value| %>
+    <tr><%= render 'translatable_value', :translatable_value => translatable_value -%></tr>
+  <% end %>
+</table>
+
+<%= link_to(t('translations.show.edit'), { :id => h(@translation.locale), :action => :edit }) %> |
+<%= link_to(t('translations.show.translations'), { :action => :index }) %>
+
+<%= render(:partial => "topics/content_wrapper_end" ) %>

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

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

data/config/locales/en.yml

@@ -0,0 +1,51 @@
+en:
+  translations:
+    form:
+      instructions: "<h3>Translate this page:</h3>
+      <ol>
+      <li>Replace the original text on the right-hand side with your translation.</li>
+      <li>Click 'Create' at the bottom of the page to save.</li>
+      </ol>"
+    available_in: "Available in:"
+    old: "Old"
+    are_you_sure_for_item_edit: "Are you sure you would like to edit this item?\n\nIf you would like to edit the item's translation, please use the 'edit' link by the translation's language name instead."
+  baskets:
+    form:
+      index_page_extra_side_bar_html: "Homepage Options - Side Bar HTML:"
+      name: "Name:"
+  choices:
+    form:
+      label: "Label:"
+  configurable_settings:
+    form:
+      value: "Value:"
+  extended_fields:
+    form:
+      example: "Example:"
+      label: "Label:"
+  feeds:
+    form:
+      title: "Title:"
+  kete_translatable:
+    only_edit_original_locale: "You can only edit the original locale."
+  licenses:
+    form:
+      description: "Description:"
+      name: "Name:"
+  search_helper:
+    tag_show_link_options:
+      title_with_translations: "Information about and translations for the {{t.base.tag}} {{tag_name}}. "
+  search_sources:
+    form:
+      source_credit: "Source Credit:"
+      title: "Title:"
+  system_settings:
+    form:
+      value: "{{t.base.value}}"
+  tags:
+    form:
+      name: "Tag Name:"
+  topic_types:
+    form:
+      description: "Description:"
+      name: "Name:"