vidibus-inheritance 0.3.6

data/spec/vidibus/inheritance/mongoid_spec.rb

@@ -0,0 +1,600 @@
+require "spec_helper"
+
+class Model
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Vidibus::Uuid::Mongoid
+  include Vidibus::Inheritance::Mongoid
+  field :name
+  field :age, :type => Integer
+  embeds_many :children
+  embeds_many :puppets
+  embeds_one :location
+end
+
+class Child
+  include Mongoid::Document
+  field :name
+  field :mutated, :type => Boolean
+  validates :name, :presence => true
+  embedded_in :model, :inverse_of => :children
+  embeds_many :puppets
+  embeds_one :location
+end
+
+class Puppet
+  include Mongoid::Document
+  field :name
+  validates :name, :presence => true
+  embedded_in :child, :inverse_of => :puppets
+  embedded_in :model, :inverse_of => :puppets
+  embedded_in :location, :inverse_of => :puppets
+  embeds_one :location
+end
+
+class Location
+  include Mongoid::Document
+  field :name
+  field :mutated, :type => Boolean
+  validates :name, :presence => true
+  embedded_in :model, :inverse_of => :location
+  embedded_in :child, :inverse_of => :location
+  embedded_in :puppet, :inverse_of => :location
+  embeds_many :puppets
+end
+
+class Manager
+  include Mongoid::Document
+  include Vidibus::Uuid::Mongoid
+  include Vidibus::Inheritance::Mongoid
+  field :name
+  validates :name, :presence => true
+end
+
+class Clerk
+  include Mongoid::Document
+  field :name
+  validates :name, :presence => true
+end
+
+describe "Vidibus::Inheritance::Mongoid" do
+  let(:ancestor) { Model.create }
+  let(:anna) { Model.create!(:name => "Anna", :age => 35) }
+  let(:inheritor) { Model.new }
+  
+  describe "validation" do
+    it "should fail if ancestor does not have an UUID" do
+      invalid_ancestor = Clerk.create(:name => "John")
+      expect {
+        inheritor.ancestor = invalid_ancestor
+      }.to raise_error
+    end
+    
+    it "should fail if ancestor is of a different object type" do
+      invalid_ancestor = Manager.create(:name => "Robin")
+      inheritor.ancestor = invalid_ancestor
+      inheritor.should be_invalid
+      inheritor.errors[:ancestor].should have(1).error
+    end
+  end
+  
+  describe "#mutated_attributes" do
+    it "should be an empty array by default" do
+      inheritor.mutated_attributes.should be_a_kind_of(Array)
+      inheritor.mutated_attributes.should be_empty
+    end
+    
+    it "should hold all attributes that have been set on creation" do
+      inheritor = Model.create(:name => "Anna")
+      inheritor.mutated_attributes.should eql(["name"])
+    end
+    
+    it "should hold all attributes that have been changed after creation" do
+      inheritor = Model.create
+      inheritor.name = "Anna"
+      inheritor.save
+      inheritor.mutated_attributes.should eql(["name"])
+    end
+    
+    it "should not contain inherited attributes when ancestor was added on creation" do
+      ancestor = Model.create(:name => "Jenny", :age => 23)
+      inheritor = Model.create(:ancestor => ancestor)
+      inheritor.mutated_attributes.should be_empty
+    end
+    
+    it "should not contain inherited attributes when ancestor was added after creation" do
+      inheritor = Model.create
+      inheritor.ancestor = Model.create(:name => "Jenny", :age => 23)
+      inheritor.save
+      inheritor.mutated_attributes.should be_empty
+    end
+    
+    it "should contain unique values" do
+      inheritor = Model.create(:name => "Anna")
+      inheritor.update_attributes(:name => "Jenny")
+      inheritor.mutated_attributes.should eql(["name"])
+    end
+  end
+  
+  describe "#mutated?" do
+    it "should be false by default" do
+      inheritor.mutated?.should be_false
+    end
+    
+    it "should be true if attributes have been changed" do
+      inheritor.name = "Anna"
+      inheritor.save
+      inheritor.reload
+      inheritor.mutated?.should be_true
+    end
+    
+    it "should be true if mutated has been set to true" do
+      inheritor.mutated = true
+      inheritor.save!
+      inheritor.reload
+      inheritor.mutated?.should be_true
+    end
+  end
+  
+  describe "#ancestor" do
+    it "should return an ancestor object by uuid" do
+      inheritor.ancestor_uuid = ancestor.uuid
+      inheritor.ancestor.should eql(ancestor)
+    end
+  end
+  
+  describe "#ancestor=" do
+    it "should set an ancestor object" do
+      inheritor.ancestor = ancestor
+      inheritor.ancestor.should eql(ancestor)
+    end
+    
+    it "should set a persistent ancestor object" do
+      inheritor.ancestor = ancestor
+      inheritor.save
+      inheritor.reload
+      inheritor.ancestor.should eql(ancestor)
+    end
+    
+    it "should set the ancestor's uuid" do
+      inheritor.ancestor = ancestor
+      inheritor.ancestor_uuid.should eql(ancestor.uuid)
+    end
+    
+    it "should not fail if ancestor is of a different object type" do
+      invalid_ancestor = Manager.create(:name => "Robin")
+      inheritor.ancestor = invalid_ancestor
+      inheritor.ancestor.should eql(invalid_ancestor)
+    end
+  end
+  
+  describe "#inherit!" do
+    it "should call #inherit_attributes once" do
+      stub(inheritor)._inherited { true }
+      stub(inheritor).inherit_attributes
+      inheritor.ancestor = anna
+      inheritor.inherit!
+      inheritor.should have_received.inherit_attributes.once.with_any_args
+    end
+    
+    it "should call #save!" do
+      stub(inheritor).save!
+      inheritor.ancestor = anna
+      inheritor.inherit!
+      inheritor.should have_received.save!
+    end
+    
+    context "with mutations" do
+      before { inheritor.update_attributes(:ancestor => anna, :name => "Jenny", :age => 19) }
+
+      it "should keep name and age" do
+        inheritor.inherit!
+        inheritor.name.should eql("Jenny")
+        inheritor.age.should eql(19)
+      end
+      
+      it "should override mutated name attribute with option :reset => :name" do
+        inheritor.inherit!(:reset => :name)
+        inheritor.name.should eql("Anna")
+        inheritor.age.should eql(19)
+      end
+
+      it "should override mutated name and age with option :reset => [:name, :age]" do
+        inheritor.inherit!(:reset => [:name, :age])
+        inheritor.name.should eql("Anna")
+        inheritor.age.should eql(35)
+      end
+
+      it "should override all mutations with option :reset => true" do
+        inheritor.inherit!(:reset => true)
+        inheritor.name.should eql("Anna")
+        inheritor.age.should eql(35)
+      end
+    end
+  end
+  
+  describe "#inherit_from!" do
+    #let(:ancestor) { Model.create!(:name => "Anna", :age => 35) }
+    
+    it "should set ancestor" do
+      inheritor.ancestor.should be_nil
+      inheritor.inherit_from!(ancestor)
+      inheritor.ancestor.should eql(ancestor)
+    end
+    
+    it "should call #inherit!" do
+      stub(inheritor).inherit!
+      inheritor.inherit!
+      inheritor.should have_received(:inherit!)
+    end
+  end
+  
+  describe "#inheritors" do
+    it "should return all inheritors" do
+      inheritor1 = Model.create(:ancestor => ancestor)
+      inheritor2 = Model.create(:ancestor => ancestor)
+      ancestor.inheritors.should have(2).inheritors
+      ancestor.inheritors.should include(inheritor1)
+      ancestor.inheritors.should include(inheritor2)
+    end
+  end
+  
+  describe "inheritance" do    
+    it "should happen when creating objects" do
+      ancestor # trigger object creation before mocking
+      mock.instance_of(Model).inherit_attributes
+      Model.create!(:ancestor => ancestor)
+    end
+    
+    it "should happen when ancestor did change" do
+      inheritor = Model.create!
+      inheritor.ancestor = ancestor
+      stub(inheritor).inherit_attributes
+      inheritor.save
+      inheritor.should have_received.inherit_attributes
+    end
+    
+    it "should not happen when ancestor did not change" do
+      inheritor = Model.create!(:ancestor => ancestor)
+      dont_allow(inheritor).inherit
+      inheritor.save
+      # Does not work with RR:
+      # inheritor.should_not have_received.inherit
+    end
+    
+    it "should apply ancestor's attributes to inheritor" do
+      inheritor.update_attributes(:ancestor => anna)
+      inheritor.name.should eql("Anna")
+      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)
+    end
+    
+    it "should apply ancestor's attributes to inheritor but keep previously mutated attributes" do
+      inheritor.update_attributes(:name => "Jenny")
+      inheritor.update_attributes(:ancestor => anna)
+      inheritor.name.should eql("Jenny")
+      inheritor.age.should eql(35)
+    end
+    
+    it "should apply ancestor's attributes to inheritor but keep recently mutated attributes" do
+      inheritor.update_attributes(:ancestor => anna, :name => "Jenny")
+      inheritor.name.should eql("Jenny")
+      inheritor.age.should eql(35)
+    end
+    
+    it "should allow switching the ancestor" do
+      inheritor.inherit_from!(anna)
+      another_ancestor = Model.create!(:name => "Leah", :age => 30)
+      inheritor.inherit_from!(another_ancestor)
+      inheritor.ancestor.should eql(another_ancestor)
+      inheritor.name.should eql("Leah")
+      inheritor.age.should eql(30)
+    end
+    
+    it "should apply changes on ancestor to inheritor" do
+      inheritor.inherit_from!(anna)
+      inheritor.name.should eql("Anna")
+      anna.update_attributes(:name => "Leah")
+      inheritor.reload
+      inheritor.name.should eql("Leah")
+    end
+    
+    it "should preserve changes on inheritor" do
+      inheritor = Model.create(:ancestor => anna)
+      inheritor.update_attributes(:name => "Sara")
+      inheritor.mutated_attributes.should eql(["name"])
+      anna.update_attributes(:name => "Leah")
+      inheritor.reload
+      inheritor.name.should eql("Sara")
+    end
+    
+    it "should not update inheritor if acquired attributes were changed on ancestor" do
+      inheritor.inherit_from!(ancestor)
+      Model::ACQUIRED_ATTRIBUTES.should include("updated_at")
+      dont_allow(ancestor.inheritors.first).inherit!
+      ancestor.update_attributes(:updated_at => Time.now)
+    end
+    
+    it "should not update inheritor if no inheritable attributes were changed on ancestor" do
+      inheritor.inherit_from!(anna)
+      dont_allow(anna.inheritors.first).inherit!
+      anna.update_attributes(:name => "Anna")
+    end
+    
+    it "should be applied before validation" do
+      ancestor = Manager.create!(:name => "John")
+      invalid = Manager.new
+      invalid.should_not be_valid
+      valid = Manager.new(:ancestor => ancestor)
+      valid.should be_valid
+    end
+    
+    context "with embedded collections" do
+      before do
+        inheritor.inherit_from!(ancestor)
+        ancestor.children.create(:name => "Han")
+        ancestor.save
+        inheritor.reload
+      end
+      
+      it "should inherit subobjects on existing relationship" do
+        inheritor.children.should have(1).child
+      end
+      
+      it "should inherit subobjects when relationship gets established" do
+        inheritor = Model.new
+        inheritor.inherit_from!(ancestor)
+        inheritor.children.should have(1).child
+        inheritor.reload.children.should have(1).child
+      end
+      
+      it "should add subobjects" do
+        ancestor.children << Child.new(:name => "Leah")
+        ancestor.save
+        ancestor.children.should have(2).children
+        inheritor.reload
+        inheritor.children.should have(2).children
+      end
+      
+      it "should add subobjects with saving" do
+        ancestor.children << Child.new(:name => "Leah")
+        ancestor.save
+        ancestor.children.should have(2).children
+        inheritor.save
+        inheritor.reload
+        inheritor.children.should have(2).children
+      end
+      
+      it "should not add existing subobjects twice" do
+        inheritor.inherit_from!(ancestor)
+        inheritor.children.should have(1).child
+        inheritor.reload.children.should have(1).child
+      end
+      
+      it "should remove subobjects" do
+        inheritor.children.should have(1).child
+        ancestor.children.first.destroy
+        ancestor.save
+        inheritor.reload
+        ancestor.children.should have(0).children
+        inheritor.children.should have(0).children
+      end
+      
+      it "should update subobjects" do
+        ancestor.children.first.name = "Luke"
+        ancestor.save
+        inheritor.reload
+        inheritor.children.first.name.should eql("Luke")
+      end
+      
+      it "should call #update_inherited_attributes for updating subobjects, if available" do
+        Child.send(:define_method, :update_inherited_attributes) do
+          self.update_attributes(:name => "Callback")
+        end
+        Child.send(:protected, :update_inherited_attributes)
+        ancestor.children.first.name = "Luke"
+        ancestor.save
+        Child.send(:remove_method, :update_inherited_attributes)
+        inheritor.reload
+        inheritor.children.first.name.should eql("Callback")
+      end
+      
+      it "should exclude acquired attributes of subobjects" do
+        ancestor.children.first.mutated = true
+        ancestor.save
+        ancestor.children.first.mutated.should be_true
+        inheritor.reload
+        inheritor.children.first.mutated.should be_false
+      end
+      
+      it "should inherit embedded documents of subobjects" do
+        ancestor.children.first.puppets.create(:name => "Goofy")
+        ancestor.save
+        inheritor.reload
+        inheritor.children.first.puppets.should have(1).puppet
+      end
+    end
+    
+    context "with embedded items" do
+      before do
+        inheritor.inherit_from!(ancestor)
+        ancestor.create_location(:name => "Home")
+        ancestor.save
+        inheritor.reload
+      end
+      
+      it "should inherit subobject on existing relationship" do
+        inheritor.location.should_not be_nil
+      end
+      
+      it "should inherit subobjects when relationship gets established" do
+        inheritor = Model.new
+        inheritor.inherit_from!(ancestor)
+        inheritor.location.should_not be_nil
+      end
+      
+      it "should update subobject" do
+        ancestor.location.name = "Studio"
+        ancestor.save
+        inheritor.reload
+        ancestor.location.name.should eql("Studio")
+        inheritor.location.name.should eql("Studio")
+      end
+      
+      it "should remove subobject" do
+        ancestor.location.destroy
+        ancestor.save
+        inheritor.reload
+        ancestor.location.should be_nil
+        inheritor.location.should be_nil
+      end
+      
+      it "should exclude acquired attributes of subobject" do
+        ancestor.location.mutated = true
+        ancestor.save
+        ancestor.location.mutated.should be_true
+        inheritor.reload
+        inheritor.location.mutated.should be_false
+      end
+      
+      it "should inherit embedded documents of subobject" do
+        ancestor.location.puppets.create(:name => "Goofy")
+        ancestor.save
+        inheritor.reload
+        inheritor.location.puppets.should have(1).puppet
+      end
+    end
+    
+    context "across several generations" do
+      let(:grand_ancestor) { Model.create!(:name => "Anna", :age => 97) }
+      
+      before do
+        ancestor.inherit_from!(grand_ancestor)
+        inheritor.inherit_from!(ancestor)
+      end
+      
+      it "should apply changes on grand ancestor to inheritor" do
+        inheritor.name.should eql("Anna")
+        grand_ancestor.update_attributes(:name => "Leah")
+        inheritor.reload
+        inheritor.name.should eql("Leah")
+      end
+      
+      it "should not apply changes on grand ancestor to inheritor if predecessor has mutations" do
+        ancestor.update_attributes(:name => "Jenny")
+        grand_ancestor.update_attributes(:name => "Leah")
+        inheritor.reload
+        inheritor.name.should eql("Jenny")
+      end
+      
+      it "should allow resetting mutated attributes" do
+        ancestor.update_attributes(:name => "Sara")
+        ancestor.name.should eql("Sara")
+        inheritor.reload
+        inheritor.name.should eql("Sara")
+        ancestor.inherit!(:reset => :name)
+        ancestor.name.should eql("Anna")
+        inheritor.reload
+        inheritor.name.should eql("Anna")
+      end
+      
+      context "with embedded collections" do
+        before do
+          grand_ancestor.children.create(:name => "Han")
+          grand_ancestor.save
+          ancestor.reload
+          inheritor.reload
+        end
+
+        it "should inherit subobjects" do
+          inheritor.children.should have(1).child
+        end
+
+        it "should add subobjects" do
+          grand_ancestor.children << Child.new(:name => "Leah")
+          grand_ancestor.save
+          inheritor.reload
+          inheritor.children.should have(2).children
+        end
+
+        it "should not add existing subobjects twice" do
+          ancestor.inherit_from!(grand_ancestor)
+          inheritor.reload
+          inheritor.children.should have(1).child
+        end
+
+        it "should remove subobjects" do
+          inheritor.children.should have(1).child
+          grand_ancestor.children.first.destroy
+          grand_ancestor.save
+          grand_ancestor.children.should have(0).children
+          inheritor.reload
+          inheritor.children.should have(0).children
+        end
+
+        it "should update subobjects" do
+          grand_ancestor.children.first.name = "Luke"
+          grand_ancestor.save
+          grand_ancestor.children.first.name.should eql("Luke")
+          inheritor.reload
+          inheritor.children.first.name.should eql("Luke")
+        end
+
+        it "should inherit embedded documents of subobjects" do
+          grand_ancestor.children.first.puppets.create(:name => "Goofy")
+          grand_ancestor.save
+          inheritor.reload
+          inheritor.children.first.puppets.should have(1).puppet
+        end
+      end
+      
+      context "with embedded items" do
+        before do
+          grand_ancestor.create_location(:name => "Home")
+          grand_ancestor.save
+          ancestor.reload
+          inheritor.reload
+        end
+
+        it "should inherit subobject on existing relationship" do
+          inheritor.location.should_not be_nil
+        end
+
+        it "should inherit subobject when relationship gets established" do
+          ancestor = Model.new
+          ancestor.inherit_from!(grand_ancestor)
+          inheritor = Model.new
+          inheritor.inherit_from!(ancestor)
+          inheritor.location.should_not be_nil
+        end
+
+        it "should update subobject" do
+          grand_ancestor.location.name = "Studio"
+          grand_ancestor.save
+          inheritor.reload
+          inheritor.location.name.should eql("Studio")
+        end
+
+        it "should remove subobject" do
+          grand_ancestor.location.destroy
+          grand_ancestor.save
+          inheritor.reload
+          grand_ancestor.location.should be_nil
+          inheritor.location.should be_nil
+        end
+        
+        it "should inherit embedded documents of subobject" do
+          grand_ancestor.location.puppets.create(:name => "Goofy")
+          grand_ancestor.save
+          inheritor.reload
+          inheritor.location.puppets.should have(1).puppet
+        end
+      end
+    end
+  end
+end

