Cuprum

Cuprum implements the Command pattern for Ruby.

Documentation

This is the documentation for the current development build of Cuprum.

• For the most recent release, see Version 1.3.
• For previous releases, see the Versions page.

Getting Started

Add the gem to your Gemfile or gemspec:

gem 'cuprum'

Require Cuprum in your code:

require 'cuprum'

To ensure that error message definitions are loaded, call the Cuprum initializer:

• In the initializer for your project:

  module Space
    @initializer = SleepingKingStudios::Tools::Toolbox::Initializer.new do
      Cuprum.initializer.call
    end
  end
  

• Or, in the entry points of your application (such as a bin script or spec_helper.rb).

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.