Sha256: 474ec8ed12bdfa2c76f43acf10cfea9576b31a54a42e2b99c554a6fb812bce93
Contents?: true
Size: 1.84 KB
Versions: 34
Compression:
Stored size: 1.84 KB
Contents
# Mixin for the {RailsOps::Operation} class that provides a simple way of
# validation the params hash against a specific schema. It internally uses
# policies for running the validations (see {RailsOps::Mixins::Policies}).
module RailsOps::Mixins::SchemaValidation
extend ActiveSupport::Concern
included do
class_attribute :_op_schema
self._op_schema = nil
class_attribute :_skip_op_schema_validation
self._skip_op_schema_validation = false
end
module ClassMethods
# Creates a policy to validate the params hash against the given schema. See
# {Schemacop::Validator} for more information on how schemas are built.
#
# Schemas are always validated on instantiation and, using defaults and
# casts, can also alter the params hash assigned to the operation.
#
# Only one schema can be active at a time. Defining multiple schemata or
# defining schemas in a subclass always override previously defined schemas.
#
# @param *args [Array] Parameters to pass at schema initialization
# @yield Block to pass at schema initialization
def schema2(*args, &block)
self._op_schema = Schemacop::Schema.new(*args, &block)
end
def schema3(type = :hash, *args, **kwargs, &block)
self._op_schema = Schemacop::Schema3.new(type, *args, **kwargs, &block)
end
def schema(*args, &block)
case RailsOps.config.default_schemacop_version
when 2
schema2(*args, &block)
when 3
schema3(*args, &block)
else
fail 'Schemacop schema versions supported are 2 and 3.'
end
end
# Skips the schema validation, even if a schema is defined. This allows you
# to manually call `validate_op_schema!`, i.e. inside of your `perform`
# method.
def skip_schema_validation(skip = true)
self._skip_op_schema_validation = skip
end
end
end
Version data entries
34 entries across 34 versions & 1 rubygems