rails_devs_for_data_integrity 0.1.4 → 0.1.5

data/CHANGELOG

@@ -0,0 +1,14 @@
+0.1.5 (2009-12-23)
+* Changed:  Il8n support for error messages
+* Changed:  Generate error messages for unique key violations based on the fields/columns derived from the mysql exception
+* Changed:  handle_unique_key_violation takes a scope parameter for unique keys across multiple columns
+			handle_unique_key_violation :field1, :scope => [:field2]
+
+0.1.4 (2009-12-17)
+* Changed:  handle_unique_key_violation can take several key arguments
+            handle_unique_key_violation :field1, :field2
+* Changed:  method to handle all violations by default: ActiveRecord::Base.enable_all_database_violation_checks
+
+0.1.3 (2009-12-16)
+* Changed:  Create a gem spec
+* Fixed:    Fix plugin to work with rails 2.0

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/lib/rails_devs_for_data_integrity.rb

@@ -33,12 +33,19 @@ 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 :class_inheritable_hash, :default_violation_messages
+
     base.send :attr_reader,            :duplicate_exception
     base.send :attr_reader,            :foreign_key_exception
 
     base.unique_key_check_options   = {}
     base.foreign_key_check_options  = {}
-
+    base.default_violation_messages = {
+      :taken           => 'has already been taken',
+      :taken_multiple  => "has already been taken for {{context}}",
+      :taken_generic   => 'Duplicate field.',
+      :foreign_key     => "association does not exist."
+    }
     base.extend ClassMethods
   end
 
@@ -60,9 +67,12 @@ module ActiveRecord::RailsDevsForDataIntegrity
       alias_data_integrity_methods
       options = args.extract_options! || {}
       options.symbolize_keys!
-
       args.each do |name|
-        self.unique_key_check_options[ name.to_sym ]= options.merge(:field_name => name)
+        self.unique_key_check_options[ name.to_sym ]= options.merge(
+          :field_name => name.to_s,
+          :columns => [name.to_s].
+            concat( (options[:scope]||[]).collect(&:to_s) ).uniq.sort
+        )
       end
     end
 
@@ -115,33 +125,78 @@ module ActiveRecord::RailsDevsForDataIntegrity
     end
   end
 
-  # Add a duplicate error message to errors based on the exception
-  def add_unique_key_error(exception)
-    unless unique_key_check_options.blank?
-      # we are not sure which violation occurred if we have multiple entries
-      # since mysql does not return a good error message
-      # add them all
-      unique_key_check_options.each do |name, options|
-        self.errors.add(options[:field_name], options[:message]||"has already been taken.")
-      end
+  def default_error_message_for_violation( violation_type, columns )#:nodoc:
+    message_key = if violation_type == :foreign_key
+      :foreign_key
     else
-      unique_key_check_options.keys
-      self.errors.add_to_base(unique_key_check_options[:message]||"Duplicate field.")
+      case columns.length
+        when 0 then :taken_generic
+        when 1 then :taken
+        else :taken_multiple
+      end
     end
+    I18n.translate(
+      :"activerecord.errors.messages.#{message_key}",
+      :default => default_violation_messages[ message_key ],
+      :context => columns.slice(1..-1).join('/')
+    )
   end
 
-    # Add a foreign key error message to errors based on the exception
-  def add_foreign_key_error(exception, foreign_key=nil)
+  # Custom error messages set with handle_violation
+  def custom_error_message_for_violation( violation_type, columns )#:nodoc:
+    options = send(
+      "#{violation_type}_check_options"
+    )[ columns.first.to_sym ] if columns.any?
+
+    message = case options[:message]
+      when Symbol then Il8n.translate( options[:message] )
+      else options[:message]
+    end unless options.blank?
+  end
+
+  # Return the error message
+  def error_message_for_violation( violation_type, columns )#:nodoc:
+    message = custom_error_message_for_violation( violation_type, columns )
+    message ||= default_error_message_for_violation( violation_type, columns )
+  end
 
-    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."
+  def add_errors_for_violation( violation_type, columns )
+    columns = [columns].flatten.compact
+    message = error_message_for_violation( violation_type, columns )
 
-    if self.class.column_names.include?(foreign_key.to_s)
-      self.errors.add(foreign_key, message)
+    if columns.blank?
+      self.errors.add_to_base( message )
     else
-      self.errors.add_to_base(" #{foreign_key} #{message}")
+      self.errors.add( columns.first, message )
+    end
+  end
+
+  def index_for_record_not_unique(exception) #:nodoc:
+    case exception.message
+      when /Duplicate entry.*for key (\d+)/
+        index_position = $1.to_i
+        # minus two b/c mysql message is one-based + rails excludes primary key index from indexes list
+        ActiveRecord::Base.connection.indexes(self.class.table_name)[index_position - 2]
+      when /Duplicate entry.*for key '(\w+)'/
+        index_name = $1
+        ActiveRecord::Base.connection.indexes(self.class.table_name).detect { |i| i.name == index_name }
+    end
+  end
+  
+  
+  # Add a duplicate error message to errors based on the exception
+  def add_unique_key_error( exception, columns = nil )
+    columns ||= begin
+      index = index_for_record_not_unique( exception )
+      index.columns if index
     end
+    add_errors_for_violation( :unique_key, columns )
+  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 )
+    add_errors_for_violation( :foreign_key, foreign_key )
   end
 
   # Return the foreign key name from the foreign key exception

data/rails_devs_for_data_integrity.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_devs_for_data_integrity}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   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.date = %q{2009-12-23}
   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
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
+     "CHANGELOG",
      "MIT-LICENSE",
      "README",
      "Rakefile",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_devs_for_data_integrity
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Blythe Dunham
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-17 00:00:00 -08:00
+date: 2009-12-23 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,7 @@ extra_rdoc_files:
 - README
 files: 
 - .gitignore
+- CHANGELOG
 - MIT-LICENSE
 - README
 - Rakefile