kete_translatable_content 0.1.0

data/config/routes.rb

@@ -0,0 +1,11 @@
+require 'kete_translatable_content'
+
+# extend routes for translations of kete content
+ActionController::Routing::Routes.draw do |map|
+  # translations routes
+  # note that we don't want to override the standard routes handled below
+  # restful index is the same as our normal index action, so we limit it to that
+  Kete.translatables.keys.each do |name|
+    map.resources name.tableize.to_sym, :path_prefix => ':urlified_name', :only => [:index], :has_many => :translations
+  end
+end

data/config/translatables.yml

@@ -0,0 +1,65 @@
+basket:
+  translatable_attributes: [:name, :index_page_extra_side_bar_html]
+  views: ['edit']
+topic_type:
+  translatable_attributes: [:name, :description]
+  views: ['edit']
+search_source:
+  translatable_attributes: [:title, :source_credit]
+  views: ['show', 'edit']
+license:
+  translatable_attributes: [:name, :description]
+  views: ['show', 'edit']
+extended_field:
+  translatable_attributes: [:label, :example]
+  views: ['show', 'edit']
+  redefine_find: false
+system_setting:
+  translatable_attributes: [:value]
+  controllers: ['configure']
+  views: ['section']
+  additional_columns:
+    takes_translations:
+      type: boolean
+      default: false
+configurable_setting:
+  translatable_attributes: [:value]
+  controllers: ['baskets']
+  views: ['appearance']
+feed:
+  translatable_attributes: [:title]
+  controllers: ['baskets']
+  views: ['homepage_options']
+choice:
+  translatable_attributes: [:label]
+  views: ['show', 'edit']
+tag:
+  translatable_attributes: [:name]
+  views: ['show']
+topic:
+  through_version: true
+  translatable_attributes: [:title, :short_summary, :description] # extended content is handled separately
+  views: ['show']
+document:
+  through_version: true
+  translatable_attributes: [:title, :short_summary, :description] # extended content is handled separately
+  views: ['show']
+audio_recording:
+  through_version: true
+  translatable_attributes: [:title, :description] # extended content is handled separately
+  views: ['show']
+  controllers: ['audio']
+still_image:
+  through_version: true
+  translatable_attributes: [:title, :description] # extended content is handled separately
+  views: ['show']
+  controllers: ['images']
+video:
+  through_version: true
+  translatable_attributes: [:title, :description] # extended content is handled separately
+  views: ['show']
+  controllers: ['video']
+web_link:
+  through_version: true
+  translatable_attributes: [:title, :description] # extended content is handled separately
+  views: ['show']

data/generators/kete_translatable_content_migration/USAGE

@@ -0,0 +1,2 @@
+Description:
+	Generates the migration necessary to track locale and original locale needed by the mongo_translatable functionality.

data/generators/kete_translatable_content_migration/kete_translatable_content_migration_generator.rb

@@ -0,0 +1,7 @@
+class KeteTranslatableContentMigrationGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate', { :migration_file_name => "add_kete_translatable_content_fields" }
+    end
+  end
+end

data/generators/kete_translatable_content_migration/templates/migration.rb

@@ -0,0 +1,82 @@
+require 'kete_translatable_content'
+class ActiveRecord::Migration
+
+  def self.add_additional_columns_for(name, table_name)
+    if Kete.translatables[name]['additional_columns'] && Kete.translatables[name]['additional_columns'].any?
+      Kete.translatables[name]['additional_columns'].each do |column|
+        column_name = column.first.to_sym
+        options = column.last
+        args = [table_name, column_name, options['type'].to_sym]
+        args << { :default => options['default'] } unless options['default'].nil?
+        add_column *args
+
+        if through_version?(name)
+          args[0] = resolve_to_table(name, :without_versions => true)
+          add_column *args
+        end
+      end
+    end
+  end
+
+  def self.remove_additional_columns_for(name, table_name)
+    if Kete.translatables[name]['additional_columns'] && Kete.translatables[name]['additional_columns'].any?
+      Kete.translatables[name]['additional_columns'].each do |column|
+        remove_column(table_name, column.first.to_sym) rescue nil
+
+        if through_version?(name)
+          remove_column(resolve_to_table(name, :without_versions => true), column.first.to_sym) rescue nil
+        end
+      end
+    end
+  end
+
+  def self.add_locale_columns_to(table_name)
+    add_column table_name, :locale, :string, :default => I18n.default_locale.to_s
+    add_column table_name, :original_locale, :string, :default => I18n.default_locale.to_s
+  end
+
+  def self.remove_locale_columns_to(table_name)
+    remove_column(table_name, :locale) rescue nil
+    remove_column(table_name, :original_locale) rescue nil
+  end
+
+  def self.through_version?(name)
+    Kete.translatables[name]['through_version'].present? ? Kete.translatables[name]['through_version'] : false
+  end
+
+  def self.resolve_to_table(name, options = { })
+    include_versions = options[:without_versions].present? ? options[:without_versions] : false 
+
+    table_name = through_version?(name) && include_versions ? name + '_versions' : name.tableize
+
+    table_name = table_name.to_sym
+  end
+end
+
+class AddKeteTranslatableContentFields < ActiveRecord::Migration
+  def self.up
+    Kete.translatables.keys.each do |name|
+      
+      table_name = resolve_to_table(name)
+
+      add_locale_columns_to(table_name)
+
+      add_locale_columns_to(resolve_to_table(name, :without_versions => true)) if through_version?(name)
+
+      add_additional_columns_for(name, table_name)
+    end
+  end
+
+  def self.down
+    Kete.translatables.keys.each do |name|
+      table_name = resolve_to_table(name)
+
+      remove_locale_columns_to(table_name)
+
+      remove_locale_columns_to(resolve_to_table(name, :without_versions => true)) if through_version?(name)
+
+      remove_additional_columns_for(name, table_name)
+    end
+  end
+end
+

data/generators/kete_translatable_content_tests/USAGE

@@ -0,0 +1,2 @@
+Description:
+	Generates the tests for the kete_translatable_content functionality that verifies that the gem's functionality are working.

data/generators/kete_translatable_content_tests/kete_translatable_content_tests_generator.rb

@@ -0,0 +1,38 @@
+class KeteTranslatableContentTestsGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.template 'configure_kete_content_translation_controller_and_routes_test.rb',
+                  File.join('test/functional',
+                            'configure_kete_content_translation_controller_and_routes_test.rb')
+
+      m.template 'configure_kete_content_translation_test.rb',
+                  File.join('test/unit',
+                            'configure_kete_content_translation_test.rb')
+
+      m.template 'kete_translatable_content_helper_test.rb',
+                  File.join('test/unit/helpers',
+                            "kete_translatable_content_helper_test.rb")
+
+      m.template 'kete_translatable_content_migration_test.rb',
+                  File.join('test/unit',
+                            'kete_translatable_content_migration_test.rb')
+
+      m.template 'kete_translatable_content_translations_test.rb',
+                  File.join('test/unit',
+                            'kete_translatable_content_translations_test.rb')
+
+      m.template 'kete_translations_test.rb',
+                  File.join('test/integration',
+                            'kete_translations_test.rb')
+      m.template 'mongo_test_helper.rb',
+                  File.join('test/',
+                            'mongo_test_helper.rb')
+      m.template 'mongo_factories.rb',
+                  File.join('test/',
+                            'mongo_factories.rb')
+      m.template 'mongo_translatable_test.rb',
+                  File.join('test/unit',
+                            'mongo_translatable_test.rb')
+    end
+  end
+end

data/generators/kete_translatable_content_tests/templates/configure_kete_content_translation_controller_and_routes_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+# test that routes exist
+# prepended with locale en which is added to all routes with a wrapper filter
+class ConfigureKeteContentTranslationControllerAndRoutesTest < ActionController::TestCase
+
+  context "The application's routing for baskets" do
+
+    setup do
+      @location = {
+        :locale => "en",
+        :urlified_name => "site",
+        :controller => "translations",
+        :basket_id => "1"
+      }
+    end
+
+    should "have translations index" do
+      assert_routing({ :path => "en/site/baskets/1/translations", :method => :get }, @location.merge(:action => "index"))
+    end
+
+    should "have translations new" do
+      assert_routing({ :path => "en/site/baskets/1/translations/new", :method => :get }, @location.merge(:action => "new"))
+    end
+
+    should "have translations create" do
+      assert_routing({ :path => "en/site/baskets/1/translations", :method => :post }, @location.merge(:action => "create"))
+    end
+
+    should "have translations show for a translation" do
+      assert_routing({ :path => "en/site/baskets/1/translations/en", :method => :get }, @location.merge(:action => "show", :id => "en"))
+    end
+
+    should "have translations edit for a translation" do
+      assert_routing({ :path => "en/site/baskets/1/translations/en/edit", :method => :get }, @location.merge(:action => "edit", :id => "en"))
+    end
+
+    should "have translations update for a translation" do
+      assert_routing({ :path => "en/site/baskets/1/translations/en", :method => :put }, @location.merge(:action => "update", :id => "en"))
+    end
+
+    should "have translations destroy for a translation" do
+      assert_routing({ :path => "en/site/baskets/1/translations/en", :method => :delete }, @location.merge(:action => "destroy", :id => "en"))
+    end
+
+  end
+
+end

data/generators/kete_translatable_content_tests/templates/configure_kete_content_translation_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+# test that models are translatable by making sure they respond
+# to mongo_translatable instance methods
+class ConfigureKeteContentTranslationTest < ActiveSupport::TestCase
+
+  Kete.translatables.keys.each do |name|
+
+    context "A #{name.humanize}" do
+
+      setup do
+        @record = name.camelize.constantize.new
+      end
+
+      should "respond to locale" do
+        assert @record.respond_to?(:locale)
+      end
+
+      should "respond to translations" do
+        assert @record.respond_to?(:translations)
+      end
+
+      should "respond to translations_locales" do
+        assert @record.respond_to?(:translations_locales)
+      end
+
+      should "respond to translate" do
+        assert @record.respond_to?(:translate)
+      end
+
+      should "respond to translation_for" do
+        assert @record.respond_to?(:translation_for)
+      end
+
+      should "respond to available_in_these_locales" do
+        assert @record.respond_to?(:available_in_these_locales)
+      end
+
+      should "respond to needed_in_these_locales" do
+        assert @record.respond_to?(:needed_in_these_locales)
+      end
+
+    end
+
+  end
+
+end

data/generators/kete_translatable_content_tests/templates/kete_translatable_content_helper_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+# test that ApplicationHelper includes the mongo_translatable's gem
+# helper is included
+class KeteTranslatableContentHelperTest < ActionView::TestCase
+
+  context "The ActionController Helpers" do
+
+    should "include TranslatablesHelper#needed_in_locales_for" do
+      assert ApplicationController.helpers.methods.include?('needed_in_locales_for')
+    end
+
+    should "include KeteTranslatableContentHelper#kete_translatable_content?" do
+      assert ApplicationController.helpers.methods.include?('kete_translatable_content?')
+    end
+
+  end
+
+end

