delete_soft 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem 'rake'
+
+gemspec

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the delete_softly plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/delete_soft.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "delete_soft/version"
+
+Gem::Specification.new do |s|
+  s.name        = "delete_soft"
+  s.version     = DeleteSoft::VERSION
+  s.authors     = ["Orban Botond"]
+  s.email       = ["orbanbotond@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A gem which adds soft delete functionality}
+  s.description = %q{A gem which adds soft delete functionality}
+
+  s.rubyforge_project = "delete_soft"
+
+  s.add_dependency('squeel', '>= 0.9.3')
+
+  s.add_development_dependency('sqlite3', ['>= 1.3.4'])
+  s.add_development_dependency('activerecord', ['>= 3.1.0'])
+  s.add_development_dependency('rake', ['0.9.2'])
+
+  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"]
+end

data/lib/class_methods.rb

@@ -0,0 +1,79 @@
+require 'arel'
+
+module DeleteSoftly
+  module ClassMethods
+    # Give the representation of items at a certain date/time.
+    #   class Item < ActiveRecord::Base
+    #     delete_softly
+    #   end
+    # Will result in:
+    #   Item.at_time(DateTime.parse('2010-01-01')) #=> (SELECT "items".* FROM "items" WHERE (((("items"."deleted_at" > '2010-01-01 00:00:00') OR ("items"."deleted_at" IS NULL)) AND ("items"."created_at" < '2010-01-01 00:00:00')))
+    def at_time(date = Time.now.utc)
+      with_deleted.where{ (deleted_at > date || deleted_at != nil) && created_at < date }
+    end
+    alias_method :at_date, :at_time
+
+    # Give the currently active items. When delete_soflty is added this is invoked by default
+    # But when false is added, items are shown by default
+    #   class Item < ActiveRecord::Base
+    #     delete_softly false
+    #   end
+    # Or similar:
+    #   class Item < ActiveRecord::Base
+    #     delete_softly :default => false
+    #   end
+    # You need to call active on the model where you want to hide deleted items
+    #   Item.all #=> SELECT "items".* FROM "items"
+    #   Item.active #=> SELECT "items".* FROM "items" WHERE ("items"."deleted_at" IS NULL)
+    def active
+      where{deleted_at == nil}
+    end
+
+    # Same as active, but not to be overwritten. Active might become with disabled => false
+    # or something like that. Without deleted should remain intact
+    def without_deleted
+      where{deleted_at.nil?}
+    end
+
+    # Include deleted items when performing queries
+    #   class Item < ActiveRecord::Base
+    #     default_scope order(:content)
+    #     delete_softly
+    #   end
+    # Will result in:
+    #   Item.first #=> SELECT "items".* FROM "items" WHERE ("items"."deleted_at" IS NULL) ORDER BY "items"."content" LIMIT 1
+    #   Item.with_deleted.first #=> SELECT "items".* FROM "items" ORDER BY "items"."content" LIMIT 1
+    #   Item.where(:content.matches => 'a%') #=> SELECT "items".* FROM "items" WHERE ("items"."deleted_at" IS NULL) AND ("items"."content" ILIKE 'a%') ORDER BY "items"."content"
+    #   Item.with_deleted do
+    #     Item.where(:content.matches => 'a%') #=> SELECT "items".* FROM "items" WHERE ("items"."content" ILIKE 'a%') ORDER BY "items"."content"
+    #   end
+    #   IHaveManyItems.first.items #=> SELECT "items".* FROM "items" WHERE ("items"."deleted_at" IS NULL) AND ("items".i_have_many_items_id = 1) ORDER BY "items"."content"
+    #   IHaveManyItems.first.items.with_deleted #=> SELECT "items".* FROM "items" WHERE ("items".i_have_many_items_id = 1) ORDER BY "items"."content"
+    def with_deleted(&block)
+      unscoped
+    end
+
+    def deleted
+      with_deleted.where{deleted_at != nil}
+    end
+
+    # Support for paper_trail if it is installed as well. Then you can use:
+    #  class Post < ActiveRecord::Base
+    #    default_scope order(:created_at)
+    #    delete_softly
+    #    has_paper_trail
+    #    has_many :comments
+    #  end
+    # Then 
+    #  Post.version_at(1.week.ago) 
+    # Will return all post of one week ago, with the appropriate field values at that time
+    def version_at(time)
+      if respond_to?(:at_time)
+        at_time(time).map{|i| i.respond_to?(:version_at) ? i.version_at(time) : i}.compact
+      else
+        scoped.map{|i| i.respond_to?(:version_at) ? i.version_at(time) : i}.compact
+      end
+    end
+  end
+
+end

data/lib/delete_soft/version.rb

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

data/lib/delete_soft.rb

@@ -0,0 +1,68 @@
+require "delete_soft/version"
+
+require 'active_record'
+require 'squeel'
+require 'class_methods'
+require 'instance_methods'
+
+module DeleteSoftly
+  module ARExtender
+
+    # Always have Model.active available. It is a good practice to use it
+    # when you want the active records. Even use it when no logic is in 
+    # place yet. Now it is an alias for scoped, but can be overwritten
+    # for custom behaviour, for example:
+    #  class Post < ActiveRecord::Base
+    #    delete_softly
+    #    has_many :comments
+    #    def self.active
+    #       super.where(:disabled.ne => true)
+    #    end
+    #  end
+    #  class Comment < ActiveRecord::Base
+    #    belongs_to :post
+    #  end
+    # will result in:
+    #  Post.all #=> SELECT * FROM posts WHERE deleted_at IS NULL;
+    #  Post.active #=> SELECT * FROM posts WHERE deleted_at IS NULL AND disabled != 't';
+    #  Comment.all #=> SELECT * FROM comments;
+    #  Comment.active #=> SELECT * FROM comments;
+    def active
+      scoped
+    end 
+
+    # Make the model delete softly. A deleted_at:datetime column is required
+    # for this to work.
+    # The two most important differences are that it can be enforce on a model
+    # or be more free. 
+    #  class Post < ActiveRecord::Base
+    #    delete_softly
+    #  end
+    # will enforce soft delete on the post model. A deleted post will never appear,
+    # unless the explicit with_deleted is called. When the model is:
+    #  class Post < ActiveRecord::Base
+    #    delete_softly :enforce => false
+    #  end
+    # An object will still be available after destroy is called, 
+    def delete_softly(options = {:enforce => :active})
+      # Make destroy! the old destroy
+      alias_method :destroy!, :destroy
+
+      include DeleteSoftly::InstanceMethods
+      extend DeleteSoftly::ClassMethods
+      # Support single argument
+      #  delete_softly :active # Same as :enforce => :active, default behaviour
+      #  delete_softly :enforce=> :with_deleted # Same as without argument
+      options = {:enforce=> options } unless options.is_a?(Hash)
+      if options[:enforce]
+        if options[:enforce].is_a?(Symbol) && respond_to?(options[:enforce])
+          default_scope send(options[:enforce])
+        else
+          default_scope active
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, DeleteSoftly::ARExtender)

data/lib/instance_methods.rb

@@ -0,0 +1,50 @@
+module DeleteSoftly
+  module InstanceMethods
+
+    # This method reports whether or not the record has been soft deleted.
+    #
+    def deleted?
+      self.deleted_at?
+    end
+    
+    # Custom destroy method for models using delete_softly
+    def destroy 
+      if persisted?
+        with_transaction_returning_status do
+          _run_destroy_callbacks do
+            update_attribute :deleted_at, Time.now
+          end
+        end
+      end
+    
+      @destroyed = true
+      freeze
+    end
+   
+    # Revive a destroyed item. For a model like:
+    #  class Post < ActiveRecord::Base
+    #    delete_softly
+    #  end
+    # Then the following can be done:
+    #  p = Post.find(1)
+    #  p.destroy
+    #  p = Post.find(1) # raise error
+    #  p = Post.with_deleted.find(1) # Original object but with deleted_at attribute set
+    #  p.revive #=> deleted_at => nil
+    #  p = Post.find(1) # business as usual
+    # If papertrail is used for this model it will not store a copy 
+    def revive
+      # Disable paper_trail when it is present and active
+      if self.class.respond_to?(:paper_trail_active) && self.class.paper_trail_active
+        self.class.paper_trail_off
+        update_attribute :deleted_at, nil
+        self.class.paper_trail_on
+      else
+        update_attribute :deleted_at, nil
+      end
+    end
+    alias_method :undelete, :revive
+    alias_method :undestroy, :revive
+      
+  end
+end

data/test/delete_softly_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+class DeleteSoftlyTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  setup do
+    puts "New setup"
+    Post.with_deleted.delete_all
+    Comment.with_deleted.delete_all
+    Tag.delete_all
+    @post1 = Post.create(:title => "post1")
+    @post1_id = @post1.id
+    @comment1_1 = @post1.comments.create(:email => "test@gmail.com", :body => "Comment 1 for post 1")
+    @comment2_1 = @post1.comments.create(:email => "test@gmail.com", :body => "Comment 2 for post 1")
+    @comment3_1 = @post1.comments.create(:email => "testother@gmail.com", :body => "Comment 2 for post 1")
+
+    @post2 = Post.create(:title => "post2")
+    @post2_id = @post2.id
+
+  end
+  test "two records available" do
+    assert_equal 2, Post.count
+  end
+  
+  test "destroy count test" do
+    @post1.destroy
+    assert_equal 1, Post.count
+    puts "It is 1"
+    assert_equal 2, Post.with_deleted.count 
+    puts "It is 2"
+    assert_nil Post.find_by_id(@post1_id)
+    @post1 = Post.with_deleted.find(@post1_id)
+    assert @post1.deleted_at
+    @post1.revive
+    assert_equal 2, Post.count
+  end
+
+  test "deleted, without_deleted methods" do
+    assert_equal [@post1, @post2], Post.all.sort_by{|p| p.title}
+    @post1.destroy
+    assert_equal [@post2], Post.without_deleted
+    assert_equal [@post1], Post.deleted
+  end
+
+  test "at_time methods" do
+    t = Time.now
+    @post1.destroy
+    assert_equal [@post2], Post.without_deleted
+    assert_equal [@post1, @post2], Post.at_time(t)
+  end
+  
+  test "other default scopes" do
+    assert_equal 2, Comment.count
+    @comment2_1.destroy
+    assert_equal 1, Comment.count
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'test/unit'
+require 'arel'
+require 'active_support'
+require 'active_support/all'
+require 'delete_soft'
+require 'sqlite3'
+
+
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => 'test/db.sqlite3'
+)
+
+class Post < ActiveRecord::Base
+  delete_softly
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  delete_softly
+  belongs_to :post
+  has_many :tags
+  default_scope where(:email => 'test@gmail.com')
+end
+
+class Tag < ActiveRecord::Base
+  belongs_to :comment
+end
+
+if Post.table_exists?
+  ActiveRecord::Base.connection.drop_table "posts"
+end
+
+puts  "Creating  table posts"
+ActiveRecord::Base.connection.create_table "posts" do |t|
+  t.string :title
+  t.text :body
+  t.datetime :deleted_at
+  t.timestamps
+end
+
+if Comment.table_exists?
+  ActiveRecord::Base.connection.drop_table "comments"
+end
+
+puts  "Creating  table comments"
+ActiveRecord::Base.connection.create_table "comments" do |t|
+  t.string :email
+  t.text :body
+  t.integer :post_id
+  t.datetime :deleted_at
+  t.timestamps
+end
+
+if Tag.table_exists?
+  ActiveRecord::Base.connection.drop_table "tags"
+end
+
+puts  "Creating  table tags"
+ActiveRecord::Base.connection.create_table "tags" do |t|
+  t.string :name
+  t.integer :comment_id
+  t.timestamps
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: delete_soft
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Orban Botond
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-03 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 9
+        - 3
+        version: 0.9.3
+  type: :runtime
+  name: squeel
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 3
+        - 4
+        version: 1.3.4
+  type: :development
+  name: sqlite3
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 1
+        - 0
+        version: 3.1.0
+  type: :development
+  name: activerecord
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  type: :development
+  name: rake
+  version_requirements: *id004
+description: A gem which adds soft delete functionality
+email: 
+- orbanbotond@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- delete_soft.gemspec
+- lib/class_methods.rb
+- lib/delete_soft.rb
+- lib/delete_soft/version.rb
+- lib/instance_methods.rb
+- test/db.sqlite3
+- test/delete_softly_test.rb
+- test/test_helper.rb
+has_rdoc: true
+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: delete_soft
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A gem which adds soft delete functionality
+test_files: 
+- test/db.sqlite3
+- test/delete_softly_test.rb
+- test/test_helper.rb