undestroy 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in undestroy.gemspec
+gemspec
+
+gem 'rake'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Travis Petticrew
+
+MIT License
+
+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,92 @@
+# Undestroy
+
+Allow copying records to alternate table before destroying an
+ActiveRecord model for archiving purposes.  Data will be mapped
+one-to-one to the archive table schema.  Additional fields can also be
+configured for additional tracking information.  Archive table schema
+will automatically be updated when the parent model's table is migrated
+through Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'undestroy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install undestroy
+
+## Usage
+
+To activate Undestroy on a model, simply call the `undestroyable` method
+on the class like so:
+
+    class Person < ActiveRecord::Base
+      undestroyable
+    end
+
+This method also can accept an options hash to further customize
+Undestroy to your needs.
+
+* `:table_name`:  use this table for archiving
+* `:class_name`:  use this AR model for archiving
+* `:connection`:  use this connection for archiving
+* `:fields`:  Specify a hash of fields to values for additional fields
+  you would like to include on the archive table -- lambdas will be
+  called with the instance being destroyed and returned value will be
+  used (default: `{ :deleted_at => proc { |instance| Time.now } }`).
+* `:migrate`:  Should Undestroy migrate the archive table together with
+  this model's table (default: true)
+
+    $ person = Person.find(1)
+    $ person.destroy
+    # => Inserts person data into archive_people table
+    # => Deletes person data from people table
+
+## Stucture
+
+This is the basic class structure of this gem.  It was designed to be
+modular and easy to tailor to your specific needs.
+
+### `Archive`
+
+Map the source model's schema to the archive model's and initiate the
+transfer through `Transfer`.  When `run` is called the Transfer is
+initialized with a primitive hash mapping the schema to the archive
+table.
+
+Initialized with:
+
+* `:config`: Instance of Undestroy::Config for this model
+* `:source`: Instance of the source model
+
+### `Restore`
+
+Map the archive model's schema to the source model's and initiate the
+transfer through `Transfer`
+
+Initialized with:
+
+* `:config`: Instance of Undestroy::Config for this model
+* `:archive`: Instance of the archived model
+
+### `Transfer`
+
+Handles the actual movement of data from one table to another.  This
+class simply uses the AR interface to create and delete the appropriate
+records.  This can be subclassed to provide enhanced performance or
+customized behavior for your situation.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+
+require 'assert/rake_tasks'
+Assert::RakeTasks.for(:test)
+
+require "bundler/gem_tasks"
+

data/lib/undestroy.rb

@@ -0,0 +1,5 @@
+require "undestroy/version"
+
+module Undestroy
+  # Your code goes here...
+end

data/lib/undestroy/version.rb

@@ -0,0 +1,3 @@
+module Undestroy
+  VERSION = "0.0.1"
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'assert'
+

data/test/unit/undestroy_test.rb

@@ -0,0 +1,10 @@
+require 'assert'
+
+class UndestroyTest < Assert::Context
+
+  should "write tests" do
+    assert true
+  end
+
+end
+

data/undestroy.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/undestroy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Travis Petticrew"]
+  gem.email         = ["bobo@petticrew.net"]
+  gem.description   = %q{Move AR records to alternate table on destroy and allow restoring.}
+  gem.summary       = %q{Allow AR records to be undestroyed by archiving their data in a seperate table when destroying the original data}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "undestroy"
+  gem.require_paths = ["lib"]
+  gem.version       = Undestroy::VERSION
+
+  gem.add_dependency 'activerecord', '~>3.0'
+
+  gem.add_development_dependency 'assert', '~>0.7'
+  gem.add_development_dependency 'assert-rails', '~>0.2'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: undestroy
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Travis Petticrew
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  name: activerecord
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  name: assert
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
+  name: assert-rails
+  version_requirements: *id003
+description: Move AR records to alternate table on destroy and allow restoring.
+email: 
+- bobo@petticrew.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/undestroy.rb
+- lib/undestroy/version.rb
+- test/helper.rb
+- test/unit/undestroy_test.rb
+- undestroy.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Allow AR records to be undestroyed by archiving their data in a seperate table when destroying the original data
+test_files: 
+- test/helper.rb
+- test/unit/undestroy_test.rb