Module: Optionable::DSL

Defined in:

lib/optionable/dsl.rb

Overview

Provides the entry point to the optionable DSL.

Since:

• 0.0.0

Instance Method Summary

• #option(key) ⇒ Optionable::Validator

  Defines an option to be validated.

• #optionable_validators ⇒ Hash<Symbol, Optionable::Validator>

  Get all the validators for all options.

Instance Method Details

#option(key) ⇒ Optionable::Validator

Defines an option to be validated.

Examples:

Define the option.

option(:read).allow(:primary, :secondary)

Parameters:

• key (Symbol) —

  The name of the option.

Returns:

• (Optionable::Validator) —

  The associated validator for the option.

Since:

• 0.0.0

# File 'lib/optionable/dsl.rb', line 19

def option(key)
  optionable_validators[key] ||= Validator.new(key)
end

#optionable_validators ⇒ Hash<Symbol, Optionable::Validator>

Get all the validators for all options.

Examples:

Get all the validators.

dsl.optionable_validators

Returns:

• (Hash<Symbol, Optionable::Validator>) —

  The validators.

Since:

• 0.0.0

# File 'lib/optionable/dsl.rb', line 31

def optionable_validators
  @optionable_validators ||= {}
end