Cuprum

Cuprum implements the Command pattern for Ruby.

Documentation

This is the documentation for Version 1.0 of Cuprum.

• For the current development build, see Documentation.
• For other releases, see the Versions page.

Reference

Cuprum defines the following core components:

• Commands
  A functional object that responds to #call and returns a Cuprum::Result.
• Results
  An immutable data object representing the result of a called Cuprum::Command. Each Result has a #status (either :success or :failure), and may have a #value, an #error, or both.
• Errors
  An object representing the failure state of a command.
• Factories
  Provides a DSL to build commands with shared configuration or context.
• Matchers
  Define handling for results based on #status, #error, and #value.

For a full list of defined classes and objects, see Reference.

---

Back to Documentation | Versions