Class: Confuse::Item

Inherits:
Object
  • Object
show all
Defined in:
lib/confuse/item.rb

Overview

An Item is a class for storing a description piece of config.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key, opts = {}) ⇒ Item

Returns a new instance of Item.



6
7
8
9
10
 
# File 'lib/confuse/item.rb', line 6

def initialize(key, opts = {})
  @key = key
  @default, @description = opts.values_at(:default, :description)
  @required = opts.key?(:required) ? opts[:required] : true
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



12
13
14
 
# File 'lib/confuse/item.rb', line 12

def description
  @description
end

#required ⇒ Object (readonly)

Returns the value of attribute required.



12
13
14
 
# File 'lib/confuse/item.rb', line 12

def required
  @required
end

Instance Method Details

#default ⇒ Object

Raises:



14
15
16
17
18
 
# File 'lib/confuse/item.rb', line 14

def default
  res = @default
  raise Errors::Undefined.new(@key) if @required && !res
  res
end