winton-acts_as_archive 0.1.0

data/CHANGELOG.markdown

@@ -0,0 +1,4 @@
+Version 0.1.0
+-------------
+
+* 

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Winton Welsh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,23 @@
+GemTemplate
+===========
+
+A gem template for new projects.
+
+Setup
+-----
+
+<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
+</pre>
+
+Rename these files/folders:
+
+<pre>
+ls **/acts_as_archive*
+</pre>
+
+Do a project-wide find/replace on <code>acts_as_archive</code>.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rubygems'
+require 'spec/rake/spectask'
+
+GEM_NAME = 'acts_as_archive'
+task :default => "#{GEM_NAME}.gemspec"
+
+file "#{GEM_NAME}.gemspec" => FileList[ '{lib,spec}/**', 'Rakefile' ] do |f|
+  # Read spec file and split out manifest section
+  spec = File.read(f.name)
+  parts = spec.split("  # = MANIFEST =\n")
+  fail 'bad spec' if parts.length != 3
+  # Determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject{ |file| file =~ /^\./ }.
+    reject { |file| file =~ /^doc/ }.
+    map{ |file| "    #{file}" }.
+    join("\n")
+  # Piece file back together and write
+  parts[1] = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = parts.join("  # = MANIFEST =\n")
+  File.open(f.name, 'w') { |io| io.write(spec) }
+  puts "Updated #{f.name}"
+end
+
+# Install the gem
+task :install do
+  `sudo gem uninstall #{GEM_NAME} -x`
+  `gem build #{GEM_NAME}.gemspec`
+  `sudo gem install #{GEM_NAME}*.gem`
+  `rm #{GEM_NAME}*.gem`
+end
+
+# rake spec
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/acts_as_archive.gemspec

@@ -0,0 +1,40 @@
+Gem::Specification.new do |s|
+  s.name    = 'acts_as_archive'
+  s.version = '0.1.0'
+  s.date    = '2009-04-22'
+  
+  s.summary     = "Moves your deleted records to a different table"
+  s.description = "Moves your deleted records to a different table"
+  
+  s.author   = 'Winton Welsh'
+  s.email    = 'mail@wintoni.us'
+  s.homepage = 'http://github.com/winton/'
+  
+  # = MANIFEST =
+  s.files = %w[
+    CHANGELOG.markdown
+    MIT-LICENSE
+    README.markdown
+    Rakefile
+    acts_as_archive.gemspec
+    init.rb
+    lib/acts_as_archive.rb
+    lib/acts_as_archive/base.rb
+    lib/acts_as_archive/base/destroy.rb
+    lib/acts_as_archive/base/restore.rb
+    lib/acts_as_archive/base/table.rb
+    lib/acts_as_archive/migration.rb
+    rails/init.rb
+    spec/acts_as_archive/base/destroy_spec.rb
+    spec/acts_as_archive/base/restore_spec.rb
+    spec/acts_as_archive/base/table_spec.rb
+    spec/acts_as_archive/migration_spec.rb
+    spec/db/config/database.yml.example
+    spec/db/log/.gitignore
+    spec/db/migrate/001_add_to_articles.rb
+    spec/db/models/article.rb
+    spec/spec.opts
+    spec/spec_helper.rb
+  ]
+  # = MANIFEST =
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/acts_as_archive/base/destroy.rb

@@ -0,0 +1,67 @@
+module ActsAsArchive
+  module Base
+    module Destroy
+
+      def self.included(base)
+        unless base.included_modules.include?(InstanceMethods)
+          base.class_eval do
+            alias_method :destroy_without_callbacks!, :destroy_without_callbacks
+            class <<self
+              alias_method :delete_all!, :delete_all
+            end
+          end
+          base.send :extend, ClassMethods
+          base.send :include, InstanceMethods
+        end
+      end
+
+      module ClassMethods
+        def copy_to_archive(conditions)
+          add_conditions!(where = '', conditions)
+          col_names = column_names - [ 'deleted_at' ]
+          connection.execute(%{
+            INSERT INTO archived_#{table_name} (#{col_names.join(', ')}, deleted_at)
+              SELECT #{col_names.join(', ')}, '#{Time.now.to_s(:db)}'
+              FROM #{table_name}
+              #{where}
+          })
+          if where.empty?
+            connection.execute("TRUNCATE TABLE #{table_name}")
+          else
+            connection.execute("DELETE FROM #{table_name} #{where}")
+          end
+        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
+        def destroy_without_callbacks
+          unless new_record?
+            self.class.copy_to_archive("#{self.class.primary_key} = #{id}")
+          end
+          freeze
+        end
+
+        def destroy!
+          transaction { destroy_with_callbacks! }
+        end
+
+        def destroy_with_callbacks!
+          return false if callback(:before_destroy) == false
+          result = destroy_without_callbacks!
+          callback(:after_destroy)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_archive/base/restore.rb

