Skip to content

Reference

Come here to look something up. A page takes one topic and covers all of it: options in a table, an example CI runs for each behaviour, and for each error what raises it. Nothing here teaches. New to the gems? The tutorial comes first, and the explanation pages give the reasons behind the design.

These pages describe field_struct 1.0.0.pre1 and actionable-rb 2.0.0.pre1. The block below is a checked example too, so the build fails if the versions named here drift from the code.

versions.rb
FieldStruct::VERSION # => '1.0.0.pre1'
Actionable::VERSION # => '2.0.0.pre1'

If a page and the code disagree, the code wins and the page has a bug. Where a spec leaves a question open, the page says that and doesn’t guess.

Typed plain-Ruby objects. The pages go from declaring a field to the exceptions the gem raises.

Service objects with declared inputs, steps and outcomes.

Both gems keep a short README in the repository that links back here: field_struct and actionable. The optional format adapters have their own pages under Adapters, and each is a prerelease too.

FieldStruct, Actionable and their adapters are open source under the MIT license.