ohm-contrib 0.0.38 → 0.0.39

data/lib/ohm/contrib.rb

@@ -1,6 +1,6 @@
 module Ohm
   module Contrib
-    VERSION = "0.0.38"
+    VERSION = "0.0.39"
   end
 
   autoload :Boundaries,        "ohm/contrib/boundaries"
@@ -16,5 +16,6 @@ module Ohm
   autoload :LunarMacros,       "ohm/contrib/lunar_macros"
   autoload :Slug,              "ohm/contrib/slug"
   autoload :Scope,             "ohm/contrib/scope"
+  autoload :SoftDelete,        "ohm/contrib/soft_delete"
 end
 

data/lib/ohm/contrib/soft_delete.rb

@@ -0,0 +1,69 @@
+module Ohm
+  # Provides support for soft deletion
+  #
+  # @example
+  #
+  #   class Post < Ohm::Model
+  #     include Ohm::SoftDelete
+  #
+  #     attribute :title
+  #     index :title
+  #   end
+  #
+  #   post = Post.create(:title => 'Title')
+  #
+  #   post.deleted?
+  #   # => false
+  #
+  #   post.delete
+  #
+  #   post.deleted?
+  #   # => true
+  #
+  #   Post.all.empty?
+  #   # => true
+  #
+  #   Post.find(:title => 'Title').empty?
+  #   # => true
+  #
+  #   Post.exists?(post.id)
+  #   # => true
+  #
+  #   post = Post[post.id]
+  #
+  #   post.deleted?
+  #   # => true
+  module SoftDelete
+    IS_DELETED = "1"
+
+    def self.included(base)
+      base.attribute :deleted
+      base.index :deleted
+      base.extend ClassMethods
+    end
+
+    def delete
+      update(:deleted => IS_DELETED)
+    end
+
+    def deleted?
+      deleted == IS_DELETED
+    end
+
+  private
+    def create_model_membership
+      self.class.key[:all].sadd(self.id)
+    end
+
+    def delete_model_membership
+      key.del
+      self.class.key[:all].srem(self.id)
+    end
+
+    module ClassMethods
+      def all
+        super.except(:deleted => IS_DELETED)
+      end
+    end
+  end
+end

data/test/soft_delete_test.rb

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+
+require File.expand_path("./helper", File.dirname(__FILE__))
+
+class Person < Ohm::Model
+  include Ohm::SoftDelete
+
+  attribute :name
+  index :name
+
+  attribute :age
+  index :age
+end
+
+test "deleted?" do
+  person = Person.create
+
+  assert !person.deleted?
+
+  person.delete
+
+  assert person.deleted?
+end
+
+test "all excludes deleted records" do
+  person = Person.create(:name => "matz")
+
+  assert Person.all.first == person
+
+  person.delete
+
+  assert Person.all.empty?
+end
+
+test "find excludes deleted records" do
+  person = Person.create(:name => "matz")
+
+  assert Person.find(:name => "matz").first == person
+
+  person.delete
+
+  assert Person.find(:name => "matz").empty?
+  assert Person.all.find(:name => "matz").empty?
+end
+
+test "find with many criteria excludes deleted records" do
+  person = Person.create(:name => "matz", :age => 38)
+
+  assert Person.find(:name => "matz", :age => 38).first == person
+
+  person.delete
+
+  assert Person.find(:name => "matz", :age => 38).empty?
+  assert Person.all.find(:name => "matz", :age => 38).empty?
+end
+
+test "exists? returns true for deleted records" do
+  person = Person.create(:name => "matz")
+
+  person.delete
+
+  assert Person.exists?(person.id)
+end
+
+test "Model[n] can be used to retrieve deleted records" do
+  person = Person.create(:name => "matz")
+
+  person.delete
+
+  assert Person[person.id].deleted?
+  assert Person[person.id].name == "matz"
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 38
-  version: 0.0.38
+  - 39
+  version: 0.0.39
 platform: ruby
 authors: 
 - Cyril David
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-06 00:00:00 +08:00
+date: 2010-10-27 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,6 +101,7 @@ files:
 - lib/ohm/contrib/number_validations.rb
 - lib/ohm/contrib/scope.rb
 - lib/ohm/contrib/slug.rb
+- lib/ohm/contrib/soft_delete.rb
 - lib/ohm/contrib/timestamping.rb
 - lib/ohm/contrib/typecast.rb
 - lib/ohm/contrib/web_validations.rb
@@ -121,6 +122,7 @@ files:
 - test/number_validations_test.rb
 - test/scope_test.rb
 - test/slug_test.rb
+- test/soft_delete_test.rb
 - test/timestamping_test.rb
 - test/typecast_array_test.rb
 - test/typecast_boolean_test.rb