kit-contract edge

Array class
Kit::Contract::BuiltInContracts::Array

View Source

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

Supported contract types:

of: alias of every_value, for types
with: run on the value of specific indeces (this is the default when using Hash[data])
at: here ordering matters
every: run on every value
instance: run on the hash instance itself
size: instance contract about size

Supported internal types of behaviour:

every_value: run on every value
index: run on value at index N
instance: run on the hash instance itself

Todo: add exemples.

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

Inheritance: InstantiableContract → Object

Defined in: app/contracts/kit/contract/built_in_contracts/array.rb#47

Direct subclasses 2

Allows to treat callable arguments as an array.

Less permissive version of Array.

Class methods 8

.at(*contracts)

Convenience methods.

.every(*contracts)

.instance(*contracts)

.of(*contracts)

.with(*contracts)

Inherited from InstantiableContract

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

Convenience Class method to generate a new Named contract.

Instance methods 10

#add_contract(contract:, safe: false)

#at(contracts, safe: false)

contract Hash.of(And[Integer, Gt[0]] => Contract).

#every(contract, safe: false)

contract Array.of(Contract).size(1).

#instance(contracts, safe: false)

contract Or[Contract, Array.of(Contract)].

#of(contract, safe: false)

contract Array.of(Contract).size(1).

#setup(*index_contracts)

#size(size, safe: true)

contract And[Integer, ->(x) { x > 0 }].

NOTE: this will only be useful when Organizer can handle any signature.

#with(contracts, safe: false)

Position matters on this one contract Array.of(Contract).

Inherited from InstantiableContract

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

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

Add a meta name to the Contract.

Assign `meta` information on the Contract.

Meta accessor.

When enabled, outputs the Contract arguments when called.

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

Handle circular reference when the contract can self-reference.

Link to this section Class methods 8

.at(*contracts)

Convenience methods. They provide a slighly terser external API to instantiate contracts.

.call(*args)

.every(*contracts)

.instance(*contracts)

.meta(opts)

.of(*contracts)

.size(size)

.with(*contracts)

Link to this section Instance methods 10

#add_contract(contract:, safe: false)

#at(contracts, safe: false)

contract Hash.of(And[Integer, Gt[0]] => Contract)

#call(*args)

#every(contract, safe: false)

contract Array.of(Contract).size(1)

#instance(contracts, safe: false)

contract Or[Contract, Array.of(Contract)]

#of(contract, safe: false)

contract Array.of(Contract).size(1)

#setup(*index_contracts)

#size(size, safe: true)

contract And[Integer, ->(x) { x > 0 }]

#to_contracts

NOTE: this will only be useful when Organizer can handle any signature

#with(contracts, safe: false)

Position matters on this one contract Array.of(Contract)