mongoid_denormalize 0.3.0 → 0.4.0

data/README.md

@@ -1,6 +1,9 @@
 Mongoid::Denormalize
 ====================
 
+*Note: I am no longer actively maintaining this module, and I do not know whether it is compatible with newer versions of mongoid. If you would like to take ownership of this repository, please let me know.*
+
+
 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.
@@ -30,7 +33,6 @@ In your model:
     denormalize :name, :email, :from => :user
 
 
-
 Example
 -------
 
@@ -39,6 +41,7 @@ Example
       include Mongoid::Denormalize
 
       has_many :comments
+      has_many :moderated_comments, :class_name => "Comment", :inverse_of => :moderator
 
       field :name
       field :email
@@ -51,6 +54,7 @@ Example
       include Mongoid::Denormalize
 
       belongs_to :user
+      belongs_to :moderator, :class_name => "User", :inverse_of => :moderated_comments
 
       field :body
       
@@ -75,20 +79,31 @@ Options
 Denormalization can happen in either or both directions. When using the `:from` option, the associated objects will fetch the values from
 the parent. When using the `:to` option, the parent will push the values to its children.
 
+    # Basic denormalization. Will set the user_name attribute of "self.comments" to the value of "self.name".
+    denormalize :name, :to => :comments
+
+    # Multiple children. Will set the user_name attribute of "self.posts" and "self.comments" with "self.name".
+    denormalize :name, :to => [:posts, :comments]
+
+    # Basic denormalization, obeying :inverse_of. Will set the moderator_name attribute of "self.moderated_comments"
+    denormalize :name, :email, :to => :moderated_comments
+
+    # With custom field name prefix. Will set the commenter_name attribute of "self.comments" (takes precedence over
+    # inverse_of).
+    denormalize :name, :to => :comments, :as => :commenter
+
     # Basic denormalization. Will set the user_name attribute with the associated user's name.
     denormalize :name, :from => :user
-    
-    # Basic denormalization. Will set the user_name attribute of "self.comments" with "self.name".
-    denormalize :name, :to => :comments
-    
+
     # Multiple fields. Will set the user_name and user_email attributes with the associated user's name and email.
     denormalize :name, :email, :from => :user
-    
-    # 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.
- 
+    # Basic denormalization. Will set the moderator_name attribute with the associated author user's name.
+    denormalize :name, :from => :moderator
+
+When using `:from`, if the type of the denormalized field is anything but `String` (the default),
+you must specify the type with the `:type` option.
+
     # in User
     field :location, :type => Array
     denormalize :location, :to => :posts
@@ -96,6 +111,14 @@ You must specify the type of all denormalizations when using the `:from` option,
     # in Post
     denormalize :location, :type => Array, :from => :user
 
+A few notes on behavior:
+
+`:from` denormalizations are processed as `before_save` callbacks.
+
+`:to` denormalizations are processed as `after_save` callbacks.
+
+With `:to`, validations are not run on the object(s) containing the denormalized field(s) when they are saved.
+
 Rake tasks
 ----------
 
@@ -117,12 +140,19 @@ It is not recommended nor supported to use mongoid_denormalize to perform denorm
 
 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.
 
