mongoid_globalize 0.1.0

data/mongoid_globalize.gemspec

@@ -0,0 +1,86 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongoid_globalize}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Mik-die}]
+  s.date = %q{2011-07-25}
+  s.description = %q{Library for translating Mongoid documents, based on Globalize3 principles}
+  s.email = %q{MikDiet@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/mongoid_globalize.rb",
+    "lib/mongoid_globalize/act_macro.rb",
+    "lib/mongoid_globalize/adapter.rb",
+    "lib/mongoid_globalize/attributes.rb",
+    "lib/mongoid_globalize/class_methods.rb",
+    "lib/mongoid_globalize/document_translation.rb",
+    "lib/mongoid_globalize/instance_methods.rb",
+    "mongoid_globalize.gemspec",
+    "spec/data/models.rb",
+    "spec/mongoid_globalize/attributes_spec.rb",
+    "spec/mongoid_globalize/clone_spec.rb",
+    "spec/mongoid_globalize/dirty_tracking_spec.rb",
+    "spec/mongoid_globalize/fallbacks_spec.rb",
+    "spec/mongoid_globalize/locale_spec.rb",
+    "spec/mongoid_globalize/set_translations_spec.rb",
+    "spec/mongoid_globalize/translation_class_spec.rb",
+    "spec/mongoid_globalize/validations_spec.rb",
+    "spec/mongoid_globalize_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/Mik-die/mongoid_globalize}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Library for translating Mongoid documents}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activemodel>, ["= 3.1.0.rc4"])
+      s.add_runtime_dependency(%q<mongoid>, [">= 0"])
+      s.add_runtime_dependency(%q<bson_ext>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<mongoid-rspec>, [">= 0"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<activemodel>, ["= 3.1.0.rc4"])
+      s.add_dependency(%q<mongoid>, [">= 0"])
+      s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<mongoid-rspec>, [">= 0"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activemodel>, ["= 3.1.0.rc4"])
+    s.add_dependency(%q<mongoid>, [">= 0"])
+    s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<mongoid-rspec>, [">= 0"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/spec/data/models.rb

@@ -0,0 +1,77 @@
+class Post
+  include Mongoid::Document
+  include Mongoid::Globalize
+  belongs_to :blog
+  translates :title, :content
+
+  translates :published => Boolean
+  translates :published_at => DateTime
+  validates_presence_of :title
+  scope :with_some_title, :conditions => { :title => 'some_title' }
+end
+
+class PostTranslation
+  include Mongoid::Document
+  field :locale
+  field :title
+  field :content
+  field :published => Boolean
+  field :published_at => DateTime
+  embedded_in :post
+
+  def existing_method
+  end
+end
+
+class ReloadingPost < Post
+  after_create { reload }
+end
+
+class Blog
+  include Mongoid::Document
+  has_many :posts
+  field :name
+end
+
+class Validatee
+  include Mongoid::Document
+  include Mongoid::Globalize
+  translates :string
+end
+
+class Parent
+  include Mongoid::Document
+  include Mongoid::Globalize
+  translates :content, :type
+end
+
+class Child < Parent
+end
+
+class Comment
+  include Mongoid::Document
+  field :content
+  validates_presence_of :content
+  belongs_to :post
+end
+
+class TranslatedComment < Comment
+  include Mongoid::Globalize
+  translates :content, :title
+end
+
+class User
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::Globalize
+  translates :name
+  field :email
+  validates_presence_of :name, :email
+end
+
+class Task
+  include Mongoid::Document
+  include Mongoid::Globalize
+  fallbacks_for_empty_translations!
+  translates :name
+end

data/spec/mongoid_globalize/attributes_spec.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe 'Attributes' do
+  it "defines accessors for the translated attributes" do
+    post = Post.new
+    post.should respond_to(:title)
+    post.should respond_to(:title=)
+  end
+
+  describe "attribute_names" do
+    it "returns translated and existing attribute names" do
+      Post.new(:blog_id => 5).attribute_names.should include('blog_id', 'content', 'title')
+    end
+  end
+
+  it "returns translated and regular attributes" do
+    post = Post.create(:title => 'foo', :blog_id => 5)
+    post.attributes.should include('blog_id' => 5, 'title' => 'foo', 'content' => nil)
+  end
+
+  describe "write_attribute for non-translated attributes" do
+    it "should return the value" do
+      user = User.create(:name => 'Max Mustermann', :email => 'max@mustermann.de')
+      new_email = 'm.muster@mann.de'
+      user.write_attribute('email', new_email).should == new_email
+    end
+  end
+
+  describe "translated_attribute_names" do
+    it "returns translated attribute names" do
+      Post.translated_attribute_names.should include(:title, :content)
+    end
+  end
+
+  describe "a translated attribute" do
+    describe "writer" do
+      it "returns its argument" do
+        (Post.new.title = 'foo').should == 'foo'
+      end
+    end
+
+    describe "reader" do
+      it "returns the correct translation for a saved record after locale switching" do
+        post = Post.create(:title => 'title')
+        post.update_attributes(:title => 'Titel', :locale => :de)
+        post.reload
+        post.should be_translated(:en).for(:title).as('title')
+        post.should be_translated(:de).for(:title).as('Titel')
+      end
+
+      it "returns the correct translation for an unsaved record after locale switching" do
+        post = Post.create(:title => 'title')
+        with_locale(:de) { post.title = 'Titel' }
+        post.should be_translated(:en).for(:title).as('title')
+        post.should be_translated(:de).for(:title).as('Titel')
+      end
+
+      it "returns the correct translation for both saved/unsaved records while switching locales" do
+        post = Post.new(:title => 'title')
+        with_locale(:de) { post.title = 'Titel' }
+        with_locale(:he) { post.title = 'שם' }
+        post.should be_translated(:de).for(:title).as('Titel')
+        post.should be_translated(:he).for(:title).as('שם')
+        post.should be_translated(:en).for(:title).as('title')
+        post.should be_translated(:he).for(:title).as('שם')
+        post.should be_translated(:de).for(:title).as('Titel')
+
+        post.save
+        post.reload
+        post.should be_translated(:de).for(:title).as('Titel')
+        post.should be_translated(:he).for(:title).as('שם')
+        post.should be_translated(:en).for(:title).as('title')
+        post.should be_translated(:he).for(:title).as('שם')
+        post.should be_translated(:de).for(:title).as('Titel')
+      end
+
+      it "returns nil if no translations are found on an unsaved record" do
+        post = Post.new(:title => 'foo')
+        post.title.should == 'foo'
+        post.content.should be_nil
+      end
+
+      it "returns nil if no translations are found on a saved record" do
+        post = Post.create(:title => 'foo')
+        post.reload
+        post.title.should == 'foo'
+        post.content.should be_nil
+      end
+    end
+  end
+
+  describe "before_type_cast reader" do
+    it "works for translated attributes" do
+      post = Post.create(:title => 'title')
+      post.update_attributes(:title => "Titel", :locale => :de)
+  
+      with_locale(:en) { post.title_before_type_cast.should == 'title' }
+      with_locale(:de) { post.title_before_type_cast.should == 'Titel' }
+    end
+  end
+
+  it "saves all translations on an sti model after locale switching" do
+    child = Child.new(:content => 'foo')
+    with_locale(:de) { child.content = 'bar' }
+    with_locale(:he) { child.content = 'baz' }
+    child.save
+    child.reload
+    child.should be_translated(:en).for(:content).as('foo')
+    child.should be_translated(:de).for(:content).as('bar')
+    child.should be_translated(:he).for(:content).as('baz')
+  end
+
+  describe "attribute reader" do
+    it "will use the current locale on Mongoid::Globalize or I18n without arguments" do
+      with_locale(:de){ Post.create!(:title => 'Titel', :content => 'Inhalt') }
+      I18n.locale = :de
+      Post.first.title.should == 'Titel'
+      I18n.locale = :en
+      Mongoid::Globalize.locale = :de
+      Post.first.title.should == 'Titel'
+    end
+
+    it "will use the given locale when passed a locale" do
+      post = with_locale(:de){ Post.create!(:title => 'Titel', :content => 'Inhalt') }
+      post.title(:de).should == 'Titel'
+    end
+  end
+
+  describe "modifying a translated attribute" do
+    it "does not change the untranslated value" do
+      post = Post.create(:title => 'title')
+      before = post.untranslated_attributes['title']
+      post.title = 'changed title'
+      post.untranslated_attributes['title'].should == before
+    end
+  end
+end

data/spec/mongoid_globalize/clone_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe "Clone" do
+  it 'stores translations from clonned new record' do
+    check_stored_translations(standard_post.clone)
+  end
+
+  it 'stores translations from clonned created record' do
+    clonned = saved_post.clone
+    check_stored_translations(clonned)
+  end
+
+  it 'stores translations from clonned found record' do
+    check_stored_translations( Post.find(saved_post.id).clone )
+  end
+
+  it 'stores translations from clonned reloaded after creation record' do
+    check_stored_translations(saved_post.reload.clone)
+  end
+end
+
+def standard_post
+  post = Post.new({:title => 'title', :content => 'content'})
+  with_locale(:he) { post.title= 'שם' }
+  post
+end
+
+def saved_post
+  standard_post.tap{|p| p.save!}
+end
+
+def translations_modifications(clonned)
+  clonned.content = 'another content'
+  with_locale(:de) { clonned.title = 'Titel' }
+end
+
+def translations_specs(clonned)
+  clonned.should be_translated(:en).for(:title).as('title')             # original
+  clonned.should be_translated(:en).for(:content).as('another content') # changed
+  clonned.should be_translated(:de).for(:title).as('Titel')             # new
+  clonned.should be_translated(:he).for(:title).as('שם')                # untouched language
+end
+
+def check_stored_translations(clonned)
+  translations_modifications(clonned)
+  translations_specs(clonned)
+  clonned.save!
+  clonned.reload
+  translations_specs(clonned)
+end

data/spec/mongoid_globalize/dirty_tracking_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe "Dirty tracking" do
+  it "works" do
+    post = Post.create(:title => 'title', :content => 'content')
+    post.changed.should == []
+
+    post.title = 'title'
+    post.changed.should == []
+
+    post.title = 'changed title'
+    post.changed.should == ['title']
+
+    post.content = 'changed content'
+    post.changed.should include('title', 'content')
+  end
+
+  it 'works per a locale' do
+    post = Post.create(:title => 'title', :content => 'content')
+    post.changed.should == []
+
+    post.title = 'changed title'
+    post.changes.should == { 'title' => ['title', 'changed title'] }
+    post.save
+
+    I18n.locale = :de
+    post.title = 'Alt Titel'
+
+    post.title = 'Titel'
+    post.changes.should == { 'title' => [nil, 'Titel'] }
+  end
+
+  it 'works after locale switching' do
+    post = Post.create(:title => 'title', :content => 'content')
+    post.changed.should == []
+
+    post.title = 'changed title'
+    I18n.locale = :de
+    post.changed.should == ['title']
+  end
+
+  it 'works on sti model' do
+    child = Child.create(:content => 'foo')
+    child.changed.should == []
+
+    child.content = 'bar'
+    child.changed.should == ['content']
+
+    child.content = 'baz'
+    child.changed.should include('content')
+  end
+
+  it 'works on sti model after locale switching' do
+    child = Child.create(:content => 'foo')
+    child.changed.should == []
+
+    child.content = 'bar'
+    I18n.locale = :de
+    child.changed.should == ['content']
+  end
+end

data/spec/mongoid_globalize/fallbacks_spec.rb

@@ -0,0 +1,135 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe "Fallbacks" do
+  before :each do
+    @previous_backend = I18n.backend
+    I18n.pretend_fallbacks
+    I18n.backend = BackendWithFallbacks.new
+
+    I18n.locale = :'en-US'
+    I18n.fallbacks = ::I18n::Locale::Fallbacks.new
+  end
+
+  after :each do
+    I18n.fallbacks.clear
+    I18n.hide_fallbacks
+    I18n.backend = @previous_backend
+  end
+
+  it "keep one field in new locale when other field is changed" do
+    I18n.fallbacks.map('de-DE' => [ 'en-US' ])
+    post = Post.create :title => 'foo'
+    I18n.locale = 'de-DE'
+    post.content = 'bar'
+    post.title.should == 'foo'
+  end
+
+  it "modify non-required field in a new locale" do
+    I18n.fallbacks.map 'de-DE' => [ 'en-US' ]
+    post = Post.create :title => 'foo'
+    I18n.locale = 'de-DE'
+    post.content = 'bar'
+    post.save.should be_true
+  end
+
+  it "resolve a simple fallback" do
+    I18n.locale = 'de-DE'
+    post = Post.create :title => 'foo'
+
+    I18n.locale = 'de'
+    post.title = 'baz'
+    post.content = 'bar'
+    post.save!
+
+    I18n.locale = 'de-DE'
+    post.title.should == 'foo'
+    post.content.should == 'bar'
+  end
+
+  it "resolve a simple fallback without reloading" do
+    I18n.locale = 'de-DE'
+    post = Post.new :title => 'foo'
+
+    I18n.locale = 'de'
+    post.title = 'baz'
+    post.content = 'bar'
+
+    I18n.locale = 'de-DE'
+    post.title.should == 'foo'
+    post.content.should == 'bar'
+  end
+
+  it "resolve a complex fallback without reloading" do
+    I18n.fallbacks.map 'de' => %w(en he)
+    I18n.locale = 'de'
+    post = Post.new
+    I18n.locale = 'en'
+    post.title = 'foo'
+    I18n.locale = 'he'
+    post.title = 'baz'
+    post.content = 'bar'
+    I18n.locale = 'de'
+    post.title.should == 'foo'
+    post.content.should == 'bar'
+  end
+
+  it 'work with lots of locale switching' do
+    I18n.fallbacks.map :'de-DE' => [ :'en-US' ]
+    post = Post.create :title => 'foo'
+    I18n.locale = :'de-DE'
+    post.title.should == 'foo'
+
+    I18n.locale = :'en-US'
+    post.update_attributes(:title => 'bar')
+    I18n.locale = :'de-DE'
+    post.title.should == 'bar'
+  end
+
+  it 'work with lots of locale switching 2' do
+    I18n.fallbacks.map :'de-DE' => [ :'en-US' ]
+    child = Child.create :content => 'foo'
+    I18n.locale = :'de-DE'
+    child.content.should == 'foo'
+
+    I18n.locale = :'en-US'
+    child.update_attributes(:content => 'bar')
+    I18n.locale = :'de-DE'
+    child.content.should == 'bar'
+  end
+
+  it 'work with nil translations' do
+    I18n.fallbacks.map :'de-DE' => [ :'en-US' ]
+    post = Post.create :title => 'foo'
+    I18n.locale = :'de-DE'
+    post.title.should == 'foo'
+
+    post.update_attribute :title, nil
+    post.title.should == 'foo'
+  end
+
+  it 'work with empty translations' do
+    I18n.fallbacks.map :'de-DE' => [ :'en-US' ]
+    task = Task.create :name => 'foo'
+    I18n.locale = :'de-DE'
+    task.name.should == 'foo'
+
+    task.update_attribute :name, ''
+    task.name.should == 'foo'
+  end
+
+  it 'work with empty translations 2' do
+    I18n.fallbacks.map :'de-DE' => [ :'en-US' ]
+    task = Task.create :name => 'foo'
+    post = Post.create :title => 'foo'
+    I18n.locale = :'de-DE'
+    task.name.should == 'foo'
+    post.title.should == 'foo'
+
+    task.update_attribute :name, ''
+    task.name.should == 'foo'
+
+    post.update_attribute :title, ''
+    post.title.should == ''
+  end
+end

data/spec/mongoid_globalize/locale_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Mongoid::Globalize do
+  it "has locale accessors" do
+    Mongoid::Globalize.should respond_to(:locale)
+    Mongoid::Globalize.should respond_to(:locale=)
+  end
+
+  describe "#locale reader" do
+    it "can be called before a locale was set" do
+      Mongoid::Globalize.locale = nil
+      lambda{ Mongoid::Globalize.locale }.should_not raise_error
+    end
+  end
+
+  describe 'locale setting' do
+    it "works" do
+      I18n.locale.should == :en
+      Mongoid::Globalize.locale.should == :en
+
+      I18n.locale = :de
+      I18n.locale.should == :de
+      Mongoid::Globalize.locale.should == :de
+
+      Mongoid::Globalize.locale = :es
+      I18n.locale.should == :de
+      Mongoid::Globalize.locale.should == :es
+
+      I18n.locale = :fr
+      I18n.locale.should == :fr
+      Mongoid::Globalize.locale.should == :es
+    end
+
+    it "works with strings" do
+      I18n.locale = 'de'
+      Mongoid::Globalize.locale = 'de'
+      Mongoid::Globalize.locale.should == I18n.locale
+
+      I18n.locale = 'de'
+      Mongoid::Globalize.locale = :de
+      Mongoid::Globalize.locale.should == I18n.locale
+
+      I18n.locale =  :de
+      Mongoid::Globalize.locale = 'de'
+      Mongoid::Globalize.locale.should == I18n.locale
+    end
+  end
+  
+  describe "with_locale" do
+    it "temporarily sets the given locale and yields the block" do
+      Mongoid::Globalize.locale.should == :en
+      Mongoid::Globalize.with_locale :de do |locale|
+        Mongoid::Globalize.locale.should == :de
+        locale.should == :de
+      end
+      Mongoid::Globalize.locale.should == :en
+    end
+
+    it "calls block once with each locale given temporarily set" do
+      locales = Mongoid::Globalize.with_locales :en, [:de, :fr] do |locale|
+        Mongoid::Globalize.locale.should == locale
+        locale
+      end
+      locales.should == [:en, :de, :fr]
+    end
+  end
+
+  describe "attribute saving" do
+    it "goes by content locale and not global locale" do
+      Mongoid::Globalize.locale = :de
+      I18n.locale.should == :en
+      Post.create :title => 'foo'
+      Post.first.translations.first.locale.should == :de
+    end
+  end
+
+  describe "attribute loading" do
+    it "goes by content locale and not global locale" do
+      post = Post.create(:title => 'title')
+      Post.first.should be_translated(:en).for(:title).as('title')
+
+      Mongoid::Globalize.locale = :de
+      post.update_attributes(:title => 'Titel')
+      Post.first.should be_translated(:en).for(:title).as('title')
+      Post.first.should be_translated(:de).for(:title).as('Titel')
+    end
+  end
+end

data/spec/mongoid_globalize/set_translations_spec.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe "#set_translations" do
+  it "sets multiple translations at once" do
+    post = Post.create(:title => 'title', :content => 'content', :locale => :en)
+    post.update_attributes(:title => 'Titel', :content => 'Inhalt', :locale => :de)
+    post.set_translations(
+      :en => { :title => 'updated title', :content => 'updated content' },
+      :de => { :title => 'geänderter Titel', :content => 'geänderter Inhalt' }
+    )
+    post.reload
+    post.should be_translated(:en).for([:title, :content])
+                .as(['updated title', 'updated content'])
+    post.should be_translated(:de).for([:title, :content])
+                .as(['geänderter Titel', 'geänderter Inhalt'])
+  end
+
+  it "does not touch existing translations for other locales" do
+    post = Post.create(:title => 'title', :content => 'content', :locale => :en)
+    post.update_attributes(:title => 'Titel', :content => 'Inhalt', :locale => :de)
+    post.set_translations(:en => { :title => 'updated title', :content => 'updated content' })
+    post.reload
+    post.should be_translated(:en).for([:title, :content])
+                .as(['updated title', 'updated content'])
+    post.should be_translated(:de).for([:title, :content]).as(['Titel', 'Inhalt'])
+  end
+
+  it "does not touch existing translations for other attributes" do
+    post = Post.create(:title => 'title', :content => 'content', :locale => :en)
+    post.update_attributes(:title => 'Titel', :content => 'Inhalt', :locale => :de)
+    post.set_translations(
+      :en => { :title => "updated title" },
+      :de => { :content => "geänderter Inhalt" }
+    )
+    post.reload
+    post.should be_translated(:en).for([:title, :content]).as(['updated title', 'content'])
+    post.should be_translated(:de).for([:title, :content]).as(['Titel', 'geänderter Inhalt'])
+  end
+
+  # in G3 error raises here. But Mongo it support, so why not.. :)
+  it "sets unknown attributes" do
+    post = Post.create(:title => 'title', :content => 'content', :locale => :en)
+    post.update_attributes(:title => 'Titel', :content => 'Inhalt', :locale => :de)
+    post.set_translations :de => {:does_not_exist => 'not exist'}
+    post.reload
+    post.translation_for(:de).does_not_exist.should == 'not exist'
+  end
+end