abstract class Avram::Operation
- Avram::Operation
- Reference
- Object
Included Modules
- Avram::Callbacks
- Avram::DefineAttribute
- Avram::NeedyInitializer
- Avram::OperationErrors
- Avram::ParamKeyOverride
- Avram::Validations
Defined in:
avram/operation.crConstant Summary
-
ATTRIBUTES =
[] of Nil
-
OPERATION_NEEDS =
[] of Nil
Constructors
Class Method Summary
- .param_key : String
-
.run(params : Avram::Paramable, *args, **named_args, &)
Yields the instance of the operation, and the return value from the
#run
instance method. -
.run(*args, **named_args, &)
Yields the instance of the operation, and the return value from the
#run
instance method. -
.run!(params : Avram::Paramable, *args, **named_args)
Returns the value from the
#run
instance method. -
.run!(*args, **named_args)
Returns the value from the
#run
instance method.
Instance Method Summary
- #after_run(_value)
- #before_run
- #custom_errors : Hash(Symbol, Array(String))
- #params : Avram::Paramable
- #run
-
#valid? : Bool
Returns
true
if all attributes are valid, and there's no custom errors
Macro Summary
Instance methods inherited from module Avram::OperationErrors
add_error(key : Symbol, message : String) : Nil
add_error,
errors : Hash(Symbol, Array(String))
errors
Instance methods inherited from module Avram::Validations
validate_acceptance_of(attribute : Avram::Attribute(Bool), message : Avram::Attribute::ErrorMessage = Avram.settings.i18n_backend.get(:validate_acceptance_of)) : Bool
validate_acceptance_of,
validate_at_most_one_filled(*attributes, message : Avram::Attribute::ErrorMessage = Avram.settings.i18n_backend.get(:validate_at_most_one_filled)) : Bool
validate_at_most_one_filled,
validate_confirmation_of(attribute : Avram::Attribute(T), with confirmation_attribute : Avram::Attribute(T), message : Avram::Attribute::ErrorMessage = Avram.settings.i18n_backend.get(:validate_confirmation_of)) : Bool forall T
validate_confirmation_of,
validate_exactly_one_filled(*attributes, message : Avram::Attribute::ErrorMessage = Avram.settings.i18n_backend.get(:validate_exactly_one_filled)) : Bool
validate_exactly_one_filled,
validate_format_of(attribute : Avram::Attribute(String), with regex : Regex, match : Bool = true, message : Avram::Attribute::ErrorMessage = Avram.settings.i18n_backend.get(:validate_format_of), allow_nil : Bool = false) : Bool
validate_format_of,
validate_inclusion_of(attribute : Avram::Attribute(T), in allowed_values : Enumerable(T), message : Avram::Attribute::ErrorMessage = Avram.settings.i18n_backend.get(:validate_inclusion_of), allow_nil : Bool = false) : Bool forall T
validate_inclusion_of,
validate_numeric(attribute : Avram::Attribute(Number), greater_than = nil, less_than = nil, message = nil, allow_nil : Bool = false) : Boolvalidate_numeric(attribute : Avram::Attribute(Number), *, at_least = nil, no_more_than = nil, message = nil, allow_nil : Bool = false) : Bool validate_numeric, validate_required(*attributes, message : Avram::Attribute::ErrorMessage = Avram.settings.i18n_backend.get(:validate_required)) : Bool validate_required, validate_size_of(attribute : Avram::Attribute(String) | Avram::Attribute(Array(T)), min : Number | Nil = nil, max : Number | Nil = nil, message : Avram::Attribute::ErrorMessage | Nil = nil, allow_nil : Bool = false) : Bool forall T
validate_size_of(attribute : Avram::Attribute(String) | Avram::Attribute(Array(T)), *, is exact_size : Number, message : Avram::Attribute::ErrorMessage = Avram.settings.i18n_backend.get(:validate_exact_size_of), allow_nil : Bool = false) : Bool forall T validate_size_of
Instance methods inherited from module Avram::DefineAttribute
attributes
attributes
Instance methods inherited from class Object
blank_for_validates_required? : Bool
blank_for_validates_required?
Constructor Detail
Class Method Detail
Yields the instance of the operation, and the return value from
the #run
instance method.
MyOperation.run(params) do |operation, value|
# operation is complete
end
Yields the instance of the operation, and the return value from
the #run
instance method.
MyOperation.run do |operation, value|
# operation is complete
end
Returns the value from the #run
instance method.
or raise Avram::FailedOperation
if the operation fails.
value = MyOperation.run!(params)
Returns the value from the #run
instance method.
or raise Avram::FailedOperation
if the operation fails.
value = MyOperation.run!
Instance Method Detail
Returns true
if all attributes are valid,
and there's no custom errors