https://github.com/sleepingkingstudios/sleeping_king_studios-tools
A library of utility services and concerns.
https://github.com/sleepingkingstudios/sleeping_king_studios-tools
Last synced: 2 months ago
JSON representation
A library of utility services and concerns.
- Host: GitHub
- URL: https://github.com/sleepingkingstudios/sleeping_king_studios-tools
- Owner: sleepingkingstudios
- License: mit
- Created: 2014-10-18T18:19:47.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2026-03-30T20:31:21.000Z (3 months ago)
- Last Synced: 2026-03-30T22:20:14.487Z (3 months ago)
- Language: Ruby
- Size: 733 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](https://yardoc.org/), and can be generated locally using the `yard` gem.
### License
SleepingKingStudios::Tools is released under the [MIT License](https://opensource.org/licenses/MIT).
### Contribute
The canonical repository for this gem is on [GitHub](https://github.com/sleepingkingstudios/sleeping_king_studios-tasks). 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](https://github.com/sleepingkingstudios/sleeping_king_studios-tools/blob/master/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
## Getting Started
Add the gem to your `Gemfile` or `gemspec`:
```ruby
gem 'sleeping_king_studios-tools'
```
Require `SleepingKingStudios::Tools` in your code:
```ruby
require 'sleeping_king_studios/tools'
```
To ensure that [message definitions](./tools/messages) are loaded, call the `SleepingKingStudios::Tools` initializer:
- In the [initializer](./initializers) for your project:
```ruby
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`).