module Sequel::Plugins::AutoValidations

  1. lib/sequel/plugins/auto_validations.rb

The auto_validations plugin automatically sets up the following types of validations for your model columns:

  1. type validations for all columns

  2. not_null validations on NOT NULL columns (optionally, presence validations)

  3. unique validations on columns or sets of columns with unique indexes

  4. max length validations on string columns

To determine the columns to use for the type/not_null/max_length validations, the plugin looks at the database schema for the model’s table. To determine the unique validations, Sequel looks at the indexes on the table. In order for this plugin to be fully functional, the underlying database adapter needs to support both schema and index parsing. Additionally, unique validations are only added for models that select from a simple table, they are not added for models that select from a subquery or joined dataset.

This plugin uses the validation_helpers plugin underneath to implement the validations. It does not allow for any per-column validation message customization, but you can alter the messages for the given type of validation on a per-model basis (see the validation_helpers documentation).

You can skip certain types of validations from being automatically added via:

Model.skip_auto_validations(:not_null)

If you want to skip all auto validations (only useful if loading the plugin in a superclass):

Model.skip_auto_validations(:all)

It is possible to skip auto validations on a per-model-instance basis via:

instance.skip_auto_validations(:unique, :not_null) do
  puts instance.valid?
end

By default, the plugin uses a not_null validation for NOT NULL columns, but that can be changed to a presence validation using an option:

Model.plugin :auto_validations, not_null: :presence

This is useful if you want to enforce that NOT NULL string columns do not allow empty values.

You can also supply hashes to pass options through to the underlying validators:

Model.plugin :auto_validations, unique_opts: {only_if_modified: true}

This works for unique_opts, max_length_opts, schema_types_opts, explicit_not_null_opts, and not_null_opts.

If you only want auto_validations to add validations to columns that do not already have an error associated with them, you can use the skip_invalid option:

Model.plugin :auto_validations, skip_invalid: true

Usage:

# Make all model subclass use auto validations (called before loading subclasses)
Sequel::Model.plugin :auto_validations

# Make the Album class use auto validations
Album.plugin :auto_validations

Methods

Public Class

  1. apply
  2. configure

Constants

EMPTY_ARRAY = [].freeze  
EXPLICIT_NOT_NULL_OPTIONS = {:from=>:values, :allow_missing=>true}.freeze  
MAX_LENGTH_OPTIONS = {:from=>:values, :allow_nil=>true}.freeze  
NOT_NULL_OPTIONS = {:from=>:values}.freeze  
NO_NULL_BYTE_OPTIONS = MAX_LENGTH_OPTIONS  
SCHEMA_TYPES_OPTIONS = NOT_NULL_OPTIONS  
UNIQUE_OPTIONS = NOT_NULL_OPTIONS  

Public Class methods

apply(model, opts=OPTS)
[show source] 
   # File lib/sequel/plugins/auto_validations.rb
77 def self.apply(model, opts=OPTS)
78   model.instance_exec do
79     plugin :validation_helpers
80     @auto_validate_presence = false
81     @auto_validate_no_null_byte_columns = []
82     @auto_validate_not_null_columns = []
83     @auto_validate_explicit_not_null_columns = []
84     @auto_validate_max_length_columns = []
85     @auto_validate_unique_columns = []
86     @auto_validate_types = true
87 
88     @auto_validate_options = {
89         :no_null_byte=>NO_NULL_BYTE_OPTIONS,
90         :not_null=>NOT_NULL_OPTIONS,
91         :explicit_not_null=>EXPLICIT_NOT_NULL_OPTIONS,
92         :max_length=>MAX_LENGTH_OPTIONS,
93         :schema_types=>SCHEMA_TYPES_OPTIONS,
94         :unique=>UNIQUE_OPTIONS
95     }.freeze
96   end
97 end
configure(model, opts=OPTS)

Setup auto validations for the model if it has a dataset.

[show source] 
    # File lib/sequel/plugins/auto_validations.rb
100 def self.configure(model, opts=OPTS)
101   model.instance_exec do
102     setup_auto_validations if @dataset
103     if opts[:not_null] == :presence
104       @auto_validate_presence = true
105     end
106 
107     h = @auto_validate_options.dup
108     [:not_null, :explicit_not_null, :max_length, :no_null_byte, :schema_types, :unique].each do |type|
109       if type_opts = opts[:"#{type}_opts"]
110         h[type] = h[type].merge(type_opts).freeze
111       end
112     end
113 
114     if opts[:skip_invalid]
115       [:not_null, :explicit_not_null, :no_null_byte, :max_length, :schema_types].each do |type|
116         h[type] = h[type].merge(:skip_invalid=>true).freeze
117       end
118     end
119 
120     @auto_validate_options = h.freeze
121   end
122 end