translatable 0.1.1 → 0.1.2

data/README.rdoc

@@ -19,9 +19,67 @@ If there is no translation available, you will get nil.
 
 Check out the examples below.
 
+== How to use?
+
+Just define inside of your model `translatable` with block.
+Block accepts following methods:
+
+  translatable *args
+    Params:
+      first - Here should be specified an attribute that will be translated.
+      second - Define here a hash that will be later provided for validation to model.
+
+      This method may be called multiple times.
+    Examples:
+      translatable :title,   :presence => true, :uniqueness => true
+      translatable :content, :presence => true
+      translatable :notes
+
+  translatable_model model_name
+    Params:
+      model_name - Define the model name here if it is different from following "Translatable<CURRENT_MODEL>".
+        For News model, TranslatableNews will be used as the one that keeping translations. It can be defined 
+        in a three ways: as constant, string or symbol.
+    Examples:
+      translatable_model TranslatedNews
+      OR
+      translatable_model "TranslatedNews"
+      OR
+      translatable_model :TranslatedNews
+
+  translatable_origin origin_key
+    Params:
+      origin_key - This key will be used to define the the relations for translations model.
+      By default it will be :origin. Translations model should also have such attribute defined.
+
+      This value will also be used for validation, as its presence is compulsory for translations model.
+    Examples:
+      translatable_origin :message
+      OR
+      translatable_origin :post
+
+  translatable_locale locale_attr
+    Params:
+      locale_attr - This key will be used to define the attribute that is keeping the locale of the translation.
+      By default it will be :locale. Translations model should also have such attribute defined.
+
+      This value will also be used for validation, as its presence is compulsory for translations model.
+    Examples:
+      translatable_locale :language
+      OR
+      translatable_locale :lang
+
+== Now to create the translations?
+
+ They can be created in two different ways:
+
+First is using the original model. Just provide the translations attributes within `translations_attributes` array.
+Second - just create a new translation as if it would be independent model.
+For details see Examples below.
+
 == Examples
 
-  Migrations:
+Migrations:
 
     class CreateTables < ActiveRecord::Migration
       def up
@@ -54,16 +112,13 @@ Check out the examples below.
       end
     end
 
-  Models:
+Models:
 
     class Author < ActiveRecord::Base
       validates :name, :presence => true
     end
 
     class TranslatableNews < ActiveRecord::Base
-      validates :title, :content, :presence => true
-      validates :title, :uniqueness => true
-
       attr_accessible :title, :content
     end
 
@@ -71,19 +126,19 @@ Check out the examples below.
 
       belongs_to  :author
 
-      is :translatable do
-        translatable  :title
-        translatable  :content
-        translatable_model TranslatedNews
+      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:
+An example of application:
 
-    news = News.create :translations => [{title: "Resent News", content: "That is where the text goes", locale: "en"}]
+    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

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/translatable.rb

@@ -12,10 +12,7 @@ module ActiveRecord
   #     validates :name, :presence => true
   #   end
   #
-  #   class TranslatableNews < ActiveRecord::Base
-  #     validates :title, :content, :presence => true
-  #     validates :title, :uniqueness => true
-  #
+  #   class TranslatableNews < ActiveRecord::Base  #
   #     attr_accessible :title, :content
   #   end
   #
@@ -23,10 +20,10 @@ module ActiveRecord
   #
   #     belongs_to  :author
   #
-  #     is :translatable do
-  #       translatable  :title
-  #       translatable  :content
-  #       translatable_model TranslatedNews
+  #     translatable do
+  #       translatable  :title, :presence => true, :uniqueness => true
+  #       translatable  :content, :presence => true
+  #       translatable_model "TranslatedNews"
   #       translatable_origin :origin_id
   #     end
   #
@@ -176,11 +173,17 @@ module ActiveRecord
           def current_translation
             if translatable_locale_changed?
               @translatable_locale = ::I18n.locale.to_s
