mongoid_globalize 0.1.0 → 0.1.1

data/Gemfile

@@ -1,6 +1,5 @@
 source "http://rubygems.org"
 
-gem 'activemodel', '3.1.0.rc4'
 gem 'mongoid', :git => 'git://github.com/mongoid/mongoid.git'
 gem 'bson_ext'
 

data/Gemfile.lock

@@ -10,23 +10,20 @@ GIT
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.1.0.rc4)
-      activesupport (= 3.1.0.rc4)
-      bcrypt-ruby (~> 2.1.4)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activesupport (3.1.0.rc4)
-      multi_json (~> 1.0)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.9)
     archive-tar-minitar (0.5.2)
-    bcrypt-ruby (2.1.4)
     bson (1.3.1)
     bson_ext (1.3.1)
-    builder (3.0.0)
+    builder (2.1.2)
     columnize (0.3.4)
     database_cleaner (0.6.7)
     diff-lcs (1.1.2)
     git (1.2.5)
-    i18n (0.6.0)
+    i18n (0.5.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -38,7 +35,6 @@ GEM
     mongoid-rspec (1.4.4)
       mongoid (~> 2.0)
       rspec (~> 2)
-    multi_json (1.0.3)
     rake (0.9.2)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
@@ -64,7 +60,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activemodel (= 3.1.0.rc4)
   bson_ext
   database_cleaner
   jeweler

data/README.textile

@@ -0,0 +1,122 @@
+h1. Mongoid::Globalize
+
+Mongoid::Globalize is based on Globalize3, but targeted at Mongoid. As Globalize3, it is compatible with and builds on the new "I18n API in Ruby on Rails":http://guides.rubyonrails.org/i18n.html and adds model translations to Mongoid::Document.
+
+Mongoid::Globalize has to work with other frameworks, that supports Mongoid (Sinatra, Padrino, and others).
+
+h2. Requirements
+
+Mongoid > 2.0.2
+
+Yes, at this moment Mongoid::Globalize doesn't support any published versions of Mongoid gem, so you need to clone master branch of this gem. I tested with "revision: e2540c818ebb1d37b3a8d1b7e6dd6836ce16d445":https://github.com/mongoid/mongoid/tree/e2540c818ebb1d37b3a8d1b7e6dd6836ce16d445, future revisions break some specs, so I wait for stable mongoid-2.1.0.
+
+I also tested against ActiveModel-3.1.0.rc4, so Mongoid::Globalize has to work with Rails 3.1.
+
+h2. Installation
+
+To install Mongoid::Globalize just use:
+
+<pre><code>
+$ gem install mongoid_globalize
+</code></pre>
+
+or, with bundler, in your Gemfile
+
+<pre><code>
+gem 'mongoid_globalize'
+</code></pre>
+
+h2. Document translations
+
+Document translations allow you to translate your document' field values. In order to make this work, you'll need to add +include Mongoid::Globalize+ into your document class and define translatable fields in block of +translates+ method, as you define usual fields. E.g.
+
+<pre><code>
+class Post
+  include Mongoid::Document
+  include Mongoid::Globalize
+  translates do
+    field :title
+    field :content
+    field :published, type: Boolean
+  end
+end
+</code></pre>
+
+This allows you to translate the fields :title, :text and :published per locale:
+
+<pre><code>
+I18n.locale = :en
+post.title # => Globalize rocks!
+
+I18n.locale = :ru
+post.title # => Глобалайз рулит!
+</code></pre>
+
+h2. I18n fallbacks for empty translations
+
+It is possible to enable fallbacks for empty translations. It will depend on the configuration setting you have set for I18n translations in your config.
+
+In Rails applications, for example, you can enable them by adding the next line to @config/application.rb@ (or only @config/environments/production.rb@ if you only want them in production)
+
+<pre><code>config.i18n.fallbacks = true</code></pre>
+
+By default, Mongoid::Globalize will only use fallbacks when your translation model does not exist or the translation value for the item you've requested is @nil@. However it is possible to also use fallbacks for @blank@ translations by adding @fallbacks_for_empty_translations!@ to the @translates@ block.
+
+<pre><code>
+  class Post
+    include Mongoid::Document
+    include Mongoid::Globalize
+    translates do
+      field :title
+      field :content
+    end
+  end
+
+  puts post.translations.inspect
+  # => [#<Post::Translation id: 1, post_id: 1, locale: "en", title: "Globalize rocks!", name: "Globalize">, #<Post::Translation id: 2, post_id: 1, locale: "nl", title: '', name: nil>]
+
+  I18n.locale = :en
+  post.title # => 'Globalize rocks!'
+  post.name  # => 'Globalize'
+
+  I18n.locale = :nl
+  post.title # => ''
+  post.name  # => 'Globalize'
+</code></pre>
+<pre><code>
+  class Post
+    include Mongoid::Document
+    include Mongoid::Globalize
+    translates do
+      field :title
+      field :content
+      fallbacks_for_empty_translations!
+    end
+  end
+
+  puts post.translations.inspect
+  # => [#<Post::Translation id: 1, post_id: 1, locale: "en", title: "Globalize rocks!", name: "Globalize">, #<Post::Translation id: 2, post_id: 1, locale: "nl", title: '', name: nil>]
+
+  I18n.locale = :en
+  post.title # => 'Globalize rocks!'
+  post.name  # => 'Globalize'
+
+  I18n.locale = :nl
+  post.title # => 'Globalize rocks!'
+  post.name  # => 'Globalize'
+</code></pre>
+
+
+h2. Scoping objects by those with translations
+
+To only return objects that have a translation for the given locale we can use the `with_translations` scope. This will only return records that have a translations for the passed in locale.
+
+<pre><code>
+
+Post.with_translations('en') # => [#<Post::Translation id: 1, post_id: 1, locale: "en", title: "Globalize rocks!", name: "Globalize">, #<Post::Translation id: 2, post_id: 1, locale: "nl", title: '', name: nil>]
+
+Post.with_translations(I18n.locale) # => [#<Post::Translation id: 1, post_id: 1, locale: "en", title: "Globalize rocks!", name: "Globalize">, #<Post::Translation id: 2, post_id: 1, locale: "nl", title: '', name: nil>]
+
+Post.with_translations('de') # => []
+
+</code></pre>

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/mongoid_globalize/act_macro.rb

@@ -1,23 +1,12 @@
 module Mongoid::Globalize
   module ActMacro
-    # TODO: other interface of +translates+. Like this:
-    #     translates do
-    #       field :title
-    #       field :visible, type: Boolean
-    #     end
-    def translates(*attr_names_or_hashes)
-      attr_hash = attr_names_or_hashes.inject({}) do |hash,attr|
-        hash.merge(attr.is_a?(Hash) ? attr : {attr => String})
-      end
-      attr_hash.each do |name, type|
-        self.translated_attribute_names.push name.to_sym
-        translated_attr_accessor(name)
-        translation_class.field name, type: type
-      end
-    end
-
-    def fallbacks_for_empty_translations!
-      self.fallbacks_for_empty_translations = true
+    #    translates do
+    #      field :title
+    #      field :visible, type: Boolean
+    #    end
+    def translates(&block)
+      builder = FieldsBuilder.new(self)
+      builder.instance_exec(&block)
     end
   end
 end

data/lib/mongoid_globalize/adapter.rb

@@ -29,22 +29,12 @@ module Mongoid::Globalize
       stash.write(locale, name, value)
     end
 
-    def save_translations!
-      stash.each do |locale, attrs|
-        translation = record.translations.find_or_initialize_by_locale(locale.to_s)
-        attrs.each{ |name, value| translation[name] = value }
-        translation.save!
-      end
-      # TODO: it's actual for mongoid?
-      #record.translations.reset
-      reset
-    end
-
     def prepare_translations!
       stash.each do |locale, attrs|
         translation = record.translations.find_or_initialize_by_locale(locale.to_s)
         attrs.each{ |name, value| translation[name] = value }
       end
+      reset
     end
 
     def reset

data/lib/mongoid_globalize/class_methods.rb

@@ -1,29 +1,34 @@
 module Mongoid::Globalize
   module ClassMethods
-    delegate :translated_locales, :to => :translation_class
+    def translated_locales
+      all.distinct("translations.locale").sort.map &:to_sym
+    end
 
-    # TODO: At first deal with +translated_locales+
-    #
-    #def with_locales(*locales)
-    #  scoped.merge(translation_class.with_locales(*locales))
-    #end
-    #
-    #def with_translations(*locales)
-    #  locales = translated_locales if locales.empty?
-    #  includes(:translations).with_locales(locales).with_required_attributes
-    #end
-    #
-    #def with_required_attributes
-    #  required_translated_attributes.inject(scoped) do |scope, name|
-    #    scope.where("#{translated_column_name(name)} IS NOT NULL")
-    #  end
-    #end
-    #
+    def with_locales(*locales)
+      where(translated_field_name(:locale).in => locales.flatten)
+    end
+    
+    def with_translations(*locales)
+      locales = translated_locales if locales.empty?
+      with_locales(locales).with_required_attributes
+    end
+    
+    def with_required_attributes
+      required_translated_attributes.inject(self) do |scope, name|
+        scope.where(translated_field_name(name).exists => true)
+      end
+    end
+
+    def translated_field_name(name)
+      "translations.#{name}".to_sym
+    end
+
+    # TODO:
     #def with_translated_attribute(name, value, locales = nil)
     #  locales ||= Globalize.fallbacks
     #  with_translations.where(
-    #    translated_column_name(name)    => value,
-    #    translated_column_name(:locale) => Array(locales).map(&:to_s)
+    #    translated_field_name(name)    => value,
+    #    translated_field_name(:locale) => Array(locales).map(&:to_s)
     #  )
     #end
 
@@ -46,11 +51,11 @@ module Mongoid::Globalize
           klass = self.const_set(:Translation, Class.new(Mongoid::Globalize::DocumentTranslation))
         end
         klass.embedded_in name.underscore.gsub('/', '_')
+        klass.translated_klass = self
         klass
       end
     end
 
-  protected
     def translated_attr_accessor(name)
       define_method(:"#{name}=") do |value|
         write_attribute(name, value)

data/lib/mongoid_globalize/document_translation.rb

@@ -3,6 +3,8 @@ module Mongoid::Globalize
     include Mongoid::Document
     field :locale
     class << self
+      attr_accessor :translated_klass
+
       def with_locales(*locales)
         locales = locales.flatten.map(&:to_s)
         where(:locale.in => locales)
@@ -10,8 +12,7 @@ module Mongoid::Globalize
       alias with_locale with_locales
 
       def translated_locales
-        # TODO
-        []
+        all.distinct("locale").sort.map &:to_sym
       end
 
       def find_or_initialize_by_locale(locale)

data/lib/mongoid_globalize/fields_builder.rb

@@ -0,0 +1,17 @@
+module Mongoid::Globalize
+  class FieldsBuilder
+    def initialize(model)
+      @model = model
+    end
+
+    def field(name, *params)
+      @model.translated_attribute_names.push name.to_sym
+      @model.translated_attr_accessor(name)
+      @model.translation_class.field name, *params
+    end
+
+    def fallbacks_for_empty_translations!
+      @model.fallbacks_for_empty_translations = true
+    end
+  end
+end

data/lib/mongoid_globalize/instance_methods.rb

@@ -19,19 +19,6 @@ module Mongoid::Globalize
       with_given_locale(attributes) { super }
     end
 
-    # All of this replaced by #process.. may be :)
-    #def write_attributes(attributes, *args)
-    #  with_given_locale(attributes) { super }
-    #end
-
-    #def update_attributes!(attributes, *args)
-    #  with_given_locale(attributes) { super }
-    #end
-    #
-    #def update_attributes(attributes, *args)
-    #  with_given_locale(attributes) { super }
-    #end
-
     def write_attribute(name, value, options = {})
       if translated?(name)
         options = {:locale => nil}.merge(options)
@@ -138,23 +125,13 @@ module Mongoid::Globalize
       locales
     end
 
-    def unmerge_translations!
+    def prepare_translations!
       @stop_merging_translated_attributes = true
       translated_attribute_names.each do |name|
         @attributes.delete name.to_s
         @changed_attributes.delete name.to_s
       end
-    end
-
-    def create_translations!
-      globalize.save_translations!
-      clear_translations!
-    end
-
-    def update_translations!
-      unmerge_translations!
       globalize.prepare_translations!
-      globalize.reset
     end
 
     def clear_translations!

data/lib/mongoid_globalize.rb

@@ -3,6 +3,7 @@ require 'mongoid_globalize/act_macro'
 require 'mongoid_globalize/attributes'
 require 'mongoid_globalize/class_methods'
 require 'mongoid_globalize/document_translation'
+require 'mongoid_globalize/fields_builder'
 require 'mongoid_globalize/instance_methods'
 
 module Mongoid::Globalize
@@ -11,11 +12,8 @@ module Mongoid::Globalize
     class_attribute :translated_attribute_names, :fallbacks_for_empty_translations
     self.translated_attribute_names = []
     embeds_many :translations, :class_name  => translation_class.name
-                #:extend => HasManyExtensions
-    before_create :unmerge_translations!
-    after_create :create_translations!
-    before_update :update_translations!
-    after_create :clear_translations!
+    before_save :prepare_translations!
+    after_save :clear_translations!
 
     extend Mongoid::Globalize::ActMacro
   end
@@ -60,10 +58,4 @@ module Mongoid::Globalize
       Thread.current[:globalize_locale] = locale.to_sym rescue nil
     end
   end
-  #
-  #module HasManyExtensions
-  #  def find_or_initialize_by_locale(locale)
-  #    with_locale(locale.to_s).first || build(:locale => locale.to_s)
-  #  end
-  #end
 end

data/mongoid_globalize.gemspec

@@ -5,15 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid_globalize}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   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.date = %q{2011-07-26}
   s.description = %q{Library for translating Mongoid documents, based on Globalize3 principles}
   s.email = %q{MikDiet@gmail.com}
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.textile"
   ]
   s.files = [
     ".rspec",
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "MIT-LICENSE",
-    "README.rdoc",
+    "README.textile",
     "Rakefile",
     "VERSION",
     "lib/mongoid_globalize.rb",
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "lib/mongoid_globalize/attributes.rb",
     "lib/mongoid_globalize/class_methods.rb",
     "lib/mongoid_globalize/document_translation.rb",
+    "lib/mongoid_globalize/fields_builder.rb",
     "lib/mongoid_globalize/instance_methods.rb",
     "mongoid_globalize.gemspec",
     "spec/data/models.rb",
@@ -54,7 +55,6 @@ Gem::Specification.new do |s|
     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"])
@@ -63,7 +63,6 @@ Gem::Specification.new do |s|
       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"])
@@ -73,7 +72,6 @@ Gem::Specification.new do |s|
       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"])

data/spec/data/models.rb

@@ -2,10 +2,12 @@ class Post
   include Mongoid::Document
   include Mongoid::Globalize
   belongs_to :blog
-  translates :title, :content
-
-  translates :published => Boolean
-  translates :published_at => DateTime
+  translates do
+    field :title
+    field :content
+    field :published, type: Boolean
+    field :published_at, type: DateTime
+  end
   validates_presence_of :title
   scope :with_some_title, :conditions => { :title => 'some_title' }
 end
@@ -15,8 +17,8 @@ class PostTranslation
   field :locale
   field :title
   field :content
-  field :published => Boolean
-  field :published_at => DateTime
+  field :published, type: Boolean
+  field :published_at, type: DateTime
   embedded_in :post
 
   def existing_method
@@ -36,13 +38,16 @@ end
 class Validatee
   include Mongoid::Document
   include Mongoid::Globalize
-  translates :string
+  translates{ field :string }
 end
 
 class Parent
   include Mongoid::Document
   include Mongoid::Globalize
-  translates :content, :type
+  translates do
+    field :content
+    field :type
+  end
 end
 
 class Child < Parent
@@ -57,14 +62,17 @@ end
 
 class TranslatedComment < Comment
   include Mongoid::Globalize
-  translates :content, :title
+  translates do
+    field :content
+    field :title
+  end
 end
 
 class User
   include Mongoid::Document
   include Mongoid::Timestamps
   include Mongoid::Globalize
-  translates :name
+  translates{ field :name }
   field :email
   validates_presence_of :name, :email
 end
@@ -72,6 +80,8 @@ end
 class Task
   include Mongoid::Document
   include Mongoid::Globalize
-  fallbacks_for_empty_translations!
-  translates :name
+  translates do
+    fallbacks_for_empty_translations!
+    field :name
+  end
 end

data/spec/mongoid_globalize/translation_class_spec.rb

@@ -32,7 +32,7 @@ describe "Translation class" do
           class Baz
             include Mongoid::Document
             include Mongoid::Globalize
-            translates :bumm
+            translates{ field :bumm }
           end
         end
       end

data/spec/mongoid_globalize_spec.rb

@@ -119,7 +119,6 @@ describe Mongoid::Globalize do
 
   describe "#translated_locales" do
     it "returns locales that have translations" do
-      pending "TODO"
       first = Post.create!(:title => 'title', :locale => :en)
       first.update_attributes(:title => 'Title', :locale => :de)
       second = Post.create!(:title => 'title', :locale => :en)
@@ -144,12 +143,21 @@ describe Mongoid::Globalize do
   end
 
   describe "#with_translations" do
-    it "eager loads translations" do
-      pending "TODO"
+    it "loads only documents with translations" do
       Post.create(:title => 'title 1')
-      Post.create(:title => 'title 2')  
-      Post.with_translations.first.translations.should be_loaded
-      Post.with_translations.map(&:title).should == ['title 1', 'title 2']
+      Post.create(:title => 'title 2')
+      Post.with_translations.map(&:title).sort.should == ['title 1', 'title 2']
+      Post.with_translations(:de).should == []
+    end
+
+    it "doesn't load document with present locale, but absent required attributes" do
+      post = Post.create(:title => 'title 1')
+      post.set_translations(
+        :en => { :title => 'updated title' },
+        :ru => { :content => 'без заголовка' }
+      )
+      Post.with_translations(:en).first.should == post
+      Post.with_translations(:de).should == []
     end
   end
 

metadata

@@ -2,7 +2,7 @@
 name: mongoid_globalize
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Mik-die
@@ -10,21 +10,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-25 00:00:00 Z
+date: 2011-07-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activemodel
+  name: mongoid
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.1.0.rc4
+        version: "0"
   type: :runtime
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: mongoid
+  name: bson_ext
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -35,18 +35,18 @@ dependencies:
   prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: bson_ext
+  name: rspec
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: mongoid-rspec
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,7 +57,7 @@ dependencies:
   prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: mongoid-rspec
+  name: database_cleaner
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -68,7 +68,7 @@ dependencies:
   prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: database_cleaner
+  name: ruby-debug19
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -79,7 +79,7 @@ dependencies:
   prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: ruby-debug19
+  name: jeweler
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -89,17 +89,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id008
 description: Library for translating Mongoid documents, based on Globalize3 principles
 email: MikDiet@gmail.com
 executables: []
@@ -107,14 +96,14 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.textile
 files: 
 - .rspec
 - .rvmrc
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - lib/mongoid_globalize.rb
@@ -123,6 +112,7 @@ files:
 - lib/mongoid_globalize/attributes.rb
 - lib/mongoid_globalize/class_methods.rb
 - lib/mongoid_globalize/document_translation.rb
+- lib/mongoid_globalize/fields_builder.rb
 - lib/mongoid_globalize/instance_methods.rb
 - mongoid_globalize.gemspec
 - spec/data/models.rb
@@ -149,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -528582867
+      hash: -1007506339
       segments: 
       - 0
       version: "0"