class GraphQL::Schema::Validator::ExclusionValidator

Use this to specifically reject values from an argument.

Examples

Example: disallow certain values

argument :favorite_non_prime, Integer, required: true,
  validates: { exclusion: { in: [2, 3, 5, 7, ... ]} }

Public Class Methods

initialize(String message:, Array in:, **default_options)

Source

# File lib/graphql/schema/validator/exclusion_validator.rb, line 25
def initialize(message: "%{validated} is reserved", in:, **default_options)
  # `in` is a reserved word, so work around that
  @in_list = binding.local_variable_get(:in)
  @message = message
  super(**default_options)
end

Parameters

message (String)
in (Array) — The values to reject

Calls superclass method GraphQL::Schema::Validator::new

Public Instance Methods

validate (_object, _context, value)

Source

# File lib/graphql/schema/validator/exclusion_validator.rb, line 32
def validate(_object, _context, value)
  if permitted_empty_value?(value)
    # pass
  elsif validation_parameter(@in_list).include?(value)
    validation_parameter(@message)
  end
end