data/spec/vidibus/inheritance/validators/ancestor_validator_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe "Vidibus::Inheritance::Validators::AncestorValidator" do
+  class ValidModel
+    include ActiveModel::Validations
+    attr_accessor :ancestor
+    validates :ancestor, :ancestor => true
+  end
+  
+  class InvalidModel; end
+  
+  let(:model) { ValidModel.new }
+  
+  it "should be available as ancestor validator" do
+    Model.validators_on(:ancestor).first.should be_a_kind_of(Vidibus::Inheritance::Validators::AncestorValidator)
+  end
+  
+  it "should validate an ancestor of same class" do
+    model.ancestor = ValidModel.new
+    model.valid?.should be_true
+  end
+  
+  it "should add an error, if ancestor is of a different class" do
+    model.ancestor = InvalidModel.new
+    model.valid?.should be_false
+    model.errors[:ancestor].should_not be_blank
+  end
+end

data/vidibus-inheritance.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vidibus-inheritance}
+  s.version = "0.3.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andre Pankratz"]
+  s.date = %q{2010-08-09}
+  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 = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "lib/vidibus-inheritance.rb",
+     "lib/vidibus/inheritance.rb",
+     "lib/vidibus/inheritance/mongoid.rb",
+     "lib/vidibus/inheritance/validators.rb",
+     "lib/vidibus/inheritance/validators/ancestor_validator.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/vidibus/inheritance/mongoid_spec.rb",
+     "spec/vidibus/inheritance/validators/ancestor_validator_spec.rb",
+     "vidibus-inheritance.gemspec"
+  ]
+  s.homepage = %q{http://github.com/vidibus/vidibus-inheritance}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Provides inheritance for models.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/vidibus/inheritance/mongoid_spec.rb",
+     "spec/vidibus/inheritance/validators/ancestor_validator_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<relevance-rcov>, [">= 0"])
+      s.add_development_dependency(%q<mongoid>, ["= 2.0.0.beta.15"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_runtime_dependency(%q<vidibus-core_extensions>, [">= 0"])
+      s.add_runtime_dependency(%q<vidibus-uuid>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<relevance-rcov>, [">= 0"])
+      s.add_dependency(%q<mongoid>, ["= 2.0.0.beta.15"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<vidibus-core_extensions>, [">= 0"])
+      s.add_dependency(%q<vidibus-uuid>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<relevance-rcov>, [">= 0"])
+    s.add_dependency(%q<mongoid>, ["= 2.0.0.beta.15"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<vidibus-core_extensions>, [">= 0"])
+    s.add_dependency(%q<vidibus-uuid>, [">= 0"])
+  end
+end
+