rails_devs_for_data_integrity 0.1.3

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+tmp
+log/*

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [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

@@ -0,0 +1,36 @@
+RailsDevsForDataIntegrity
+=========================
+Rails Devs For Data Integrity catches unique key and foreign key violations
+coming from the  MySQLdatabase and converts them into an error on the
+ActiveRecord object similar to validation errors
+
+ class User < ActiveRecord::Base
+   handle_unique_key_violation  :user_name, :message => 'is taken"
+   handle_foreign_key_violation :primary_email_id, :message => 'is not available'
+ end
+
+Instead of this nasty MySQL foreign key error:
+ ActiveRecord::StatementInvalid: Mysql::Error: Cannot add or update a child row:
+ a foreign key constraint fails (`zoo_development/animals`,
+ CONSTRAINT `fk_animal_species` FOREIGN KEY (`species_id`)
+ REFERENCES `species` (`id`) ON DELETE SET NULL ON UPDATE CASCADE)
+
+ >> user.errors.on(:user_name)
+ => "association does not exist."
+
+Or in the case of a unique key violation:
+
+  >> user.errors.on(:primary_email_id)
+  => "is a duplicate."
+
+==== Developers
+* Blythe Dunham http://snowgiraffe.com
+
+=== Install
+* Rdoc:           http://snowgiraffe.com/rdocs/rails_devs_for_data_integrity
+* Github Project: http://github.com/blythedunham/rails_devs_for_data_integrity/tree/master
+* Install:        script/plugin install git://github.com/blythedunham/rails_devs_for_data_integrity.git
+
+
+
+Copyright (c) 2009 [name of plugin creator], released under the MIT license

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rails_devs_for_data_integrity"
+    gem.summary = %Q{Gracefully handles MySQL unique and foreign key violations by adding an error to the ActiveRecord object}
+    gem.description = %Q{Rails Devs For Data Integrity catches unique key and foreign key violations
+    coming from the  MySQLdatabase and converts them into an error on the
+    ActiveRecord object similar to validation errors
+    }
+    gem.email = "blythe@snowgiraffe.com"
+    gem.homepage = "http://github.com/blythedunham/rails_devs_for_data_integrity"
+    gem.authors = ["Blythe Dunham"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: 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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails_devs_for_data_integrity #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.3

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/lib/rails_devs_for_data_integrity'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/rails_devs_for_data_integrity.rb

@@ -0,0 +1,218 @@
+# Rails Devs For Data Integrity catches unique key and foreign key violations
+# coming from the  MySQLdatabase and converts them into an error on the
+# ActiveRecord object similar to validation errors
+#
+#  class User < ActiveRecord::Base
+#    handle_unique_key_violation  :user_name, :message => 'is taken"
+#    handle_foreign_key_violation :primary_email_id, :message => 'is not available'
+#  end
+#
+# Instead of this nasty MySQL foreign key error:
+#  ActiveRecord::StatementInvalid: Mysql::Error: Cannot add or update a child row:
+#  a foreign key constraint fails (`zoo_development/animals`,
+#  CONSTRAINT `fk_animal_species` FOREIGN KEY (`species_id`)
+#  REFERENCES `species` (`id`) ON DELETE SET NULL ON UPDATE CASCADE)
+#
+#  >> user.errors.on(:user_name)
+#  => "association does not exist."
+#
+# Or in the case of a unique key violation:
+#
+#   >> user.errors.on(:primary_email_id)
+#   => "is a duplicate."
+# ==== Developers
+# * Blythe Dunham http://snowgiraffe.com
+#
+# === Install
+# * Rdoc:           http://snowgiraffe.com/rdocs/rails_devs_for_data_integrity
+# * Github Project: http://github.com/blythedunham/rails_devs_for_data_integrity/tree/master
+# * Install:        script/plugin install git://github.com/blythedunham/rails_devs_for_data_integrity.git
+
+module ActiveRecord::RailsDevsForDataIntegrity
+
+  def self.included(base)#:nodoc
+    base.send :class_inheritable_hash, :unique_key_check_options
+    base.send :class_inheritable_hash, :foreign_key_check_options
+    base.send :attr_reader,            :duplicate_exception
+    base.send :attr_reader,            :foreign_key_exception
+
+    base.unique_key_check_options   = {}
+    base.foreign_key_check_options  = {}
+
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    # Handle a MySQL unique key violation by placing an error message on +name+
+    # Currently only one duplicate key per table is supported because no parsing support
+    # to determine the violating key
+    #
+    # +name+ - the field name of the duplicate key.
+    #
+    # == Options
+    # <tt>:message</tt> - custom message. Defaults 'is not unique'.
+    #
+    # == Example
+    #  class User < ActiveRecord::Base
+    #    handle_unique_key_violation :user_name, :message => 'is taken"
+    #  end
+    def handle_unique_key_violation(name, options={})
+      alias_data_integrity_methods
+      self.unique_key_check_options = options.merge(:field_name => name)
+    end
+
+    # Handle a MySQL foreign key violation by placing an error message on violating
+    # foreign key field
+    #
+    # +name+ - the field name of the duplicate key.
+    #
+    # == Options
+    # <tt>:message</tt> - custom message. Defaults 'association does not exist'.
+    #
+    # == Example
+    #  class User < ActiveRecord::Base
+    #    handle_foreign_key_violation :primary_email_id, :message => 'is does not exist"
+    #  end
+    def handle_foreign_key_violation(name, options={})
+      alias_data_integrity_methods
+      self.foreign_key_check_options = {name.to_sym => options}
+    end
+
+    # Handle a MySQL foreign key violations by placing an error message on violating
+    # foreign key field
+    #
+    # <tt>:message</tt> - custom message. Defaults 'association does not exist'.
+    #== Options
+    # Options are a hash of foreign_key field name to options (messages). Without options
+    # all violations use the default.
+    #
+    # == Example
+    #  class User < ActiveRecord::Base
+    #    handle_foreign_key_violations :primary_email_id => {:message => 'is does not exist"}
+    #  end
+    def handle_foreign_key_violations(options={})
+      self.foreign_key_check_options = options
+      alias_data_integrity_methods
+    end
+
+    protected
+
+    #alias insert and update methods
+    def alias_data_integrity_methods#:nodoc:
+      return if method_defined?(:create_or_update_without_data_integrity_check)
+      alias_method_chain :create_or_update, :data_integrity_check
+      alias_method_chain :save!, :data_integrity_check
+    end
+  end
+
+  # Add a duplicate error message to errors based on the exception
+  def add_unique_key_error(exception)
+    if unique_key_check_options[:field_name]
+      self.errors.add(unique_key_check_options[:field_name], unique_key_check_options[:message]||"is a duplicate.")
+    else
+      self.errors.add_to_base(unique_key_check_options[:message]||"Duplicate field.")
+    end
+  end
+
+    # Add a foreign key error message to errors based on the exception
+  def add_foreign_key_error(exception, foreign_key=nil)
+
+    foreign_key ||= foreign_key_from_error_message(exception)
+    message = foreign_key_check_options[foreign_key.to_sym][:message] if foreign_key_check_options[foreign_key.to_sym]
+    message ||= "association does not exist."
+
+    if self.class.column_names.include?(foreign_key.to_s)
+      self.errors.add(foreign_key, message)
+    else
+      self.errors.add_to_base(" #{foreign_key} #{message}")
+    end
+  end
+
+  # Return the foreign key name from the foreign key exception
+  def foreign_key_from_error_message(exception)
+    if (match = exception.to_s.match(/^Mysql::Error.*foreign key constraint fails.*FOREIGN KEY\s*\(`?([\w_]*)`?\)/))
+      return match[1].dup
+    end
+  end
+
+  # The classes unique key check options
+  def unique_key_check_options
+    self.class.unique_key_check_options
+  end
+
+  # The classes foreign key check options
+  def foreign_key_check_options
+    self.class.foreign_key_check_options
+  end
+
+  # If +exception+ is a unique key violation or a foreign key error,
+  # excute the block if it exists. If not and a record exists, add the
+  # appropriate error messages. Reraise any exceptions that are not data integrity violation errors
+  # Sometimes better to use +execute_with_data_integrity_check+ block
+  #
+  # +exception+ - Exception thrown from save (insert or update)
+  # +record+ - The activerecord object to add errors
+  #
+  # ===Example
+  #
+  # def save_safe
+  #   record = self
+  #   save
+  # rescue ActiveRecord::StatementInvalid => exception
+  #   handle_data_integrity_error(exception, record)
+  # end
+  def handle_data_integrity_error(exception, record=nil, &block)
+    @duplicate_exception = exception if exception.to_s =~ /^Mysql::Error: Duplicate entry/
+    @foreign_key_exception = exception if exception.to_s =~ /^Mysql::Error.*foreign key constraint fails /
+
+    if @duplicate_exception || @foreign_key_exception
+      if block
+        yield
+      elsif record
+        record.add_unique_key_error(exception)   if @duplicate_exception
+        record.add_foreign_key_error(exception)  if @foreign_key_exception
+        record
+      end
+    else
+      raise exception
+    end
+  end
+
+  # Executes the block and traps data integrity violations
+  # Populates the +record+ errors objects with an appropriate message if such violation occurs
+  #
+  # ===Example
+  #  def save_safe
+  #   execute_with_data_integrity_check(self) { save }
+  #  end
+  def execute_with_data_integrity_check(record = nil, &block)
+    @duplicate_exception = nil
+    @foreign_key_exception = nil
+    yield record
+    true
+  rescue ActiveRecord::StatementInvalid => exception
+    handle_data_integrity_error(exception, record)
+    return false
+  end
+
+  # do a create or update with data integrity check
+  def create_or_update_with_data_integrity_check(options={})
+    execute_with_data_integrity_check(self) do
+      return create_or_update_without_data_integrity_check
+    end
+  end
+
+  # save! with data integrity check
+  # RecordNotSaved will be thrown by save! before converting to the standard
+  # validation error ActiveRecord::RecordInvalid
+  def save_with_data_integrity_check!(*args)
+    unless save(*args)
+      raise ActiveRecord::RecordInvalid.new(self) if @duplicate_exception||@foreign_key_exception
+      raise ActiveRecord::RecordNotSaved 
+    end
+    true
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::RailsDevsForDataIntegrity
+

data/rails_devs_for_data_integrity.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rails_devs_for_data_integrity}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Blythe Dunham"]
+  s.date = %q{2009-12-17}
+  s.description = %q{Rails Devs For Data Integrity catches unique key and foreign key violations
+    coming from the  MySQLdatabase and converts them into an error on the
+    ActiveRecord object similar to validation errors
+    }
+  s.email = %q{blythe@snowgiraffe.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "install.rb",
+     "lib/rails_devs_for_data_integrity.rb",
+     "rails_devs_for_data_integrity.gemspec",
+     "tasks/rails_devs_for_data_integrity_tasks.rake",
+     "test/rails_devs_for_data_integrity_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/blythedunham/rails_devs_for_data_integrity}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Gracefully handles MySQL unique and foreign key violations by adding an error to the ActiveRecord object}
+  s.test_files = [
+    "test/rails_devs_for_data_integrity_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<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/tasks/rails_devs_for_data_integrity_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_devs_for_data_integrity do
+#   # Task goes here
+# end

data/test/rails_devs_for_data_integrity_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class RailsDevsForDataIntegrityTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: rails_devs_for_data_integrity
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- Blythe Dunham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-17 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "Rails Devs For Data Integrity catches unique key and foreign key violations\n    coming from the  MySQLdatabase and converts them into an error on the\n    ActiveRecord object similar to validation errors\n    "
+email: blythe@snowgiraffe.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/rails_devs_for_data_integrity.rb
+- rails_devs_for_data_integrity.gemspec
+- tasks/rails_devs_for_data_integrity_tasks.rake
+- test/rails_devs_for_data_integrity_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/blythedunham/rails_devs_for_data_integrity
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Gracefully handles MySQL unique and foreign key violations by adding an error to the ActiveRecord object
+test_files: 
+- test/rails_devs_for_data_integrity_test.rb
+- test/test_helper.rb