@@ -0,0 +1,38 @@
+module ActsAsArchive
+  module Base
+    module Restore
+
+      def self.included(base)
+        unless base.included_modules.include?(InstanceMethods)
+          base.send :extend, ClassMethods
+          base.send :include, InstanceMethods
+        end
+      end
+
+      module ClassMethods
+        
+        def copy_from_archive(conditions)
+          add_conditions!(where = '', conditions)
+          connection.execute(%{
+            INSERT INTO #{table_name} (#{column_names.join(', ')})
+              SELECT #{column_names.join(', ')}
+              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
+        end
+        
+        def restore_all(conditions=nil)
+          copy_from_archive(conditions)
+        end
+      end
+
+      module InstanceMethods
+      end
+    end
+  end
+end

data/lib/acts_as_archive/base/table.rb

@@ -0,0 +1,36 @@
+module ActsAsArchive
+  module Base
+    module Table
+
+      def self.included(base)
+        unless base.included_modules.include?(InstanceMethods)
+          base.send :extend, ClassMethods
+          base.send :include, InstanceMethods
+          # Create archive table when Rails starts
+          base.create_archive_table unless $TESTING
+        end
+      end
+
+      module ClassMethods
+        
+        def create_archive_table
+          if connection.table_exists?(table_name) && !connection.table_exists?("archived_#{table_name}")
+            connection.execute(%{
+              CREATE TABLE archived_#{table_name}
+              ENGINE=InnoDB
+                AS SELECT * from #{table_name}
+                WHERE false;
+            })
+          end
+          columns = connection.columns("archived_#{table_name}").collect(&:name)
+          unless columns.include?('deleted_at')
+            connection.add_column("archived_#{table_name}", 'deleted_at', :datetime)
+          end
+        end
+      end
+
+      module InstanceMethods
+      end
+    end
+  end
+end

data/lib/acts_as_archive/base.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + "/base/destroy"
+require File.dirname(__FILE__) + "/base/restore"
+require File.dirname(__FILE__) + "/base/table"
+
+module ActsAsArchive
+  module Base
+    def self.included(base)
+      base.extend ActMethods
+    end
+  
+    module ActMethods
+      def acts_as_archive
+        include Destroy
+        include Restore
+        include Table
+        class_eval <<-end_eval
+          class Archive < ActiveRecord::Base
+            self.record_timestamps = false
+            self.table_name = "archived_#{self.table_name}"
+          end
+        end_eval
+      end
+    end
+  end
+end

data/lib/acts_as_archive/migration.rb

@@ -0,0 +1,43 @@
+module ActsAsArchive
+  module Migration
+    
+    def self.included(base)
+      unless base.included_modules.include?(InstanceMethods)
+        base.send :extend, ClassMethods
+        base.class_eval do
+          class <<self
+            alias_method :method_missing_without_archive, :method_missing
+            alias_method :method_missing, :method_missing_with_archive
+          end
+        end
+      end
+    end
+    
+    module ClassMethods
+      
+      def method_missing_with_archive(method, *arguments, &block)
+        args = Marshal.load(Marshal.dump(arguments))
+        method_missing_without_archive(method, *arguments, &block)
+        supported = [
+          :add_column, :add_timestamps, :change_column,
+          :change_column_default, :change_table,
+          :drop_table, :remove_column, :remove_columns,
+          :remove_timestamps, :rename_column, :rename_table
+        ]
+        if !args.empty? && supported.include?(method)
+          connection = ActiveRecord::Base.connection
+          args[0] = "archived_" + ActiveRecord::Migrator.proper_table_name(args[0])
+          if method == :rename_table
+            args[1] = "archived_" + args[1]
+          end
+          if connection.table_exists?(args[0])
+            connection.send(method, *args, &block)
+          end
+        end
+      end
+    end
+    
+    module InstanceMethods
+    end
+  end
+end

data/lib/acts_as_archive.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + "/acts_as_archive/base"
+require File.dirname(__FILE__) + "/acts_as_archive/migration"

data/rails/init.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + "/../lib/acts_as_archive")
+
+ActiveRecord::Base.send(:include, ActsAsArchive::Base)
+ActiveRecord::Migration.send(:include, ActsAsArchive::Migration)

data/spec/acts_as_archive/base/destroy_spec.rb

@@ -0,0 +1,109 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe ActsAsArchive::Base::Destroy do
+  
+  before(:all) do
+    establish_test_db
+    Article.create_archive_table
+    @connection = ActiveRecord::Base.connection
+  end
+  
+  describe 'delete_all!' do
+    
+    before(:each) do
+      @articles = []
+      @connection.execute("TRUNCATE TABLE #{Article.table_name}")
+      5.times do |x|
+        @articles << Article.create(:title => "Title #{x}", :body => "Body #{x}")
+      end
+    end
+    
+    it "should really delete all records" do
+      Article.delete_all!
+      Article.count.should == 0
+      Article::Archive.count.should == 0
+    end
+    
+  end
+  
+  describe 'delete_all' do
+    
+    before(:each) do
+      @articles = []
+      5.times do |x|
+        @articles << Article.create(:title => "Title #{x}", :body => "Body #{x}")
+      end
+    end
+    
+    describe 'with conditions' do
+      
+      before(:each) do
+        # Mini delete_all parameter test
+        Article.delete_all [ 'id = ?', @articles[0].id ]
+        Article.delete_all "id = #{@articles[1].id}"
+      end
+      
+      it "should move some records to the archive table" do
+        Article.count.should == 3
+        Article::Archive.count.should == 2
+      end
+      
+      it "should preserve record attributes" do
+        2.times do |x|
+          original = @articles[x]
+          copy = Article::Archive.find(original.id)
+          article_match?(original, copy)
+        end
+      end
+    end
+    
+    describe 'without conditions' do
+      
+      before(:each) do
+        Article.delete_all
+      end
+      
+      it "should move all records to the archive table" do
+        Article.count.should == 0
+        Article::Archive.count.should == 5
+      end
+      
+      it "should preserve record attributes" do
+        5.times do |x|
+          original = @articles[x]
+          copy = Article::Archive.find(original.id)
+          article_match?(original, copy)
+        end
+      end
+    end
+  end
+  
+  [ :destroy, :delete ].each do |d|
+    
+    describe d do
+    
+      before(:each) do
+        @articles = []
+        5.times do |x|
+          @articles << Article.create(:title => "Title #{x}", :body => "Body #{x}")
+        end
+        Article.find(@articles[0..1].collect(&:id)).each do |a|
+          a.send(d)
+        end
+      end
+    
+      it "should move some records to the archive table" do
+        Article.count.should == 3
+        Article::Archive.count.should == 2
+      end
+    
+      it "should preserve record attributes" do
+        2.times do |x|
+          original = @articles[x]
+          copy = Article::Archive.find(original.id)
+          article_match?(original, copy)
+        end
+      end
+    end
+  end
+end

data/spec/acts_as_archive/base/restore_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe ActsAsArchive::Base::Restore do
+  
+  before(:all) do
+    establish_test_db
+    Article.create_archive_table
+    @connection = ActiveRecord::Base.connection
+  end
+  
+  describe 'restore_all' do
+    
+    before(:each) do
+      @articles = []
+      @connection.execute("TRUNCATE TABLE #{Article.table_name}")
+      5.times do |x|
+        @connection.execute(%{
+          INSERT INTO archived_#{Article.table_name} (`id`, `title`, `body`) VALUES (#{x+1}, 'Title #{x}', 'Body #{x}')
+        })
+        @articles << Article::Archive.find(x+1)
+      end
+    end
+    
+    describe 'with conditions' do
+      
+      before(:each) do
+        # Mini restore parameter test
+        Article.restore_all [ 'id = ?', @articles[0].id ]
+        Article.restore_all "id = #{@articles[1].id}"
+      end
+      
+      it "should move some records to the article table" do
+        Article::Archive.count.should == 3
+        Article.count.should == 2
+      end
+      
+      it "should preserve record attributes" do
+        2.times do |x|
+          original = @articles[x]
+          copy = Article.find(original.id)
+          article_match?(original, copy)
+        end
+      end
+    end
+    
+    describe 'without conditions' do
+      
+      before(:each) do
+        Article.restore_all
+      end
+      
+      it "should move all records to the archive table" do
+        Article::Archive.count.should == 0
+        Article.count.should == 5
+      end
+      
+      it "should preserve record attributes" do
+        5.times do |x|
+          original = @articles[x]
+          copy = Article.find(original.id)
+          article_match?(original, copy)
+        end
+      end
+    end
+  end
+end

data/spec/acts_as_archive/base/table_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe ActsAsArchive::Base::Table do
+  
+  before(:all) do
+    establish_test_db
+    @connection = ActiveRecord::Base.connection
+  end
+  
+  describe 'create_archive_table' do
+    
+    before(:all) do
+      Article.create_archive_table
+      @article_columns = @connection.columns("articles").collect(&:name)
+      @archive_columns = @connection.columns("archived_articles").collect(&:name)
+    end
+    
+    it "should create an archive table" do
+      @connection.table_exists?("archived_articles").should == true
+    end
+    
+    it "should create an archive table with the same structure as the original table" do
+      @article_columns.each do |col|
+        @archive_columns.include?(col).should == true
+      end
+    end
+    
+    it "should add a deleted_at column to the archive table" do
+      (@archive_columns - @article_columns).should == [ 'deleted_at' ]
+    end
+  end
+end

data/spec/acts_as_archive/migration_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ActsAsArchive::Migration do
+  
+  before(:each) do
+    establish_test_db
+    Article.create_archive_table
+    @connection = ActiveRecord::Base.connection
+  end
+  
+  describe 'method_missing_with_archive' do
+    
+    before(:each) do
+      @old_article_columns = @connection.columns("articles").collect(&:name)
+      @old_archive_columns = @connection.columns("archived_articles").collect(&:name)
+      ActiveRecord::Migrator.migrate("#{SPEC}/db/migrate")
+      @new_article_columns = @connection.columns("articles").collect(&:name)
+      @new_archive_columns = @connection.columns("archived_articles").collect(&:name)
+    end
+    
+    it 'should migrate both tables up' do
+      (@new_article_columns - @old_article_columns).should == [ 'permalink' ]
+      (@new_archive_columns - @old_archive_columns).should == [ 'permalink' ]
+    end
+    
+    it 'should migrate both tables down' do
+      @old_article_columns = @new_article_columns
+      @old_archive_columns = @new_archive_columns
+      ActiveRecord::Migrator.migrate("#{SPEC}/db/migrate", 0)
+      @new_article_columns = @connection.columns("articles").collect(&:name)
+      @new_archive_columns = @connection.columns("archived_articles").collect(&:name)
+      (@old_article_columns - @new_article_columns).should == [ 'permalink' ]
+      (@old_archive_columns - @new_archive_columns).should == [ 'permalink' ]
+    end
+  end
+end

data/spec/db/config/database.yml.example

@@ -0,0 +1,6 @@
+test:
+  adapter: mysql
+  database: acts_as_archive
+  username: root
+  password: 
+  host: localhost

data/spec/db/migrate/001_add_to_articles.rb

@@ -0,0 +1,9 @@
+class AddToArticles < ActiveRecord::Migration
+  def self.up
+    add_column :articles, :permalink, :string
+  end
+
+  def self.down
+    remove_column :articles, :permalink
+  end
+end

data/spec/db/models/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  acts_as_archive
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+$TESTING=true
+SPEC = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'active_record'
+require 'logger'
+require 'yaml'
+require 'pp'
+
+require File.expand_path("#{SPEC}/../rails/init")
+
+Spec::Runner.configure do |config|
+end
+
+def article_match?(original, copy)
+  copy.id.should == original.id
+  copy.title.should == original.title
+  copy.body.should == original.body
+  copy.created_at.to_s.should == original.created_at.to_s
+  copy.updated_at.to_s.should == original.updated_at.to_s
+  if copy.respond_to?(:deleted_at)
+    copy.deleted_at.strftime('%j%H%M').should == Time.now.strftime('%j%H%M')
+  end
+end
+
+def debug(object)
+  puts "<pre>"
+  pp object
+  puts "</pre>"
+end
+
+def establish_test_db
+  # Establish connection
+  unless ActiveRecord::Base.connected?
+    config = YAML::load(File.open("#{SPEC}/db/config/database.yml"))
+    ActiveRecord::Base.configurations = config
+    ActiveRecord::Base.establish_connection(config['test'])
+  end
+  # Establish logger
+  logger_file = File.open("#{SPEC}/db/log/test.log", 'a')
+  logger_file.sync = true
+  @logger = Logger.new logger_file
+  ActiveRecord::Base.logger = @logger
+  # Drop articles and archived_articles
+  ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS articles")
+  ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS archived_articles")
+  ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS schema_migrations")
+  # Create articles table
+  ActiveRecord::Base.connection.create_table(:articles) do |t|
+    t.string :title
+    t.string :body
+    t.timestamps
+  end
+  # Load model
+  require "#{SPEC}/db/models/article"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: winton-acts_as_archive
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Winton Welsh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Moves your deleted records to a different table
+email: mail@wintoni.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG.markdown
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- acts_as_archive.gemspec
+- init.rb
+- lib/acts_as_archive.rb
+- lib/acts_as_archive/base.rb
+- lib/acts_as_archive/base/destroy.rb
+- lib/acts_as_archive/base/restore.rb
+- lib/acts_as_archive/base/table.rb
+- lib/acts_as_archive/migration.rb
+- rails/init.rb
+- spec/acts_as_archive/base/destroy_spec.rb
+- spec/acts_as_archive/base/restore_spec.rb
+- spec/acts_as_archive/base/table_spec.rb
+- spec/acts_as_archive/migration_spec.rb
+- spec/db/config/database.yml.example
+- spec/db/log/.gitignore
+- spec/db/migrate/001_add_to_articles.rb
+- spec/db/models/article.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/winton/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Moves your deleted records to a different table
+test_files: []
+