vidibus-inheritance 0.3.10 → 0.3.11

data/README.rdoc

@@ -58,6 +58,12 @@ All attributes will be inherited, except these ACQUIRED_ATTRIBUTES:
   updated_at
   version
   versions
+  
+You may overwrite acquired attributes by defining a method on your inherited document and its embedded documents:
+
+  def acquired_attributes
+    Vidibus::Inheritance::Mongoid::ACQUIRED_ATTRIBUTES + %w[my custom values]
+  end
 
 
 === Manage mutations of embedded documents

data/VERSION

@@ -1 +1 @@
-0.3.10
+0.3.11

data/lib/vidibus/inheritance.rb

@@ -1,2 +1,3 @@
 require "inheritance/mongoid"
-require "inheritance/validators"
+require "inheritance/validators"
+

data/lib/vidibus/inheritance/mongoid.rb

@@ -2,10 +2,14 @@ module Vidibus
   module Inheritance
     module Mongoid
       extend ActiveSupport::Concern
-
+      
       ACQUIRED_ATTRIBUTES = %w[_id _type uuid ancestor_uuid mutated_attributes mutated created_at updated_at version versions]
       
       included do
+        
+        # To define additional aquired attributes on your model, set @@acquired_attributes on it.
+        #@@aquired_attributes = nil
+        
         attr_accessor :inherited_attributes, :_inherited
         attr_protected :mutated_attributes, :mutated
         
@@ -139,7 +143,13 @@ module Vidibus
         clone.save!
         clone
       end
-
+      
+      # Returns acquired attributes.
+      # Overwrite this method to define custom ones.
+      def acquired_attributes
+        ACQUIRED_ATTRIBUTES
+      end
+      
       private
     
       # Performs inheritance of attributes while excluding acquired and mutated ones.
@@ -147,7 +157,7 @@ module Vidibus
       def inherit_attributes(options = {})
         track_mutations
         self._inherited = true
-        exceptions = ACQUIRED_ATTRIBUTES
+        exceptions = self.acquired_attributes
         reset = options[:reset]
         if !reset
           exceptions += mutated_attributes
@@ -228,7 +238,7 @@ module Vidibus
       # Stores changed attributes as #mutated_attributes unless they have been inherited recently.
       def track_mutations
         changed_items = new_record? ? attributes.keys : changes.keys
-        changed_items -= ACQUIRED_ATTRIBUTES
+        changed_items -= self.acquired_attributes
         if inherited_attributes
           for key, value in inherited_attributes
             changed_items.delete(key) if value == attributes[key]
@@ -270,11 +280,15 @@ module Vidibus
       # Returns list of inheritable attributes of a given document.
       # The list will include the _id as reference.
       def inheritable_document_attributes(doc)
-        attrs = doc.attributes.except(*ACQUIRED_ATTRIBUTES)
+        # puts "doc = #{doc.inspect}"
+        # puts "doc.acquired_attributes = #{doc.acquired_attributes.inspect}"
+        # puts "doc.try!(:acquired_attributes) = #{doc.try!(:acquired_attributes).inspect}"
+        exceptions = doc.try!(:acquired_attributes) || ACQUIRED_ATTRIBUTES
+        attrs = doc.attributes.except(*exceptions)
         attrs[:_reference_id] = doc._id
         attrs
       end
-    
+      
       # Applies changes to inheritors.
       def update_inheritors
         return unless inheritors.any?

data/spec/models.rb

@@ -19,6 +19,7 @@ class Child
   include Mongoid::Document
   field :name
   field :mutated, :type => Boolean
+  field :custom
   validates :name, :presence => true
   embedded_in :model, :inverse_of => :children
   embeds_many :puppets

data/spec/vidibus/inheritance/inheritance_spec.rb

@@ -34,10 +34,31 @@ describe "Inheritance" do
     inheritor.age.should eql(35)
   end
   
-  it "should not inherit acquired attributes" do
-    inheritor.update_attributes(:ancestor => ancestor)
-    Model::ACQUIRED_ATTRIBUTES.should include("uuid")
-    inheritor.uuid.should_not eql(ancestor.uuid)
+  context "of acquired attributes" do
+    it "should not inherit ACQUIRED_ATTRIBUTES" do
+      inheritor.update_attributes(:ancestor => ancestor)
+      Model::ACQUIRED_ATTRIBUTES.should include("uuid")
+      inheritor.uuid.should_not eql(ancestor.uuid)
+    end
+    
+    it "should not inherit custom acquired_attributes" do
+      Model.send(:define_method, :acquired_attributes) do
+        Model::ACQUIRED_ATTRIBUTES + ["name"]
+      end
+      inheritor.update_attributes(:ancestor => anna)
+      inheritor.name.should be_nil
+      Model.send(:remove_method, :acquired_attributes)
+    end
+     
+    it "should not inherit custom acquired_attributes on embedded documents" do
+      Child.send(:define_method, :acquired_attributes) do
+        Vidibus::Inheritance::Mongoid::ACQUIRED_ATTRIBUTES + ["custom"]
+      end
+      anna.children.create(:name => "Lucy", :custom => "something")
+      inheritor.update_attributes(:ancestor => anna)
+      inheritor.children.first.custom.should be_nil
+      Child.send(:remove_method, :acquired_attributes)
+    end
   end
   
   it "should apply ancestor's attributes to inheritor but keep previously mutated attributes" do

data/vidibus-inheritance.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{vidibus-inheritance}
-  s.version = "0.3.10"
+  s.version = "0.3.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andre Pankratz"]
-  s.date = %q{2010-08-16}
+  s.date = %q{2010-08-17}
   s.description = %q{This gem allows inheritance of objects for Rails 3 with Mongoid. It will update all attributes and embedded documents of inheritors when ancestor gets changed.}
   s.email = %q{andre@vidibus.com}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vidibus-inheritance
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 3
-  - 10
-  version: 0.3.10
+  - 11
+  version: 0.3.11
 platform: ruby
 authors: 
 - Andre Pankratz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-16 00:00:00 +02:00
+date: 2010-08-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency