paranoid_create 0.0.10

data/spec/models.rb

@@ -0,0 +1,159 @@
+class Person < ActiveRecord::Base #:nodoc:
+  validates_uniqueness_of :name
+  has_many :androids, :foreign_key => :owner_id, :dependent => :destroy
+end
+
+class Android < ActiveRecord::Base #:nodoc:
+  paranoid
+  validates_uniqueness_of :name
+  has_many :components, :dependent => :destroy
+  has_one :sticker
+  has_many :memories, :foreign_key => 'parent_id'
+  has_many :dents
+  has_many :dings, :through => :dents
+  has_many :scratches, :through => :dents
+  has_and_belongs_to_many :places
+
+  # this code is to ensure that our destroy and restore methods
+  # work without triggering before/after_update callbacks
+  before_update :raise_hell
+  def raise_hell
+    raise "hell"
+  end
+end
+
+class Biped < Android
+end
+
+class Dent < ActiveRecord::Base #:nodoc:
+  paranoid
+  belongs_to :android
+  has_many :dings
+  has_many :scratches
+end
+
+class Ding < ActiveRecord::Base #:nodoc:
+  paranoid :field => :not_deleted, :destroyed_value => true, :not_destroyed_value => false
+  belongs_to :dent
+end
+
+class Scratch < ActiveRecord::Base #:nodoc:
+  paranoid
+  belongs_to :dent
+end
+
+class Component < ActiveRecord::Base #:nodoc:
+  paranoid
+  belongs_to :android, :dependent => :destroy
+  has_many :sub_components, :dependent => :destroy
+  NEW_NAME = 'Something Else!'
+
+  after_destroy :change_name
+  def change_name
+    self.update_attribute(:name, NEW_NAME)
+  end
+end
+
+class SubComponent < ActiveRecord::Base #:nodoc:
+  paranoid
+  belongs_to :component, :dependent => :destroy
+end
+
+class Memory < ActiveRecord::Base #:nodoc:
+  paranoid
+  belongs_to :android, :class_name => "Android", :foreign_key => "parent_id"
+end
+
+class Sticker < ActiveRecord::Base #:nodoc:
+  MM_NAME = "You've got method_missing"
+
+  # this simply serves to ensure that we don't break method_missing
+  # if it is implemented on a class and called before is_paranoid
+  def method_missing name, *args, &block
+    self.name = MM_NAME
+  end
+
+  paranoid
+  belongs_to :android
+end
+
+class AndroidWithScopedUniqueness < ActiveRecord::Base #:nodoc:
+  set_table_name :androids
+  validates_uniqueness_of :name, :scope => :deleted_at
+  paranoid
+end
+
+class Place < ActiveRecord::Base #:nodoc:
+  paranoid
+  has_and_belongs_to_many :androids
+
+  # this code is to ensure that our destroy and restore methods
+  # work without triggering before/after_update callbacks
+  before_update :raise_hell
+  def raise_hell
+    raise "hell"
+  end
+end
+
+class AndroidsPlaces < ActiveRecord::Base #:nodoc:
+end
+
+class Ninja < ActiveRecord::Base #:nodoc:
+  validates_uniqueness_of :name, :scope => :visible
+  paranoid :field => [:visible, false, true]
+
+  alias_method :vanish, :destroy
+
+  # this code is to ensure that our destroy and restore methods
+  # work without triggering before/after_update callbacks
+  before_update :raise_hell
+  def raise_hell
+    raise "hell"
+  end
+end
+
+class Pirate < ActiveRecord::Base #:nodoc:
+  paranoid :field => :alive, :destroyed_value => false, :not_destroyed_value => true
+
+  # this code is to ensure that our destroy and restore methods
+  # work without triggering before/after_update callbacks
+  before_update :raise_hell
+  def raise_hell
+    raise "hell"
+  end
+end
+
+class DeadPirate < ActiveRecord::Base #:nodoc:
+  set_table_name :pirates
+  paranoid :field => :alive, :destroyed_value => true, :not_destroyed_value => false
+end
+
+class RandomPirate < ActiveRecord::Base #:nodoc:
+  set_table_name :pirates
+
+  after_destroy :raise_an_error
+  def raise_an_error
+    raise 'after_destroy works'
+  end
+end
+
+class UndestroyablePirate < ActiveRecord::Base #:nodoc:
+  set_table_name :pirates
+  paranoid :field => :alive, :destroyed_value => false, :not_destroyed_value => true
+
+  before_destroy :ret_false
+  def ret_false
+    false
+  end
+end
+
+class Uuid < ActiveRecord::Base #:nodoc:
+  set_primary_key "uuid"
+
+  before_create :set_uuid
+  def set_uuid
+    self.uuid = "295b3430-85b8-012c-cfe4-002332cf7d5e"
+  end
+
+  paranoid
+end

