| Module | Sequel::Plugins::ValidationHelpers::InstanceMethods |
| In: |
lib/sequel/plugins/validation_helpers.rb
|
Check that the attribute values are the given exact length.
# File lib/sequel/plugins/validation_helpers.rb, line 96
96: def validates_exact_length(exact, atts, opts={})
97: validatable_attributes_for_type(:exact_length, atts, opts){|a,v,m| validation_error_message(m, exact) if v.nil? || v.length != exact}
98: end
Check the string representation of the attribute value(s) against the regular expression with.
# File lib/sequel/plugins/validation_helpers.rb, line 101
101: def validates_format(with, atts, opts={})
102: validatable_attributes_for_type(:format, atts, opts){|a,v,m| validation_error_message(m, with) unless v.to_s =~ with}
103: end
Check attribute value(s) is included in the given set.
# File lib/sequel/plugins/validation_helpers.rb, line 106
106: def validates_includes(set, atts, opts={})
107: validatable_attributes_for_type(:includes, atts, opts){|a,v,m| validation_error_message(m, set) unless set.send(set.respond_to?(:cover?) ? :cover? : :include?, v)}
108: end
Check attribute value(s) string representation is a valid integer.
# File lib/sequel/plugins/validation_helpers.rb, line 111
111: def validates_integer(atts, opts={})
112: validatable_attributes_for_type(:integer, atts, opts) do |a,v,m|
113: begin
114: Kernel.Integer(v.to_s)
115: nil
116: rescue
117: validation_error_message(m)
118: end
119: end
120: end
Check that the attribute values length is in the specified range.
# File lib/sequel/plugins/validation_helpers.rb, line 123
123: def validates_length_range(range, atts, opts={})
124: validatable_attributes_for_type(:length_range, atts, opts){|a,v,m| validation_error_message(m, range) if v.nil? || !range.send(range.respond_to?(:cover?) ? :cover? : :include?, v.length)}
125: end
Check that the attribute values are not longer than the given max length.
Accepts a :nil_message option that is the error message to use when the value is nil instead of being too long.
# File lib/sequel/plugins/validation_helpers.rb, line 131
131: def validates_max_length(max, atts, opts={})
132: validatable_attributes_for_type(:max_length, atts, opts){|a,v,m| v ? validation_error_message(m, max) : validation_error_message(opts[:nil_message] || DEFAULT_OPTIONS[:max_length][:nil_message]) if v.nil? || v.length > max}
133: end
Check that the attribute values are not shorter than the given min length.
# File lib/sequel/plugins/validation_helpers.rb, line 136
136: def validates_min_length(min, atts, opts={})
137: validatable_attributes_for_type(:min_length, atts, opts){|a,v,m| validation_error_message(m, min) if v.nil? || v.length < min}
138: end
Check attribute value(s) are not NULL/nil.
# File lib/sequel/plugins/validation_helpers.rb, line 141
141: def validates_not_null(atts, opts={})
142: validatable_attributes_for_type(:not_null, atts, opts){|a,v,m| validation_error_message(m) if v.nil?}
143: end
Check that the attribute value(s) is not a string. This is generally useful in conjunction with raise_on_typecast_failure = false, where you are passing in string values for non-string attributes (such as numbers and dates). If typecasting fails (invalid number or date), the value of the attribute will be a string in an invalid format, and if typecasting succeeds, the value will not be a string.
# File lib/sequel/plugins/validation_helpers.rb, line 151
151: def validates_not_string(atts, opts={})
152: Sequel::Deprecation.deprecate('validates_not_string', "Please switch to validates_schema_types")
153: validatable_attributes_for_type(:not_string, atts, opts){|a,v,m| validation_error_message(m, (db_schema[a]||{})[:type]) if v.is_a?(String)}
154: end
Check attribute value(s) string representation is a valid float.
# File lib/sequel/plugins/validation_helpers.rb, line 157
157: def validates_numeric(atts, opts={})
158: validatable_attributes_for_type(:numeric, atts, opts) do |a,v,m|
159: begin
160: Kernel.Float(v.to_s)
161: nil
162: rescue
163: validation_error_message(m)
164: end
165: end
166: end
Check attribute value(s) is not considered blank by the database, but allow false values.
# File lib/sequel/plugins/validation_helpers.rb, line 195
195: def validates_presence(atts, opts={})
196: validatable_attributes_for_type(:presence, atts, opts){|a,v,m| validation_error_message(m) if model.db.send(:blank_object?, v) && v != false}
197: end
Validates for all of the model columns (or just the given columns) that the column value is an instance of the expected class based on the column‘s schema type.
# File lib/sequel/plugins/validation_helpers.rb, line 171
171: def validates_schema_types(atts=keys, opts={})
172: Array(atts).each do |k|
173: if type = schema_type_class(k)
174: validates_type(type, k, {:allow_nil=>true}.merge(opts))
175: end
176: end
177: end
Check if value is an instance of a class. If klass is an array, the value must be an instance of one of the classes in the array.
# File lib/sequel/plugins/validation_helpers.rb, line 181
181: def validates_type(klass, atts, opts={})
182: klass = klass.to_s.constantize if klass.is_a?(String) || klass.is_a?(Symbol)
183: validatable_attributes_for_type(:type, atts, opts) do |a,v,m|
184: if v.nil?
185: Sequel::Deprecation.deprecate('validates_type will no longer allow nil values by default in Sequel 4. Use the :allow_nil=>true option to allow nil values.')
186: next
187: end
188: if klass.is_a?(Array) ? !klass.any?{|kls| v.is_a?(kls)} : !v.is_a?(klass)
189: validation_error_message(m, klass)
190: end
191: end
192: end
Checks that there are no duplicate values in the database for the given attributes. Pass an array of fields instead of multiple fields to specify that the combination of fields must be unique, instead of that each field should have a unique value.
This means that the code:
validates_unique([:column1, :column2])
validates the grouping of column1 and column2 while
validates_unique(:column1, :column2)
validates them separately.
You can pass a block, which is yielded the dataset in which the columns must be unique. So if you are doing a soft delete of records, in which the name must be unique, but only for active records:
validates_unique(:name){|ds| ds.filter(:active)}
You should also add a unique index in the database, as this suffers from a fairly obvious race condition.
This validation does not respect the :allow_* options that the other validations accept, since it can deal with a grouping of multiple attributes.
Possible Options:
| :message : | The message to use (default: ‘is already taken’) |
| :only_if_modified : | Only check the uniqueness if the object is new or one of the columns has been modified. |
| :where : | A callable object where call takes three arguments, a dataset, the current object, and an array of columns, and should return a modified dataset that is filtered to include only rows with the same values as the current object for each column in the array. |
If you want to to a case insensitive uniqueness validation on a database that is case sensitive by default, you can use:
:where=>(proc do |ds, obj, cols|
ds.where(cols.map do |c|
v = obj.send(c)
v = v.downcase if v
[Sequel.function(:lower, c), v]
end)
end)
# File lib/sequel/plugins/validation_helpers.rb, line 241
241: def validates_unique(*atts)
242: opts = default_validation_helpers_options(:unique)
243: if atts.last.is_a?(Hash)
244: opts = opts.merge(atts.pop)
245: end
246: message = validation_error_message(opts[:message])
247: where = opts[:where]
248: atts.each do |a|
249: arr = Array(a)
250: next if arr.any?{|x| errors.on(x)}
251: next if opts[:only_if_modified] && !new? && !arr.any?{|x| changed_columns.include?(x)}
252: ds = if where
253: where.call(model.dataset, self, arr)
254: else
255: vals = arr.map{|x| send(x)}
256: next if vals.any?{|v| v.nil?}
257: model.where(arr.zip(vals))
258: end
259: ds = yield(ds) if block_given?
260: ds = ds.exclude(pk_hash) unless new?
261: errors.add(a, message) unless ds.count == 0
262: end
263: end