JackDanger-permanent_records 1.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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/Manifest.txt

@@ -0,0 +1,18 @@
+MIT-LICENSE
+Manifest.txt
+README
+Rakefile
+init.rb
+install.rb
+lib/permanent_records.rb
+tasks/permanent_records_tasks.rake
+test/cached_values_test.rb
+test/database.yml
+test/hole.rb
+test/kitty.rb
+test/mole.rb
+test/muskrat.rb
+test/permanent_records_test.rb
+test/schema.rb
+test/test_helper.rb
+uninstall.rb

data/README

@@ -0,0 +1,22 @@
+PermanentRecords
+================
+
+This plugin prevents any of your records from being destroyed casually.
+Any model with a deleted_at datetime column will have that column set rather than being deleted.
+
+Usage
+=======
+
+User.find(3).destroy          # sets the 'deleted_at' attribute to Time.now and returns a frozen record
+User.find(3).destroy(:force)  # executes the real destroy method, the record will be removed from the database
+User.delete_all               # bye bye everything
+
+There are also two named scopes provided for easily searching deleted and not deleted records:
+
+User.send :with_deleted { User.find(:all) }     # only returns deleted records.
+User.send :with_not_deleted { User.find(:all) } # you guessed it.
+
+These are named so as to work smoothly with other scoping plugins like scope_out.
+
+
+Copyright (c) 2008 Jack Danger Canty of adPickles Inc., released under the MIT license

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require File.dirname(__FILE__) + '/lib/permanent_records'
+
+Hoe.new('permanent_records', PermanentRecords::VERSION) do |p|
+  p.summary = "Soft-delete your ActiveRecord data."
+  p.developer('Jack Danger Canty', 'gems@6brand.com')
+end
+
+# vim: syntax=Ruby

data/init.rb

@@ -0,0 +1,3 @@
+require 'permanent_records'
+
+ActiveRecord::Base.send :include, PermanentRecords

data/lib/permanent_records.rb

@@ -0,0 +1,86 @@
+module PermanentRecords
+  VERSION = '1.0.1'
+  def self.included(base)
+    if base.respond_to?(:named_scope)
+      base.named_scope :deleted, :conditions => {:deleted_at => true}
+      base.named_scope :not_deleted, :conditions => { :deleted_at => nil }
+    else
+      base.extend LegacyScopes
+    end
+    base.send :include, InstanceMethods
+    base.define_callbacks :before_revive, :after_revive
+    base.alias_method_chain :destroy, :permanent_record_force
+    base.alias_method_chain :destroy_without_callbacks, :permanent_record
+  end
+  
+  module LegacyScopes
+    def with_deleted
+      with_scope :find => {:conditions => "#{quoted_table_name}.deleted_at IS NOT NULL"} do
+        yield
+      end
+    end
+    
+    def with_not_deleted
+      with_scope :find => {:conditions => "#{quoted_table_name}.deleted_at IS NULL"} do
+        yield
+      end
+    end
+    
+    # this next bit is basically stolen from the scope_out plugin
+    [:deleted, :not_deleted].each do |name|
+      define_method "find_#{name}" do |*args|
+        send("with_#{name}") { find(*args) }
+      end
+
+      define_method "count_#{name}" do |*args|
+        send("with_#{name}") { count(*args) }
+      end
+
+      define_method "calculate_#{name}" do |*args|
+        send("with_#{name}") { calculate(*args) }
+      end
+
+      define_method "find_all_#{name}" do |*args|
+        send("with_#{name}") { find(:all, *args) }
+      end
+    end
+  end
+  
+  module InstanceMethods
+    
+    def is_permanent?
+      respond_to?(:deleted_at)
+    end
+    
+    def deleted?
+      deleted_at if is_permanent?
+    end
+    
+    def revive
+      run_callbacks :before_revive
+      set_deleted_at nil
+      run_callbacks :after_revive
+      self
+    end
+    
+    def set_deleted_at(value)
+      return self unless is_permanent?
+      record = self.class.find(id)
+      record.update_attribute(:deleted_at, value)
+      @attributes, @attributes_cache = record.attributes, record.attributes
+    end
+    
+    def destroy_with_permanent_record_force(force = nil)
+      @force_permanent_record_destroy = (:force == force)
+      destroy_without_permanent_record_force
+    end
+    
+    def destroy_without_callbacks_with_permanent_record
+      return destroy_without_callbacks_without_permanent_record if @force_permanent_record_destroy || !is_permanent?
+      unless deleted? || new_record?
+        set_deleted_at Time.now
+      end
+      self
+    end
+  end
+end

data/tasks/permanent_records_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :permanent_records do
+#   # Task goes here
+# end

data/test/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: plugin.sqlite.db
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: ":memory:"
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: rails
+  :password:
+  :database: plugin_test

data/test/hole.rb

@@ -0,0 +1,6 @@
+class Hole < ActiveRecord::Base
+  # muskrats are permanent
+  has_many :muskrats, :dependent => :destroy
+  # moles are not permanent
+  has_many :moles, :dependent => :destroy
+end

data/test/kitty.rb

@@ -0,0 +1,2 @@
+class Kitty < ActiveRecord::Base
+end

data/test/mole.rb

@@ -0,0 +1,3 @@
+class Mole < ActiveRecord::Base
+  belongs_to :hole
+end

data/test/muskrat.rb

@@ -0,0 +1,3 @@
+class Muskrat < ActiveRecord::Base
+  belongs_to :hole
+end

data/test/permanent_records_test.rb

@@ -0,0 +1,110 @@
+require 'test/unit'
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+%w(hole mole muskrat kitty).each do |a|
+  require File.expand_path(File.dirname(__FILE__) + "/" + a)
+end
+
+class PermanentRecordsTest < Test::Unit::TestCase
+  
+  def setup
+    super
+    Muskrat.delete_all
+    @active = Muskrat.create!(:name => 'Wakko')
+    @deleted = Muskrat.create!(:name => 'Yakko', :deleted_at => 4.days.ago)
+    @the_girl   = Muskrat.create!(:name => 'Dot')
+    Kitty.delete_all
+    @kitty = Kitty.create!(:name => 'Meow Meow')
+    @hole = Hole.create(:number => 14)
+    @mole = @hole.muskrats.create(:name => "Steady Rat")
+    @mole = @hole.moles.create(:name => "Grabowski")
+  end
+  
+  def teardown
+    setup
+  end
+  
+  def test_destroy_should_return_the_record
+    muskrat = @active
+    assert_equal muskrat, muskrat.destroy
+  end
+  
+  def test_revive_should_return_the_record
+    muskrat = @deleted
+    assert_equal muskrat, muskrat.destroy
+  end
+
+  def test_destroy_should_set_deleted_at_attribute
+    assert @active.destroy.deleted_at
+  end
+  
+  def test_destroy_should_save_deleted_at_attribute
+    assert Muskrat.find(@active.destroy.id).deleted_at
+  end
+  
+  def test_destroy_should_not_really_remove_the_record
+    assert Muskrat.find(@active.destroy.id)
+  end
+  
+  def test_destroy_should_recognize_a_force_parameter
+    assert_raises(ActiveRecord::RecordNotFound) { @active.destroy(:force).reload }
+  end
+  
+  def test_destroy_should_ignore_other_parameters
+    assert Muskrat.find(@active.destroy(:hula_dancer).id)
+  end
+  
+  def test_revive_should_unfreeze_record
+    assert !@deleted.revive.frozen?
+  end
+  
+  def test_revive_should_unset_deleted_at
+    assert !@deleted.revive.deleted_at
+  end
+  
+  def test_revive_should_make_deleted_return_false
+    assert !@deleted.revive.deleted?
+  end
+  
+  def test_deleted_returns_true_for_deleted_records
+    assert @deleted.deleted?
+  end
+  
+  def test_destroy_returns_record_with_modified_attributes
+    assert @active.destroy.deleted?
+  end
+  
+  def test_revive_and_destroy_should_be_chainable
+    assert @active.destroy.revive.destroy.destroy.revive.revive.destroy.deleted?
+    assert !@deleted.destroy.revive.revive.destroy.destroy.revive.deleted?
+  end
+  
+  def test_with_deleted_limits_scope_to_deleted_records
+    assert Muskrat.deleted.all?(&:deleted?)
+  end
+  
+  def test_with_not_deleted_limits_scope_to_not_deleted_records
+    assert !Muskrat.not_deleted.any?(&:deleted?)
+  end
+  
+  def test_models_without_a_deleted_at_column_should_destroy_as_normal
+    assert_raises(ActiveRecord::RecordNotFound) {@kitty.destroy.reload}
+  end
+  
+  def test_dependent_non_permanent_records_should_be_destroyed
+    assert @hole.is_permanent?
+    assert !@hole.moles.first.is_permanent?
+    assert_difference "Mole.count", -1 do
+      @hole.destroy
+    end
+  end
+  
+  def test_dependent_permanent_records_should_be_marked_as_deleted
+    assert @hole.is_permanent?
+    assert @hole.muskrats.first.is_permanent?
+    assert_no_difference "Muskrat.count" do
+      @hole.destroy
+    end
+    assert @hole.muskrats.first.deleted?
+  end
+end

data/test/schema.rb

@@ -0,0 +1,23 @@
+ActiveRecord::Schema.define(:version => 1) do
+  
+  create_table :muskrats do |t|
+    t.column :name,         :string
+    t.column :deleted_at,   :datetime
+    t.references :hole
+  end
+  
+  create_table :kitties do |t|
+    t.column :name,   :string
+  end
+
+  create_table :holes do |t|
+    t.integer :number
+    t.datetime :deleted_at
+  end
+  
+  create_table :moles do |t|
+    t.string :name
+    t.references :hole
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+# Include this file in your test by copying the following line to your test:
+#   require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+RAILS_ROOT = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_record/fixtures'
+require "#{File.dirname(__FILE__)}/../init"
+require File.expand_path(File.dirname(__FILE__) + "/muskrat")
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3'])
+
+load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
+
+class Test::Unit::TestCase #:nodoc:
+  # def create_fixtures(*table_names)
+  #   if block_given?
+  #     Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
+  #   else
+  #     Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
+  #   end
+  # end
+
+  # Turn off transactional fixtures if you're working with MyISAM tables in MySQL
+  self.use_transactional_fixtures = true
+  
+  # Instantiated fixtures are slow, but give you @david where you otherwise would need people(:david)
+  self.use_instantiated_fixtures  = false
+
+  # Add more helper methods to be used by all tests here...
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: JackDanger-permanent_records
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Jack Danger Canty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.11.0
+    version: 
+description: 
+email: 
+- gems@6brand.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+files: 
+- MIT-LICENSE
+- Manifest.txt
+- README
+- Rakefile
+- init.rb
+- install.rb
+- lib/permanent_records.rb
+- tasks/permanent_records_tasks.rake
+- test/cached_values_test.rb
+- test/database.yml
+- test/hole.rb
+- test/kitty.rb
+- test/mole.rb
+- test/muskrat.rb
+- test/permanent_records_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: permanent_records
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Soft-delete your ActiveRecord data.
+test_files: 
+- test/test_helper.rb