kit-organizer edge

Contracts module
Kit::Organizer::Contracts

View Source

Contracts for the project.

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

Used instance mixins: Contract::BuiltInContracts

Defined in: app/contracts/kit/organizer/contracts.rb#2

Shortcut to specify Tupple[:ok, Hash[values]] || Tupple[:errors, Any] with specific valid keyword arguments.

TODO: provide smarter `SuccessResultTupple` to express expected ctx values.

Accepts laxer Error formats that will need to be sanitized.

Or[
  Tupple[ErrorStatus],
  Tupple[ErrorStatus, Hash],
].named('ErrorResultTupple')

Eq[:error]

Or[
  SuccessResultTupple,
  ErrorResultTupple,
].named('ResultTupple')

Or[SuccessStatus, ErrorStatus].named('Status')

TODO: provide smarter SuccessResultTupple to express expected ctx values

Or[
  Tupple[SuccessStatus],
  Tupple[SuccessStatus, Hash],
].named('SuccessResultTupple')

Eq[:ok]

Accepts laxer Error formats that will need to be sanitized

Or[
  ErrorResultTupple,
  Tupple[ErrorStatus, String],
  Tupple[ErrorStatus, Array],
].named('TmpErrorResultTupple')

Or[
  ResultTupple,
  TmpErrorResultTupple,
].named('TmpResultTupple')