acts_as_archival 0.5.2 → 0.5.3

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changes!
 
+## 0.5.3
+* Major refactoring of archiving/unarchiving logic into nice command classes instead of big ball of ARec voodoo. Thanks, Marten Claes!
+
 ## 0.5.2
 * More changes to support Rails 4
 * fix scoping combinations with relations for Rails 4

data/README.md

@@ -16,10 +16,14 @@ Additionally, other plugins generally screw with how
 to destroy records.
 
 ## Install
-Rails 3.2+ (maybe 3.1?)
+Rails 3.2 and up
 
 `gem install acts_as_archival`
 
+or in your Gemfile
+
+`gem "acts_as_archival"`
+
 Rails 3.0x:
 
 `rails plugin install http://github.com/expectedbehavior/acts_as_archival.git -r rails3.0x`
@@ -97,8 +101,8 @@ postgres and if not, submit a patch / let us know about it!
 
 ## Thanks
 
-ActsAsParanoid and PermanentRecords were both inspirations for this:  
-http://github.com/technoweenie/acts_as_paranoid  
+ActsAsParanoid and PermanentRecords were both inspirations for this:
+http://github.com/technoweenie/acts_as_paranoid
 http://github.com/fastestforward/permanent_records
 
 ## Contributors
@@ -111,6 +115,7 @@ http://github.com/fastestforward/permanent_records
 * Dave Woodward
 * Miles Sterrett
 * James Hill
+* Marten Claes
 
 Thanks!
 

data/acts_as_archival.gemspec

@@ -13,10 +13,14 @@ Gem::Specification.new do |gem|
                      "David Jones",
                      "Dave Woodward",
                      "Miles Sterrett",
-                     "James Hill"]
+                     "James Hill",
+                     "Marten Claes"]
   gem.email       = ["joel@expectedbehavior.com",
                      "michael@expectedbehavior.com",
-                     "matt@expectedbehavior.com"]
+                     "matt@expectedbehavior.com",
+                     "jason@expectedbehavior.com",
+                     "tyler@expectedbehavior.com",
+                     "nathan@expectedbehavior.com"]
   gem.homepage    = "http://github.com/expectedbehavior/acts_as_archival"
 
   gem.files         = `git ls-files`.split("\n")

data/lib/acts_as_archival.rb

@@ -1,5 +1,9 @@
 require "acts_as_archival/version"
 
+require "expected_behavior/association_operation/base"
+require "expected_behavior/association_operation/archive"
+require "expected_behavior/association_operation/unarchive"
+
 require "expected_behavior/acts_as_archival"
 require "expected_behavior/acts_as_archival_active_record_methods"
 

data/lib/acts_as_archival/version.rb

@@ -1,3 +1,3 @@
 module ActsAsArchival
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/lib/expected_behavior/acts_as_archival.rb

@@ -103,42 +103,11 @@ module ExpectedBehavior
       end
 
       def archive_associations(head_archive_number)
-        act_only_on_dependent_destroy_associations = Proc.new {|association| association.options[:dependent] == :destroy}
-        act_on_all_archival_associations(head_archive_number, :archive => true, :association_options => act_only_on_dependent_destroy_associations)
+        AssociationOperation::Archive.new(self, head_archive_number).execute
       end
 
       def unarchive_associations(head_archive_number)
-        act_on_all_archival_associations(head_archive_number, :unarchive => true)
-      end
-
-      def act_on_all_archival_associations(head_archive_number, options={})
-        return if options.length == 0
-        options[:association_options] ||= Proc.new { true }
-        self.class.reflect_on_all_associations.each do |association|
-          if (association.macro.to_s =~ /^has/ && association.klass.is_archival? &&
-              options[:association_options].call(association) &&
-              association.options[:through].nil?)
-            association_key = association.respond_to?(:foreign_key) ? association.foreign_key : association.primary_key_name
-            act_on_a_related_archival(association.klass, association_key, id, head_archive_number, options)
-          end
-        end
-      end
-
-      def act_on_a_related_archival(klass, key_name, id, head_archive_number, options={})
-        return if options.length == 0 || (!options[:archive] && !options[:unarchive])
-        if options[:archive]
-          klass.unarchived.where(["#{key_name} = ?", id]).each do |related_record|
-            unless related_record.archive(head_archive_number)
-              raise ActiveRecord::Rollback
-            end
-          end
-        else
-          klass.archived.where(["#{key_name} = ? AND archive_number = ?", id, head_archive_number]).each do |related_record|
-            unless related_record.unarchive(head_archive_number)
-              raise ActiveRecord::Rollback
-            end
-          end
-        end
+        AssociationOperation::Unarchive.new(self, head_archive_number).execute
       end
     end
   end

