SleepingKingStudios::Tools

A library of utility services and concerns to expand the functionality of core classes without polluting the global namespace.

Documentation

This is the documentation for the current development build of SleepingKingStudios::Tools.

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

Getting Started

Add the gem to your Gemfile or gemspec:

gem 'sleeping_king_studios-tools'

Require SleepingKingStudios::Tools in your code:

require 'sleeping_king_studios/tools'

To ensure that message definitions are loaded, call the SleepingKingStudios::Tools initializer:

• In the initializer for your project:

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

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

Reference

SleepingKingStudios::Tools defines the following tools:

• Toolbelt
  Functional tools for operating on Ruby objects, grouped by object type.
• Assertions
  Methods for asserting on the type or content of values.
• Messages
  Tool for defining and generating human-readable messages.

It also provides a set of utility classes:

• Constant Map
  Provides an enumerable interface for defining a group of constants.
• HeritableData
  Define Data subclasses with inheritable members and methods.
• Initializer
  Utility class for initializing a library or project and its dependencies.
• Mixin
  Implements recursive inheritance of both class and instance methods.
• Subclass
  Define subclasses with partially applied constructor parameters.

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