murbanski-affected_on_destroy 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Marcin Urbanski
+
+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,91 @@
+# affected_on_destroy
+
+affected_on_destroy is a simple Rails plugin that recursively reflects on defined associations and lets you know which records will be deleted/nullified when using <b>:dependent => :destroy</b> or <b>:dependent => :nullify</b>.
+
+## Installation
+
+    config.gem 'murbanski-affected_on_destroy', :lib => 'affected_on_destroy', :source => 'http://gems.github.com'
+
+
+## Usage
+
+schema.rb:
+
+	create_table "users", :force => true do |t|
+	  t.string   "login"
+	  t.string   "password"
+	  t.datetime "created_at"
+	  t.datetime "updated_at"
+	end
+
+	create_table "blogs", :force => true do |t|
+	  t.integer  "user_id"
+	  t.string   "name"
+	  t.datetime "created_at"
+	  t.datetime "updated_at"
+	end
+
+	create_table "posts", :force => true do |t|
+	  t.integer  "blog_id"
+	  t.text     "content"
+	  t.datetime "created_at"
+	  t.datetime "updated_at"
+	end
+
+
+ 
+
+models:
+	class User < ActiveRecord::Base
+	  has_many :blogs, :dependent => :destroy
+	end
+	
+	class Blog < ActiveRecord::Base
+	  belongs_to :user
+	  has_many :posts, :dependent => :nullify
+	end
+	
+	class Post < ActiveRecord::Base
+	  belongs_to :blog
+	end
+
+
+Sample script/console session:
+	>>  marcin = User.create(:login => 'marcin', :password => 'my_pass')
+	=> #<User id: 1, login: "marcin", password: "my_pass", created_at: "2009-06-26 01:47:36", updated_at: "2009-06-26 01:47:36">
+
+	>> blog = marcin.blogs.create(:name => 'My Ruby Blog')
+	=> #<Blog id: 1, user_id: 1, name: "My Ruby Blog", created_at: "2009-06-26 01:47:57", updated_at: "2009-06-26 01:47:57">
+
+	>> blog.posts.create(:content => 'Ruby tricks #1')
+	=> #<Post id: 1, blog_id: 1, content: "Ruby tricks #1", created_at: "2009-06-26 01:48:40", updated_at: "2009-06-26 01:48:40">
+	>> blog.posts.create(:content => 'Ruby tricks #2')
+	=> #<Post id: 2, blog_id: 1, content: "Ruby tricks #2", created_at: "2009-06-26 01:48:45", updated_at: "2009-06-26 01:48:45">
+
+What records will be affected when we destroy user 'marcin'?
+	>> marcin.affected_on_destroy
+	=> [#<Blog id: 1, user_id: 1, name: "My Ruby Blog", created_at: "2009-06-26 01:47:57", updated_at: "2009-06-26 01:47:57">, 
+	#<Post id: 1, blog_id: 1, content: "Ruby tricks #1", created_at: "2009-06-26 01:48:40", updated_at: "2009-06-26 01:48:40">, 
+	#<Post id: 2, blog_id: 1, content: "Ruby tricks #2", created_at: "2009-06-26 01:48:45", updated_at: "2009-06-26 01:48:45">]
+
+A bit cleaner summary - only with model name and id:
+	>> puts marcin.affected_on_destroy_info
+	Blog 1
+	Post 1
+	Post 2
+	=> nil
+
+Which models are affected when destroying user?
+	>> User.affected_on_destroy
+	=> ["Blog", "Post"]
+
+Same for blog:
+	>> Blog.affected_on_destroy
+	=> ["Post"]
+
+
+## Rails Version
+
+Works on Rails 2.3 and 2.2
+
+

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "affected_on_destroy"
+    gem.summary = %Q{Rails plugin showing which related records will be deleted from DB when :dependent => :destroy is used}
+    gem.description = %Q{Rails plugin showing which related records will be deleted from DB when :dependent => :destroy is used}
+    gem.email = "marcin@urbanski.vdl.pl"
+    gem.homepage = "http://github.com/murbanski/affected_on_destroy"
+    gem.authors = ["Marcin Urbanski"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "affected_on_destroy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/affected_on_destroy.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{affected_on_destroy}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marcin Urbanski"]
+  s.date = %q{2009-06-26}
+  s.description = %q{Rails plugin showing which related records will be deleted from DB when :dependent => :destroy is used}
+  s.email = %q{marcin@urbanski.vdl.pl}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "affected_on_destroy.gemspec",
+     "lib/affected_on_destroy.rb",
+     "rails/init.rb",
+     "test/affected_on_destroy_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/murbanski/affected_on_destroy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Rails plugin showing which related records will be deleted from DB when :dependent => :destroy is used}
+  s.test_files = [
+    "test/affected_on_destroy_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/affected_on_destroy.rb

@@ -0,0 +1,57 @@
+
+
+module AffectedOnDestroy
+
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+
+  module ClassMethods
+    def dependent_associations
+      associations = self.reflect_on_all_associations(:has_many) + self.reflect_on_all_associations(:has_one)
+      associations.select {|a| a.options.has_key?(:dependent)}
+    end
+
+
+    # TODO: infinite recursion: create array already_inspected_associations
+    # User.affected_on_destroy   # => ["Post", "Comments", "Ratings"]
+    def affected_on_destroy
+      returning affected = [] do
+        dependent_associations.map do |assoc|
+          affected << assoc.class_name
+          affected << assoc.class_name.constantize.affected_on_destroy
+        end
+      end.flatten.uniq.sort
+    end
+  end
+
+
+  # u = User.first
+  # u.affected_on_destroy   # => [ #<Post id: 25>, #<Comment id: 10, post_id: 25>, #<Rating id: 3, post_id: 25>]
+  def affected_on_destroy
+    affected_objects = []
+      self.class.dependent_associations.each do |assoc|
+        next if (associated_relation = self.send(assoc.name)).blank?
+        if assoc.macro == :has_one
+          affected_objects << associated_relation
+          affected_objects << associated_relation.affected_on_destroy
+        elsif assoc.macro == :has_many
+          associated_relation.each do |associated_object|
+            affected_objects << associated_object 
+            affected_objects << associated_object.affected_on_destroy
+          end
+        end
+      end
+
+    affected_objects.flatten.uniq.sort_by {|elem| elem.class.to_s }
+  end
+
+  def affected_on_destroy_info
+    self.affected_on_destroy.map{|obj| "#{obj.class.to_s} #{obj.id}"}
+  end
+
+end
+
+
+ActiveRecord::Base.send :include, AffectedOnDestroy

data/rails/init.rb

@@ -0,0 +1 @@
+require 'affected_on_destroy'

data/test/affected_on_destroy_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AffectedOnDestroyTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'affected_on_destroy'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: murbanski-affected_on_destroy
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Marcin Urbanski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Rails plugin showing which related records will be deleted from DB when :dependent => :destroy is used
+email: marcin@urbanski.vdl.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- affected_on_destroy.gemspec
+- lib/affected_on_destroy.rb
+- rails/init.rb
+- test/affected_on_destroy_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/murbanski/affected_on_destroy
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Rails plugin showing which related records will be deleted from DB when :dependent => :destroy is used
+test_files: 
+- test/affected_on_destroy_test.rb
+- test/test_helper.rb