SleepingKingStudios::Tools

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

Read The Documentation

About

SleepingKingStudios::Tools is tested against MRI Ruby 3.2 through 4.0.

Documentation

Method and class documentation is available courtesy of RubyDoc.

Documentation is generated using YARD, and can be generated locally using the yard gem.

License

SleepingKingStudios::Tools is released under the MIT License.

Contribute

The canonical repository for this gem is on GitHub. Community contributions are welcome - please feel free to fork or submit issues, bug reports or pull requests.

Code of Conduct

Please note that the SleepingKingStudios::Tools project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

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:

  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).