dm-constraints 0.9.9 → 0.9.10

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.9.10 / 2009-01-19
+
+* 1 major enhancement:
+
+  * Add :protect, :destroy, :set_nil and :skip constraints
+
 === 0.9.9 / 2009-01-04
 
 * No changes this version

data/Manifest.txt

@@ -6,6 +6,7 @@ Rakefile
 TODO
 lib/dm-constraints.rb
 lib/dm-constraints/data_objects_adapter.rb
+lib/dm-constraints/delete_constraint.rb
 lib/dm-constraints/mysql_adapter.rb
 lib/dm-constraints/postgres_adapter.rb
 lib/dm-constraints/version.rb

data/lib/dm-constraints/data_objects_adapter.rb

@@ -13,7 +13,18 @@ module DataMapper
             foreign_table = parent.storage_name(repository_name)
             foreign_keys  = parent.key.map { |key| property_to_column_name(parent.repository(repository_name), key, false) }
 
-            create_constraints_statement(table_name, constraint_name, keys, foreign_table, foreign_keys)
+            one_to_many_relationship = parent.relationships.values.select { |rel| rel.child_model == model }.first
+            delete_constraint_type = case one_to_many_relationship.delete_constraint
+            when :protect, nil
+              "NO ACTION"
+            when :destroy, :destroy!
+              "CASCADE"
+            when :set_nil
+              "SET NULL"
+            when :skip
+              nil
+            end
+            create_constraints_statement(table_name, constraint_name, keys, foreign_table, foreign_keys, delete_constraint_type) if delete_constraint_type
           end.compact
         end
 
@@ -29,14 +40,14 @@ module DataMapper
 
         private
 
-        def create_constraints_statement(table_name, constraint_name, keys, foreign_table, foreign_keys)
+        def create_constraints_statement(table_name, constraint_name, keys, foreign_table, foreign_keys, delete_constraint_type)
           <<-EOS.compress_lines
             ALTER TABLE #{quote_table_name(table_name)}
             ADD CONSTRAINT #{quote_constraint_name(constraint_name)}
             FOREIGN KEY (#{keys * ', '})
             REFERENCES #{quote_table_name(foreign_table)} (#{foreign_keys * ', '})
-            ON DELETE NO ACTION
-            ON UPDATE NO ACTION
+            ON DELETE #{delete_constraint_type}
+            ON UPDATE #{delete_constraint_type}
           EOS
         end
 

data/lib/dm-constraints/delete_constraint.rb

@@ -0,0 +1,59 @@
+module DataMapper
+  module Constraints
+    module DeleteConstraint
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        DELETE_CONSTRAINT_OPTIONS = [:protect, :destroy, :destroy!, :set_nil, :skip]
+        def check_delete_constraint_type(cardinality, name, options = {})
+          constraint_type = options[:constraint]
+          return if constraint_type.nil?
+          delete_constraint_options = DELETE_CONSTRAINT_OPTIONS.map { |o| ":#{o}" }
+          if !DELETE_CONSTRAINT_OPTIONS.include?(constraint_type)
+            raise ArgumentError, ":constraint option must be one of #{delete_constraint_options * ', '}"
+          end
+        end
+
+        # TODO: that should be moved to a 'util-like' module
+        def with_changed_method_visibility(method, from_visibility, to_visibility, &block)
+          send(to_visibility, method)
+          yield
+          send(from_visibility, method)
+        end
+
+      end
+
+      def add_delete_constraint_option(name, repository_name, child_model, parent_model, options = {})
+        @delete_constraint = options[:constraint]
+      end
+
+      def check_delete_constraints
+        model.relationships.each do |rel_name, rel|
+          children = self.send(rel_name)
+          case rel.delete_constraint
+          when nil, :protect
+            # only prevent deletion if the resource is a parent in a relationship and has children
+            throw(:halt, false) if children && children.respond_to?(:empty?) && !children.empty?
+          when :destroy
+            if children && children.respond_to?(:each)
+              children.each { |child| child.destroy }
+            end
+          when :set_nil
+            if children && children.respond_to?(:each)
+              children.each do |child|
+                child.class.many_to_one_relationships.each do |mto_rel|
+                  child.send("#{mto_rel.name}=", nil) if child.send(mto_rel.name).eql?(self)
+                end
+              end
+            end
+          end # case
+        end # relationships
+      end # check_delete_constraints
+
+
+    end # DeleteConstraint
+  end # Constraints
+end # DataMapper

data/lib/dm-constraints/version.rb

@@ -1,5 +1,5 @@
 module DataMapper
   module Constraints
-    VERSION = '0.9.9'
+    VERSION = '0.9.10'
   end
 end

data/lib/dm-constraints.rb

@@ -3,15 +3,55 @@ require 'rubygems'
 require 'pathname'
 
 # Add all external dependencies for the plugin here
-gem 'dm-core', '~>0.9.9'
+gem 'dm-core', '~>0.9.10'
 require 'dm-core'
 
 # Require plugin-files
 require Pathname(__FILE__).dirname.expand_path / 'dm-constraints' / 'data_objects_adapter'
 require Pathname(__FILE__).dirname.expand_path / 'dm-constraints' / 'postgres_adapter'
 require Pathname(__FILE__).dirname.expand_path / 'dm-constraints' / 'mysql_adapter'
+require Pathname(__FILE__).dirname.expand_path / 'dm-constraints' / 'delete_constraint'
 
 module DataMapper
+  module Associations
+    class Relationship
+      include Extlib::Hook
+      include DataMapper::Constraints::DeleteConstraint
+
+      attr_reader :delete_constraint
+      OPTIONS << :constraint
+
+      # initialize is a private method in Relationship
+      # and private methods can not be "advised" (hooked into)
+      # in extlib.
+      with_changed_method_visibility(:initialize, :private, :public) do
+        before :initialize, :add_delete_constraint_option
+      end
+    end
+  end
+end
+
+module DataMapper
+  module Constraints
+
+    include DeleteConstraint
+
+    module ClassMethods
+      include DeleteConstraint::ClassMethods
+    end
+
+    def self.included(model)
+      model.extend(ClassMethods)
+      model.class_eval do
+        before_class_method :has, :check_delete_constraint_type
+        if method_defined?(:destroy)
+          before :destroy, :check_delete_constraints
+        end
+      end
+    end
+
+  end
+
   class AutoMigrator
     include Extlib::Hook
     include DataMapper::Constraints::DataObjectsAdapter::Migration

data/spec/integration/constraints_spec.rb

@@ -5,11 +5,14 @@ ADAPTERS.each do |adapter|
 
   describe 'DataMapper::Constraints' do
 
+    # load_models_for_metaphor :stable, :farmer, :cow
+
     before do
       DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[adapter]
 
-      class Stable
+      class ::Stable
         include DataMapper::Resource
+        include DataMapper::Constraints
 
         property :id,       Serial
         property :location, String
@@ -18,8 +21,9 @@ ADAPTERS.each do |adapter|
         has n, :cows
       end
 
-      class Farmer
+      class ::Farmer
         include DataMapper::Resource
+        include DataMapper::Constraints
 
         property :first_name, String, :key => true
         property :last_name,  String, :key => true
@@ -27,7 +31,7 @@ ADAPTERS.each do |adapter|
         has n, :cows
       end
 
-      class Cow
+      class ::Cow
         include DataMapper::Resource
         include DataMapper::Constraints
 
@@ -61,5 +65,169 @@ ADAPTERS.each do |adapter|
       lambda { @c1 = Cow.create(:name => "Bea", :stable_id => s.id + 1) }.should raise_error
     end
 
-  end
-end
+    # :constraint associations
+    # value  | on deletion of parent...
+    # ---------------------------------
+    # :protect | raises exception if there are child records
+    # :destroy | deletes children
+    # :destroy! | deletes children directly without instantiating the resource, bypassing any hooks
+    # :set_nil | sets parent id to nil in child associations
+    # :skip | does not do anything with children (they'll become orphan records)
+
+    describe "constraint options" do
+      describe "when no constraint options are given" do
+
+        it "should destroy the parent if there are no children in the association" do
+          @f1 = Farmer.create(:first_name => "John", :last_name => "Doe")
+          @f2 = Farmer.create(:first_name => "Some", :last_name => "Body")
+          @c1 = Cow.create(:name => "Bea", :farmer => @f2)
+          @f1.destroy.should == true
+        end
+
+        it "should not destroy the parent if there are children in the association" do
+          @f = Farmer.create(:first_name => "John", :last_name => "Doe")
+          @c1 = Cow.create(:name => "Bea", :farmer => @f)
+          @f.destroy.should == false
+        end
+
+      end
+
+      describe "when :constraint => :protect is given" do
+        before do
+          class ::Farmer
+            has n, :cows, :constraint => :protect
+          end
+          class ::Cow
+            belongs_to :farmer
+          end
+        end
+
+        it "should destroy the parent if there are no children in the association" do
+          @f1 = Farmer.create(:first_name => "John", :last_name => "Doe")
+          @f2 = Farmer.create(:first_name => "Some", :last_name => "Body")
+          @c1 = Cow.create(:name => "Bea", :farmer => @f2)
+          @f1.destroy.should == true
+        end
+
+        it "should not destroy the parent if there are children in the association" do
+          @f = Farmer.create(:first_name => "John", :last_name => "Doe")
+          @c1 = Cow.create(:name => "Bea", :farmer => @f)
+          @f.destroy.should == false
+        end
+
+        it "the child should be destroyable" do
+          @f = Farmer.create(:first_name => "John", :last_name => "Doe")
+          @c = Cow.create(:name => "Bea", :farmer => @f)
+          @c.destroy.should == true
+        end
+
+      end
+
+      describe "when :constraint => :destroy is given" do
+        before do
+          class ::Farmer
+            has n, :cows, :constraint => :destroy
+          end
+          class ::Cow
+            belongs_to :farmer
+          end
+          DataMapper.auto_migrate!
+        end
+
+        it "should destroy the parent and the children, too" do
+          #NOTE: the repository wrapper is needed in order for
+          # the identity map to work (otherwise @c1 in the below two calls
+          # would refer to different instances)
+          repository do
+            @f = Farmer.create(:first_name => "John", :last_name => "Doe")
+            @c1 = Cow.create(:name => "Bea", :farmer => @f)
+            @c2 = Cow.create(:name => "Riksa", :farmer => @f)
+            @f.destroy.should == true
+            @f.should be_new_record
+            @c1.should be_new_record
+            @c2.should be_new_record
+          end
+        end
+
+        it "the child should be destroyable" do
+          @f = Farmer.create(:first_name => "John", :last_name => "Doe")
+          @c = Cow.create(:name => "Bea", :farmer => @f)
+          @c.destroy.should == true
+        end
+
+      end
+
+      describe "when :constraint => :set_nil is given" do
+        before do
+          class ::Farmer
+            has n, :cows, :constraint => :set_nil
+          end
+          class ::Cow
+            belongs_to :farmer
+          end
+          DataMapper.auto_migrate!
+        end
+
+        it "destroying the parent should set children foreign keys to nil" do
+          @f = Farmer.create(:first_name => "John", :last_name => "Doe")
+          @c1 = Cow.create(:name => "Bea", :farmer => @f)
+          @c2 = Cow.create(:name => "Riksa", :farmer => @f)
+          cows = @f.cows
+          @f.destroy.should == true
+          cows.all? { |cow| cow.farmer.should be_nil }
+        end
+
+        it "the child should be destroyable" do
+          @f = Farmer.create(:first_name => "John", :last_name => "Doe")
+          @c = Cow.create(:name => "Bea", :farmer => @f)
+          @c.destroy.should == true
+        end
+
+      end # describe
+
+      describe "when :constraint => :skip is given" do
+        before do
+          class ::Farmer
+            has n, :cows, :constraint => :skip
+          end
+          class ::Cow
+            belongs_to :farmer
+          end
+          DataMapper.auto_migrate!
+        end
+
+        it "destroying the parent should be allowed, children should become orphan records" do
+          @f = Farmer.create(:first_name => "John", :last_name => "Doe")
+          @c1 = Cow.create(:name => "Bea", :farmer => @f)
+          @c2 = Cow.create(:name => "Riksa", :farmer => @f)
+          @f.destroy.should == true
+          @c1.farmer.should be_new_record
+          @c2.farmer.should be_new_record
+        end
+
+        it "the child should be destroyable" do
+          @f = Farmer.create(:first_name => "John", :last_name => "Doe")
+          @c = Cow.create(:name => "Bea", :farmer => @f)
+          @c.destroy.should == true
+        end
+
+      end # describe
+
+      describe "when an invalid option is given" do
+        before do
+        end
+
+        it "should raise an error" do
+          lambda do
+            class ::Farmer
+              has n, :cows, :constraint => :chocolate
+            end
+          end.should raise_error(ArgumentError)
+        end
+
+      end
+
+    end # describe 'constraint options'
+
+  end # DataMapper::Constraints
+end # ADAPTERS.each

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@ require 'rubygems'
 gem 'rspec', '~>1.1.11'
 require 'spec'
 
-gem 'dm-core', '~>0.9.9'
+gem 'dm-core', '~>0.9.10'
 require 'dm-core'
 
 ADAPTERS = []

data/tasks/spec.rb

@@ -8,7 +8,7 @@ begin
   desc 'Run specifications'
   Spec::Rake::SpecTask.new(:spec) do |t|
     t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
-    t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+    t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s).map { |f| f.to_s }
 
     begin
       gem 'rcov', '~>0.8'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-constraints
 version: !ruby/object:Gem::Version 
-  version: 0.9.9
+  version: 0.9.10
 platform: ruby
 authors: 
 - Dirkjan Bussink
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-04 00:00:00 -08:00
+date: 2009-01-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.9.9
+        version: 0.9.10
     version: 
 description: DataMapper plugin constraining relationships
 email: 
@@ -43,6 +43,7 @@ files:
 - TODO
 - lib/dm-constraints.rb
 - lib/dm-constraints/data_objects_adapter.rb
+- lib/dm-constraints/delete_constraint.rb
 - lib/dm-constraints/mysql_adapter.rb
 - lib/dm-constraints/postgres_adapter.rb
 - lib/dm-constraints/version.rb