+Contributing
+-------
+
+Clone the repository and run Bundler with `bundle install` so that you can run the rake tasks.
 
 Contributors
 -------
 * hubsmoke (https://github.com/hubsmoke)
 * Leo Lou (https://github.com/l4u)
 * Austin Bales (https://github.com/arbales)
+* Isaac Cambron (https://github.com/icambron)
+* Shannon Carey (https://github.com/rehevkor5)
+* Sebastien Azimi (https://github.com/suruja)
 
 
 Credits

data/lib/mongoid_denormalize.rb

@@ -5,10 +5,10 @@ require File.dirname(__FILE__) + '/railties/railtie' if defined?(Rails::Railtie)
 # Helper module for denormalizing association attributes in Mongoid models.
 module Mongoid::Denormalize
   extend ActiveSupport::Concern
-  
+
   included do
     cattr_accessor :denormalize_definitions
-    
+
     before_save :denormalize_from
     after_save :denormalize_to
   end
@@ -26,8 +26,8 @@ module Mongoid::Denormalize
     #     denormalize :name, :avatar, :from => :user
     #     denormalize :created_at, :to => :comments
     #   end
-    def denormalize(*fields)
-      options = fields.pop
+    def denormalize(*args)
+      *fields, options = args
       
       (self.denormalize_definitions ||= []) << { :fields => fields, :options => options }
 
@@ -36,7 +36,7 @@ module Mongoid::Denormalize
         fields.each { |name| field "#{options[:from]}_#{name}", :type => options[:type] || String }
       end
     end
-    
+
     def is_denormalized?
       true
     end
@@ -50,49 +50,69 @@ module Mongoid::Denormalize
   def repair_denormalized!
     self.save! unless denormalized_valid?
   end
-  
+
   private
-    def denormalize_from
-      self.denormalize_definitions.each do |definition|
-        next if definition[:options][:to]
-        
-        definition[:fields].each { |name| self.send("#{definition[:options][:from]}_#{name}=", self.send(definition[:options][:from]).try(name)) }
+  def denormalize_from
+    Array(self.denormalize_definitions).reject do |definition|
+      definition[:options][:to]
+    end.each do |definition|
+      definition[:fields].each do |name|
+        field = definition[:options][:from]
+        # force reload if :from method is an association ; call it normally otherwise
+        associated =  self.class.reflect_on_association(field) ? self.send(field, true) : self.send(field)
+        self.send("#{field}_#{name}=", associated.try(name))
       end
     end
-    
-    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)]
-        
-      
-        [definition[:options][:to]].flatten.each do |association|
-          relation = []
-          reflect = self.class.reflect_on_association(association)
-          relation = reflect.relation.macro unless reflect.nil? || reflect.relation.nil?
+  end
 
-          reflect.klass.skip_callback(:save, :before, :denormalize_from) if reflect.klass.try(:is_denormalized?)
+  def denormalize_to
+    Array(self.denormalize_definitions).find_all do |definition|
+      definition[:options][:to]
+    end.each do |definition|
+      as = definition[:options][:as]
 
-          if [:embedded_in, :embeds_one, :referenced_in, :references_one, :has_one, :belongs_to].include? relation
-            c = self.send(association)
-          
-            unless c.blank?
-              assigns.each { |assign| c.send("#{assign[0]}=", assign[1]) }
-              
-              c.save
-            end
-          else
-            c = self.send(association)
-            
-            c.to_a.each do |a|
-              assigns.each { |assign| a.send("#{assign[0]}=", assign[1]) }
-              
-              a.save
-            end
+      assignments = definition[:fields].collect do |source_field|
+        {
+          :source_field => source_field.to_s,
+          :value => self.send(source_field)
+        }
+      end
+
+      Array(definition[:options][:to]).each do |association|
+        relation = []
+        reflect = self.class.reflect_on_association(association)
+        relation = reflect.relation.macro unless reflect.nil? || reflect.relation.nil?
+
+        reflect.klass.skip_callback(:save, :before, :denormalize_from) if reflect.klass.try(:is_denormalized?)
+
+        associated = self.send(association)
+        prefix = (as || reflect.inverse_of || reflect.inverse_class_name).to_s.underscore
+        
+        if [:embedded_in, :embeds_one, :referenced_in, :references_one, :has_one, :belongs_to].include? relation
+          unless associated.blank?
+            assign_and_save(associated, assignments, prefix)
           end
-          
-          reflect.klass.set_callback(:save, :before, :denormalize_from) if reflect.klass.try(:is_denormalized?)
+        else
+          associated.to_a.each { |c| assign_and_save(c, assignments, prefix) }
         end
+        
+        reflect.klass.set_callback(:save, :before, :denormalize_from) if reflect.klass.try(:is_denormalized?)
       end
     end
-end
+  end
+
+  def assign_and_save(obj, assignments, prefix)
+    attributes_hash = Hash[assignments.collect do |assignment|
+      if self.changed_attributes.has_key?(assignment[:source_field])
+        ["#{prefix}_#{assignment[:source_field]}", assignment[:value]]
+      end
+    end]
+    
+    unless attributes_hash.empty?
+      # The more succinct update_attributes(changes, :without_protection => true) requires Mongoid 3.0.0, 
+      # but we only require 2.1.9
+      obj.assign_attributes(attributes_hash, :without_protection => true)
+      obj.save(:validate => false)
+    end
+  end
+end

metadata

@@ -1,80 +1,150 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mongoid_denormalize
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Logan Raarup
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-05 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: mongoid
+date: 2013-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid_denormalize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 1
-        - 9
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.1.9
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.9
 description: Helper module for denormalizing association attributes in Mongoid models.
 email: logan@logan.dk
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
-files: 
+files:
 - lib/mongoid_denormalize.rb
 - lib/railties/denormalize.rake
 - lib/railties/railtie.rb
 - LICENSE
 - README.md
-has_rdoc: true
 homepage: http://github.com/logandk/mongoid_denormalize
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 4386387219584124888
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Mongoid denormalization helper.
 test_files: []
-