module SchemaValidations
module ActiveRecord
module Validations
def self.extended(base) # :nodoc:
base.class_eval do
define_method :load_schema_validations do
self.class.send :load_schema_validations
end
class_attribute :schema_validations_loaded
end
class << base
alias_method_chain :validators, :schema_validations
alias_method_chain :validators_on, :schema_validations
end if base.respond_to? :validators
end
def inherited(klass) # :nodoc:
super
before_validation :load_schema_validations unless schema_validations_loaded?
end
def validators_with_schema_validations
load_schema_validations unless schema_validations_loaded?
validators_without_schema_validations
end
def validators_on_with_schema_validations(*args)
load_schema_validations unless schema_validations_loaded?
validators_on_without_schema_validations(*args)
end
# Per-model override of Config options. Use via, e.g.
# class MyModel < ActiveRecord::Base
# schema_validations :auto_create => false
# end
#
# If :auto_create is not specified, it is implicitly
# specified as true. This allows the "non-invasive" style of using
# SchemaValidations in which you set the global Config to
# auto_create = false, then in any model that you want auto
# validations you simply do:
#
# class MyModel < ActiveRecord::Base
# schema_validations
# end
#
# Of course other options can be passed, such as
#
# class MyModel < ActiveRecord::Base
# schema_validations :except_type => :validates_presence_of
# end
#
#
def schema_validations(opts={})
@schema_validations_config = SchemaValidations.config.merge({:auto_create => true}.merge(opts))
end
def schema_validations_config # :nodoc:
@schema_validations_config ||= SchemaValidations.config.dup
end
private
# Adds schema-based validations to model.
# Attributes as well as associations are validated.
# For instance if there is column
#
# email NOT NULL
#
# defined at database-level it will be translated to
#
# validates_presence_of :email
#
# If there is an association named user
# based on user_id NOT NULL it will be translated to
#
# validates_presence_of :user
#
# Note it uses the name of association (user) not the column name (user_id).
# Only belongs_to associations are validated.
#
# This accepts following options:
# * :only - auto-validate only given attributes
# * :except - auto-validate all but given attributes
#
def load_schema_validations #:nodoc:
# Don't bother if: it's already been loaded; the class is abstract; not a base class; or the table doesn't exist
return unless create_schema_validations?
load_column_validations
load_association_validations
self.schema_validations_loaded = true
end
def load_column_validations #:nodoc:
content_columns.each do |column|
name = column.name.to_sym
# Data-type validation
datatype = case
when respond_to?(:defined_enums) && defined_enums.has_key?(column.name) then :enum
when column.type == :integer then :integer
when column.number? then :numeric
when column.text? then :text
when column.type == :boolean then :boolean
end
case datatype
when :integer
load_integer_column_validations(name, column)
when :numeric
validate_logged :validates_numericality_of, name, :allow_nil => true
when :text
validate_logged :validates_length_of, name, :allow_nil => true, :maximum => column.limit if column.limit
end
# NOT NULL constraints
if column.required_on
if datatype == :boolean
validate_logged :validates_inclusion_of, name, :in => [true, false], :message => :blank
else
validate_logged :validates_presence_of, name
end
end
# UNIQUE constraints
add_uniqueness_validation(column) if column.unique?
end
end
def load_integer_column_validations(name, column) # :nodoc:
options = { :allow_nil => true, :only_integer => true }
range = column.cast_type.send(:range)
options[:greater_than_or_equal_to] = range.begin
if range.exclude_end?
options[:less_than] = range.end
else
options[:less_than_or_equal_to] = range.end
end
validate_logged :validates_numericality_of, name, options
end
def load_association_validations #:nodoc:
reflect_on_all_associations(:belongs_to).each do |association|
# :primary_key_name was deprecated (noisily) in rails 3.1
foreign_key_method = (association.respond_to? :foreign_key) ? :foreign_key : :primary_key_name
column = columns_hash[association.send(foreign_key_method).to_s]
next unless column
# NOT NULL constraints
validate_logged :validates_presence_of, association.name if column.required_on
# UNIQUE constraints
add_uniqueness_validation(column) if column.unique?
end
end
def add_uniqueness_validation(column) #:nodoc:
scope = column.unique_scope.map(&:to_sym)
name = column.name.to_sym
options = {}
options[:scope] = scope if scope.any?
options[:allow_nil] = true
options[:case_sensitive] = false if has_case_insensitive_index?(column, scope)
options[:if] = (proc do |record|
if scope.all? { |scope_sym| record.public_send(:"#{scope_sym}?") }
record.public_send(:"#{column.name}_changed?")
else
false
end
end)
validate_logged :validates_uniqueness_of, name, options
end
def has_case_insensitive_index?(column, scope)
indexed_columns = (scope + [column.name]).map(&:to_sym).sort
index = column.indexes.select { |i| i.unique && i.columns.map(&:to_sym).sort == indexed_columns }.first
index && index.respond_to?(:case_sensitive?) && !index.case_sensitive?
end
def create_schema_validations? #:nodoc:
schema_validations_config.auto_create? && !(schema_validations_loaded || abstract_class? || name.blank? || !table_exists?)
end
def validate_logged(method, arg, opts={}) #:nodoc:
if _filter_validation(method, arg)
msg = "[schema_validations] #{self.name}.#{method} #{arg.inspect}"
msg += ", #{opts.inspect[1...-1]}" if opts.any?
logger.debug msg
send method, arg, opts
end
end
def _filter_validation(macro, name) #:nodoc:
config = schema_validations_config
types = [macro]
if match = macro.to_s.match(/^validates_(.*)_of$/)
types << match[1].to_sym
end
return false if config.only and not Array.wrap(config.only).include?(name)
return false if config.except and Array.wrap(config.except).include?(name)
return false if config.only_type and not (Array.wrap(config.only_type) & types).any?
return false if config.except_type and (Array.wrap(config.except_type) & types).any?
return true
end
end
end
end