module Flows::Plugin::OutputContract::DSL
DSL
for OutputContract
plugin.
Constants
- SingletonVarsSetup
Attributes
failure_contracts[R]
Hash of contracts for failure results.
skip_output_contract_flag[R]
Is contract check and transformation disabled
success_contracts[R]
Hash of contracts for successful results.
Public Instance Methods
failure_with(status, &contract_block)
click to toggle source
Defines a contract for a failure result with specific status.
@param status [Symbol] Corresponding result status. @param contract_block [Proc] This block will be passed to {Contract.make} to get a contract.
# File lib/flows/plugin/output_contract/dsl.rb, line 35 def failure_with(status, &contract_block) failure_contracts[status] = Flows::Contract.make(&contract_block) end
skip_output_contract(enable: true)
click to toggle source
Disables contract check and transformation for current class and children.
@param enable [Boolean] if true - contracts are disabled
# File lib/flows/plugin/output_contract/dsl.rb, line 42 def skip_output_contract(enable: true) @skip_output_contract_flag = enable end
success_with(status, &contract_block)
click to toggle source
Defines a contract for a successful result with specific status.
@param status [Symbol] Corresponding result status. @param contract_block [Proc] This block will be passed to {Contract.make} to get a contract.
# File lib/flows/plugin/output_contract/dsl.rb, line 27 def success_with(status, &contract_block) success_contracts[status] = Flows::Contract.make(&contract_block) end