data/spec/paranoid_spec.rb

@@ -0,0 +1,298 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/models')
+
+LUKE = 'Luke Skywalker'
+
+describe Paranoid do
+  before(:each) do
+    # Sticker.delete_all
+    # Place.delete_all
+    # Android.delete_all
+    # Person.delete_all
+    # Component.delete_all
+    #
+    # @luke = Person.create(:name => LUKE)
+    # @r2d2 = Android.create(:name => 'R2D2', :owner_id => @luke.id)
+    # @c3p0 = Android.create(:name => 'C3P0', :owner_id => @luke.id)
+    #
+    # @r2d2.components.create(:name => 'Rotors')
+    #
+    # @r2d2.memories.create(:name => 'A pretty sunset')
+    # @c3p0.sticker = Sticker.create(:name => 'OMG, PONIES!')
+    # @tatooine = Place.create(:name => "Tatooine")
+    # @r2d2.places << @tatooine
+  end
+
+  describe 'basic functionality' do
+    before(:each) do
+      Place.delete_all
+      @tatooine, @mos_eisley, @coruscant = Place.create([{:name => "Tatooine"}, {:name => 'Mos Eisley'}, {:name => 'Coruscant'}])
+    end
+
+    it 'should recognize a class as paranoid' do
+      Person.paranoid?.should be_false
+      Place.paranoid?.should be_true
+    end
+
+    it 'should recognize an STI class as paranoid' do
+      Biped.paranoid?.should be_true
+    end
+
+    it 'should hide destroyed records' do
+      @tatooine.destroy
+      Place.first(:conditions => {:name => 'Tatooine'}).should be_nil
+    end
+
+    it 'should reveal destroyed records when with_destroyed' do
+      @tatooine.destroy
+      Place.with_destroyed.first(:conditions => {:name => 'Tatooine'}).should_not be_nil
+    end
+
+    it 'should restore the destroyed record' do
+      @tatooine.destroy
+
+      @tatooine = Place.with_destroyed.first(:conditions => {:name => 'Tatooine'})
+      @tatooine.restore
+
+      Place.first(:conditions => {:name => 'Tatooine'}).should_not be_nil
+    end
+
+    it 'should soft delete paranoid records' do
+      @tatooine.destroy
+
+      record = Place.with_destroyed.first(:conditions => {:name => 'Tatooine'})
+      record.should_not be_nil
+      record.deleted_at.should_not be_nil
+    end
+
+    it 'should mark the record destroyed' do
+      @tatooine.destroy
+      @tatooine.destroyed?.should be_true
+    end
+
+    it 'should set the deleted_field' do
+      @tatooine.destroy
+      @tatooine.deleted_at.should_not be_nil
+    end
+
+    it 'should show deleted_only' do
+      @tatooine.destroy
+      destroyed = Place.with_destroyed_only.all
+      destroyed.size.should == 1
+      destroyed[0].should == @tatooine
+    end
+
+    it 'should properly count records' do
+      Place.count.should == 3
+
+      @tatooine.destroy
+      Place.count.should == 2
+      Place.with_destroyed.count.should == 3
+      Place.with_destroyed_only.count.should == 1
+    end
+  end
+
+  describe 'for alternate field information' do
+    before(:each) do
+      Pirate.delete_all
+      @roberts, @jack, @hook = Pirate.create([{:name => 'Roberts'}, {:name => 'Jack'}, {:name => 'Hook'}])
+    end
+
+    it 'should have 3 alive pirates' do
+      Pirate.all.size.should == 3
+    end
+
+    it 'should kill the pirate' do
+      @roberts.destroy
+
+      record = Pirate.first(:conditions => {:name => 'Roberts'})
+      record.should be_nil
+    end
+
+    it 'should not remove the pirate record' do
+      @roberts.destroy
+
+      record = Pirate.with_destroyed.first(:conditions => {:name => 'Roberts'})
+      record.should_not be_nil
+      record.alive.should be_false
+    end
+
+    it 'should mark the pirate dead' do
+      @roberts.destroy
+      @roberts.destroyed?.should be_true
+    end
+
+    it 'should set alive to false' do
+      @roberts.destroy
+      @roberts.alive.should be_false
+    end
+
+    it 'should show deleted_only' do
+      @roberts.destroy
+      destroyed = Pirate.with_destroyed_only.all
+      destroyed.size.should == 1
+      destroyed[0].should == @roberts
+    end
+
+    it 'should properly count records' do
+      Pirate.count.should == 3
+
+      @roberts.destroy
+      Pirate.count.should == 2
+      Pirate.with_destroyed.count.should == 3
+      Pirate.with_destroyed_only.count.should == 1
+    end
+  end
+
+  describe 'for alternate field information with is_paranoid format field information' do
+    before(:each) do
+      Ninja.delete_all
+      @steve, @bob, @tim = Ninja.create([{:name => 'Steve', :visible => true}, {:name => 'Bob', :visible => true}, {:name => 'Tim', :visible => true}])
+    end
+
+    it 'should have 3 visible ninjas' do
+      Ninja.all.size.should == 3
+    end
+
+    it 'should vanish the ninja' do
+      @steve.destroy
+
+      record = Ninja.first(:conditions => {:name => 'Steve'})
+      record.should be_nil
+    end
+
+    it 'should not delete the ninja' do
+      @steve.destroy
+
+      record = Ninja.with_destroyed.first(:conditions => {:name => 'Steve'})
+      record.should_not be_nil
+      record.visible.should be_false
+    end
+
+    it 'should mark the ninja vanished' do
+      @steve.destroy
+      @steve.destroyed?.should be_true
+    end
+
+    it 'should set visible to false' do
+      @steve.destroy
+      @steve.visible.should be_false
+    end
+
+    it 'should show deleted_only' do
+      @steve.destroy
+      destroyed = Ninja.with_destroyed_only.all
+      destroyed.size.should == 1
+      destroyed[0].should == @steve
+    end
+
+    it 'should properly count records' do
+      Ninja.count.should == 3
+
+      @steve.destroy
+      Ninja.count.should == 2
+      Ninja.with_destroyed.count.should == 3
+      Ninja.with_destroyed_only.count.should == 1
+    end
+  end
+
+  describe 'has_many association' do
+    before(:each) do
+      Android.delete_all
+      Dent.delete_all
+
+      @r2d2 = Android.create(:name => 'R2D2')
+      @dents = Dent.create([
+        {:android => @r2d2, :description => 'Hit by debris'},
+        {:android => @r2d2, :description => 'Dropped while loading into X-Wing'},
+        {:android => @r2d2, :description => 'Blaster hit'}
+      ])
+
+      @dents[2].destroy
+    end
+
+    it 'should hide the soft deleted dent' do
+      @r2d2.dents.to_a.should == @dents[0,2]
+    end
+
+    it 'should show all dents with_destroyed' do
+      @r2d2.dents.with_destroyed.to_a.should == @dents
+    end
+
+    it 'should show only soft deleted with destroyed_only' do
+      @r2d2.dents.with_destroyed_only.to_a.should == [@dents[2]]
+    end
+
+    it 'should show the correct counts' do
+      @r2d2.dents.size.should == 2
+      @r2d2.dents.with_destroyed.size.should == 3
+      @r2d2.dents.with_destroyed_only.size.should == 1
+    end
+
+    it 'should load correctly through an eager load' do
+      @r2d2 = Android.eager_load(:dents).first
+      @r2d2.dents.loaded?.should be_true
+      @r2d2.dents.size.should == 2
+      @r2d2.dents.to_a.should == @dents[0,2]
+    end
+
+    it 'should load correctly through an include' do
+      @r2d2 = Android.includes(:dents).first
+      @r2d2.dents.loaded?.should be_true
+      @r2d2.dents.size.should == 2
+      @r2d2.dents.to_a.should == @dents[0,2]
+    end
+
+    it 'should work correctly for a include dependency' do
+      @nil = Android.includes(:dents).where('dents.description' => 'Blaster hit').first
+      @nil.should be_nil
+    end
+  end
+
+  describe 'callbacks' do
+    before(:each) do
+      Pirate.delete_all
+    end
+
+    it 'should not destroy the record when before_destroy returns false' do
+      pirate = UndestroyablePirate.create!(:name => 'Roberts')
+      lambda { pirate.destroy }.should_not change(UndestroyablePirate, :count)
+    end
+
+    it 'should run after_destroy callbacks' do
+      pirate = RandomPirate.create!(:name => 'Roberts')
+      lambda { pirate.destroy }.should raise_error(/after_destroy works/)
+    end
+
+    it 'should rollback on after_destroy error' do
+      pirate = RandomPirate.create!(:name => 'Roberts')
+      lambda { pirate.destroy rescue nil }.should_not change(RandomPirate, :count)
+    end
+  end
+  
+  describe 'association destroy' do
+    before(:each) do
+      Android.delete_all
+      Component.delete_all
+      @r2d2 = Android.create(:name => 'R2D2')
+      @components = Component.create([{ :android => @r2d2, :name => 'Rotors' }, { :android => @r2d2, :name => 'Wheels' }])
+    end
+    
+    it 'should delete associated models' do
+      Android.count.should == 1
+      @r2d2.components.count.should == 2
+      @r2d2.destroy
+      Android.count.should == 0
+      @r2d2.components.count.should == 0
+    end
+    
+    it 'should restore associated models' do
+      @r2d2.destroy
+      Android.count.should == 0
+      @r2d2.components.count.should == 0
+      Android.with_destroyed_only.first.restore
+      Android.count.should == 1
+      @r2d2.components.count.should == 2
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,86 @@
+ActiveRecord::Schema.define do
+  create_table "androids", :force => true do |t|
+    t.string   "name"
+    t.integer  "owner_id"
+    t.datetime "deleted_at"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "dents", :force => true do |t|
+    t.integer  "android_id"
+    t.string   "description"
+    t.datetime "deleted_at"
+  end
+
+  create_table "dings", :force => true do |t|
+    t.integer  "dent_id"
+    t.string   "description"
+    t.boolean  "not_deleted"
+  end
+
+  create_table "scratches", :force => true do |t|
+    t.integer  "dent_id"
+    t.string   "description"
+    t.datetime "deleted_at"
+  end
+
+  create_table "androids_places", :force => true, :id => false do |t|
+    t.integer  "android_id"
+    t.integer  "place_id"
+  end
+
+  create_table "places", :force => true do |t|
+    t.string   "name"
+    t.datetime "deleted_at"
+  end
+
+  create_table "people", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "components", :force => true do |t|
+    t.string   "name"
+    t.integer  "android_id"
+    t.datetime "deleted_at"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "sub_components", :force => true do |t|
+    t.string "name"
+    t.integer "component_id"
+    t.datetime "deleted_at"
+  end
+
+  create_table "memories", :force => true do |t|
+    t.string   "name"
+    t.integer  "parent_id"
+    t.datetime "deleted_at"
+  end
+
+  create_table "stickers", :force => true do |t|
+    t.string   "name"
+    t.integer  "android_id"
+    t.datetime "deleted_at"
+  end
+
+  create_table "ninjas", :force => true do |t|
+    t.string   "name"
+    t.boolean  "visible", :default => false
+  end
+
+  create_table "pirates", :force => true do |t|
+    t.string   "name"
+    t.boolean  "alive", :default => true
+  end
+
+  create_table "uuids", :id => false, :force => true  do |t|
+    t.string   "uuid",     :limit => 36,  :primary => true
+    t.string   "name"
+    t.datetime "deleted_at"
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'paranoid'
+
+$enabled = false
+
+ActiveSupport::Notifications.subscribe(/sql/i) do |*args|
+  if $enabled
+    event = ActiveSupport::Notifications::Event.new(*args)
+    puts "SQL #{event.duration}: #{event.payload[:sql]}"
+  end
+end
+
+def connect(environment)
+  conf = YAML::load(File.open(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.establish_connection(conf[environment])
+end
+
+# Open ActiveRecord connection
+connect('test')
+
+original_stdout = $stdout
+$stdout = StringIO.new
+
+begin
+  load(File.dirname(__FILE__) + "/schema.rb")
+ensure
+  $stdout = original_stdout
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: paranoid_create
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 10
+  version: 0.0.10
+platform: ruby
+authors: 
+- Philipp Ullmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 3
+        - 0
+        - 5
+        version: 3.0.5
+  type: :development
+  version_requirements: *id003
+description: 
+email: philipp.ullmann@create.at
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- init.rb
+- lib/paranoid.rb
+- lib/paranoid/base.rb
+- lib/paranoid/join_association.rb
+- lib/paranoid/paranoid_methods.rb
+- lib/paranoid/relation.rb
+- lib/paranoid/version.rb
+- paranoid.gemspec
+- rdoc/template.rb
+- spec/database.yml
+- spec/models.rb
+- spec/paranoid_spec.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/create-philipp-ullmann/paranoid/
+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: paranoid_create
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Enable soft delete of ActiveRecord records. Based off defunct ActsAsParanoid and IsParanoid
+test_files: 
+- spec/database.yml
+- spec/models.rb
+- spec/paranoid_spec.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb