dependent_protect 0.0.2

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 0.9.2'
+  gem 'rdoc', '~> 3.12'
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'simplecov-rcov'
+  gem 'sqlite3'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Tom Preston-Werner
+
+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,21 @@
+= dependent => :protect option
+
+Adds a new option :protect for the parameter <tt>:depends</tt> from +has_many+
+method. This option forbids destroying records with associated records in a
+association created with <tt>:dependent => :protect</tt> option, more or less
+like <tt>ON DELETE RESTRICT</tt> SQL statement. If you try to destroy a record with
+associated records it will raise a
+ActiveRecord::ReferentialIntegrityProtectionError (defined also in this 
+plugin).
+
+Based on the idea and the code from diego.algorta@gmail.com in Ruby on Rails
+ticket #3837 (http://dev.rubyonrails.org/ticket/3837).
+
+You can download this plugin at:
+
+http://svn.ruido-blanco.net/dependent_protect/trunk
+
+== Author
+
+Daniel Rodr�guez Troiti�o <drodrigueztroitino@yahoo.es>, based on the ideas and
+the code from <diego.algorta@gmail.com>.

data/Rakefile

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+desc 'Default: run specs.'
+task :default => :spec
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Generate SimpleCov test coverage and open in your browser"
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].invoke
+end
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/dependent_protect.gemspec

@@ -0,0 +1,76 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'dependent_protect'
+  s.version           = '0.0.2'
+  s.date              = '2012-04-09'
+  s.rubyforge_project = 'dependent_protect'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Add dependent protect/restrict functionality to ActiveRecord 2.x."
+  s.description = "This gem is not needed in Rails 3 as dependent => :raise is included in 3.0."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Michael Noack"]
+  s.email    = 'development@travellink.com.au'
+  s.homepage = 'http://github.com/sealink/dependent_protect'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## This sections is only necessary if you have C extensions.
+  # s.require_paths << 'ext'
+  # s.extensions = %w[ext/extconf.rb]
+
+  ## If your gem includes any executables, list them here.
+  # s.executables = ["name"]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('activerecord', [">= 2.3.0", "< 3.0.0"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  # s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    dependent_protect.gemspec
+    lib/dependent_protect.rb
+    spec/dependent_protect_spec.rb
+    spec/schema.rb
+    spec/spec_helper.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/dependent_protect.rb

@@ -0,0 +1,95 @@
+# DependentProtect
+#
+require 'activerecord'
+
+module DependentProtect
+  VERSION = '0.0.2'
+
+  DESTROY_PROTECT_ERROR_MESSAGE = 'Cant destroy because there are dependent_count dependent_type dependent on dependee_type dependee.\n\n\nThese include:\ndependent_examples'
+
+  def self.included(base)
+    super
+    base.extend(ClassMethods)
+
+    klass = Class.new(ActiveRecord::ActiveRecordError)
+    ActiveRecord.const_set('DependencyError', klass)
+
+    base.class_eval do
+      class << self
+        alias_method_chain :has_one, :protect
+        alias_method_chain :has_many, :protect
+        alias_method_chain :has_and_belongs_to_many, :protect
+      end
+    end
+  end
+
+  module ClassMethods
+    # We should be aliasing configure_dependency_for_has_many but that method
+    # is private so we can't. We alias has_many instead trying to be as fair
+    # as we can to the original behaviour.
+    def has_one_with_protect(association_id, options = {}, &extension) #:nodoc:
+      reflection = create_reflection(:has_one, association_id, options, self)
+      add_dependency_callback!(reflection, options)
+      has_one_without_protect(association_id, options, &extension)
+    end
+
+    def has_many_with_protect(association_id, options = {}, &extension) #:nodoc:
+      reflection = create_reflection(:has_many, association_id, options, self)
+      add_dependency_callback!(reflection, options)
+      has_many_without_protect(association_id, options, &extension)
+    end
+
+    def has_and_belongs_to_many_with_protect(association_id, options = {}, &extension)
+      reflection = create_reflection(:has_and_belongs_to_many, association_id, options, self)
+      add_dependency_callback!(reflection, options)
+      has_and_belongs_to_many_without_protect(association_id, options, &extension)
+    end
+
+    private
+    def add_dependency_callback!(reflection, options)
+      # This would break if has_many :dependent behaviour changes. One
+      # solution is removing both the second when and the else branches but
+      # the exception message wouldn't be exact.
+      condition = if reflection.collection?
+        "record.#{reflection.name}.empty?"
+      else
+        "record.#{reflection.name}.nil?"
+      end
+
+      case reflection.options[:dependent]
+      when :rollback
+        options.delete(:dependent)
+        module_eval "before_destroy, :protect_rollback, :unless => proc{ |record| #{condition} }"
+      when :raise
+        options.delete(:dependent)
+        error = reflection.collection? ? dependency_error(reflection) : "Cannot remove as the associated object is dependent on this."
+        module_eval <<-METHOD
+def protect_raise_#{reflection.name}
+  raise ActiveRecord::DependencyError, "#{error}"
+end
+METHOD
+        module_eval "before_destroy :protect_raise_#{reflection.name}, :unless => proc{ |record| #{condition} }"
+      end
+    end
+
+    def protect_rollback
+      raise ActiveRecord::Rollback
+    end
+
+    def dependency_error(reflection)
+      # TODO: gotta be a more easier approach!
+      count_code = "#{reflection.name}.count"
+      first_five_code = reflection.name.to_s+'.first(5).map{|o| "#{o.id}: #{o.to_s}"}'
+      DESTROY_PROTECT_ERROR_MESSAGE.
+        gsub('dependent_type', reflection.class_name.to_s.underscore.gsub('_', ' ').pluralize).
+        gsub('dependent_examples', '#{(' + first_five_code + ' + [("...and #{' + count_code + ' - 5} more" if ' + count_code + ' > 5)]).join("\n")}').
+        gsub('dependent_count', '#{' + count_code + '}').
+        gsub('dependee_type', '#{self.class.to_s.underscore.gsub(\'_\', \' \')}').
+        gsub('dependee', '#{self}')
+    end
+
+  end
+end
+
+
+ActiveRecord::Base.send(:include, DependentProtect)

data/spec/dependent_protect_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+DB_FILE = 'tmp/test_db'
+FileUtils.mkdir_p File.dirname(DB_FILE)
+FileUtils.rm_f DB_FILE
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => DB_FILE
+
+load 'spec/schema.rb'
+
+class OrderInvoice < ActiveRecord::Base
+  belongs_to :order
+end
+
+class Order < ActiveRecord::Base
+  belongs_to :category
+  has_one :order_invoice, :dependent => :raise
+end
+
+class Category < ActiveRecord::Base
+  has_many :orders, :dependent => :raise
+end
+
+describe DependentProtect do
+  it 'should restrict has_many relationships' do
+    category = Category.create!
+    order = Order.create!(:category => category)
+    lambda{category.reload.destroy}.should raise_error(ActiveRecord::DependencyError)
+
+    order.destroy
+    lambda{category.reload.destroy}.should_not raise_error
+  end
+
+  it 'should restrict has_one relationships' do
+    order = Order.create!
+    order_invoice = OrderInvoice.create!(:order => order)
+    lambda{order.reload.destroy}.should raise_error(ActiveRecord::DependencyError)
+
+    order_invoice.destroy
+    lambda{order.reload.destroy}.should_not raise_error
+  end
+end
+

data/spec/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :categories do |t|
+  end
+
+  create_table :order_invoices do |t|
+    t.integer :order_id
+  end
+
+  create_table :orders do |t|
+    t.integer :category_id
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rubygems'
+require 'bundler/setup'
+require 'dependent_protect'
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  require 'simplecov-rcov'
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+  SimpleCov.start
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: dependent_protect
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Michael Noack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: This gem is not needed in Rails 3 as dependent => :raise is included
+  in 3.0.
+email: development@travellink.com.au
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dependent_protect.gemspec
+- lib/dependent_protect.rb
+- spec/dependent_protect_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: http://github.com/sealink/dependent_protect
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: dependent_protect
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 2
+summary: Add dependent protect/restrict functionality to ActiveRecord 2.x.
+test_files: []