prevent_destroy_if_any 0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,46 @@
+prevent_destroy_if_any
+===
+
+This plugin adds ActiveRecord models a way to prevent destroy if specified `has_many`, `has_one` and/or `belongs_to` associations are present. This is achieved by adding a `before_destroy` callback that aborts the destroy and adds a base error on the instance when detecting associations.
+
+It's inspired from [this stackoverflow answer](http://stackoverflow.com/questions/4054112/how-do-i-prevent-deletion-of-parent-if-it-has-child-records/4054170#4054170) and was created to factorize this solution when you need it for various models in an application.
+
+It has been tested only with ActiveRecord 3.
+
+Installation
+---
+
+`gem install prevent_destroy_if_any`
+
+If you use Bundler, edit your `Gemfile` to add `gem 'prevent_destroy_if_any'`.
+
+
+Example usage
+---
+
+A Person model for which you want to prevent destroy when it has an associated user, projects or public profile. Destroy will work if it has associated logs.
+
+    class Person < ActiveRecord::Base
+      belongs_to :user
+      has_many   :projects
+      has_one    :public_profile
+      has_many   :logs
+
+      prevent_destroy_if_any :user, :projects, :public_profile
+    end
+
+Then in Rails you can write your PeopleController destroy action like this:
+
+    def destroy
+      person = Person.find params[:id]
+      if person.destroy
+        redirect_to people_url, :notice => "Person successfully deleted"
+      else
+        redirect_to person, :alert => person.errors.full_messages.join
+      end
+    end
+
+License
+---
+
+Copyright © 2011 Florent Guilleux, released under the MIT license.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+
+task :default => :spec

data/lib/prevent_destroy_if_any/version.rb

@@ -0,0 +1,3 @@
+module PreventDestroyIfAny
+  VERSION = "0.1"
+end

data/lib/prevent_destroy_if_any.rb

@@ -0,0 +1,24 @@
+require "prevent_destroy_if_any/version"
+
+class ActiveRecord::Base
+  def self.prevent_destroy_if_any(*association_names)
+    before_destroy do |model|
+      associations_present = []
+
+      association_names.each do |association_name|
+        association = model.send association_name
+        if association.class == Array
+          associations_present << association_name if association.any?
+        else
+          associations_present << association_name if association
+        end
+      end
+
+      if associations_present.any?
+        errors.add :base, "Cannot delete #{model.class.model_name.human.downcase} while #{associations_present.join ', '} exist"
+        return false
+      end
+
+    end
+  end
+end

data/prevent_destroy_if_any.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "prevent_destroy_if_any/version"
+
+Gem::Specification.new do |s|
+  s.name        = "prevent_destroy_if_any"
+  s.version     = PreventDestroyIfAny::VERSION
+  s.authors     = ["Florent Guilleux"]
+  s.email       = ["florent2@gmail.com"]
+  s.homepage    = "https://github.com/Florent2/prevent_destroy_if_any"
+  s.summary     = %q{ActiveRecord plugin to prevent destroy when associations are present}
+  s.description = %q{ActiveRecord plugin to prevent destroy when associations are present}
+
+  s.rubyforge_project = "prevent_destroy_if_any"
+
+  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.0'
+  s.add_development_dependency "bundler", '>= 1.0.0'
+  s.add_development_dependency "rspec", '>= 0'
+  s.add_development_dependency "database_cleaner", '>= 0'
+  s.add_development_dependency "sqlite3-ruby", '>= 0'
+  s.add_development_dependency "rake", '>= 0'
+end

data/spec/prevent_destroy_if_any_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe "prevent_destroy_if_any" do
+
+  let(:person) { Person.create! }
+
+  context "when there are associated records" do
+
+    it "destroy preventing works for has_many association" do
+      person.projects.create
+      person.destroy
+      person.destroyed?.should be_false
+    end
+
+    it "destroy preventing works for has_one association" do
+      person.create_public_profile
+      person.destroy
+      person.destroyed?.should be_false
+    end
+
+    it "destroy preventing works for belongs_ association" do
+      person.create_user
+      person.destroy
+      person.destroyed?.should be_false
+    end
+
+    it "adds an error message" do
+      person.projects.create
+      person.create_public_profile
+      person.destroy
+      person.errors[:base].first.should == "Cannot delete person while projects, public_profile exist"
+    end
+
+
+    it "does not prevent the destroy if the association is not listed as preventing the destroy" do
+      person.logs.create
+      person.destroy
+      person.destroyed?.should be_true
+    end
+  end
+
+  context "when there is no associated records" do
+
+    it "does not prevent the destroy" do
+      person.destroy
+      person.destroyed?.should be_true
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require "rubygems"
+require "bundler"
+require "rspec"
+require "active_record"
+require "database_cleaner"
+
+require "prevent_destroy_if_any"
+
+ActiveRecord::Base.configurations = { 'test' => { :adapter => 'sqlite3', :database => ':memory:' } }
+ActiveRecord::Base.establish_connection('test')
+
+class Person < ActiveRecord::Base
+  belongs_to :user
+  has_many   :projects
+  has_one    :public_profile
+  has_many   :logs
+
+  prevent_destroy_if_any :user, :projects, :public_profile
+end
+
+class User < ActiveRecord::Base
+  has_one :person
+end
+
+class Project < ActiveRecord::Base
+  belongs_to :person
+end
+
+class PublicProfile < ActiveRecord::Base
+  belongs_to :person
+end
+
+class Log < ActiveRecord::Base
+  belongs_to :person
+end
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Schema.define :version => 0 do
+    create_table(:people)          { |t| t.string :name; t.integer :user_id }
+    create_table(:users)           { |t| t.string :uid }
+    create_table(:projects)        { |t| t.string :name; t.integer :person_id }
+    create_table(:public_profiles) { |t| t.string :name; t.integer :person_id }
+    create_table(:logs)            { |t| t.string :message; t.integer :person_id }
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: prevent_destroy_if_any
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Florent Guilleux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-07 00:00:00.000000000 -05:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2157972440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157972440
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2157971360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157971360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157970640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157970640
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &2157969820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157969820
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &2157968200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157968200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157709680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157709680
+description: ActiveRecord plugin to prevent destroy when associations are present
+email:
+- florent2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/prevent_destroy_if_any.rb
+- lib/prevent_destroy_if_any/version.rb
+- prevent_destroy_if_any.gemspec
+- spec/prevent_destroy_if_any_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/Florent2/prevent_destroy_if_any
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3762508194909461440
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3762508194909461440
+requirements: []
+rubyforge_project: prevent_destroy_if_any
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: ActiveRecord plugin to prevent destroy when associations are present
+test_files:
+- spec/prevent_destroy_if_any_spec.rb
+- spec/spec_helper.rb