-              @current_translation = translations.where(:#{@translatable[:locale]} => @translatable_locale).first
+              translatable_set_current
             end
             @current_translation
           end
           protected :current_translation
+
+
+          def translatable_set_current
+            @current_translation = translations.where(:#{@translatable[:locale]} => @translatable_locale).first
+          end
+          protected :translatable_set_current
         RUBY
       end
 
@@ -193,6 +196,14 @@ module ActiveRecord
 
           attr_accessible :#{@translatable[:locale]}, :#{@translatable[:origin]}_id
         RUBY
+
+        @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
 

data/test/news.rb

@@ -1,7 +1,7 @@
 require 'active_record'
 require 'translatable'
 
-class CreateTables < ActiveRecord::Migration
+class CreateNewsTables < ActiveRecord::Migration
   def up
     create_table(:authors) do |t|
       t.string :name, :null => false
@@ -32,7 +32,7 @@ class CreateTables < ActiveRecord::Migration
   end
 end
 
-CreateTables.migrate(:up)
+CreateNewsTables.migrate(:up)
 
 class Author < ActiveRecord::Base
   validates :name, :presence => true

data/test/posts.rb

@@ -0,0 +1,66 @@
+require 'active_record'
+require 'translatable'
+
+class CreatePostsTables < ActiveRecord::Migration
+  def up
+    create_table(:writers) do |t|
+      t.string :name, :null => false
+
+      t.timestamps
+    end
+
+    create_table(:translated_posts) do |t|
+      t.string :title, :null => false
+      t.string :content, :null => false
+      t.integer :post_id, :null => false
+      t.string :locale, :null => false, :limit => 2
+      t.integer :writer_id
+
+      t.timestamps
+    end
+
+    create_table(:posts) do |t|
+      t.integer :writer_id
+
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table(:writers)
+    drop_table(:translated_posts)
+    drop_table(:posts)
+  end
+end
+
+CreatePostsTables.migrate(:up)
+
+class Author < ActiveRecord::Base
+  validates :name, :presence => true
+end
+
+class TranslatedPost < ActiveRecord::Base
+  attr_accessible :title, :content
+
+  before_create :duplicate_writer_id
+
+  protected
+
+  def duplicate_writer_id
+    self.writer_id = post.writer_id
+  end
+end
+
+class Post < ActiveRecord::Base
+
+  belongs_to  :writer
+
+  translatable do
+    translatable  :title, :presence => true, :uniqueness => true
+    translatable  :content, :presence => true
+    translatable_model 'TranslatedPost'
+    translatable_origin :post
+  end
+
+  attr_accessible :writer_id, :writer
+end

data/test/test_translatable.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require 'helper'
 require 'news'
+require 'posts'
 
 class TestDmTranslatable < Test::Unit::TestCase
 
@@ -185,4 +186,36 @@ class TestDmTranslatable < Test::Unit::TestCase
       assert t.new_record?
     end
   end
+
+  def test_validations_are_defined
+    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_equal post, post.translations.first.post
+  end
 end

data/translatable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "translatable"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["E-Max"]
-  s.date = "2012-08-17"
+  s.date = "2012-08-18"
   s.description = "This game was build to make whole proccess of working with translation for DM to be almost invisble. That was THE AIM."
   s.email = "max@studentify.nl"
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "lib/translatable.rb",
     "test/helper.rb",
     "test/news.rb",
+    "test/posts.rb",
     "test/support/active_record.rb",
     "test/support/database_cleaner.rb",
     "test/test_translatable.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translatable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000Z
+date: 2012-08-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &79558880 !ruby/object:Gem::Requirement
+  requirement: &86896860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79558880
+  version_requirements: *86896860
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &79558640 !ruby/object:Gem::Requirement
+  requirement: &86896620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79558640
+  version_requirements: *86896620
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &79558400 !ruby/object:Gem::Requirement
+  requirement: &86896380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79558400
+  version_requirements: *86896380
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &79558160 !ruby/object:Gem::Requirement
+  requirement: &86896140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.0
   type: :development
   prerelease: false
-  version_requirements: *79558160
+  version_requirements: *86896140
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &79557920 !ruby/object:Gem::Requirement
+  requirement: &86895900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *79557920
+  version_requirements: *86895900
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &79557680 !ruby/object:Gem::Requirement
+  requirement: &86895660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *79557680
+  version_requirements: *86895660
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &79557440 !ruby/object:Gem::Requirement
+  requirement: &86895420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *79557440
+  version_requirements: *86895420
 description: This game was build to make whole proccess of working with translation
   for DM to be almost invisble. That was THE AIM.
 email: max@studentify.nl
@@ -109,6 +109,7 @@ files:
 - lib/translatable.rb
 - test/helper.rb
 - test/news.rb
+- test/posts.rb
 - test/support/active_record.rb
 - test/support/database_cleaner.rb
 - test/test_translatable.rb
@@ -128,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 191627663
+      hash: -150355887
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: