Class: SleepingKingStudios::Tools::Toolbox::Initializer

Parent Namespace

SleepingKingStudios::Tools::Toolbox

Defined In

lib/sleeping_king_studios/tools/toolbox/initializer.rb

Table Of Contents

• Overview
  • Examples
• Constructor
• Instance Methods
  • call
  • initialize

Overview

Utility class for initializing a library or project.

An initializer is used to set up the project, including loading configuration, setting initial data or states, and initializing dependencies.

Using an initializer provides several advantages:

• Potentially-expensive setup code is run on your own schedule, not when the module is first loaded.
• The setup code will only run once, even if the initializer is called multiple times or from multiple places.
• The setup code will only run once, even in a multi-threaded environment.

Examples

Defining An Initializer

module Space
  @initializer = SleepingKingStudios::Tools::Toolbox::Initializer.new do
    # Initializers can safely call other initializers to ensure
    # dependencies are set up.
    Physics.initializer.call

    Space.load_configuration
  end

  def self.initializer = @initializer
end

Calling An Initializer

# In spec/spec_helper.rb

require 'space'

Space.initializer.call

Back To Top

Constructor

#initialize(&block) => Initializer

Yields

• the block to execute when the initializer is called.

Returns

• (Initializer) — a new instance of Initializer

Raises

• (ArgumentError)

Back To Top

Instance Methods

#call => Object

Runs the initialization block exactly once.

Back To Top

---

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