immortal 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    immortal (0.1.0)
+      activerecord (~> 3.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    sqlite3-ruby (1.3.2)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.3)
+  immortal!
+  rspec (~> 2.3.0)
+  sqlite3-ruby (~> 1.3.2)

data/README.md

@@ -0,0 +1,43 @@
+# Immortal
+
+Make any ActiveRecord model paranoid by just including `Immortal`, and instead of being deleted from the database, the object will just marked as 'deleted' with a boolean field in the database.
+
+## Installation
+
+Add the gem dependency to your Gemfile:
+
+    gem 'immortal'
+
+## Usage
+
+    class User < ActiveRecord::Base
+      include Immortal
+    end
+
+And add a boolean field called `deleted` to that model:
+
+    class AddDeletedToUsers < ActiveRecord::Migration
+      def self.up
+        add_column :users, :deleted, :boolean
+      end
+
+      def self.down
+        remove_column :users, :deleted
+      end
+    end
+
+## TODO
+
+- Add documentation in the code
+- Spec associations
+- Add support for a :with_deleted option in associations, like acts_as_paranoid
+- Improve compatibility with acts_as_paranoid
+
+## Contributing
+
+If you want to improve immortal
+
+1. Fork the repo
+2. Create a topic branch `git checkout -b my_feature`
+3. Push it! `git push origin my_feature`
+4. Open a pull request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/immortal.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "immortal"
+  s.version     = '0.1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jordi Romero", "Saimon Moore"]
+  s.email       = ["jordi@jrom.net", "saimon@saimonmoore.net"]
+  s.homepage    = "http://github.com/teambox/immortal"
+  s.summary     = %q{Replacement for acts_as_paranoid for Rails 3}
+  s.description = %q{Typical paranoid gem built for Rails 3 and with the minimum code needed to satisfy acts_as_paranoid's API}
+
+  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.3'
+  s.add_development_dependency 'rspec', '~> 2.3.0'
+  s.add_development_dependency 'sqlite3-ruby', '~> 1.3.2'
+end

data/lib/immortal.rb

@@ -0,0 +1,80 @@
+module Immortal
+  def self.included(base)
+    base.send :extend, ClassMethods
+    base.send :include, InstanceMethods
+    base.class_eval do
+      class << self
+        alias :mortal_delete_all :delete_all
+        alias :delete_all :immortal_delete_all
+      end
+    end
+  end
+
+  module ClassMethods
+
+    def with_deleted
+      unscoped
+    end
+
+    def only_deleted
+      unscoped.where(:deleted => true)
+    end
+
+    def count_with_deleted(*args)
+      with_deleted.count(*args)
+    end
+
+    def count_only_deleted(*args)
+      only_deleted.count(*args)
+    end
+
+    def find_with_deleted(*args)
+      with_deleted.find(*args)
+    end
+
+    def find_only_deleted(*args)
+      only_deleted.find(*args)
+    end
+
+    def immortal_delete_all(*args)
+      unscoped.update_all :deleted => true
+    end
+
+    def delete_all!(*args)
+      unscoped.mortal_delete_all
+    end
+
+  end
+
+  module InstanceMethods
+    def self.included(base)
+      base.class_eval do
+        default_scope where(arel_table[:deleted].eq(nil).or(arel_table[:deleted].eq(false)))
+        alias :mortal_destroy :destroy
+        alias :destroy :immortal_destroy
+      end
+    end
+
+    def immortal_destroy(*args)
+      run_callbacks :destroy do
+        destroy_without_callbacks(*args)
+      end
+    end
+
+    def destroy!(*args)
+      mortal_destroy
+    end
+
+    def destroy_without_callbacks(*args)
+      self.class.unscoped.update_all({ :deleted => true }, "id = #{self.id}")
+      reload
+      freeze
+    end
+
+    def recover!
+      self.class.unscoped.update_all({ :deleted => false }, "id = #{self.id}")
+      reload
+    end
+
+  end
+end

data/spec/immortal_spec.rb

@@ -0,0 +1,180 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Immortal do
+  before do
+    @m = ImmortalModel.create! :title => 'testing immortal'
+  end
+
+  it "should not be deleted from the database using #destroy" do
+    expect {
+      @m.destroy
+    }.to_not change(ImmortalModel, :count_with_deleted)
+  end
+
+  it "should be frozen using #destroy" do
+    @m.destroy
+    @m.should be_frozen
+  end
+
+  it "should not be dirty using #destroy" do
+    @m.destroy
+    @m.should_not be_changed
+  end
+
+  it "should be deleted from the database using #destroy!" do
+    expect {
+      @m.destroy!
+    }.to change(ImmortalModel, :count_with_deleted)
+  end
+
+  it "should find non deleted records" do
+    ImmortalModel.first.should == @m
+    ImmortalModel.all.should include(@m)
+  end
+
+  it "should not find deleted records" do
+    @m.destroy
+    ImmortalModel.first.should be_nil
+    ImmortalModel.all.should be_empty
+  end
+
+  it "should find deleted records using scope" do
+    @m.destroy
+    ImmortalModel.with_deleted.first.should == @m
+    ImmortalModel.with_deleted.all.should include(@m)
+  end
+
+  it "should find deleted records using the old method" do
+    ImmortalModel.find_with_deleted(@m.id).should == @m
+    @m.destroy
+    ImmortalModel.find_with_deleted(@m.id).should == @m
+  end
+
+  it "should count undeleted records by default" do
+    @m2 = ImmortalModel.create! :title => 'testing immortal again'
+    ImmortalModel.count_only_deleted.should == 0
+    ImmortalModel.only_deleted.count.should == 0
+
+    @m.destroy
+
+    ImmortalModel.count_only_deleted.should == 1
+    ImmortalModel.only_deleted.count.should == 1
+  end
+
+  it "should find only deleted records" do
+    @m2 = ImmortalModel.create! :title => 'testing immortal again'
+    expect {
+      ImmortalModel.find_only_deleted(@m.id)
+    }.to raise_error(ActiveRecord::RecordNotFound)
+
+    expect {
+      ImmortalModel.only_deleted.find(@m.id)
+    }.to raise_error(ActiveRecord::RecordNotFound)
+
+    @m.destroy
+
+    ImmortalModel.find_only_deleted(@m.id).should == @m
+    expect {
+      ImmortalModel.find_only_deleted(@m2.id)
+    }.to raise_error(ActiveRecord::RecordNotFound)
+
+    ImmortalModel.only_deleted.should include(@m)
+    ImmortalModel.only_deleted.should_not include(@m2)
+  end
+
+  it "should be able to count undeleted records" do
+    @m2 = ImmortalModel.create! :title => 'testing immortal again'
+    ImmortalModel.count.should == 2
+
+    @m.destroy
+
+    ImmortalModel.count.should == 1
+  end
+
+  it "should be able to count all the records including deleted" do
+    @m2 = ImmortalModel.create! :title => 'testing immortal again'
+    @m.destroy
+    ImmortalModel.count_with_deleted.should == 2
+    ImmortalModel.with_deleted.count.should == 2
+  end
+
+  it "should not exist if deleted" do
+    ImmortalModel.exists?(@m.id).should be_true
+    @m.destroy
+    ImmortalModel.exists?(@m.id).should be_false
+  end
+
+  it "should calculate without deleted" do
+    @m2 = ImmortalModel.create! :value => 10
+    @m3 = ImmortalModel.create! :value => 20
+    ImmortalModel.calculate(:sum, :value).should == 30
+    @m2.destroy
+    ImmortalModel.calculate(:sum, :value).should == 20
+  end
+
+  it "should execute the before_destroy callback when immortally destroyed" do
+    @m.destroy
+    @m.before_d.should be_true
+  end
+
+  it "should execute the after_destroy callback when immortally destroyed" do
+    @m.destroy
+    @m.after_d.should be_true
+  end
+
+  it "should not execute the before_update callback when immortally destroyed" do
+    @m.destroy
+    @m.before_u.should be_nil
+  end
+
+  it "should not execute the after_update callback when immortally destroyed" do
+    @m.destroy
+    @m.after_u.should be_nil
+  end
+
+  it "should not execute the before_destroy callback when immortally destroyed without callbacks" do
+    @m.destroy_without_callbacks
+    @m.before_d.should be_nil
+  end
+
+  it "should not execute the after_destroy callback when immortally destroyed without callbacks" do
+    @m.destroy_without_callbacks
+    @m.after_d.should be_nil
+  end
+
+  it "should immortally delete all records with delete_all" do
+    expect {
+      ImmortalModel.delete_all
+    }.to change(ImmortalModel, :count).by(-1)
+    ImmortalModel.count_with_deleted.should == 1
+  end
+
+  it "should immortally delete all records with delete_all!" do
+    expect {
+      ImmortalModel.delete_all!
+    }.to change(ImmortalModel.with_deleted, :count).by(-1)
+  end
+
+  it "should know if it's deleted" do
+    @m.should_not be_deleted
+    @m.destroy
+    @m.should be_deleted
+  end
+
+  it "should be recoverable" do
+    @m.destroy
+    @m = ImmortalModel.with_deleted.find(@m.id)
+    @m.recover!
+    @m.should_not be_frozen
+    @m.should_not be_changed
+    ImmortalModel.first.should == @m
+  end
+
+  it "should consider an object with deleted = nil as not deleted" do
+    @m2 = ImmortalModel.create! :deleted => nil
+    @m2.deleted.should be_nil
+    @m2.should_not be_deleted
+    ImmortalModel.count.should == 2
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+Bundler.require(:default, :development)
+require 'rspec'
+require 'lib/immortal'
+require 'active_record'
+require 'sqlite3'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    ActiveRecord::Base.connection.execute('delete from immortal_models')
+  end
+
+  config.after(:all) do
+  end
+end
+
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+old_stdout = $stdout
+$stdout = StringIO.new
+
+begin
+  ActiveRecord::Schema.define do
+    create_table :immortal_models do |t|
+      t.string :title
+      t.integer :value
+      t.boolean :deleted, :default => false
+      t.timestamps
+    end
+  end
+ensure
+  $stdout = old_stdout
+end
+
+class ImmortalModel < ActiveRecord::Base
+  include Immortal
+
+  attr_accessor :before_d, :after_d, :before_u, :after_u
+
+  before_destroy   :set_before
+  after_destroy    :set_after
+  before_update    :set_before_update
+  after_update     :set_after_update
+
+  private
+  def set_before
+    @before_d = true
+  end
+
+  def set_after
+    @after_d = true
+  end
+
+  def set_after_update
+    @after_u = true
+  end
+
+  def set_before_update
+    @before_u = true
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: immortal
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jordi Romero
+- Saimon Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  type: :development
+  version_requirements: *id003
+description: Typical paranoid gem built for Rails 3 and with the minimum code needed to satisfy acts_as_paranoid's API
+email: 
+- jordi@jrom.net
+- saimon@saimonmoore.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- immortal.gemspec
+- lib/immortal.rb
+- spec/immortal_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/teambox/immortal
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Replacement for acts_as_paranoid for Rails 3
+test_files: 
+- spec/immortal_spec.rb
+- spec/spec_helper.rb