Module: Flows::Plugin::OutputContract::DSL

Defined in:
lib/flows/plugin/output_contract/dsl.rb

Overview

DSL for OutputContract plugin.

Since:

  • 0.4.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#failure_contracts ⇒ Object (readonly)

Hash of contracts for failure results.

Since:

  • 0.4.0



10
11
12
 
# File 'lib/flows/plugin/output_contract/dsl.rb', line 10

def failure_contracts
  @failure_contracts
end

#success_contracts ⇒ Object (readonly)

Hash of contracts for successful results.

Since:

  • 0.4.0



7
8
9
 
# File 'lib/flows/plugin/output_contract/dsl.rb', line 7

def success_contracts
  @success_contracts
end

Instance Method Details

#failure_with(status, &contract_block) ⇒ Object

Defines a contract for a failure result with specific status.

Parameters:

  • status (Symbol) —

    Corresponding result status.

  • contract_block (Proc) —

    This block will be passed to Contract.make to get a contract.

Since:

  • 0.4.0



30
31
32
 
# File 'lib/flows/plugin/output_contract/dsl.rb', line 30

def failure_with(status, &contract_block)
  failure_contracts[status] = Flows::Contract.make(&contract_block)
end

#success_with(status, &contract_block) ⇒ Object

Defines a contract for a successful result with specific status.

Parameters:

  • status (Symbol) —

    Corresponding result status.

  • contract_block (Proc) —

    This block will be passed to Contract.make to get a contract.

Since:

  • 0.4.0



22
23
24
 
# File 'lib/flows/plugin/output_contract/dsl.rb', line 22

def success_with(status, &contract_block)
  success_contracts[status] = Flows::Contract.make(&contract_block)
end