mongoid_denormalize 0.1.0 → 0.2.0

data/README.md

@@ -3,6 +3,8 @@ Mongoid::Denormalize
 
 Helper module for denormalizing association attributes in Mongoid models. Why denormalize? Read *[A Note on Denormalization](http://www.mongodb.org/display/DOCS/MongoDB+Data+Modeling+and+Rails#MongoDBDataModelingandRails-ANoteonDenormalization)*.
 
+Extracted from [coookin'](http://coookin.com), where it is used in production.
+
 
 Installation
 ------------
@@ -86,6 +88,27 @@ the parent. When using the `:to` option, the parent will push the values to its
     denormalize :name, :to => [:posts, :comments]
 
 
+Rake tasks
+----------
+
+A rake task is included for verifying and repairing inconsistent denormalizations. This might be useful your records may be modified
+without Mongoid, or if you are using relational associations in combination with embedded records (see *Known issues*).
+
+    rake db:denormalize
+    
+This task will only update records that have outdated denormalized fields.
+
+
+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.
+
+
 Credits
 -------
 

data/lib/mongoid_denormalize.rb

@@ -1,9 +1,11 @@
+require File.dirname(__FILE__) + '/railties/railtie' if defined?(Rails::Railtie)
+
 # = Mongoid::Denormalize
 #
 # Helper module for denormalizing association attributes in Mongoid models.
 module Mongoid::Denormalize
   extend ActiveSupport::Concern
-
+  
   included do
     cattr_accessor :denormalize_definitions
     
@@ -36,6 +38,15 @@ module Mongoid::Denormalize
     end
   end
 
+  def denormalized_valid?
+    denormalize_from
+    !self.changed?
+  end
+
+  def repair_denormalized!
+    self.save! unless denormalized_valid?
+  end
+
   private
     def denormalize_from
       self.denormalize_definitions.each do |definition|

data/lib/railties/denormalize.rake

@@ -0,0 +1,39 @@
+namespace :db do
+  desc "Verify all denormalizations and repair any inconsistencies"
+  task :denormalize => :environment 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
+        
+        unless parent.embedded?
+          parent.all.each do |parent_instance|
+            parent_instance.send(reflection.options[:inverse_of]).each(&:repair_denormalized!)
+          end
+        end
+      else
+        klass.all.each do |instance|
+          instance.repair_denormalized!
+        end
+      end
+    end
+  end
+  
+  def get_denormalizable_models
+    documents = []
+    Dir.glob("app/models/**/*.rb").sort.each do |file|
+      model_path = file[0..-4].split('/')[2..-1]
+      begin
+        klass = model_path.map(&:classify).join('::').constantize
+        
+        if klass.ancestors.include?(Mongoid::Document) && klass.ancestors.include?(Mongoid::Denormalize)
+          documents << klass
+        end
+      rescue => e
+        # Just for non-mongoid objects that dont have the embedded
+        # attribute at the class level.
+      end
+    end
+    documents
+  end
+end

data/lib/railties/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module Mongoid::Denormalize
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'railties/denormalize.rake'
+    end
+  end
+end

data/spec/mongoid_denormalize_spec.rb

@@ -2,9 +2,7 @@ require "spec_helper"
 
 describe Mongoid::Denormalize do
   before(:all) do
-    Mongoid.master.collections.each do |c|
-      c.drop rescue nil
-    end
+    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)
@@ -77,4 +75,29 @@ describe Mongoid::Denormalize do
       @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

@@ -2,15 +2,17 @@ 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|
-  settings = YAML.load(File.read(File.join(File.dirname(__FILE__), "database.yml")))
-  
-  db = Mongo::Connection.new(settings['host'], settings['port']).db(settings['database'])
-  db.authenticate(settings['username'], settings['password'])
-  
-  config.master = db
+  config.master = Mongo::Connection.new.db("mongoid_denormalize_development")
 end
 
 require File.expand_path("../../lib/mongoid_denormalize", __FILE__)
-Dir["#{File.dirname(__FILE__)}/models/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/app/models/*.rb"].each { |f| require f }

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid_denormalize
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Logan Raarup
@@ -15,18 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-09 00:00:00 +02:00
+date: 2010-09-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mongoid
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: -1848230043
         segments: 
         - 2
         - 0
@@ -48,11 +45,8 @@ files:
 - LICENSE
 - README.md
 - lib/mongoid_denormalize.rb
-- spec/models/comment.rb
-- spec/models/post.rb
-- spec/models/user.rb
-- spec/mongoid_denormalize_spec.rb
-- spec/spec_helper.rb
+- lib/railties/denormalize.rake
+- lib/railties/railtie.rb
 has_rdoc: true
 homepage: http://github.com/logandk/mongoid_denormalize
 licenses: []
@@ -63,33 +57,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Mongoid denormalization helper.
 test_files: 
-- spec/models/comment.rb
-- spec/models/post.rb
-- spec/models/user.rb
+- spec/app/models/comment.rb
+- spec/app/models/post.rb
+- spec/app/models/user.rb
 - spec/mongoid_denormalize_spec.rb
 - spec/spec_helper.rb