Class: ArrayInclusionValidator

Inherits:
ActiveModel::EachValidator
  • Object
show all
Defined in:
app/validators/array_inclusion_validator.rb

Overview

Like the default Rails inclusion validator, but the built-in Rails validator won’t work on an array of things.

So if you have an array of primitive values, you can use this to validate that all elements of the array are in the inclusion list.

Or that all the elements of the array are whatever you want, by supplying a proc that returns false for bad values.

Empty arrays are always allowed, add a presence validator if you don’t want to allow them, eg ‘validates :genre, presence: true, array_inclusion: { in: whatever }`

Custom message can interpolate ‘rejected_values` value. (Should also work for i18n)

Note: There isn’t currently a great way to show primitive array validation errors on a form for an invalid edit, the validation error can only be shown as if for the entire array field, not the individual invalid edit. You might consider modelling as a compound Model with only one attribute instead of as a primitive.

Examples:

class Work < Kithe::Work
  attr_json :genre, :string, array: true
  validates :genre, array_inclusion: { in: ALLOWED_GENRES  }
  validates :genre, array_inclusion: { proc: ->(val) { val =~ /\d+/ } }
  #...
validates :genre, array_inclusion: { in: ALLOWED_GENRES, message: "option %{rejected_values} not allowed"  }

Instance Method Summary collapse

Instance Method Details

#validate_each(record, attribute, value) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'app/validators/array_inclusion_validator.rb', line 30

def validate_each(record, attribute, value)
  values = value || []
  not_allowed_values = []


  if options[:in]
    not_allowed_values.concat(values - options[:in])
  end

  if options[:proc]
    not_allowed_values.concat(values.find_all { |v| ! options[:proc].call(v) })
  end

  unless not_allowed_values.blank?
    formatted_rejected = not_allowed_values.uniq.collect(&:inspect).join(",")
    record.errors.add(attribute, :inclusion, **options.except(:in).merge!(rejected_values: formatted_rejected, value: value))
  end
end