winton-acts_as_archive 0.1.0 → 0.1.1

data/README.markdown

@@ -1,23 +1,73 @@
-GemTemplate
-===========
+ActsAsArchive
+=============
 
-A gem template for new projects.
+Don't delete your records, move them to a different table.
+Like <code>acts\_as\_paranoid</code>, but doesn't change all your SQL queries.
 
-Setup
------
+Install
+-------
+
+script/plugin:
+
+<pre>
+script/plugin install git://github.com/winton/acts_as_archive.git
+</pre>
+
+rubygems:
 
 <pre>
-git clone git://github.com/winton/acts_as_archive.git my_project
-cd my_project
-rm -Rf .git
-git init
-git remote add origin git@github.com:winton/my_project.git
+# terminal
+sudo gem install winton-acts_as_archive
+
+# environment.rb
+config.gem "winton-acts_as_archive", :lib => "acts_as_archive", :source => "http://gems.github.com"
 </pre>
 
-Rename these files/folders:
+Models
+------
+
+Add <code>acts\_as\_archive</code> to your models:
 
 <pre>
-ls **/acts_as_archive*
+class Article < ActiveRecord::Base
+  acts_as_archive
+end
 </pre>
 
-Do a project-wide find/replace on <code>acts_as_archive</code>.
+That's it!
+----------
+
+Next time your Rails instance boots up, the plugin replicates your table's structure into
+<code>archived\_articles</code> (as per the example), with an additional <code>deleted\_at</code> column.
+
+Use <code>destroy</code>, <code>delete</code>, and <code>delete_all</code> like you normally would.
+Records are copied into the archive table before being destroyed.
+
+What if my schema changes?
+--------------------------
+
+Any new migrations on your <code>acts\_as\_archive</code> table are automatically applied to the archive table.
+
+Query the archive
+-----------------
+
+Add <code>::Archive</code> to your ActiveRecord class:
+
+<pre>
+Article::Archive.find(:first)
+</pre>
+
+Restore from the archive
+------------------------
+
+Use <code>restore\_all</code> to copy archived records back to your table:
+
+<pre>
+Article.restore_all([ 'id = ?', 1 ])
+</pre>
+
+Auto-migrate from acts\_as\_paranoid
+------------------------------------
+
+If a <code>deleted\_at</code> column is present in your table, the plugin will attempt to move deleted
+records to the archive table, preserving the <code>deleted\_at</code> value.

data/acts_as_archive.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name    = 'acts_as_archive'
-  s.version = '0.1.0'
-  s.date    = '2009-04-22'
+  s.version = '0.1.1'
+  s.date    = '2009-04-23'
   
-  s.summary     = "Moves your deleted records to a different table"
-  s.description = "Moves your deleted records to a different table"
+  s.summary     = "Don't delete your records, move them to a different table"
+  s.description = "Don't delete your records, move them to a different table"
   
   s.author   = 'Winton Welsh'
   s.email    = 'mail@wintoni.us'
-  s.homepage = 'http://github.com/winton/'
+  s.homepage = 'http://github.com/winton/acts_as_archive'
   
   # = MANIFEST =
   s.files = %w[

data/lib/acts_as_archive/base/destroy.rb

@@ -16,31 +16,30 @@ module ActsAsArchive
       end
 
       module ClassMethods
-        def copy_to_archive(conditions)
+        def copy_to_archive(conditions, import=false)
           add_conditions!(where = '', conditions)
-          col_names = column_names - [ 'deleted_at' ]
+          insert_cols = column_names.clone
+          select_cols = column_names.clone
+          if insert_cols.include?('deleted_at')
+            unless import
+              select_cols[select_cols.index('deleted_at')] = "'#{Time.now.to_s(:db)}'"
+            end
+          else
+            insert_cols << 'deleted_at'
+            select_cols << "'#{Time.now.to_s(:db)}'"
+          end
           connection.execute(%{
-            INSERT INTO archived_#{table_name} (#{col_names.join(', ')}, deleted_at)
-              SELECT #{col_names.join(', ')}, '#{Time.now.to_s(:db)}'
+            INSERT INTO archived_#{table_name} (#{insert_cols.join(', ')})
+              SELECT #{select_cols.join(', ')}
               FROM #{table_name}
               #{where}
           })
-          if where.empty?
-            connection.execute("TRUNCATE TABLE #{table_name}")
-          else
-            connection.execute("DELETE FROM #{table_name} #{where}")
-          end
+          connection.execute("DELETE FROM #{table_name} #{where}")
         end
       
         def delete_all(conditions=nil)
           copy_to_archive(conditions)
         end
-        
-        def migrate_from_acts_as_paranoid
-          if column_names.include?('deleted_at')
-            copy_to_archive('deleted_at IS NOT NULL')
-          end
-        end
       end
 
       module InstanceMethods

data/lib/acts_as_archive/base/restore.rb

@@ -19,11 +19,7 @@ module ActsAsArchive
               FROM archived_#{table_name}
               #{where}
           })
-          if where.empty?
-            connection.execute("TRUNCATE TABLE archived_#{table_name}")
-          else
-            connection.execute("DELETE FROM archived_#{table_name} #{where}")
-          end
+          connection.execute("DELETE FROM archived_#{table_name} #{where}")
         end
         
         def restore_all(conditions=nil)

data/lib/acts_as_archive/base/table.rb

@@ -21,10 +21,20 @@ module ActsAsArchive
                 AS SELECT * from #{table_name}
                 WHERE false;
             })
+            columns = connection.columns("archived_#{table_name}").collect(&:name)
+            unless columns.include?('deleted_at')
+              connection.add_column("archived_#{table_name}", :deleted_at, :datetime)
+            end
+            connection.add_index("archived_#{table_name}", :id)
+            connection.add_index("archived_#{table_name}", :deleted_at)
+            migrate_from_acts_as_paranoid
           end
-          columns = connection.columns("archived_#{table_name}").collect(&:name)
-          unless columns.include?('deleted_at')
-            connection.add_column("archived_#{table_name}", 'deleted_at', :datetime)
+        end
+        
+        def migrate_from_acts_as_paranoid
+          if column_names.include?('deleted_at')
+            # Base::Destroy.copy_to_archive
+            copy_to_archive('deleted_at IS NOT NULL', true)
           end
         end
       end

data/lib/acts_as_archive/migration.rb

@@ -24,6 +24,10 @@ module ActsAsArchive
           :drop_table, :remove_column, :remove_columns,
           :remove_timestamps, :rename_column, :rename_table
         ]
+        if args.include?(:deleted_at) || args.include?('deleted_at')
+          # Don't change the archive's deleted_at column
+          return
+        end
         if !args.empty? && supported.include?(method)
           connection = ActiveRecord::Base.connection
           args[0] = "archived_" + ActiveRecord::Migrator.proper_table_name(args[0])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: winton-acts_as_archive
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Winton Welsh
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-22 00:00:00 -07:00
+date: 2009-04-23 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: Moves your deleted records to a different table
+description: Don't delete your records, move them to a different table
 email: mail@wintoni.us
 executables: []
 
@@ -46,7 +46,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: false
-homepage: http://github.com/winton/
+homepage: http://github.com/winton/acts_as_archive
 post_install_message: 
 rdoc_options: []
 
@@ -70,6 +70,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Moves your deleted records to a different table
+summary: Don't delete your records, move them to a different table
 test_files: []