data/generators/kete_translatable_content_tests/templates/kete_translatable_content_migration_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper.rb'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+# skipping tests here, as this testcase can only be run in isolation from other testcases
+# uncomment and run "cd test; ruby unit/kete_translatable_content_migration_test.rb"
+# from command line, if you need to test this
+class MigrationGeneratorTest < ActiveSupport::TestCase
+  test "the truth" do
+    assert true
+  end
+
+#   context "Calling script/generate kete_translatable_content_migration" do
+
+#     setup do
+#       FileUtils.mkdir_p(fake_rails_root)
+#       @original_files = file_list
+#     end
+
+#     should "generate correct file with kete's translatable models" do
+#       Rails::Generator::Scripts::Generate.new.run(["kete_translatable_content_migration"],
+#                                                   :destination => fake_rails_root)
+#       new_file = (file_list - @original_files).first
+#       assert_match /add_kete_translatable_content_fields/, new_file
+#       assert_match /require \'kete_translatable_content\'/, File.read(new_file)
+#       assert_match /Kete.translatables.keys.each/, File.read(new_file)
+#     end
+
+#     teardown do
+#       FileUtils.rm_r(fake_rails_root)
+#     end
+
+#   end
+
+#   private
+
+#   def fake_rails_root
+#     File.join(File.dirname(__FILE__), 'rails_root')
+#   end
+
+#   def file_list
+#     Dir.glob(File.join(fake_rails_root, "db", "migrate", "*"))
+#   end
+
+end

data/generators/kete_translatable_content_tests/templates/kete_translatable_content_oai_dc_helpers_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+require 'mongo_test_helper'
+
+# test that the oai dc helpers we use are overridden
+# to return translations as well as locale's xml:lang
+class KeteTranslatableContentOaiDcHelpersTest < ActiveSupport::TestCase
+  
+  zoom_translatables = Array.new
+  Kete.translatables.each { |k,v| zoom_translatables << k.camelize if v['through_version'] }
+
+  zoom_translatables.each do |zoom_class|
+
+    context "#{zoom_class.humanize}" do
+      setup do
+        I18n.locale = I18n.default_locale
+        
+        item_for(zoom_class)
+
+        create_translations_for(@item, [:title, :description])
+      end
+
+      should "return xml for title in original locale plus all translated titles" do
+        builder = Nokogiri::XML::Builder.new
+        builder.root do |xml|
+          @item.oai_dc_xml_dc_title(xml)
+        end
+        assert builder.to_stripped_xml.include?("<dc:title xml:lang=\"#{I18n.default_locale}\">Item</dc:title>")
+        ALL_TRANSLATION_LOCALE_KEYS_EXCEPT_EN.each do |key|
+          assert builder.to_stripped_xml.include?("<dc:title xml:lang=\"#{key.to_s}\">#{LOCALE_LABELS[key]}</dc:title>")
+        end
+      end
+
+      should "return xml for description in original locale plus all translated descriptions" do
+        builder = Nokogiri::XML::Builder.new
+        builder.root do |xml|
+          @item.oai_dc_xml_dc_description(xml)
+        end
+        assert builder.to_stripped_xml.include?("<dc:description xml:lang=\"#{I18n.default_locale}\"><![CDATA[Description]]></dc:description>")
+        ALL_TRANSLATION_LOCALE_KEYS_EXCEPT_EN.each do |key|
+          assert builder.to_stripped_xml.include?("<dc:description xml:lang=\"#{key.to_s}\"><![CDATA[#{LOCALE_LABELS[key]}]]></dc:description>")
+        end
+      end
+
+      should "return xml for tags in original locale plus all translated tags" do
+        @item.tag_list << "tag"
+        @item.save
+        @item.reload
+        @item.add_as_contributor(User.first, @item.version)
+
+        # translate tag
+        tag = @item.tags.first
+        create_translations_for(tag, [:name])
+
+        builder = Nokogiri::XML::Builder.new
+        builder.root do |xml|
+          @item.oai_dc_xml_tags_to_dc_subjects(xml)
+        end
+        assert builder.to_stripped_xml.include?("<dc:subject xml:lang=\"#{I18n.default_locale}\"><![CDATA[tag]]></dc:subject>")
+
+        ALL_TRANSLATION_LOCALE_KEYS_EXCEPT_EN.each do |key|
+          assert builder.to_stripped_xml.include?("<dc:subject xml:lang=\"#{key.to_s}\"><![CDATA[#{LOCALE_LABELS[key]}]]></dc:subject>")
+        end
+      end
+    end
+  end
+end