Class: Cuprum::Collections::Basic::Commands::ValidateOne
- Inherits:
-
Cuprum::Collections::Basic::Command
- Object
- Cuprum::Command
- Command
- Cuprum::Collections::Basic::Command
- Cuprum::Collections::Basic::Commands::ValidateOne
- Defined in:
- lib/cuprum/collections/basic/commands/validate_one.rb
Overview
Command for validating a collection entity.
Instance Attribute Summary
Attributes inherited from Cuprum::Collections::Basic::Command
#collection_name, #data, #default_contract, #member_name, #options, #primary_key_name, #primary_key_type
Instance Method Summary collapse
-
#call(entity: , contract: nil) ⇒ Cuprum::Result<Hash>
Validates the entity against the given or default contract.
Methods inherited from Cuprum::Collections::Basic::Command
Constructor Details
This class inherits a constructor from Cuprum::Collections::Basic::Command
Instance Method Details
#call(entity: , contract: nil) ⇒ Cuprum::Result<Hash>
Validates the entity against the given or default contract.
If the entity matches the contract, #call will return a passing result with the entity as the result value. If the entity does not match the contract, #call will return a failing result with a FailedValidation error and the validation errors.
27 28 29 30 31 32 33 |
# File 'lib/cuprum/collections/basic/commands/validate_one.rb', line 27 validate_parameters :call do keyword :contract, Stannum::Constraints::Base, optional: true keyword :entity, Stannum::Constraints::Types::HashWithStringKeys.new end |