protected_parent 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+  gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    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)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rcov
+  rspec
+  shoulda

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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/README.md

@@ -0,0 +1,81 @@
+protected_parent_of
+==============
+
+Stops the deletion of an ActiveRecord object when members of a specified child association exist.
+
+It adds a "removeable?" method to evaluate whether the object may be deleted and the necessary before_destroy callback.
+
+Example Usage
+=============
+
+Adding to your models
+---------------------
+
+The model 'has_many :posts'. Do not allow deletion if there are Post records associated with this object:
+    
+    class Category < ActiveRecord::Base
+      protected_parent_of :posts
+    end
+    
+If it 'has_one :attachement', don't allow deletion until the attachment has been removed. Use the singular, just like the 'has_one'
+    
+    class Category < ActiveRecord::Base
+      protected_parent_of :attachment
+    end
+    
+If necessary, allow several child objects to stay deletion. For example, a polymorphic category model may have:
+    
+    class Category < ActiveRecord::Base
+      protected_parent_of :posts, :comments
+    end
+    
+Depending on taste, you can call protected_parent_of multiple times:
+    
+    class Category < ActiveRecord::Base
+      has_many :posts
+      has_many :comments
+      protected_parent_of :posts, :comments
+      
+      has_one :attachment
+      protected_parent_of :attachment
+    end
+    
+When you need something more sophisticated, you can target a method or named_scope. This would block deletion of the category if there were any active posts:
+
+    class Category < ActiveRecord::Base
+      has_many :posts
+      protected_parent_of :active_posts
+      
+      def active_posts
+        posts.active
+      end
+    end
+    
+    class Post < ActiveRecord::Base
+      named_scope :active, :condition => { :active => true }
+    end
+
+Using the methods
+-----------------
+
+Once applied to a model, protected_parent_of adds several methods to your model. You can now use 'protected?' and 'removable?'
+
+    category = Category.new
+    category.protected?                 # False
+    category.removable?                 # True
+
+    category = Category.new
+    category.posts << Post.create
+    category.protected?                 # True
+    category.removable?                 # False
+
+And most importantly, it will block deletion
+
+    category = Category.create
+    category.posts = Post.create
+    category.delete                     # False
+    category.delete!                    # Raises an exception
+    
+License
+=======
+Copyright (c) 2010 Tim Harvey, released under the MIT license

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "protected_parent"
+  gem.homepage = "http://github.com/openteam/protected_parent"
+  gem.license = "MIT"
+  gem.summary = %Q{Protect a parent record from deletion when it has specified child records}
+  gem.description = %Q{Stops the deletion of an ActiveRecord object when members of a specified child association exist.}
+  gem.email = "lda@openteam.ru"
+  gem.authors = ["Tim Harvey", "Dmitry Lihachev"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+#require 'spec/rake/spectask'
+
+#desc 'Default: run specs.'
+#task :default => :spec
+
+#desc 'Run the specs'
+#Spec::Rake::SpecTask.new(:spec) do |t|
+#  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+#  t.spec_files = FileList['spec/**/*_spec.rb']
+#end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "protected_parent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/protected_parent/protected_parent_of.rb

@@ -0,0 +1,58 @@
+#encoding: utf-8
+module ProtectedParent
+  def self.included(base)
+    base.send :extend, ClassMethods
+    base.send :include, InstanceMethods
+  end
+
+  module ClassMethods
+
+    def protected_parent_of(*children_names)
+
+      @softly_protected = children_names.extract_options!.delete(:protects) == :softly
+
+      children_names.each do |child_name|
+        self.children_of_protected_parent << child_name.to_s
+      end
+
+      before_destroy :removable?
+    end
+
+    def children_of_protected_parent
+      @children_of_protected_parent ||= []
+    end
+
+    def softly_protected
+      @softly_protected
+    end
+
+  end
+
+  module InstanceMethods
+    # Can the instance be deleted?
+    def removable?
+      self.class.softly_protected || protected_children.empty?
+    end
+
+    def protected_children
+      self.class.children_of_protected_parent.select do |child|
+        if a_plural child
+          child unless send(child).count.zero?
+        else
+          child unless send(child).nil?
+        end
+      end
+    end
+
+    # The inverse of removable?, is this instance protected from deletion?
+    def protected?
+      !removable?
+    end
+
+    def a_plural(child)
+      child.pluralize == child
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ProtectedParent

data/lib/protected_parent.rb

@@ -0,0 +1 @@
+require 'protected_parent/protected_parent_of'

data/protected_parent.gemspec

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{protected_parent}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Harvey", "Dmitry Lihachev"]
+  s.date = %q{2010-12-18}
+  s.description = %q{Stops the deletion of an ActiveRecord object when members of a specified child association exist.}
+  s.email = %q{lda@openteam.ru}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/protected_parent.rb",
+    "lib/protected_parent/protected_parent_of.rb",
+    "protected_parent.gemspec",
+    "spec/db/database.yml",
+    "spec/db/schema.rb",
+    "spec/models/attachment.rb",
+    "spec/models/category.rb",
+    "spec/models/comment.rb",
+    "spec/models/post.rb",
+    "spec/protected_parent_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/openteam/protected_parent}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Protect a parent record from deletion when it has specified child records}
+  s.test_files = [
+    "spec/db/schema.rb",
+    "spec/models/attachment.rb",
+    "spec/models/category.rb",
+    "spec/models/comment.rb",
+    "spec/models/post.rb",
+    "spec/protected_parent_spec.rb",
+    "spec/spec_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::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["> 1.2.3"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["> 1.2.3"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["> 1.2.3"])
+  end
+end
+

data/spec/db/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  :adapter: sqlite3
+  :database: vendor/plugins/protected_parent/spec/db/protected_parent.sqlite3.db

data/spec/db/schema.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :categories, :force => true do |t|
+    t.column :name, :string
+  end  
+  
+  create_table :posts, :force => true do |t|
+    t.column :category_id, :integer
+  end
+ 
+  create_table :comments, :force => true do |t|
+    t.column :category_id, :integer
+  end
+ 
+  create_table :attachments, :force => true do |t|
+    t.column :category_id, :integer
+  end
+end

data/spec/models/attachment.rb

@@ -0,0 +1,3 @@
+class Attachment < ActiveRecord::Base
+  belongs_to :category
+end

data/spec/models/category.rb

@@ -0,0 +1,8 @@
+class Category < ActiveRecord::Base
+  has_many :posts
+  has_many :comments
+  protected_parent_of :posts, :comments
+  
+  has_one :attachment
+  protected_parent_of :attachment
+end

data/spec/models/comment.rb

@@ -0,0 +1,3 @@
+class Comment < ActiveRecord::Base
+  belongs_to :category
+end

data/spec/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  belongs_to :category
+end

data/spec/protected_parent_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "ProtectedParent" do
+  describe "with an instance that does not have associated records" do
+    it "should allow a destroy" do
+      category = Category.create
+      lambda { category.destroy }.should change{ Category.count }
+    end
+  end  
+  
+  describe "with an instance that has associated records" do
+    it "should block the destroy" do
+      category = Category.create
+      category.posts << Post.new
+      category.save!
+      lambda { category.destroy }.should_not change{ Category.count }
+    end
+  end
+  
+  describe "removable? method" do
+    it "should return true when there are no children for the instance" do
+      category = Category.create
+      category.removable?.should == true
+    end
+    
+    it "should be false when the instance has only the firs of the two defined child record types" do
+      category = Category.create
+      category.posts << Post.new
+      category.removable?.should == false
+    end
+    
+    it "should be false when the instance has only the firs of the two defined child record types" do
+      category = Category.create
+      category.comments << Comment.new
+      category.removable?.should == false
+    end
+    
+    it "should be false when the instance has both of the two defined child record types" do
+      category = Category.create
+      category.posts << Post.new
+      category.comments << Comment.new
+      category.removable?.should == false
+    end
+  end
+  
+  describe "protected? method" do
+    it "should return the opposite of removable?" do
+      category = Category.create
+      category.removable?.should == !category.protected?
+      
+      category = Category.create
+      category.posts << Post.new
+      category.removable?.should == !category.protected?
+    end
+  end
+  describe "has an instance with a single 'has_one' child" do
+    it "should allow delete if the instance doesn't have a child assigned" do
+      category = Category.create
+      lambda { category.destroy }.should change{ Category.count }
+    end
+    
+    it "should block the delete if the instance has a child assigned" do
+      category = Category.create
+      category.attachment = Attachment.new
+      lambda { category.destroy }.should_not change{ Category.count }
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format progress
+--loadby mtime
+--reverse
+--drb

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+plugin_spec_dir = File.dirname(__FILE__)
+
+# Load up the dummy db with the schema used by the dummy models
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+databases = YAML::load(IO.read(plugin_spec_dir + "/db/database.yml"))
+ActiveRecord::Base.establish_connection(databases[ENV["DB"] || "sqlite3"])
+load(File.join(plugin_spec_dir, "db", "schema.rb"))
+
+# Load the dummy models used in testing
+path = File.join(plugin_spec_dir, "models")
+$LOAD_PATH << File.join(plugin_spec_dir, "models")
+ActiveSupport::Dependencies.load_paths << path
+ActiveSupport::Dependencies.load_once_paths.delete(path)

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification 
+name: protected_parent
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tim Harvey
+- Dmitry Lihachev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-18 00:00:00 +06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 3
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: Stops the deletion of an ActiveRecord object when members of a specified child association exist.
+email: lda@openteam.ru
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/protected_parent.rb
+- lib/protected_parent/protected_parent_of.rb
+- protected_parent.gemspec
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/models/attachment.rb
+- spec/models/category.rb
+- spec/models/comment.rb
+- spec/models/post.rb
+- spec/protected_parent_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/openteam/protected_parent
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -948303156927737748
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Protect a parent record from deletion when it has specified child records
+test_files: 
+- spec/db/schema.rb
+- spec/models/attachment.rb
+- spec/models/category.rb
+- spec/models/comment.rb
+- spec/models/post.rb
+- spec/protected_parent_spec.rb
+- spec/spec_helper.rb