Class: SleepingKingStudios::Tools::Toolbelt

Parent Namespace

SleepingKingStudios::Tools

Defined In

lib/sleeping_king_studios/tools/toolbelt.rb

Table Of Contents

• Overview
  • Examples
• Class Methods
  • global
• Constructor
• Instance Methods
  • array_tools
  • assertions
  • core_tools
  • hash_tools
  • initialize
  • inspect
  • integer_tools
  • messages
  • object_tools
  • string_tools

Overview

Helper object for quick access to all available tools.

Specific tools can be accessed by name. For example, to access the configured instance of ArrayTools, call Toolbelt#array_tools. Certain tools also define a shorthand - for example, the array_tools instance can also be accessed using Toolbelt#ary.

Examples

toolbelt = SleepingKingStudios::Tools::Toolbelt.new

toolbelt.array_tools.pluralize('light')
#=> 'lights'

Back To Top

Class Methods

.global() => Registry

Also known as: instance

Returns a singleton instance of the messages registry, instantiating the instance if needed.

Returns

• (Registry) — the messages registry singleton.

Back To Top

Constructor

#initialize(deprecation_caller_depth: nil, deprecation_strategy: nil, inflector: nil, messages_registry: nil) => Toolbelt

Parameters

• deprecation_caller_depth (Integer) — the number of backtrace lines to display when outputting a deprecation warning.
• deprecation_strategy (String) — the name of the strategy used when deprecated code is called. Must be 'ignore', 'raise', or 'warn'.
• inflector (Object) — service object for inflecting strings. The inflector must be an object that conforms to the interface used by by SleepingKingStudios::Tools::Toolbox::Inflector, such as an instance of ActiveSupport::Inflector .
• messages_registry (SleepingKingStudios::Tools::Messages::Registry) — the strategies registry to use for the tool. Defaults to the value of Registry.global.

Returns

• (Toolbelt) — a new instance of Toolbelt

Back To Top

Instance Methods

#array_tools => SleepingKingStudios::Tools::ArrayTools

Also known as: ary

Returns

• (SleepingKingStudios::Tools::ArrayTools) — tools for working with array-like enumerable objects.

#assertions => SleepingKingStudios::Tools::Assertions

Returns

• (SleepingKingStudios::Tools::Assertions) — methods for asserting on the state of a function or application.

#core_tools => SleepingKingStudios::Tools::CoreTools

Returns

• (SleepingKingStudios::Tools::CoreTools) — tools for working with an application or working environment.

#hash_tools => SleepingKingStudios::Tools::HashTools

Also known as: hsh

Returns

• (SleepingKingStudios::Tools::HashTools) — tools for working with hash-like enumerable objects.

#inspect => String

Also known as: to_s

Returns

• (String) — a human-readable representation of the object.

#integer_tools => SleepingKingStudios::Tools::IntegerTools

Also known as: int

Returns

• (SleepingKingStudios::Tools::IntegerTools) — tools for working with integers.

#messages => SleepingKingStudios::Tools::Messages

Returns

• (SleepingKingStudios::Tools::Messages) — methods for generating human-readable messages.

#object_tools => SleepingKingStudios::Tools::ObjectTools

Also known as: obj

Returns

• (SleepingKingStudios::Tools::ObjectTools) — low-level tools for working with objects.

#string_tools => SleepingKingStudios::Tools::ObjectTools

Also known as: str

Returns

• (SleepingKingStudios::Tools::ObjectTools) — tools for working with strings.

Back To Top

---

Back to Documentation | Reference | SleepingKingStudios | SleepingKingStudios::Tools