translatable 0.2.4 → 0.3.0

data/lib/translatable.rb

@@ -1,261 +1,16 @@
-require 'active_record'
-require 'i18n'
-
-module ActiveRecord
-  ###
-  # In order to made the model Translatable, an additional fields should
-  # should be added first to it. Here is an example of it might be implemented:
-  # 
-  # Examples:
-  #
-  #   class Author < ActiveRecord::Base
-  #     validates :name, :presence => true
-  #   end
-  #
-  #   class TranslatableNews < ActiveRecord::Base  #
-  #     attr_accessible :title, :content
-  #   end
-  #
-  #   class News < ActiveRecord::Base
-  #
-  #     belongs_to  :author
-  #
-  #     translatable do
-  #       translatable  :title, :presence => true, :uniqueness => true
-  #       translatable  :content, :presence => true
-  #       translatable_model "TranslatedNews"
-  #       translatable_origin :origin_id
-  #     end
-  #
-  #     attr_accessible :author_id, :author
-  #   end
-  #
-  # An example of application:
-  #
-  #   news = News.create :translations_attributes => [{title: "Resent News", content: "That is where the text goes", locale: "en"}]
-  #   news.translations.create title: "Заголовок", content: "Содержание",locale: "ru"
-  #
-  #   news.content
-  #   # => "That is where the text goes"
-  #
-  #   ::I18n.locale = "ru"
-  #   news.content
-  #   # => "Сюди идет текст"
-  #
-  #   ::I18n.locale = "de"
-  #   news.content
-  #   # => nil
-  #
-  #   ::I18n.locale = ::I18n.default_locale
-  #   news.content
-  #   # => "That is where the text goes"
-  #
-  module Translatable
-
-    def translatable
-      extend ActiveRecord::Translatable::ClassMethods
-      include ActiveRecord::Translatable::InstanceMethods
-
-      translatable_define_hash
-      yield
-      translatable_register
-    end
-
-    module ClassMethods
-
-      protected
-
-      ###
-      # Fields that are translatable.
-      # Those fields should be defined in the original model including all the related params.
-      # Examples:
-      #
-      #   translatable_property  :title,    String,   required: true, unique: true
-      #   translatable_property  :content,  Text
-      #
-      # NB! Will raise an error if there was no fields specified
-      #
-      def translatable *args
-        (@translatable[:properties] ||= [])  << args
-      end
-
-      ###
-      # Defines model that will be treated as translation handler.
-      # Model can be defined as String, Symbol or Constant.
-      # Examples:
-      #
-      #   translated_model TranslatedNews
-      #   translated_model "TranslatedNews"
-      #   translated_model :TranslatedNews
-      #
-      # Default: Translatable<ModelName>
-      #
-      def translatable_model model_name
-        @translatable[:model] = translatable_model_prepared model_name
-      end
-
-      ###
-      # Define the key that the translation will be used for belongs_to association,
-      # to communicate with original model
-      # Example:
-      #
-      #   translatable_origin :news
-      #
-      # Default: :origin
-      #
-      def translatable_origin origin_key
-        @translatable[:origin] = translatable_origin_prepared origin_key
-      end
-
-      ###
-      # Will not register the attributes as accessible.
-      # IMPORTANT: Translatable block will be evaluated on the model after it
-      # was loaded, so it will modify certain thing on final version. Hence this thing is needed.
-      # Examples:
-      #
-      #   translatable_attr_protected
-      #
-      # Default: false
-      #
-      def translatable_attr_protected
-        @translatable[:attr_accessible] = false
-      end
-
-      ###
-      # Will not register the attributes as accessible.
-      # IMPORTANT: Translatable block will be evaluated on the model after it
-      # was loaded, so it will modify certain thing on final version. Hence this thing is needed.
-      # Examples:
-      #
-      #   translatable_attr_protected
-      #
-      # Default: false
-      #
-      def translatable_attr_accessible
-        @translatable[:attr_accessible] = true
-      end
-
-      ###
-      # Define the key that the translation will be used for belongs_to association,
-      # to communicate with original model
-      # Example:
-      #
-      #   translatable_origin :language
-      #
-      # Default: :locale
-      #
-      def translatable_locale locale_attr
-        @translatable[:locale] = translatable_locale_prepared locale_attr
-      end
-
-      ###
-      # Returns Model as a constant that deals with translations
-      def translatable_model_prepared model_name = nil
-        model_constant = model_name
-        model_constant ||= "Translatable#{self.name}"
-        model_constant.to_s.constantize
-      end
-
-
-      def translatable_origin_prepared origin_key = nil
-        origin_key || "origin"
-      end
-
-      def translatable_locale_prepared locale = nil
-        locale || "locale"
-      end
-
-      ###
-      # Define hash that contains all the translations
-      def translatable_define_hash
-        @translatable = {}
-      end
-
-      ###
-      # Handles all the registring routine, defining methods,
-      # properties, and everything else
-      def translatable_register
-        raise ArgumentError.new("At least one property should be defined") if [nil, []].include?(@translatable[:properties])
-        [:model,:origin,:locale].each { |hash_key| @translatable[hash_key] ||= send "translatable_#{hash_key}_prepared" }
-
-        translatable_register_properties_for_origin
-        translatable_register_properties_for_translatable
-      end
-
-      ###
-      # Handle the routine to define all th required stuff on the original maodel
-      def translatable_register_properties_for_origin
-        has_many :translations, :class_name => @translatable[:model].name, :foreign_key => :"#{@translatable[:origin]}_id"
-        accepts_nested_attributes_for :translations
-        attr_accessible :translations_attributes
-
-        @translatable[:properties].each do |p|
-          accessible_as = (p.last.delete(:as) || p.first rescue p.first)
-          self.module_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def #{accessible_as}
-              current_translation.try(:#{p.first})
-            end
-          RUBY
-        end
-
-        self.module_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def translatable_set_current
-            @current_translation = if translations.loaded?
-              translations.select { |t| t.send(:"#{@translatable[:locale]}") == @translatable_locale }
-            else
-              translations.where(:"#{@translatable[:locale]}" => @translatable_locale)
-            end.first
-          end
-          protected :translatable_set_current
-        RUBY
-      end
-
-      def translatable_register_properties_for_translatable
-        @translatable[:model].module_eval <<-RUBY, __FILE__, __LINE__ + 1
-          validates :#{@translatable[:locale]}, :presence => true
-          validates :#{@translatable[:locale]}, :format => { :with => /[a-z]{2}/}, :if => Proc.new {|record| !record.#{@translatable[:locale]}.blank? }
-          validates :#{@translatable[:locale]}, :uniqueness => { :scope => :#{@translatable[:origin]}_id }
-
-          belongs_to :#{@translatable[:origin]}, :class_name => "#{self.name}"
-        RUBY
-
-        unless @translatable[:attr_accessible].nil?
-          @translatable[:model].module_eval <<-RUBY, __FILE__, __LINE__ + 1
-            attr_#{!!@translatable[:attr_accessible] ? "accessible" : "protected" } :#{@translatable[:locale]}, :#{@translatable[:origin]}_id
-          RUBY
-        end
-
-        @translatable[:properties].each do |p|
-          if p.size > 1
-            @translatable[:model].module_eval <<-RUBY, __FILE__, __LINE__ + 1
-              validates :#{p.first}, #{p.last.inspect}
-            RUBY
-          end
-        end
-      end
-    end
-
-    module InstanceMethods
-
-      def current_translation
-        if translatable_locale_changed?
-          @translatable_locale = ::I18n.locale.to_s
-          translatable_set_current
-        end
-        @current_translation
-      end
-
-      def other_translations
-        translations - [current_translation]
-      end
-
-      protected
-      
-      def translatable_locale_changed?
-        @translatable_locale.to_s != ::I18n.locale.to_s
-      end
+require 'translatable/active_record'
+  
+if defined?(Rails)
+  require 'translatable/engine'
+
+  ActiveSupport.on_load(:active_record) do
+    ActiveSupport.on_load(:i18n) do
+      ActiveRecord::Base.extend Translatable::ActiveRecord
     end
   end
+else
+  require 'active_record'
+  require 'i18n'
+  
+  ActiveRecord::Base.extend Translatable::ActiveRecord
 end
-
-ActiveRecord::Base.extend ActiveRecord::Translatable

data/test/cases/translatable_test.rb

@@ -0,0 +1,276 @@
+# encoding: utf-8
+require 'test_helper'
+require 'support/models/news'
+require 'support/models/posts'
+require 'support/models/messages'
+
+class TranslatableTest < Test::Unit::TestCase
+  context "Translatable hash" do
+    should "Define default" do
+      th = News.instance_variable_get :@translatable
+
+      assert_kind_of Hash, th
+      assert th.has_key?(:properties)
+    end
+
+    should "Has dafault model" do
+      assert_equal ::TranslatableNews, News.send(:translatable_model_prepared, 'TranslatableNews')
+    end
+  end
+
+  context "Translatable model preparation" do
+    should "Accept constant" do
+      assert_equal ::TranslatableNews, News.send(:translatable_model_prepared, ::TranslatableNews)
+    end
+
+    should "Accept string" do
+      assert_equal ::TranslatableNews, News.send(:translatable_model_prepared, "TranslatableNews")
+    end
+
+    should "Accept symbol" do
+      assert_equal ::TranslatableNews, News.send(:translatable_model_prepared, :TranslatableNews)
+    end
+  end
+
+  context "Instance" do
+    should "Respond to translatable methods" do
+      news = News.new
+
+      assert news.respond_to?(:title), "title methods is missing for News instance"
+      assert news.respond_to?(:content), "content methods is missing for News instance"
+    end
+
+    should "Creates without translation" do
+      news = News.create
+
+      assert news.persisted?
+      assert_nil TranslatableNews.last
+    end
+
+    should "Have no other translation" do
+      news = News.create :translations_attributes => [{ :title => "Заголовок", :content => "Содержание", :locale => "ru"}]
+
+      assert news.persisted?
+
+      t_news = TranslatableNews.last
+      assert_equal [t_news], news.other_translations
+      ::I18n.locale = :ru
+      assert_equal [], news.other_translations
+      ::I18n.locale = ::I18n.default_locale
+    end
+
+    should "Provide errors on creation" do
+      news = News.create :translations_attributes => [{:title => "Заголовок", :content => "Содержание", :locale => "ru"},
+        {:title => "Resent News", :content => "That is where the text goes", :locale => ""}]
+
+      assert news.new_record?
+
+      assert_equal ["Translations locale can't be blank"], news.errors.full_messages
+
+      news.translations.each do |t|
+        assert t.new_record?
+      end
+    end
+  end
+
+  context "Translatable instance" do
+    should "Respond to translatable methods" do
+      news = TranslatableNews.new
+
+      assert news.respond_to?(:title), "Title method is missing for TranslatableNews instance"
+      assert news.respond_to?(:content), "Content method is missing for TranslatableNews instance"
+    end
+
+    should "Respond to methods related to origin" do
+      news = TranslatableNews.new
+
+      assert news.respond_to?(:locale), "Locale method is missing for TranslatableNews instance"
+      assert news.respond_to?(:origin_id), "Origin methods is missing for TranslatableNews instance"
+      assert news.respond_to?(:origin), "Origin methods is missing for TranslatableNews instance"
+    end
+  end
+
+  context "Creation with translation" do
+    should "Assign to origin" do
+      news = News.create
+      t_news = TranslatableNews.create :title => "Заголовок", :content => "Содержание", :locale => "ru", :origin_id => news.id
+
+      assert t_news.persisted?
+
+      t_news = TranslatableNews.last
+      assert_equal news.id, t_news.origin_id
+      assert_equal "Заголовок", t_news.title
+      assert_equal "Содержание", t_news.content
+      assert_equal "ru", t_news.locale
+    end
+
+    should "Create translation on origin creation" do
+      news = News.create :translations_attributes => [{ :title => "Заголовок", :content => "Содержание", :locale => "ru"}]
+
+      assert news.persisted?
+
+      t_news = TranslatableNews.last
+      assert_equal news.id, t_news.origin_id.to_i
+      assert_equal "Заголовок", t_news.title
+      assert_equal "Содержание", t_news.content
+      assert_equal "ru", t_news.locale
+    end
+
+    should "Create multiple translations" do
+      news = News.create :translations_attributes => [{ :title => "Заголовок", :content => "Содержание", :locale => "ru"},
+        {:title => "Resent News", :content => "That is where the text goes", :locale => "en"}]
+
+      assert news.persisted?
+
+      t_news = TranslatableNews.first
+      assert_equal news.id, t_news.origin_id.to_i
+      assert_equal "Заголовок", t_news.title
+      assert_equal "Содержание", t_news.content
+      assert_equal "ru", t_news.locale
+
+      t_news = TranslatableNews.last
+      assert_equal news.id, t_news.origin_id.to_i
+      assert_equal "Resent News", t_news.title
+      assert_equal "That is where the text goes", t_news.content
+      assert_equal "en", t_news.locale
+    end
+  end
+
+  context "Current translation" do
+    should "Set default translation" do
+      news = News.create :translations_attributes => [{:title => "Заголовок", :content => "Содержание", :locale => "ru"},
+        {:title => "Resent News", :content => "That is where the text goes", :locale => "en"}]
+
+      assert news.persisted?
+
+      assert_equal "Resent News", news.title
+      assert_equal "That is where the text goes", news.content
+    end
+    
+    should "Been set equal to current locale" do
+      news = News.create :translations_attributes => [{:title => "Заголовок", :content => "Содержание", :locale => "ru"},
+        {:title => "Resent News", :content => "That is where the text goes", :locale => "en"}]
+
+      assert news.persisted?
+
+      ::I18n.locale = :ru
+      assert_equal "Заголовок", news.title
+      assert_equal "Содержание", news.content
+      ::I18n.locale = ::I18n.default_locale
+    end
+    
+    should "Not been set if unavailable" do
+      news = News.create :translations_attributes => [{:title => "Заголовок", :content => "Содержание", :locale => "ru"},
+        {:title => "Resent News", :content => "That is where the text goes", :locale => "en"}]
+
+      assert news.persisted?
+
+      ::I18n.locale = :de
+      assert_nil news.title
+      assert_nil news.content
+    end
+
+    should "Be be switched on locale switching" do
+      news = News.create :translations_attributes => [{:title => "Resent News", :content => "That is where the text goes", :locale => "en"}]
+
+      assert news.persisted?
+
+      t_news = news.translations.create :title => "Заголовок", :content => "Содержание",:locale => "ru"
+      assert t_news.persisted?
+
+      ::I18n.locale = ::I18n.default_locale
+
+      assert_equal "Resent News", news.title
+      assert_equal "That is where the text goes", news.content
+
+      ::I18n.locale = :ru
+
+      assert_equal "Заголовок", news.title
+      assert_equal "Содержание", news.content
+    end
+  end
+
+  should "Add translation to existing record" do
+    news = News.create :translations_attributes => [{:title => "Resent News", :content => "That is where the text goes", :locale => "en"}]
+
+    assert news.persisted?
+
+    t_news = news.translations.create :title => "Заголовок", :content => "Содержание",:locale => "ru"
+
+    assert t_news.persisted?
+    assert t_news.persisted?
+  end
+
+  should "Define validations" do
+    post = Post.create :translations_attributes => [{:title => "Заголовок",:content => "Содержание", :locale => "ru"},
+      {:title => "Resent Post", :content => "That is where the text goes", :locale => "en"}]
+    assert post.persisted?, "Message had errors: #{post.errors.inspect}"
+
+    post = Post.create :translations_attributes => [{:content => "Содержание", :locale => "ru"},
+      {:title => "Resent Post 2", :content => "That is where the text goes", :locale => "en"}]
+    
+    assert post.new_record?, "Message had errors: #{post.errors.full_messages.inspect}"
+    assert_equal ["Translations title can't be blank"], post.errors.full_messages
+
+    post = Post.create :translations_attributes => [{:title => "Заголовок 2", :locale => "ru"},
+      {:title => "Resent Post 3", :content => "That is where the text goes", :locale => "en"}]
+
+    assert post.new_record?, "Message had errors: #{post.errors.full_messages.inspect}"
+    assert_equal ["Translations content can't be blank"], post.errors.full_messages
+
+    post = Post.create :translations_attributes => [{:title => "Заголовок", :content => "Содержание", :locale => "ru"},
+      {:title => "Resent Post 3", :content => "That is where the text goes", :locale => "en"}]
+
+    assert post.new_record?, "Message had errors: #{post.errors.full_messages.inspect}"
+    assert_equal ["Translations title has already been taken"], post.errors.full_messages
+  end
+
+  def test_origin_is_owerwrittent
+    post = Post.create :translations_attributes => [{:title => "Заголовок",:content => "Содержание", :locale => "ru"},
+      {:title => "Resent Post", :content => "That is where the text goes", :locale => "en"}]
+    assert post.persisted?, "Message had errors: #{post.errors.inspect}"
+
+    assert_not_equal post.object_id, post.translations.first.post.object_id
+  end
+
+  should "Accept aliases for fileds" do
+    post = Post.create :translations_attributes => [{:title => "Заголовок",:content => "Содержание", :locale => "ru"},
+      {:title => "Resent Post", :content => "That is where the text goes", :locale => "en"}]
+    assert post.persisted?, "Message had errors: #{post.errors.inspect}"
+
+    assert_equal "Resent Post", post.translated_title
+
+    ::I18n.locale = :ru
+    assert_equal "Заголовок", post.translated_title
+    ::I18n.locale = ::I18n.default_locale
+  end
+
+  context "Mass assigment" do
+    should "Be available to mass assigment by default" do
+      tp = TranslatableNews.new( :title => "Resent News", :content => "That is where the text goes", :locale => "en", :origin_id => 1)
+
+      assert_equal "Resent News", tp.title
+      assert_equal "That is where the text goes", tp.content
+      assert_equal "en", tp.locale
+      assert_equal 1, tp.origin_id
+    end
+
+    should "Protect internal fields on desire" do
+      tm = TranslatedMessage.new( :title => "Resent Post", :content => "That is where the text goes", :locale => "en", :message_id => 1)
+
+      assert_equal "Resent Post", tm.title
+      assert_equal "That is where the text goes", tm.content
+      assert_equal nil, tm.locale
+      assert_equal nil, tm.message_id
+    end
+
+    should "Allow multiple assigment rules" do
+      tm = TranslatedMessage.new( {:title => "Resent Post", :content => "That is where the text goes", :locale => "en", :message_id => 1}, :as => :editor)
+
+      assert_equal "Resent Post", tm.title
+      assert_equal "That is where the text goes", tm.content
+      assert_equal "en", tm.locale
+      assert_equal nil, tm.message_id
+    end
+  end
+end

data/test/generators/model_generator_test.rb

@@ -0,0 +1,97 @@
+require "test_helper"
+require "rails"
+require 'rails/generators'
+require "generators/translatable/model_generator"
+
+class ModelGeneratorTest < Rails::Generators::TestCase
+  tests Translatable::Generators::ModelGenerator
+  destination File.expand_path("../../../tmp", __FILE__)
+  setup :prepare_destination
+  teardown :cleanup_destination_root
+
+  should "Create required files with default options" do
+    run_generator %w(article title:string content:string)
+    assert_file "app/models/article.rb", <<CONTENT
+class Article < ActiveRecord::Base
+  translatable do
+    translatable :title, :presence => true#, :uniqueness => true
+    translatable :content, :presence => true#, :uniqueness => true
+    #translatable_model 'TranslatedArticle'
+    #translatable_origin :article
+    #translatable_locale :locale
+  end
+end
+CONTENT
+    assert_migration "db/migrate/create_articles.rb", <<CONTENT
+class CreateArticles < ActiveRecord::Migration
+  def change
+    create_table :articles do |t|
+
+      t.timestamps
+    end
+  end
+end
+CONTENT
+  end
+
+  should "Create required files with special options" do
+    run_generator %w(article title:string content:string --translated_model=ArticleTranslation --origin=post --locale=language)
+    assert_file "app/models/article.rb", <<CONTENT
+class Article < ActiveRecord::Base
+  translatable do
+    translatable :title, :presence => true#, :uniqueness => true
+    translatable :content, :presence => true#, :uniqueness => true
+    translatable_model 'ArticleTranslation'
+    translatable_origin :post
+    translatable_locale :language
+  end
+end
+CONTENT
+    assert_migration "db/migrate/create_articles.rb", <<CONTENT
+class CreateArticles < ActiveRecord::Migration
+  def change
+    create_table :articles do |t|
+
+      t.timestamps
+    end
+  end
+end
+CONTENT
+  end
+
+  should "Inject into existing class" do
+    create_model_file
+    run_generator %w(article title:string content:string)
+    
+    assert_file "app/models/article.rb", <<CONTENT
+class Article < ActiveRecord::Base
+  translatable do
+    translatable :title, :presence => true#, :uniqueness => true
+    translatable :content, :presence => true#, :uniqueness => true
+    #translatable_model 'TranslatedArticle'
+    #translatable_origin :article
+    #translatable_locale :locale
+  end
+  attr_accessor :created_at, :updated_at
+end
+CONTENT
+    assert_no_migration "db/migrate/create_articles.rb"
+  end
+
+  protected
+
+  def create_model_file
+    FileUtils.mkdir_p File.join(destination_root, "app", "models")
+    f = File.open(File.join(destination_root, "app", "models", "article.rb"), "w+")
+    f.write <<CONTENT
+class Article < ActiveRecord::Base
+  attr_accessor :created_at, :updated_at
+end
+CONTENT
+    f.close
+  end
+
+  def cleanup_destination_root
+    FileUtils.rm_rf destination_root
+  end
+end