delete_softly 0.0.2 → 0.0.3

data/README

@@ -2,19 +2,30 @@ DeleteSoftly
 ============
 
 Add soft delete functionality to ActiveRecord models. Important information:
-This is Rails3 only, no backwards compatibility.
+This is Rails3 only, no backwards compatibility. Important features are
+* It works through relations
+* papertrail support
+
+Tested with Postgresql
+
+New in version 0.3
+* without_deleted, same as active, but not meant to be overwritten
+* deleted is back, misteriously disappeared in version 0.2
 
 Example
 =======
  class Post
+   # Replace normal behavior of object completely
    delete_softly
  end
 
  class Comment
+   # Rely on calling active for this object when needed
    delete_softly false
  end
  
 Now the following stuff works:
+== The Post model == 
  p1 = Post.create
  p2 = Post.create
  Post.count #=> 2
@@ -29,5 +40,6 @@ Now the following stuff works:
  Comment.count #=> 2 (Since we added false)
  Comment.active.count #=> 1
  
+See the rdoc for better examples and documentation
 
 Copyright (c) 2010 [Benjamin ter Kuile], released under the MIT license

data/Rakefile

@@ -15,7 +15,7 @@ Rake::TestTask.new(:test) do |t|
 end
 
 desc 'Echoe'
-Echoe.new('delete_softly', '0.0.2') do |p|
+Echoe.new('delete_softly', '0.0.3') do |p|
   p.description = "Add soft delete functionality to your ActiveRecord models"
   p.url = "http://github.com/bterkuile/delete_softly"
   p.author = "Benjamin ter Kuile"

data/delete_softly.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{delete_softly}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Benjamin ter Kuile"]
-  s.date = %q{2010-11-05}
+  s.date = %q{2010-12-17}
   s.description = %q{Add soft delete functionality to your ActiveRecord models}
   s.email = %q{bterkuile@gmail.com}
   s.extra_rdoc_files = ["README", "lib/class_methods.rb", "lib/delete_softly.rb", "lib/instance_methods.rb"]

data/lib/class_methods.rb

@@ -2,25 +2,25 @@ module DeleteSoftly
   module ClassMethods
 
     # Give the representation of items at a certain date/time.
-    #   class Item
+    #   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_date(date = Time.now.utc)
+    def at_time(date = Time.now.utc)
       with_deleted do
         where(({:deleted_at.gt => date} | {:deleted_at => nil}) & {:created_at.lt => date})
       end
     end
-    alias_method :at_time, :at_date
+    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
+    #   class Item < ActiveRecord::Base
     #     delete_softly false
     #   end
     # Or similar:
-    #   class Item
+    #   class Item < ActiveRecord::Base
     #     delete_softly :default => false
     #   end
     # You need to call active on the model where you want to hide deleted items
@@ -30,8 +30,14 @@ module DeleteSoftly
       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
+    #   class Item < ActiveRecord::Base
     #     default_scope order(:content)
     #     delete_softly
     #   end
@@ -42,7 +48,8 @@ module DeleteSoftly
     #   Item.with_deleted do
     #     Item.where(:content.matches => 'a%') #=> SELECT "items".* FROM "items" WHERE ("items"."content" ILIKE 'a%') ORDER BY "items"."content"
     #   end
-    #   IHaveManyItems.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 #=> 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)
       if scoped_methods.any? # There are scoped methods in place
 
@@ -63,7 +70,20 @@ module DeleteSoftly
       end
     end
 
-    # Support for paper_trail if it is installed as well
+    def deleted
+      with_deleted.where(:deleted_at.ne => 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

data/lib/delete_softly.rb

@@ -1,4 +1,11 @@
 # DeleteSoftly
+# This is a gem/plugin that adds soft delete functionality to ActiveRecord.
+# Take a look at the 
+#  DeleteSoftly::ArExtender
+#  DeleteSoftly::ClassMethods
+#  DeleteSoftly::InstanceMethods
+# to get a feel of what is being done. This gem works through many relations
+
 require 'active_record'
 require 'meta_where'
 require 'class_methods'
@@ -8,26 +15,53 @@ module DeleteSoftly
 
     # 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.
+    # 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
-    def delete_softly(options = {:default => :active})
+    # 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
-      #  delete_softly :default => :with_deleted
-      options = {:default => options } unless options.is_a?(Hash)
-      if options[:default]
-        if options[:default].is_a?(Symbol) && respond_to?(options[:default])
-          default_scope send(options[:default])
+      #  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

data/lib/instance_methods.rb

@@ -1,6 +1,8 @@
 module DeleteSoftly
   module InstanceMethods
-    def destroy
+
+    # Custom destroy method for models using delete_softly
+    def destroy 
       if persisted?
         with_transaction_returning_status do
           _run_destroy_callbacks do
@@ -12,8 +14,21 @@ module DeleteSoftly
       @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

data/test/delete_softly_test.rb

@@ -2,7 +2,41 @@ 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 => "comment1_1", :body => "Comment 1 for post 1")
+    @comment2_1 = @post1.comments.create("email" => "comment1_2", :body => "Comment 2 for post 1")
+
+    @post2 = Post.create(:title => "post2")
+    @post2_id = @post2.id
+  end
   test "the truth" do
     assert true
   end
+  test "two records available" do
+    assert_equal 2, Post.count
+  end
+
+  test "destroy count test" do
+    @post1.destroy
+    assert_equal 1, Post.count
+    assert_equal 2, Post.with_deleted.count 
+    assert_nil Post.find_by_id(@post1_id)
+    @post1 = Post.with_deleted.find(@post1_id)
+    assert @post1.deleted_at
+    @post1.revive
+    assert 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.all
+    assert_equal [@post1], Post.deleted.all
+  end
 end

data/test/test_helper.rb

@@ -1,3 +1,57 @@
 require 'rubygems'
 require 'test/unit'
+require 'arel'
 require 'active_support'
+require 'active_support/all'
+require 'lib/delete_softly'
+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 false
+  belongs_to :post
+  has_many :tags
+end
+
+class Tag < ActiveRecord::Base
+  belongs_to :comment
+end
+
+unless Post.table_exists?
+  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
+end
+unless Comment.table_exists?
+  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
+end
+unless Tag.table_exists?
+  puts  "Creating  table tags"
+  ActiveRecord::Base.connection.create_table "tags" do |t|
+    t.string :name
+    t.integer :comment_id
+    t.timestamps
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: delete_softly
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Benjamin ter Kuile
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-05 00:00:00 +01:00
+date: 2010-12-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency