kit-contract
kit-contract

edge

kit-contract edge

InstantiableContract class
Kit::Contract::BuiltInContracts::InstantiableContract
View Source

Helper class to memoize Contract values.

Link to this section Summary ⚠️ Private APIs are currently hidden.

Inheritance: Object
Defined in: app/contracts/kit/contract/built_in_contracts/instantiable_contract.rb#4

Direct subclasses 12

And

Ensure all contracts are successful.
Array

Enable Contracts on Array instances, and on elements at specific indeces.
Delayed

The actual contract is wrapped in a Callable and resolved on `call`.
Eq

Ensure that the argument equals the saved Contract value.
Hash

Enable Contracts on Hash instances, on keys themselves, on values themselves, and on elements at specific keys.
In

Acts as an enum.
IsA

Ensure that the Contract value is of a given Type.
None

Ensure no contract is successful.
NotEq

Ensure that the argument is different from the Contract value.
Optional

Ensure that Contract is obeyed when not nil.
Or

Ensure at least one contract is successful.
RespondTo

Ensure that the object `respond_to?` a specific method.

Class methods 2

.[](*args)

Convenience use of the `[]` operator as an implicit `.new`.
.named(name)

Convenience Class method to generate a new Named contract.

Instance methods 8

#call

Run contracts.
#debug(args:)

When enabled, outputs the Contract arguments when called.
#get_meta

Meta accessor.
#initialize(state: nil, args: nil, bypass_setup: false) RUBYConstructor

The ctor allows for creation (`args`) && duplication (`state`).
#meta(hash)

Assign `meta` information on the Contract.
#named(name)

Add a meta name to the Contract.
#safe_nested_call(list:, args:, contract:)

Handle circular reference when the contract can self-reference.
#setup(*args)

Handles initialization logic for `InstantiableContract`s.

Instance attributes 1

.disable_safe_nesting

Purely for spec purpose.

Link to this section Class methods 2

Link to this method

.[](*args)

View Source

Convenience use of the [] operator as an implicit .new.

Examples

# The two following are identical:
Eq[2]
Eq.new(args: [2])
Link to this method

.named(name)

View Source

Convenience Class method to generate a new Named contract

Link to this section Instance methods 8

Link to this method

#call

View Source

Run contracts

Link to this method

#debug(args:)

View Source

When enabled, outputs the Contract arguments when called.

Link to this method

#get_meta

View Source

Meta accessor

Link to this method

#initialize(state: nil, args: nil, bypass_setup: false)

View Source RUBYConstructor

The ctor allows for creation (args) && duplication (state)

All the object state is held in the @state instance variable to simplify object cloning.

Link to this method

#meta(hash)

View Source

Assign meta information on the Contract.

⚠️ Warning: It it merged into the existing value.

Link to this method

#named(name)

View Source

Add a meta name to the Contract. This is helpfull for generating Error messages & debugging.

⚠️⚠️ Danger: when called, the Contract is cloned to avoid namig collisions. This is a tradeoffs between obvious side-effects & less obvious ones.

Link to this method

#safe_nested_call(list:, args:, contract:)

View Source

Handle circular reference when the contract can self-reference. If a circular reference is detected, skip the contract and let the top level one sort it out.

Link to this method

#setup(*args)

View Source

Handles initialization logic for InstantiableContracts

Link to this section Instance attributes 1

Link to this method

.disable_safe_nesting

View Source

Purely for spec purpose. This allows to check that the safe mechanism actually does something.