joshuaclayton-paranoia 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joshua Clayton
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,12 @@
+lib/paranoia.rb
+MIT-LICENSE
+rails/init.rb
+Rakefile
+README.textile
+test/database.yml
+test/factories.rb
+test/models.rb
+test/paranoia_test.rb
+test/schema.rb
+test/test_helper.rb
+Manifest

data/README.textile

@@ -0,0 +1,7 @@
+h1. Paranoia
+
+Essentially, paranoia is a ripoff of is_paranoid; I'm just trying to get the paranoid scope to work without using `with_exclusive_scope`, since it nullifies any other named scopes etc.
+
+It's purely test-driven, since I'm planning on hacking on it 'til everything passes.  Until then, consider this alpha software.
+
+Copyright (c) 2009 Joshua Clayton, released under the MIT license

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'rake/testtask'
+
+Echoe.new("paranoia", "0.0.1") do |p|
+  p.description = "Paranoid models"
+  p.url = "http://github.com/joshuaclayton/paranoia"
+  p.author = "Joshua Clayton"
+  p.email = "joshua.clayton@gmail.com"
+  p.ignore_pattern = ["tmp/*"]
+  p.development_dependencies = ["activerecord >= 2.3.0", "activesupport >= 2.1.0"]
+end

data/lib/paranoia.rb

@@ -0,0 +1,29 @@
+require "active_record"
+
+module Paranoia
+  
+  def paranoia(opts = {})
+    opts[:field] ||= [:deleted_at, Proc.new { Time.now.utc }, nil]
+    class_inheritable_accessor :destroyed_field, :field_destroyed, :field_not_destroyed
+    self.destroyed_field, self.field_destroyed, self.field_not_destroyed = opts[:field]
+    
+    extend ClassMethods
+    include InstanceMethods
+  end
+  
+  module ClassMethods
+    def with_destroyed
+      scoped({})
+    end
+    
+    def only_destroyed
+      scoped({:conditions => ["#{self.quoted_table_name}.#{self.destroyed_field} IS NOT ?", self.field_not_destroyed]})
+    end
+  end
+  
+  module InstanceMethods
+    
+  end
+end
+
+ActiveRecord::Base.send(:extend, Paranoia)

data/paranoia.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{paranoia}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Clayton"]
+  s.date = %q{2009-05-30}
+  s.description = %q{Paranoid models}
+  s.email = %q{joshua.clayton@gmail.com}
+  s.extra_rdoc_files = ["lib/paranoia.rb", "README.textile"]
+  s.files = ["lib/paranoia.rb", "MIT-LICENSE", "rails/init.rb", "Rakefile", "README.textile", "test/database.yml", "test/factories.rb", "test/models.rb", "test/paranoia_test.rb", "test/schema.rb", "test/test_helper.rb", "Manifest", "paranoia.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/joshuaclayton/paranoia}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Paranoia", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{paranoia}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Paranoid models}
+  s.test_files = ["test/paranoia_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<activerecord>, [">= 0", ">= 2.3.0"])
+      s.add_development_dependency(%q<activesupport>, [">= 0", ">= 2.1.0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0", ">= 2.3.0"])
+      s.add_dependency(%q<activesupport>, [">= 0", ">= 2.1.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0", ">= 2.3.0"])
+    s.add_dependency(%q<activesupport>, [">= 0", ">= 2.1.0"])
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "paranoia"

data/test/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/test/factories.rb

@@ -0,0 +1,8 @@
+Factory.define :person do |person|
+  person.sequence(:name) {|n| "Person #{n}" }
+end
+
+Factory.define :android do |android|
+  android.sequence(:name) {|n| "Person #{n}" }
+  android.active { true }
+end

data/test/models.rb

@@ -0,0 +1,95 @@
+class Person < ActiveRecord::Base
+  validates_uniqueness_of :name
+  has_many :androids, :foreign_key => :owner_id, :dependent => :destroy
+end
+
+class Android < ActiveRecord::Base
+  validates_uniqueness_of :name
+  has_many :components, :dependent => :destroy
+  has_one :sticker
+  has_many :memories, :foreign_key => "parent_id"
+  
+  named_scope :active, :conditions => {:active => true}
+  paranoia
+
+  # 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 RuntimeError, "hell"
+  end
+end
+
+class Component < ActiveRecord::Base
+  paranoia
+  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
+  paranoia
+  belongs_to :component, :dependent => :destroy
+end
+
+class Memory < ActiveRecord::Base
+  paranoia
+  belongs_to :android, :class_name => "Android", :foreign_key => "parent_id"
+end
+
+class Sticker < ActiveRecord::Base
+  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 paranoia
+  def method_missing(name, *args, &block)
+    self.name = MM_NAME
+  end
+
+  paranoia
+  belongs_to :android
+end
+
+class AndroidWithScopedUniqueness < ActiveRecord::Base
+  set_table_name :androids
+  validates_uniqueness_of :name, :scope => :deleted_at
+  paranoia
+end
+
+class Ninja < ActiveRecord::Base
+  validates_uniqueness_of :name, :scope => :visible
+  paranoia :field => [:visible, false, true]
+  
+  alias_method :vanish, :destroy
+end
+
+class Pirate < ActiveRecord::Base
+  paranoia :field => [:alive, false, true]
+end
+
+class DeadPirate < ActiveRecord::Base
+  set_table_name :pirates
+  paranoia :field => [:alive, true, false]
+end
+
+class RandomPirate < ActiveRecord::Base
+  set_table_name :pirates
+
+  def after_destroy
+    raise "after_destroy works"
+  end
+end
+
+class UndestroyablePirate < ActiveRecord::Base
+  set_table_name :pirates
+  paranoia :field => [:alive, false, true]
+
+  def before_destroy
+    false
+  end
+end

data/test/paranoia_test.rb

@@ -0,0 +1,80 @@
+require "test_helper"
+
+class ParanoiaTest < ActiveSupport::TestCase
+  context "A model without paranoia" do
+    setup { @person = Factory(:person) }
+    
+    context "when destroyed" do
+      setup { @person.destroy }
+      should_change "Person.count", :by => -1
+    end
+    
+    should "not be paranoid" do
+      assert_raise NoMethodError do
+        Person.count_with_destroyed
+      end
+    end
+  end
+  
+  context "A model with paranoia" do
+    setup { @android = Factory(:android); Factory(:android, :active => false) }
+    teardown { DatabaseCleaner.clean }
+    
+    context "when saved" do
+      should "trigger callbacks normally" do
+        assert_raise RuntimeError do
+          @android.update_attribute :name, "Junk"
+        end
+      end
+      
+      should "not trigger callbacks when destroyed" do
+        assert_nothing_raised do
+          @android.destroy
+        end
+      end
+    end
+    
+    context "when destroyed" do
+      context "as an instance" do
+        setup { @android.destroy }
+        should_change "Android.count", :by => -1
+        
+        should "count the correct number of models" do
+          assert_equal 1, Android.count
+          assert_equal 2, Android.with_destroyed.count
+        end
+      end
+      
+      context "without additional named scopes" do
+        setup { Android.destroy_all }
+        should_change "Android.count", :from => 2, :to => 0
+        should_change "Android.only_destroyed.count", :from => 0, :to => 2
+      end
+      
+      context "with additional named scopes" do
+        setup { Android.active.destroy_all }
+        should_change "Android.count", :from => 2, :to => 1
+        should_change "Android.only_destroyed.count", :from => 0, :to => 1
+        should_change "Android.active.count", :from => 1, :to => 0
+        should_change "Android.active.only_destroyed.count", :from => 0, :to => 1
+      end
+    end
+    
+    context "when deleted" do
+      context "without additional named scopes" do
+        setup { Android.delete_all }
+        should_change "Android.with_destroyed.count", :from => 2, :to => 0
+        should_not_change "Android.only_destroyed.count"
+      end
+      
+      context "with additional named scopes" do
+        setup { Android.active.delete_all }
+        should_change "Android.with_destroyed.count", :from => 2, :to => 1
+        should_not_change "Android.only_destroyed.count"
+        should_change "Android.active.with_destroyed.count", :from => 1, :to => 0
+        should_not_change "Android.active.only_destroyed.count"
+      end
+    end
+    
+  end
+end

data/test/schema.rb

@@ -0,0 +1,49 @@
+ActiveRecord::Schema.define(:version => 20090529222000) do
+  create_table :androids, :force => true do |table|
+    table.string :name
+    table.belongs_to :owner
+    table.boolean :active, :default => true
+    table.timestamps
+    table.datetime :deleted_at
+  end
+  
+  create_table :people, :force => true do |table|
+    table.string :name
+    table.timestamps
+  end
+
+  create_table :components, :force => true do |table|
+    table.string :name
+    table.belongs_to :android
+    table.timestamps
+    table.datetime :deleted_at
+  end
+
+  create_table :sub_components, :force => true do |table|
+    table.string :name
+    table.belongs_to :component
+    table.datetime :deleted_at
+  end
+
+  create_table :memories, :force => true do |table|
+    table.string   :name
+    table.belongs_to :parent
+    table.datetime :deleted_at
+  end
+
+  create_table :stickers, :force => true do |table|
+    table.string   :name
+    table.belongs_to :android
+    table.datetime :deleted_at
+  end
+
+  create_table :ninjas, :force => true do |table|
+    table.string   :name
+    table.boolean  :visible, :default => false
+  end
+
+  create_table :pirates, :force => true do |table|
+    table.string :name
+    table.boolean :alive, :default => true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+require "rubygems"
+require "test/unit"
+
+gem "sqlite3-ruby"
+
+require "active_record"
+require "active_support"
+require "active_support/test_case"
+
+gem "thoughtbot-shoulda", ">= 2.10.1"
+gem "thoughtbot-factory_girl", ">= 1.2.1"
+
+require "shoulda"
+require "mocha"
+require "factory_girl"
+
+require File.join(File.dirname(__FILE__), "..", "rails", "init")
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + "/database.yml"))
+ActiveRecord::Base.establish_connection(config["test"])
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+require File.join(File.dirname(__FILE__), "models")
+
+require "database_cleaner"
+DatabaseCleaner.strategy = :truncation
+DatabaseCleaner.clean

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: joshuaclayton-paranoia
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Clayton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: Paranoid models
+email: joshua.clayton@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/paranoia.rb
+- README.textile
+files: 
+- lib/paranoia.rb
+- MIT-LICENSE
+- rails/init.rb
+- Rakefile
+- README.textile
+- test/database.yml
+- test/factories.rb
+- test/models.rb
+- test/paranoia_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- Manifest
+- paranoia.gemspec
+has_rdoc: true
+homepage: http://github.com/joshuaclayton/paranoia
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Paranoia
+- --main
+- README.textile
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: paranoia
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Paranoid models
+test_files: 
+- test/paranoia_test.rb
+- test/test_helper.rb