dependent_protect 0.0.3 → 0.0.4

data/Gemfile

@@ -8,4 +8,5 @@ group :development, :test do
   gem 'simplecov'
   gem 'simplecov-rcov'
   gem 'sqlite3'
+  gem 'activerecord', '2.3.14'
 end

data/dependent_protect.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'dependent_protect'
-  s.version           = '0.0.3'
-  s.date              = '2012-04-29'
+  s.version           = '0.0.4'
+  s.date              = '2012-06-10'
   s.rubyforge_project = 'dependent_protect'
 
   ## Make sure your summary is short. The description may be as long
@@ -66,6 +66,7 @@ Gem::Specification.new do |s|
     gemfiles/rails2.gemfile
     gemfiles/rails3.gemfile
     lib/dependent_protect.rb
+    lib/dependent_protect/delete_restriction_error.rb
     spec/dependent_protect_spec.rb
     spec/schema.rb
     spec/spec_helper.rb

data/lib/dependent_protect/delete_restriction_error.rb

@@ -0,0 +1,31 @@
+module ActiveRecord
+  # This error is raised when trying to destroy a parent instance in N:1 or 1:1 associations
+  # (has_many, has_one) when there is at least 1 child associated instance.
+  # ex: if @project.tasks.size > 0, DeleteRestrictionError will be raised when trying to destroy @project
+  class DeleteRestrictionError < ActiveRecordError #:nodoc:
+    def initialize(reflection, record)
+      @reflection = reflection
+      @record = record
+      super(basic_message)
+    end
+
+    def basic_message
+      single = @reflection.class_name.to_s.underscore.gsub('_', ' ')
+      if [:has_many, :has_and_belongs_to_many].include?(@reflection.macro)
+        count = @record.send(@reflection.name).count
+        type = count == 1 ? single : single.pluralize
+        exist = (count == 1 ? 'exists' : 'exist')
+        "Cannot delete record because #{count} dependent #{type} #{exist}"
+      else
+        "Cannot delete record because dependent #{single} exists"
+      end
+    end
+
+    def detailed_message
+      count = @record.send(@reflection.name).count
+      examples = @record.send(@reflection.name).all(:limit => 5).map{|o| "#{o.id}: #{o.to_s}"}
+      examples[4] = "...and #{count - 4} more" if count > 5
+      basic_message + "\n\n\nThese include:\n#{examples.join("\n")}"
+    end
+  end
+end

data/lib/dependent_protect.rb

@@ -1,19 +1,15 @@
 # DependentProtect
 #
 require 'active_record'
+require 'dependent_protect/delete_restriction_error'
 
 module DependentProtect
-  VERSION = '0.0.3'
-
-  DESTROY_PROTECT_ERROR_MESSAGE = 'Cant destroy because there are dependent_count dependent_type dependent on dependee_type dependee.\n\n\nThese include:\ndependent_examples'
+  VERSION = '0.0.4'
 
   def self.included(base)
     super
     base.extend(ClassMethods)
 
-    klass = Class.new(ActiveRecord::ActiveRecordError)
-    ActiveRecord.const_set('DependencyError', klass)
-
     base.class_eval do
       class << self
         alias_method_chain :has_one, :protect
@@ -47,49 +43,30 @@ module DependentProtect
 
     private
     def add_dependency_callback!(reflection, options)
-      # This would break if has_many :dependent behaviour changes. One
-      # solution is removing both the second when and the else branches but
-      # the exception message wouldn't be exact.
-      condition = if reflection.collection?
-        "record.#{reflection.name}.empty?"
-      else
-        "record.#{reflection.name}.nil?"
-      end
-
       case reflection.options[:dependent]
       when :rollback
         options.delete(:dependent)
-        module_eval "before_destroy, :protect_rollback, :unless => proc{ |record| #{condition} }"
-      when :raise
+        method_name = "dependent_rollback_for_#{reflection.name}".to_sym
+        define_method(method_name) do
+          method = reflection.collection? ? :empty? : :nil?
+          unless send(reflection.name).send(method)
+            raise ActiveRecord::Rollback
+          end
+        end
+        before_destroy method_name
+      when :restrict
         options.delete(:dependent)
-        error = reflection.collection? ? dependency_error(reflection) : "Cannot remove as the associated object is dependent on this."
-        module_eval <<-METHOD
-def protect_raise_#{reflection.name}
-  raise ActiveRecord::DependencyError, "#{error}"
-end
-METHOD
-        module_eval "before_destroy :protect_raise_#{reflection.name}, :unless => proc{ |record| #{condition} }"
+        method_name = "dependent_restrict_for_#{reflection.name}".to_sym
+        define_method(method_name) do
+          method = reflection.collection? ? :empty? : :nil?
+          unless send(reflection.name).send(method)
+            raise ActiveRecord::DeleteRestrictionError.new(reflection, self)
+          end
+        end
+        before_destroy method_name
       end
     end
-
-    def protect_rollback
-      raise ActiveRecord::Rollback
-    end
-
-    def dependency_error(reflection)
-      # TODO: gotta be a more easier approach!
-      count_code = "#{reflection.name}.count"
-      first_five_code = reflection.name.to_s+'.first(5).map{|o| "#{o.id}: #{o.to_s}"}'
-      DESTROY_PROTECT_ERROR_MESSAGE.
-        gsub('dependent_type', reflection.class_name.to_s.underscore.gsub('_', ' ').pluralize).
-        gsub('dependent_examples', '#{(' + first_five_code + ' + [("...and #{' + count_code + ' - 5} more" if ' + count_code + ' > 5)]).join("\n")}').
-        gsub('dependent_count', '#{' + count_code + '}').
-        gsub('dependee_type', '#{self.class.to_s.underscore.gsub(\'_\', \' \')}').
-        gsub('dependee', '#{self}')
-    end
-
   end
 end
 
-
 ActiveRecord::Base.send(:include, DependentProtect)

data/spec/dependent_protect_spec.rb

@@ -14,27 +14,44 @@ end
 
 class Order < ActiveRecord::Base
   belongs_to :category
-  has_one :order_invoice, :dependent => :raise
+  has_one :order_invoice, :dependent => :restrict
+  def to_s
+    "Order #{id}"
+  end
 end
 
 class Category < ActiveRecord::Base
-  has_many :orders, :dependent => :raise
+  has_many :orders, :dependent => :restrict
+  def to_s
+    "Category #{id}"
+  end
 end
 
 describe DependentProtect do
   it 'should restrict has_many relationships' do
     category = Category.create!
-    order = Order.create!(:category => category)
-    lambda{category.reload.destroy}.should raise_error(ActiveRecord::DependencyError)
-
-    order.destroy
+    5.times { Order.create!(:category => category) }
+    lambda{category.reload.destroy}.should raise_error(ActiveRecord::DeleteRestrictionError, 'Cannot delete record because 5 dependent orders exist')
+    begin
+      category.destroy
+    rescue ActiveRecord::DeleteRestrictionError => e
+      e.detailed_message.should == "Cannot delete record because 5 dependent orders exist\n\n\nThese include:\n1: Order 1\n2: Order 2\n3: Order 3\n4: Order 4\n5: Order 5"
+    end
+    1.times { Order.create!(:category => category) }
+    begin
+      category.destroy
+    rescue ActiveRecord::DeleteRestrictionError => e
+      e.detailed_message.should == "Cannot delete record because 6 dependent orders exist\n\n\nThese include:\n1: Order 1\n2: Order 2\n3: Order 3\n4: Order 4\n...and 2 more"
+    end
+
+    Order.destroy_all
     lambda{category.reload.destroy}.should_not raise_error
   end
 
   it 'should restrict has_one relationships' do
     order = Order.create!
     order_invoice = OrderInvoice.create!(:order => order)
-    lambda{order.reload.destroy}.should raise_error(ActiveRecord::DependencyError)
+    lambda{order.reload.destroy}.should raise_error(ActiveRecord::DeleteRestrictionError, 'Cannot delete record because dependent order invoice exists')
 
     order_invoice.destroy
     lambda{order.reload.destroy}.should_not raise_error

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dependent_protect
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-29 00:00:00.000000000 Z
+date: 2012-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -50,6 +50,7 @@ files:
 - gemfiles/rails2.gemfile
 - gemfiles/rails3.gemfile
 - lib/dependent_protect.rb
+- lib/dependent_protect/delete_restriction_error.rb
 - spec/dependent_protect_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb