deactivatable 0.0.1 → 0.0.2

data/.gitignore

@@ -3,3 +3,4 @@
 coverage
 rdoc
 pkg
+.project

data/README.rdoc

@@ -1,10 +1,25 @@
 = deactivatable
 
+== Description
 Deactivatable provides methods and a default_scope to allow ActiveRecord objects to be deactivated instead of deleted.
 This is useful if an object needs to be removed from general use, but it's data needs to be retained.
 Additionally, Deactivatable provides the ability to specify dependencies which also need to be deactivated.
 Deactivation is determined by populating a deactivated_at field with the date time at which deactivation happened.
 
+== Install
+The deactivatable gem is hosted on GemCutter (http://gemcutter.org)
+  gem install deactivatable
+OR
+  config.gem 'deactivatable', :source => 'http://gemcutter.org'
+  
+== Usage
+* Add a deactivated_at datetime field to any table you want to be deactivatable
+    add_column :table_name, :deactivated_at, :datetime
+* Add the acts_as_deactivatable call to any class that should be deactivatable
+    Options
+      :dependencies - A list of symbols specifying any associations that are also deactivatable.  (The dependent association must separately be defined with acts_as_deactivatable).
+      :auto_configure_dependencies - true or false (default).  If set to true, any association defined as :dependent => :destroy or :dependent => :delete_all will be added to the list of dependencies to deactivate.  NOTE: This call must occur after your dependency definitions to work properly.
+ 
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/deactivatable.rb

@@ -11,7 +11,8 @@ module ActiveRecord
         # Define the calling class as being deactivatable.  
         # A call to this will set the default scope of the object to look for deactivated_at = nil.
         # Options
-        #   *:dependencies* => A list of symbols specifying any associations that are also deactivatable.  (This associations must separately be defined with acts_as_deactivatable).
+        #   :dependencies - A list of symbols specifying any associations that are also deactivatable.  (The dependent association must separately be defined with acts_as_deactivatable).
+        #   :auto_configure_dependencies - true or false (default).  If set to true, any association defined as :dependent => :destroy or :dependent => :delete_all will be added to the list of dependencies to deactivate.  NOTE: This call must occur after your dependency definitions to work properly.
         #
         def acts_as_deactivatable(options={})
           extend ActiveRecord::Acts::Deactivatable::ClassMethods          
@@ -20,6 +21,7 @@ module ActiveRecord
           default_scope :conditions => {:deactivated_at => nil}
           
           @deactivatable_options = options
+          setup_autoconfigured_dependencies if @deactivatable_options[:auto_configure_dependencies]
         end
         
       end
@@ -30,10 +32,6 @@ module ActiveRecord
           @deactivatable_options || {}
         end
         
-        def deactivated_dependencies
-          @deactivated_dependencies ||= []
-        end
-        
         # Yields to a block, executing that block after removing the deactivated_at scope.
         #
         def with_deactivated_objects_scope
@@ -43,8 +41,26 @@ module ActiveRecord
             end
           end
         end
+
+        private
+        # Scan the reflection associations defined on the current class,
+        # if the :dependent option is set to :destroy or :delete_all then add that reflection to the list of dependencies to be deactivated.
+        #
+        def setup_autoconfigured_dependencies
+          self.reflections.each_key { |reflection_name| setup_auto_configured_dependency(reflection_name) } 
+        end
+        
+        def setup_auto_configured_dependency(reflection_name)
+          @deactivatable_options[:dependencies] ||= []
+          reflection = self.reflections[reflection_name]
+          
+          if [:destroy, :delete_all].include?(reflection.options[:dependent])
+            @deactivatable_options[:dependencies] << reflection_name
+          end          
+        end
+
       end
-   
+
       module InstanceMethods
         
         # Deactivate this object, and any associated objects as specified at definition time.
@@ -97,8 +113,9 @@ module ActiveRecord
         #
         def execute_on_dependency(dependency_name, method)
           self.class.reflections[dependency_name].klass.send(:with_exclusive_scope) do
-            dependency = self.__send__(dependency_name)          
-            dependency.respond_to?(:map) ? dependency.map(&method) : dependency.__send__(method)
+            if dependency = self.__send__(dependency_name)
+              dependency.respond_to?(:map) ? dependency.map(&method) : dependency.__send__(method)
+            end
           end
         end
         

data/test/deactivatable_item.rb

@@ -1,7 +1,6 @@
 class DeactivatableItem < ActiveRecord::Base
 
-  has_many :deactivatable_dependencies
-
-  acts_as_deactivatable :dependencies => [:deactivatable_dependencies]
+  acts_as_deactivatable
+  
   
 end

data/test/deactivatable_test.rb

@@ -2,6 +2,38 @@ require 'test_helper'
 
 class DeactivatableTest < Test::Unit::TestCase
   
+  
+  def self.should_deactivate_and_reactivate_dependencies
+    context "on a call to deactivate!" do
+      setup do
+        @item.deactivate!
+      end
+      
+      should "render dependency unfindable" do
+        @dependencies.each { |dependency| assert !DeactivatableDependency.exists?(dependency.id) }
+      end
+      
+      should "set deactivate on dependency post" do
+        DeactivatableDependency.send(:with_exclusive_scope) do
+          @dependencies.map(&:reload)
+          @dependencies.each {|dependency| assert_not_nil(dependency.deactivated_at) }
+        end
+      end
+      
+      context "when reactivated" do
+        setup do
+          @item.activate!
+        end
+        
+        should "reactivate all dependencies" do
+          @dependencies.each { |dependency| assert(DeactivatableDependency.exists?(dependency.id)) }
+        end
+      end #when reactivated
+      
+    end #on a call to deactivate!
+  end
+
+  
   context "An inactive item, @item" do
     setup do
       @inactive_item = DeactivatableItem.new
@@ -57,38 +89,65 @@ class DeactivatableTest < Test::Unit::TestCase
     
     context "with dependencies, @dependencies" do
       setup do
-        @dependencies = (0..5).map { DeactivatableDependency.new }
-        @item.deactivatable_dependencies = @dependencies
+        @item.class.instance_eval { has_many :deactivatable_dependencies }
+        @item.class.instance_eval { acts_as_deactivatable :dependencies => [:deactivatable_dependencies] }
+        create_item_dependencies
       end
 
-      context "on a call to deactivate!" do
-        setup do
-          @item.deactivate!
-        end
-        
-        should "render dependency unfindable" do
-          @dependencies.each { |dependency| assert !DeactivatableDependency.exists?(dependency.id) }
-        end
-        
-        should "set deactivate on dependency post" do
-          DeactivatableDependency.send(:with_exclusive_scope) do
-            @dependencies.map(&:reload)
-            @dependencies.each {|dependency| assert_not_nil(dependency.deactivated_at) }
-          end
-        end
-        
-        context "when reactivated" do
-          setup do
-            @item.activate!
-          end
-          
-          should "reactivate all dependencies" do
-            @dependencies.each { |dependency| assert(DeactivatableDependency.exists?(dependency.id)) }
-          end
-        end #when reactivated
-        
-      end #on a call to deactivate!
+      should_deactivate_and_reactivate_dependencies
     end #with dependencies, @dependencies
+    
+    context "with dependencies, @dependencies, that are :dependent => :destroy, and with auto_configure_dependencies => true" do
+    	setup do
+        @item.class.instance_eval { has_many :deactivatable_dependencies, :dependent => :destroy }
+        @item.class.instance_eval { acts_as_deactivatable :auto_configure_dependencies => true }
+        create_item_dependencies
+    	end
+
+      should_deactivate_and_reactivate_dependencies
+    end #with dependencies, @dependencies, that are dependent destroy, and with auto_configure_dependencies => true
+    
+    context "with dependencies, @dependencies, that are :dependent => :delete_all , and with auto_configure_dependencies => true" do
+      setup do
+        @item.class.instance_eval { has_many :deactivatable_dependencies, :dependent => :delete_all }
+        @item.class.instance_eval { acts_as_deactivatable :auto_configure_dependencies => true }
+        create_item_dependencies
+      end
+
+      should_deactivate_and_reactivate_dependencies
+    end #with dependencies, @dependencies, that are dependent destroy, and with auto_configure_dependencies => true
+    
+    context "with a single dependency" do
+    	setup do
+        @item.class.instance_eval { has_one :deactivatable_dependency } 
+        @item.class.instance_eval { acts_as_deactivatable :dependencies => [:deactivatable_dependency] }
+    		@dependency = DeactivatableDependency.new
+        @item.deactivatable_dependency = @dependency
+        @item.save!
+        @dependencies = [@dependency]        
+    	end
+    
+      should_deactivate_and_reactivate_dependencies
+      
+      context "that is nil" do
+      	setup do
+      		@item.deactivatable_dependency = nil
+          @item.save!
+      	end
+
+        
+       	should "not raise an exception when deactivated" do
+       	  assert_nothing_raised { @item.deactivate! }
+       	end
+      end #that is nil
+    end #with a single dependency
+    
   end #An active item, @item
+  
+  private
+  def create_item_dependencies
+    @dependencies = (0..5).map { DeactivatableDependency.new }
+    @item.deactivatable_dependencies = @dependencies
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: deactivatable
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Greg Fitzgerald
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-06 00:00:00 -05:00
+date: 2009-11-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency