mongoid_denormalize 0.2.0 → 0.2.2

data/README.md

@@ -34,11 +34,11 @@ In your model:
 Example
 -------
 
-    def User
+    class User
       include Mongoid::Document
       include Mongoid::Denormalize
 
-      references_many :comments
+      has_many :comments
 
       field :name
       field :email
@@ -46,11 +46,11 @@ Example
       denormalize :name, :email, :to => :comments
     end
     
-    def Comment
+    class Comment
       include Mongoid::Document
       include Mongoid::Denormalize
 
-      referenced_in :user
+      belongs_to :user
 
       field :body
       
@@ -87,6 +87,14 @@ the parent. When using the `:to` option, the parent will push the values to its
     # Multiple children. Will set the user_name attribute of "self.posts" and "self.comments" with "self.name".
     denormalize :name, :to => [:posts, :comments]
 
+You must specify the type of all denormalizations when using the `:from` option, unless the denormalized type is `String`, the default.
+ 
+    # in User
+    field :location, :type => Array
+    denormalize :location, :to => :posts
+    
+    # in Post
+    denormalize :location, :type => Array, :from => :user
 
 Rake tasks
 ----------
@@ -104,12 +112,20 @@ Known issues
 
 **Relational associations in combination with embedded records**
 
-If you are using denormalize with the `:to` option, to denormalize values on a relational association that is embedded in another collection,
-the denormalized fields will not be updated when the parent record is changed. This is due to a limitation in Mongoid that prevents querying
-embedded records through relational associations. One way to overcome this issue is to run `rake db:denormalize` in a cron job.
+It is not recommended nor supported to use mongoid_denormalize to perform denormalization to embedded records through a relational association because
+ MongoDB/Mongoid do not support direct access to embedded fields via a relational association.
+
+So, if User has_many :posts and User has_many :comments, but Comments are embedded_in :post, a user can't directly access a comment.
+
+
+Contributors
+-------
+* hubsmoke (https://github.com/hubsmoke)
+* Leo Lou (https://github.com/l4u)
+* Austin Bales (https://github.com/arbales)
 
 
 Credits
 -------
 
-Copyright (c) 2010 Logan Raarup, released under the MIT license.
+Copyright (c) 2010 Logan Raarup, released under the MIT license.

data/lib/mongoid_denormalize.rb

@@ -33,7 +33,7 @@ module Mongoid::Denormalize
 
       # Define schema
       unless options[:to]
-        fields.each { |name| field "#{options[:from]}_#{name}", :type => options[:type] }
+        fields.each { |name| field "#{options[:from]}_#{name}", :type => options[:type] || String }
       end
     end
   end
@@ -59,14 +59,21 @@ module Mongoid::Denormalize
     def denormalize_to
       self.denormalize_definitions.each do |definition|
         next unless definition[:options][:to]
+        assigns = Hash[*definition[:fields].collect { |name| ["#{self.class.name.underscore}_#{name}", self.send(name)] }.flatten(1)]
         
-        assigns = Hash[*definition[:fields].collect { |name| ["#{self.class.name.underscore}_#{name}", self.send(name)] }.flatten]
-        
+      
         [definition[:options][:to]].flatten.each do |association|
-          if [:embedded_in, :embeds_one, :referenced_in, :references_one].include? self.class.reflect_on_association(association)
-            self.send(association).update_attributes(assigns) unless self.send(association).blank?
+          relation = []
+          reflect = self.class.reflect_on_association(association)
+          relation = reflect.relation.macro unless reflect.nil? || reflect.relation.nil?
+          
+          if [:embedded_in, :embeds_one, :referenced_in, :references_one, :has_one, :belongs_to].include? relation
+            c = self.send(association)
+          
+            c.update_attributes(assigns) unless c.blank?
           else
-            self.send(association).to_a.each { |a| a.update_attributes(assigns) }
+            c = self.send(association)
+            c.to_a.each { |a| a.update_attributes(assigns) }
           end
         end
       end

data/lib/railties/denormalize.rake

@@ -4,11 +4,11 @@ namespace :db do
     get_denormalizable_models.each do |klass|
       if klass.embedded?
         reflection = klass.reflect_on_all_associations(:embedded_in).first
-        parent     = reflection.options[:name].to_s.classify.constantize
+        parent     = reflection.class_name.to_s.classify.constantize
         
         unless parent.embedded?
           parent.all.each do |parent_instance|
-            parent_instance.send(reflection.options[:inverse_of]).each(&:repair_denormalized!)
+            parent_instance.send(reflection.inverse).each(&:repair_denormalized!)
           end
         end
       else

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Logan Raarup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-07 00:00:00 +02:00
+date: 2011-08-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,14 +22,13 @@ dependencies:
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 2
-        - 0
-        - 0
-        - beta9
-        version: 2.0.0.beta9
+        - 1
+        - 9
+        version: 2.1.9
   type: :runtime
   version_requirements: *id001
 description: Helper module for denormalizing association attributes in Mongoid models.
@@ -52,8 +51,8 @@ homepage: http://github.com/logandk/mongoid_denormalize
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -77,9 +76,5 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Mongoid denormalization helper.
-test_files: 
-- spec/app/models/comment.rb
-- spec/app/models/post.rb
-- spec/app/models/user.rb
-- spec/mongoid_denormalize_spec.rb
-- spec/spec_helper.rb
+test_files: []
+

data/spec/app/models/comment.rb

@@ -1,13 +0,0 @@
-class Comment
-  include Mongoid::Document
-  include Mongoid::Denormalize
-  
-  field :body
-  
-  embedded_in :post, :inverse_of => :comments
-  referenced_in :user
-  
-  denormalize :name, :from => :user
-  denormalize :email, :from => :user
-  denormalize :created_at, :type => Time, :from => :post
-end

data/spec/app/models/post.rb

@@ -1,14 +0,0 @@
-class Post
-  include Mongoid::Document
-  include Mongoid::Denormalize
-  
-  field :title
-  field :body
-  field :created_at, :type => Time
-  
-  referenced_in :user
-  embeds_many :comments
-  
-  denormalize :name, :email, :from => :user
-  denormalize :created_at, :to => :comments
-end

data/spec/app/models/user.rb

@@ -1,12 +0,0 @@
-class User
-  include Mongoid::Document
-  include Mongoid::Denormalize
-  
-  field :name
-  field :email
-  
-  references_one :post
-  references_many :comments
-  
-  denormalize :name, :email, :to => [:post, :comments]
-end

data/spec/mongoid_denormalize_spec.rb

@@ -1,103 +0,0 @@
-require "spec_helper"
-
-describe Mongoid::Denormalize do
-  before(:all) do
-    Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:drop)
-    
-    @post = Post.create!(:title => "Blog post", :body => "Lorem ipsum...", :created_at => Time.parse("Jan 1 2010 12:00"))
-    @user = User.create!(:name => "John Doe", :email => "john@doe.com", :post => @post)
-    @comment = @post.comments.create(:body => "This is the comment", :user => @user)
-    
-    @user.comments << @comment
-    
-    @other_user = User.create!(:name => "Bill")
-  end
-
-  context "denormalize from" do
-    it "should define multiple fields for association" do
-      @post.fields.should have_key "user_name"
-      @post.fields.should have_key "user_email"
-    end
-    
-    it "should default to string field type for associated fields" do
-      @post.fields["user_name"].type.should eql String
-    end
-    
-    it "should allow setting the field type for associated fields" do
-      @comment.fields["post_created_at"].type.should eql Time
-    end
-    
-    it "should allow multiple declarations for the same association" do
-      @comment.fields.should have_key "user_name"
-      @comment.fields.should have_key "user_email"
-    end
-    
-    it "should denormalize fields without specified type" do
-      @comment.user_name.should eql @user.name
-      @comment.user_email.should eql @user.email
-      @post.user_name.should eql @user.name
-      @post.user_email.should eql @user.email
-    end
-    
-    it "should denormalize fields with specified type" do
-      @comment.post_created_at.should eql @post.created_at
-    end
-    
-    it "should update denormalized values if attribute is changed" do
-      @user.update_attributes(:name => "Bob Doe")
-      
-      @comment.user_name.should eql @user.name
-    end
-    
-    it "should update denormalized values if object is changed" do
-      @other_user = User.create!(:name => "Bill", :email => "bill@doe.com")
-      
-      @comment.user = @other_user
-      @comment.save!
-      
-      @comment.user_name.should eql @other_user.name
-      @comment.user_email.should eql @other_user.email
-    end
-  end
-  
-  context "denormalize to" do
-    it "should push denormalized fields to one-to-one association" do
-      @user.name = "Elvis"
-      @user.save!
-      
-      @post.user_name.should eql "Elvis"
-    end
-    
-    it "should push denormalized fields to one-to-many association" do
-      @post.created_at = Time.parse("Jan 1 2011 12:00")
-      @post.save!
-      
-      @comment.post_created_at.should eql Time.parse("Jan 1 2011 12:00")
-    end
-  end
-  
-  context "rake task" do
-    it "should correct inconsistent denormalizations on regular documents" do
-      Post.collection.update({ '_id' => @post.id }, { '$set' => { 'user_name' => 'Clint Eastwood' } })
-      
-      Rake::Task["db:denormalize"].invoke
-      Rake::Task["db:denormalize"].reenable
-      
-      @post.reload
-      @post.user_name.should eql @user.name
-    end
-    
-    it "should correct inconsistent denormalizations on referenced embedded documents" do
-      @rake_user = User.create!(:name => "Johnny Depp", :email => "johnny@depp.com")
-      @rake_comment = @post.comments.create!(:body => "Depp's comment", :user => @rake_user)
-      
-      @rake_user.update_attributes!(:name => "J. Depp")
-      
-      Rake::Task["db:denormalize"].invoke
-      Rake::Task["db:denormalize"].reenable
-      
-      @post.reload
-      @post.comments.last.user_name.should eql @rake_user.name
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'spec'
-require 'mongoid'
-require 'yaml'
-require 'rake'
-
-# Load rake tasks
-load File.expand_path("../../lib/railties/denormalize.rake", __FILE__)
-task :environment do
-  Dir.chdir(File.dirname(__FILE__))
-end
-
-Mongoid.configure do |config|
-  config.master = Mongo::Connection.new.db("mongoid_denormalize_development")
-end
-
-require File.expand_path("../../lib/mongoid_denormalize", __FILE__)
-Dir["#{File.dirname(__FILE__)}/app/models/*.rb"].each { |f| require f }