data/lib/expected_behavior/association_operation/archive.rb

@@ -0,0 +1,21 @@
+module ExpectedBehavior
+  module ActsAsArchival
+    module AssociationOperation
+      class Archive < Base
+
+        protected
+
+        def act_on_archivals(archivals)
+          archivals.unarchived.find_each do |related_record|
+            raise ActiveRecord::Rollback unless related_record.archive(head_archive_number)
+          end
+        end
+
+        def association_conditions_met?(association)
+          association.options[:dependent] == :destroy
+        end
+
+      end
+    end
+  end
+end

data/lib/expected_behavior/association_operation/base.rb

@@ -0,0 +1,51 @@
+module ExpectedBehavior
+  module ActsAsArchival
+    module AssociationOperation
+
+      class Base
+        attr_reader :model, :head_archive_number
+
+        def initialize(model, head_archive_number)
+          @model = model
+          @head_archive_number = head_archive_number
+        end
+
+        def execute
+          each_archivable_association do |association|
+            act_on_association(association) if association_conditions_met? association
+          end
+        end
+
+        protected
+
+        def each_archivable_association
+          self.model.class.reflect_on_all_associations.each do |association|
+            yield(association) if archivable_association?(association)
+          end
+        end
+
+        def archivable_association?(association)
+          association.macro.to_s =~ /^has/ &&
+            association.klass.is_archival? &&
+            association.options[:through].nil?
+        end
+
+        def association_conditions_met?(association)
+          true
+        end
+
+        def act_on_association(association)
+          key = association.respond_to?(:foreign_key) ? association.foreign_key : association.primary_key_name
+          scope = association.klass.where(key => model.id)
+          act_on_archivals(scope)
+        end
+
+        def act_on_archivals(scope)
+          raise NotImplementedError,
+            "The #{self.class} hasn't implemented 'act_on_archivals(scope)'"
+        end
+      end
+
+    end
+  end
+end

data/lib/expected_behavior/association_operation/unarchive.rb

@@ -0,0 +1,17 @@
+module ExpectedBehavior
+  module ActsAsArchival
+    module AssociationOperation
+      class Unarchive < Base
+
+        protected
+
+        def act_on_archivals(scope)
+          scope.archived.where(:archive_number => head_archive_number).find_each do |related_record|
+            raise ActiveRecord::Rollback unless related_record.unarchive(head_archive_number)
+          end
+        end
+
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_archival
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,6 +13,7 @@ authors:
 - Dave Woodward
 - Miles Sterrett
 - James Hill
+- Marten Claes
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -158,6 +159,9 @@ email:
 - joel@expectedbehavior.com
 - michael@expectedbehavior.com
 - matt@expectedbehavior.com
+- jason@expectedbehavior.com
+- tyler@expectedbehavior.com
+- nathan@expectedbehavior.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -176,6 +180,9 @@ files:
 - lib/acts_as_archival/version.rb
 - lib/expected_behavior/acts_as_archival.rb
 - lib/expected_behavior/acts_as_archival_active_record_methods.rb
+- lib/expected_behavior/association_operation/archive.rb
+- lib/expected_behavior/association_operation/base.rb
+- lib/expected_behavior/association_operation/unarchive.rb
 - test/ambiguous_table_test.rb
 - test/associations_test.rb
 - test/basic_test.rb