Class: SleepingKingStudios::Tools::Toolbox::ConstantMap

Parent Namespace

SleepingKingStudios::Tools::Toolbox

Inherited Classes

Module > Object

Extended Modules

Forwardable

Included Modules

Enumerable

Defined In

lib/sleeping_king_studios/tools/toolbox/constant_map.rb

Table Of Contents

• Overview
  • Examples
• Constructor
• Instance Attributes
  • to_h
• Instance Methods
  • each
  • each_key
  • each_pair
  • each_value
  • freeze
  • initialize
  • keys
  • values

Overview

Provides an enumerable interface for defining a group of constants.

Examples

UserRoles = ConstantMap.new(
  {
    GUEST: 'guest',
    USER:  'user',
    ADMIN: 'admin'
  }
)

UserRoles::GUEST
#=> 'guest'

UserRoles.user
#=> 'user'

UserRoles.all
#=> { :GUEST => 'guest', :USER => 'user', :ADMIN => 'admin' }

Back To Top

Constructor

#initialize(constants) => ConstantMap

Parameters

• constants (Hash) — the constants to define.

Returns

• (ConstantMap) — a new instance of ConstantMap

Back To Top

Instance Attributes

#to_h => Hash (readonly)

Also known as: all

Returns

• (Hash) — The defined constants.

Back To Top

Instance Methods

#each => Object

Iterates through the defined constants, yielding the name and value of each constant to the block.

Yield Parameters

• key (Symbol) — the name of the constant.
• value (Object) — the value of the constant.

#each_key => Object

Iterates through the defined constants, yielding the name of each constant to the block.

Yield Parameters

• key (Symbol) — the name of the constant.

#each_pair => Object

Iterates through the defined constants, yielding the name and value of each constant to the block.

Yield Parameters

• key (Symbol) — the name of the constant.
• value (Object) — the value of the constant.

#each_value => Object

Iterates through the defined constants, yielding the value of each constant to the block.

Yield Parameters

• value (Object) — the value of the constant.

#freeze => self

Freezes the constant map and recursively freezes every constant value.

Returns

• (self) — the constant map.

See Also

• SleepingKingStudios::Tools::ObjectTools#deep_freeze

#keys => Array

Returns

• (Array) — the names of the defined constants.

#values => Array

Returns

• (Array) — the values of the defined constants.

Back To Top

---

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