delete_softly 0.0.1 → 0.0.2

data/Manifest

@@ -1,6 +1,7 @@
 MIT-LICENSE
 README
 Rakefile
+delete_softly.gemspec
 init.rb
 install.rb
 lib/class_methods.rb

data/README

@@ -1,7 +1,8 @@
 DeleteSoftly
 ============
 
-Add soft delete functionality to ActiveRecord models
+Add soft delete functionality to ActiveRecord models. Important information:
+This is Rails3 only, no backwards compatibility.
 
 Example
 =======
@@ -19,7 +20,7 @@ Now the following stuff works:
  Post.count #=> 2
  p2.destroy
  Post.count #=> 1
- Post.at(1.year.ago).count #=> 0
+ Post.at_time(1.year.ago).count #=> 0
 
  c1 = Comment.create
  c2 = Comment.create

data/Rakefile

@@ -15,7 +15,7 @@ Rake::TestTask.new(:test) do |t|
 end
 
 desc 'Echoe'
-Echoe.new('delete_softly', '0.0.1') do |p|
+Echoe.new('delete_softly', '0.0.2') 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,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{delete_softly}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   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-10-31}
+  s.date = %q{2010-11-05}
   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"]
-  s.files = ["MIT-LICENSE", "README", "Rakefile", "init.rb", "install.rb", "lib/class_methods.rb", "lib/delete_softly.rb", "lib/instance_methods.rb", "test/delete_softly_test.rb", "test/test_helper.rb", "uninstall.rb", "Manifest", "delete_softly.gemspec"]
+  s.files = ["MIT-LICENSE", "README", "Rakefile", "delete_softly.gemspec", "init.rb", "install.rb", "lib/class_methods.rb", "lib/delete_softly.rb", "lib/instance_methods.rb", "test/delete_softly_test.rb", "test/test_helper.rb", "uninstall.rb", "Manifest"]
   s.homepage = %q{http://github.com/bterkuile/delete_softly}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Delete_softly", "--main", "README"]
   s.require_paths = ["lib"]

data/lib/class_methods.rb

@@ -1,17 +1,76 @@
 module DeleteSoftly
   module ClassMethods
+
+    # Give the representation of items at a certain date/time.
+    #   class Item
+    #     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)
-      with_deleted.where(({:deleted_at.gt => date} | {:deleted_at => nil}) & {:created_at.lt => date})
+      with_deleted do
+        where(({:deleted_at.gt => date} | {:deleted_at => nil}) & {:created_at.lt => date})
+      end
     end
-    alias_method :at, :at_date
     alias_method :at_time, :at_date
 
+    # 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
+    #     delete_softly false
+    #   end
+    # Or similar:
+    #   class Item
+    #     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
 
-    def with_deleted
-      unscoped
+    # Include deleted items when performing queries
+    #   class Item
+    #     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.items #=> SELECT "items".* FROM "items" WHERE ("items"."deleted_at" IS NULL) AND ("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
+
+        # remove deleted at condition if present
+        del = scoped_methods.last.where_values.delete(:deleted_at => nil)
+
+        # Execute block with deleted or just run scoped
+        r = block_given? ? yield : scoped
+
+        # Add deleted condition if it was present
+        scoped_methods.last.where_values << del if del
+
+        # Return de relation generated without deleted_at => nil
+        r
+      else
+        # Do not do anything special when there are no scoped_methods
+        r = block_given? ? yield : scoped
+      end
+    end
+
+    # Support for paper_trail if it is installed as well
+    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_softly.rb

@@ -1,7 +1,8 @@
 # DeleteSoftly
+require 'active_record'
+require 'meta_where'
 require 'class_methods'
 require 'instance_methods'
-require 'meta_where'
 module DeleteSoftly
   module ARExtender
 
@@ -36,3 +37,14 @@ module DeleteSoftly
 end
 
 ActiveRecord::Base.send(:extend, DeleteSoftly::ARExtender)
+
+# Overwrite ActiveRecord::Base#default_scope
+class ActiveRecord::Base
+  # default_scope fix discussed in ticket:
+  # https://rails.lighthouseapp.com/projects/8994/tickets/4583-merge-default-scopes-by-default#ticket-4583-11
+  def self.default_scope(options = {})
+    key = :"#{self}_scoped_methods"
+    Thread.current[key] = nil
+    self.default_scoping << construct_finder_arel(options, default_scoping.pop)    
+  end
+end

data/lib/instance_methods.rb

@@ -12,5 +12,18 @@ module DeleteSoftly
       @destroyed = true
       freeze
     end
+    
+    def revive
+      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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: delete_softly
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Benjamin ter Kuile
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-31 00:00:00 +02:00
+date: 2010-11-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,7 @@ files:
 - MIT-LICENSE
 - README
 - Rakefile
+- delete_softly.gemspec
 - init.rb
 - install.rb
 - lib/class_methods.rb
@@ -56,7 +57,6 @@ files:
 - test/test_helper.rb
 - uninstall.rb
 - Manifest
-- delete_softly.gemspec
 has_rdoc: true
 homepage: http://github.com/bterkuile/delete_softly
 licenses: []