simple_soft_delete 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+simple_soft_delete.db
+.bundle
+Gemfile.lock
+pkg/*

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in simple_soft_delete.gemspec
+gemspec

data/README.md

@@ -0,0 +1,51 @@
+# Simple Soft Delete
+
+Simple soft delete is a rails 3 gem for flagging models once they have
+been deleted/destroyed with the following commands:
+
+- Model.delete_all
+- Model.destroy_all
+- model.delete
+- model.destroy
+
+## Installation
+
+Add a deleted column to the model you want to soft delete
+
+```
+class AddDeletedToModel < ActiveRecord::Migration                 
+  def change                                         
+    add_column :models, :deleted, :boolean, :null => false, :default => false 
+  end                                                                           
+end
+```
+
+Add SimpleSoftDelete module to the model
+
+```
+class Model < ActiveRecord::Base                                                                             
+  include SimpleSoftDelete
+  
+  # Scope any uniqueness validations
+  validates_uniqueness_of :attribute_name, :scope => :deleted
+end
+```
+
+## Example usage
+
+```
+Model.count => 10
+model = Model.find 3
+model.delete # UPDATE `models` SET `deleted` = 1, `updated_at` = '2012-01-27 22:34:52' WHERE `models`.`id` = 3
+Model.count => 9 # SELECT COUNT(*) FROM `models` WHERE `models`.`deleted` = 0
+Model.unscoped.count => 10 # SELECT COUNT(*) FROM `models`
+Model.with_deleted.count => 10
+```
+
+```
+Model.count => 10
+Model.delete_all
+Model.count => 0
+Model.with_deleted.count => 10
+```
+*it also works the same for destroy which just aliases their delete counterparts*

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simple_soft_delete.rb

@@ -0,0 +1,30 @@
+require "simple_soft_delete/version"
+require 'active_support/concern'
+
+module SimpleSoftDelete
+  
+  extend ActiveSupport::Concern
+
+  included do
+    alias_method :destroy, :delete
+    default_scope where(:deleted => false)
+  end
+
+  def delete
+    update_attribute(:deleted, true)
+  end
+
+  module ClassMethods
+
+    def delete_all
+      update_all(:deleted => true)
+    end
+
+    def with_deleted
+      unscoped
+    end
+
+    alias_method :destroy_all, :delete_all
+  end
+
+end

data/lib/simple_soft_delete/version.rb

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

data/simple_soft_delete.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_soft_delete/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_soft_delete"
+  s.version     = SimpleSoftDelete::VERSION
+  s.authors     = ["David Batey"]
+  s.email       = ["davidlbatey@gmail.com"]
+  s.homepage    = "https://github.com/davidlbatey/simple_soft_delete"
+  s.summary     = "Simple soft delete for rails"
+  s.description = "Flags records as deleted instead of removing them"
+
+  s.rubyforge_project = "simple_soft_delete"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord", " > 3.0.0"
+  s.add_development_dependency "bundler", "~> 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.8.0"
+  s.add_development_dependency "database_cleaner", "~> 0.7.1"
+  s.add_development_dependency "sqlite3-ruby", "~> 1.3.3"
+
+end

data/spec/database.yml

@@ -0,0 +1,3 @@
+test:
+  :adapter: sqlite3
+  :database: simple_soft_delete.db

data/spec/fixtures/bar.rb

@@ -0,0 +1,5 @@
+class Bar < ActiveRecord::Base
+  include SimpleSoftDelete
+
+  validates_uniqueness_of :name, :scope => :deleted
+end

data/spec/fixtures/foo.rb

@@ -0,0 +1,4 @@
+class Foo < ActiveRecord::Base
+  include SimpleSoftDelete 
+
+end

data/spec/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define do                                                  
+  create_table "foos", :force => true do |t|                                    
+    t.string   "name"                                                              
+    t.boolean  "deleted", :null => false, :default => false                        
+  end
+
+  create_table "bars", :force => true do |t|
+    t.string "name"
+    t.boolean  "deleted", :null => false, :default => false
+  end
+end      

data/spec/simple_soft_delete_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe SimpleSoftDelete do
+
+  context "an instance of a model" do
+    
+    it "flags foo as deleted on delete" do
+      foo = Foo.create :name => "david"
+      foo.delete
+
+      Foo.find_by_name("david").should be_nil
+      Foo.unscoped.find_by_name("david").should == foo
+    end
+
+    it "flags foo as deleted on destroy" do
+      foo = Foo.create :name => "bob"
+      foo.destroy
+
+      Foo.find_by_name("bob").should be_nil
+      Foo.unscoped.find_by_name("bob").should == foo
+    end
+  
+  end
+
+  context "all instances of a model" do
+
+    it "flags all of the models as deleted" do
+      Foo.create :name => "john"
+      Foo.create :name => "kieran"
+      Foo.delete_all
+
+      Foo.count.should == 0
+      Foo.unscoped.count.should == 2
+    end
+
+    it "flags all of the models as deleted on destroy" do
+      Foo.create :name => "fraser"
+      Foo.create :name => "dean"
+      Foo.create :name => "steve"
+      Foo.destroy_all
+
+      Foo.count.should == 0
+      Foo.unscoped.count.should == 3
+    end
+
+    it "aliases unscoped as with_deleted" do
+      Foo.create :name => "bob"
+      Foo.create :name => "mike"
+      Foo.delete_all
+
+      Foo.count.should == 0
+      Foo.with_deleted.count.should == 2
+    end
+
+    it "flags a subsection" do
+      Foo.create :name => "chris"
+      Foo.create :name => "andy"
+
+      Foo.where("name = 'andy'").delete_all
+      
+      Foo.count.should == 1
+    end
+  
+  end
+
+  context "with uniqueness validations" do
+    
+    it "validates name with the scope undeleted" do
+      Bar.create :name => "chris"
+
+      Bar.create(:name => "chris").should_not be_valid
+      Bar.count.should == 1
+    end
+
+    it "scopes to deleted correctly" do
+      bar = Bar.create :name => "lucius"
+      bar.delete
+ 
+      Bar.create(:name => "lucius").should be_valid
+      Bar.count.should == 1
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'simple_soft_delete'
+require 'active_record'
+require 'database_cleaner'
+
+require File.expand_path(File.dirname(__FILE__) + '/fixtures/foo')
+require File.expand_path(File.dirname(__FILE__) + '/fixtures/bar')
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  def connect(environment)
+    conf = YAML::load(File.open(File.dirname(__FILE__) + '/database.yml'))
+    ActiveRecord::Base.establish_connection(conf[environment])
+  end
+
+  connect('test')
+
+  load(File.dirname(__FILE__) + "/schema.rb")
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: simple_soft_delete
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Batey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70094299639000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70094299639000
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70094299637820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70094299637820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70094299631180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70094299631180
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &70094299630220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: *70094299630220
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &70094299628860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: *70094299628860
+description: Flags records as deleted instead of removing them
+email:
+- davidlbatey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/simple_soft_delete.rb
+- lib/simple_soft_delete/version.rb
+- simple_soft_delete.gemspec
+- spec/database.yml
+- spec/fixtures/bar.rb
+- spec/fixtures/foo.rb
+- spec/schema.rb
+- spec/simple_soft_delete_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/davidlbatey/simple_soft_delete
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: simple_soft_delete
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Simple soft delete for rails
+test_files:
+- spec/database.yml
+- spec/fixtures/bar.rb
+- spec/fixtures/foo.rb
+- spec/schema.rb
+- spec/simple_soft_delete_spec.rb
+- spec/spec_helper.rb