rylwin-acts_as_archive 0.4.0

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+*.gem
+coverage
+pkg
+spec/fixtures/config/database.yml
+spec/fixtures/builds
+spec/fixtures/log
+tmp
+vendor

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2010
+
+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.md

@@ -0,0 +1,130 @@
+ActsAsArchive
+=============
+
+Don't delete your records, move them to a different table.
+
+Like <code>acts\_as\_paranoid</code>, but doesn't mess with your SQL queries.
+
+Install
+-------
+
+<pre>
+gem install acts_as_archive
+</pre>
+
+### Rails 2
+
+#### config/environment.rb
+
+<pre>
+config.gem 'acts_as_archive'
+</pre>
+
+### Rails 3
+
+#### Gemfile
+
+<pre>
+gem 'acts_as_archive'
+</pre>
+
+### Sinatra
+
+<pre>
+require 'acts_as_archive'
+
+class Application &lt; Sinatra::Base
+  include ActsAsArchive::Adapters::Sinatra
+end
+</pre>
+
+config/acts\_as\_archive.yml
+----------------------------
+
+Create <code>config/acts\_as\_archive.yml</code> to define the archive class and archive table for each of your models:
+
+<pre>
+Article:
+  - class: Article::Archive
+    table: archived_articles
+</pre>
+
+It is expected that neither the archive class or archive table exist yet. <code>ActsAsArchive</code> will create these automatically.
+
+Migrate
+-------
+
+Run <code>rake db:migrate</code>. Your archive table is created automatically.
+
+That's it!
+----------
+
+Use <code>destroy</code>, <code>destroy\_all</code>, <code>delete</code>, and <code>delete_all</code> like you normally would.
+
+Records move into the archive table instead of being destroyed.
+
+Automatically archive relationships
+-----------------------------------
+
+If your model's relationship has the <code>:dependent</code> option, and the relationship also uses <code>acts\_as\_archive</code>, that relationship will archive automatically.
+
+What if my schema changes?
+--------------------------
+
+New migrations are automatically applied to the archive table.
+
+No action is necessary on your part.
+
+Query the archive
+-----------------
+
+Use the archive class you specified in the configuration:
+
+<pre>
+Article::Archive.first
+</pre>
+
+Delete records without archiving
+--------------------------------
+
+Use any of the destroy methods, but add a bang (!):
+
+<pre>
+Article::Archive.first.destroy!
+Article.delete_all!([ "id in (?)", [ 1, 2, 3 ] ])
+</pre>
+
+Restore from the archive
+------------------------
+
+Use any of the destroy/delete methods on the archived record to move it back to its original table:
+
+<pre>
+Article::Archive.first.destroy
+Article::Archive.delete_all([ "id in (?)", [ 1, 2, 3 ] ])
+</pre>
+
+Any relationships that were automatically archived will be restored as well.
+
+Magic columns
+-------------
+
+You will find an extra <code>deleted_at</code> datetime column on the archive table.
+
+You may manually add a <code>restored_at</code> datetime column to the origin table if you wish to store restoration time as well.
+
+Migrate from acts\_as\_paranoid
+-------------------------------
+
+Add this line to a migration, or run it via <code>script/console</code>:
+
+<pre>
+Article.migrate_from_acts_as_paranoid
+</pre>
+
+This copies all records with non-null <code>deleted_at</code> values to the archive.
+
+Running specs
+-------------
+
+There is a [wiki entry](https://github.com/winton/acts_as_archive/wiki/Running-Specs) that describes the development setup in-depth.

data/Rakefile

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '/lib/acts_as_archive/gems'
+
+ActsAsArchive::Gems.activate %w(rake rspec)
+
+require 'rake'
+require 'spec/rake/spectask'
+
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path('../acts_as_archive.gemspec', __FILE__)
+    eval(File.read(file), binding, file)
+  end
+end
+
+if defined?(Spec::Rake::SpecTask)
+  desc "Run specs"
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = %w(-fs --color)
+    t.warning = true
+  end
+  task :spec
+  task :default => :spec
+end
+
+desc "Build gem(s)"
+task :gem do
+  old_gemset = ENV['GEMSET']
+  root = File.expand_path('../', __FILE__)
+  pkg = "#{root}/pkg"
+  system "rm -Rf #{pkg}"
+  ActsAsArchive::Gems.gemset_names.each do |gemset|
+    ENV['GEMSET'] = gemset.to_s
+    system "cd #{root} && gem build acts_as_archive.gemspec"
+    system "mkdir -p #{pkg} && mv *.gem pkg"
+  end
+  ENV['GEMSET'] = old_gemset
+end
+
+namespace :gem do
+  desc "Install gem(s)"
+  task :install do
+    Rake::Task['gem'].invoke
+    Dir["#{File.dirname(__FILE__)}/pkg/*.gem"].each do |pkg|
+      system "gem install #{pkg} --no-ri --no-rdoc"
+    end
+  end
+  
+  desc "Push gem(s)"
+  task :push do
+    Rake::Task['gem'].invoke
+    Dir["#{File.dirname(__FILE__)}/pkg/*.gem"].each do |pkg|
+      system "gem push #{pkg}"
+    end
+  end
+end
+
+namespace :gems do
+  desc "Install gem dependencies (DEV=0 DOCS=0 GEMSPEC=default SUDO=0)"
+  task :install do
+    dev = ENV['DEV'] == '1'
+    docs = ENV['DOCS'] == '1' ? '' : '--no-ri --no-rdoc'
+    gemset = ENV['GEMSET']
+    sudo = ENV['SUDO'] == '1' ? 'sudo' : ''
+    
+    ActsAsArchive::Gems.gemset = gemset if gemset
+    
+    if dev
+      gems = ActsAsArchive::Gems.gemspec.development_dependencies
+    else
+      gems = ActsAsArchive::Gems.gemspec.dependencies
+    end
+    
+    gems.each do |name|
+      name = name.to_s
+      version = ActsAsArchive::Gems.versions[name]
+      if Gem.source_index.find_name(name, version).empty?
+        version = version ? "-v #{version}" : ''
+        system "#{sudo} gem install #{name} #{version} #{docs}"
+      else
+        puts "already installed: #{name} #{version}"
+      end
+    end
+  end
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end

data/acts_as_archive.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+root = File.expand_path('../', __FILE__)
+lib = "#{root}/lib"
+$:.unshift lib unless $:.include?(lib)
+ 
+require 'acts_as_archive/gems'
+ActsAsArchive::Gems.gemset ||= ENV['GEMSET'] || :default
+
+Gem::Specification.new do |s|
+  ActsAsArchive::Gems.gemspec.hash.each do |key, value|
+    if key == 'name' && ActsAsArchive::Gems.gemset != :default
+      s.name = "#{value}-#{ActsAsArchive::Gems.gemset}"
+    elsif key == 'summary' && ActsAsArchive::Gems.gemset == :solo
+      s.summary = value + " (no dependencies)"
+    elsif !%w(dependencies development_dependencies).include?(key)
+      s.send "#{key}=", value
+    end
+  end
+
+  ActsAsArchive::Gems.dependencies.each do |g|
+    s.add_dependency g.to_s, ActsAsArchive::Gems.versions[g]
+  end
+  
+  ActsAsArchive::Gems.development_dependencies.each do |g|
+    s.add_development_dependency g.to_s, ActsAsArchive::Gems.versions[g]
+  end
+
+  s.executables = `cd #{root} && git ls-files -- {bin}/*`.split("\n").collect { |f| File.basename(f) }
+  s.files = `cd #{root} && git ls-files`.split("\n")
+  s.require_paths = %w(lib)
+  s.test_files = `cd #{root} && git ls-files -- {features,test,spec}/*`.split("\n")
+end

data/bin/acts_as_archive

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+puts `script/runner "ActsAsArchive.update #{ARGV.join ', '}"`

data/config/externals.yml

@@ -0,0 +1,12 @@
+active_wrapper-solo:
+  repo: git@github.com:winton/active_wrapper.git
+  path: vendor
+also_migrate:
+  repo: git@github.com:winton/also_migrate.git
+  path: vendor
+framework_fixture:
+  repo: git@github.com:winton/framework_fixture.git
+  path: vendor
+mover:
+  repo: git@github.com:winton/mover.git
+  path: vendor

data/config/gemsets.yml

@@ -0,0 +1,10 @@
+acts_as_archive:
+  rake: >=0.8.7
+  rspec: ~>1.0
+  default:
+    active_wrapper-solo: =0.4.4
+    also_migrate: =0.3.5
+    externals: =1.0.2
+    framework_fixture: =0.1.3
+    mover: =0.3.6
+    rack-test: =0.5.6

data/config/gemspec.yml

@@ -0,0 +1,12 @@
+name: rylwin-acts_as_archive
+version: 0.4.0
+authors:
+  - Winton Welsh
+email: mail@wintoni.us
+homepage: http://github.com/winton/acts_as_archive
+summary: Don't delete your records, move them to a different table
+description: Don't delete your records, move them to a different table. Like acts_as_paranoid, but doesn't mess with your SQL queries.
+dependencies:
+  - also_migrate
+  - mover
+development_dependencies: null

data/init.rb

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

data/lib/acts_as_archive.rb

@@ -0,0 +1,230 @@
+require File.dirname(__FILE__) + '/acts_as_archive/gems'
+
+ActsAsArchive::Gems.activate %w(also_migrate mover)
+
+require 'also_migrate'
+require 'mover'
+require 'yaml'
+
+$:.unshift File.dirname(__FILE__)
+
+class ActsAsArchive
+  class << self
+
+    attr_accessor :configuration, :disabled
+
+    def deprecate(msg)
+      if defined?(::ActiveSupport::Deprecation)
+        ::ActiveSupport::Deprecation.warn msg
+      else
+        $stdout.puts msg
+      end
+    end
+
+    def disable(&block)
+      @mutex ||= Mutex.new
+      @mutex.synchronize do
+        self.disabled = true
+        block.call
+      end
+    ensure
+      self.disabled = false
+    end
+
+    def find(from)
+      from = [ from ] unless from.is_a?(::Array)
+      (@configuration || []).select do |hash|
+        if from[0].is_a?(::String)
+          from.include?(hash[:from].table_name)
+        else
+          from.include?(hash[:from])
+        end
+      end
+    end
+
+    def load_from_yaml(root)
+      if File.exists?(yaml = "#{root}/config/acts_as_archive.yml")
+        YAML.load(File.read(yaml)).each do |klass, config|
+          klass = eval(klass) rescue nil
+          if klass
+            if (%w(class table) - config.last.keys).empty?
+              options = {}
+            else
+              options = config.pop
+            end
+            config.each do |c|
+              klass.acts_as_archive options.merge(c)
+            end
+          end
+        end
+      end
+    end
+
+    def move(config, where, merge_options={})
+      options = config[:options].dup.merge(merge_options)
+      if options[:conditions]
+        options[:conditions] += " AND #{where}"
+      elsif where
+        options[:conditions] = where
+      end
+      config[:from].move_to(config[:to], options)
+    end
+
+    def update(*args)
+      deprecate "ActsAsArchive.update is deprecated and no longer necessary."
+    end
+  end
+
+  module Base
+    def self.included(base)
+      unless base.included_modules.include?(InstanceMethods)
+        base.extend ClassMethods
+        base.send :include, InstanceMethods
+      end
+    end
+
+    module ClassMethods
+      def acts_as_archive(options={})
+        return unless ActsAsArchive.find(self).empty?
+
+        ActsAsArchive.configuration ||= []
+        ActsAsArchive.configuration << (config = { :from => self })
+
+        options[:copy] = true
+
+        if options[:archive]
+          options[:magic] = 'restored_at'
+          klass = options[:class]
+        else
+          options[:magic] = 'deleted_at' if options[:magic].nil?
+          options[:add] = [[ options[:magic], :datetime ]]
+          options[:ignore] = options[:magic]
+          options[:subtract] = 'restored_at'
+          options[:timestamps] = false if options[:timestamps].nil?
+
+          unless options[:class]
+            options[:class] = "#{self}::Archive"
+          end
+
+          unless options[:table]
+            options[:table] = "archived_#{self.table_name}"
+          end
+
+          klass = eval(options[:class]) rescue nil
+
+          if klass
+            klass.send :set_table_name, options[:table]
+          else
+            eval <<-EVAL
+              class ::#{options[:class]} < ActiveRecord::Base
+                set_table_name "#{options[:table]}"
+              end
+            EVAL
+            klass = eval("::#{options[:class]}")
+          end
+
+          klass.record_timestamps = options[:timestamps].inspect
+          klass.acts_as_archive(:class => self, :archive => true)
+
+          self.reflect_on_all_associations.each do |association|
+            if association.options[:dependent] && !association.options[:polymorphic] && !ActsAsArchive.find(association.klass).empty?
+              opts = association.options.dup
+              opts[:class_name] = "::#{association.class_name}::Archive"
+              opts[:foreign_key] = association.primary_key_name
+              klass.send association.macro, association.name, opts
+            end
+          end
+
+          unless options[:migrate] == false
+            AlsoMigrate.configuration ||= []
+            AlsoMigrate.configuration << options.merge(
+              :source => self.table_name,
+              :destination => klass.table_name
+            )
+          end
+        end
+
+        config[:to] = klass
+        config[:options] = options
+      end
+
+      def delete_all!(*args)
+        ActsAsArchive.disable { self.delete_all(*args) }
+      end
+
+      def destroy_all!(*args)
+        ActsAsArchive.disable { self.destroy_all(*args) }
+      end
+
+      def migrate_from_acts_as_paranoid
+        time = Benchmark.measure do
+          ActsAsArchive.find(self).each do |config|
+            config = config.dup
+            config[:options][:copy] = false
+            ActsAsArchive.move(
+              config,
+              "`#{config[:options][:magic]}` IS NOT NULL",
+              :migrate => true
+            )
+          end
+        end
+        $stdout.puts "-- #{self}.migrate_from_acts_as_paranoid"
+        $stdout.puts "   -> #{"%.4fs" % time.real}"
+      end
+
+      def restore_all(*args)
+        ActsAsArchive.deprecate "#{self}.restore_all is deprecated, please use #{self}.delete_all."
+        self.delete_all *args
+      end
+    end
+
+    module InstanceMethods
+      def delete!(*args)
+        ActsAsArchive.disable { self.delete(*args) }
+      end
+
+      def destroy!(*args)
+        ActsAsArchive.disable { self.destroy(*args) }
+      end
+    end
+  end
+
+  module DatabaseStatements
+    def self.included(base)
+      unless base.included_modules.include?(InstanceMethods)
+        base.send :include, InstanceMethods
+        base.class_eval do
+          unless method_defined?(:delete_sql_without_archive)
+            alias_method :delete_sql_without_archive, :delete_sql
+            alias_method :delete_sql, :delete_sql_with_archive
+          end
+        end
+      end
+    end
+
+    module InstanceMethods
+      def delete_sql_with_archive(sql, name = nil)
+        @mutex ||= Mutex.new
+        @mutex.synchronize do
+          unless ActsAsArchive.disabled
+            from, where = /DELETE FROM (.+)/i.match(sql)[1].split(/\s+WHERE\s+/i, 2)
+            from = from.strip.gsub(/`/, '').split(/\s*,\s*/)
+
+            ActsAsArchive.find(from).each do |config|
+              ActsAsArchive.move(config, where)
+            end
+          end
+        end
+
+        delete_sql_without_archive(sql, name)
+      end
+    end
+  end
+end
+
+::ActiveRecord::Base.send(:include, ::ActsAsArchive::Base)
+::ActiveRecord::ConnectionAdapters::DatabaseStatements.send(:include, ::ActsAsArchive::DatabaseStatements)
+
+require "acts_as_archive/adapters/rails#{Rails.version[0..0]}" if defined?(Rails)
+require "acts_as_archive/adapters/sinatra" if defined?(Sinatra)
+