Module: Sequel::Plugins::ValidationHelpers::InstanceMethods
- Defined in:
- lib/sequel/plugins/validation_helpers.rb
Instance Method Summary collapse
-
#validates_exact_length(exact, atts, opts = {}) ⇒ Object
Check that the attribute values are the given exact length.
-
#validates_format(with, atts, opts = {}) ⇒ Object
Check the string representation of the attribute value(s) against the regular expression with.
-
#validates_includes(set, atts, opts = {}) ⇒ Object
Check attribute value(s) is included in the given set.
-
#validates_integer(atts, opts = {}) ⇒ Object
Check attribute value(s) string representation is a valid integer.
-
#validates_length_range(range, atts, opts = {}) ⇒ Object
Check that the attribute values length is in the specified range.
-
#validates_max_length(max, atts, opts = {}) ⇒ Object
Check that the attribute values are not longer than the given max length.
-
#validates_min_length(min, atts, opts = {}) ⇒ Object
Check that the attribute values are not shorter than the given min length.
-
#validates_not_string(atts, opts = {}) ⇒ Object
Check that the attribute value(s) is not a string.
-
#validates_numeric(atts, opts = {}) ⇒ Object
Check attribute value(s) string representation is a valid float.
-
#validates_presence(atts, opts = {}) ⇒ Object
Check attribute value(s) is not considered blank by the database, but allow false values.
-
#validates_type(klass, atts, opts = {}) ⇒ Object
Check if value is an instance of a class.
-
#validates_unique(*atts) ⇒ Object
Checks that there are no duplicate values in the database for the given attributes.
Instance Method Details
#validates_exact_length(exact, atts, opts = {}) ⇒ Object
Check that the attribute values are the given exact length.
64 65 66 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 64 def validates_exact_length(exact, atts, opts={}) validatable_attributes_for_type(:exact_length, atts, opts){|a,v,m| (m, exact) unless v && v.length == exact} end |
#validates_format(with, atts, opts = {}) ⇒ Object
Check the string representation of the attribute value(s) against the regular expression with.
69 70 71 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 69 def validates_format(with, atts, opts={}) validatable_attributes_for_type(:format, atts, opts){|a,v,m| (m, with) unless v.to_s =~ with} end |
#validates_includes(set, atts, opts = {}) ⇒ Object
Check attribute value(s) is included in the given set.
74 75 76 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 74 def validates_includes(set, atts, opts={}) validatable_attributes_for_type(:includes, atts, opts){|a,v,m| (m, set) unless set.include?(v)} end |
#validates_integer(atts, opts = {}) ⇒ Object
Check attribute value(s) string representation is a valid integer.
79 80 81 82 83 84 85 86 87 88 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 79 def validates_integer(atts, opts={}) validatable_attributes_for_type(:integer, atts, opts) do |a,v,m| begin Kernel.Integer(v.to_s) nil rescue (m) end end end |
#validates_length_range(range, atts, opts = {}) ⇒ Object
Check that the attribute values length is in the specified range.
91 92 93 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 91 def validates_length_range(range, atts, opts={}) validatable_attributes_for_type(:length_range, atts, opts){|a,v,m| (m, range) unless v && range.include?(v.length)} end |
#validates_max_length(max, atts, opts = {}) ⇒ Object
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.
99 100 101 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 99 def validates_max_length(max, atts, opts={}) validatable_attributes_for_type(:max_length, atts, opts){|a,v,m| v ? (m, max) : (opts[:nil_message] || DEFAULT_OPTIONS[:max_length][:nil_message]) unless v && v.length <= max} end |
#validates_min_length(min, atts, opts = {}) ⇒ Object
Check that the attribute values are not shorter than the given min length.
104 105 106 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 104 def validates_min_length(min, atts, opts={}) validatable_attributes_for_type(:min_length, atts, opts){|a,v,m| (m, min) unless v && v.length >= min} end |
#validates_not_string(atts, opts = {}) ⇒ Object
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.
114 115 116 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 114 def validates_not_string(atts, opts={}) validatable_attributes_for_type(:not_string, atts, opts){|a,v,m| (m, (db_schema[a]||{})[:type]) if v.is_a?(String)} end |
#validates_numeric(atts, opts = {}) ⇒ Object
Check attribute value(s) string representation is a valid float.
119 120 121 122 123 124 125 126 127 128 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 119 def validates_numeric(atts, opts={}) validatable_attributes_for_type(:numeric, atts, opts) do |a,v,m| begin Kernel.Float(v.to_s) nil rescue (m) end end end |
#validates_presence(atts, opts = {}) ⇒ Object
Check attribute value(s) is not considered blank by the database, but allow false values.
137 138 139 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 137 def validates_presence(atts, opts={}) validatable_attributes_for_type(:presence, atts, opts){|a,v,m| (m) if model.db.send(:blank_object?, v) && v != false} end |
#validates_type(klass, atts, opts = {}) ⇒ Object
Check if value is an instance of a class
131 132 133 134 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 131 def validates_type(klass, atts, opts={}) klass = klass.to_s.constantize if klass.is_a?(String) || klass.is_a?(Symbol) validatable_attributes_for_type(:type, atts, opts){|a,v,m| (m, klass) if v && !v.is_a?(klass)} end |
#validates_unique(*atts) ⇒ Object
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.
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/sequel/plugins/validation_helpers.rb', line 168 def validates_unique(*atts) opts = (:unique) if atts.last.is_a?(Hash) opts = opts.merge(atts.pop) end = (opts[:message]) atts.each do |a| arr = Array(a) next if opts[:only_if_modified] && !new? && !arr.any?{|x| changed_columns.include?(x)} ds = model.filter(arr.map{|x| [x, send(x)]}) ds = yield(ds) if block_given? ds = ds.exclude(pk_hash) unless new? errors.add(a, ) unless ds.count == 0 end end |