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
11
12
13
14
 
# File 'lib/confuse/item.rb', line 6

def initialize(key, opts = {})
  @key = key
  @default, @description = opts.values_at(:default, :description)

  @converter = opts[:converter]
  @type = opts[:type]

  @required = opts.key?(:required) ? opts[:required] : true
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



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

def description
  @description
end

#required ⇒ Object (readonly)

Returns the value of attribute required.



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

def required
  @required
end

Instance Method Details

#convert(value) ⇒ Object 



18
19
20
 
# File 'lib/confuse/item.rb', line 18

def convert(value)
  converter.call(value)
end

#default(config) ⇒ Object

Raises:



22
23
24
25
26
 
# File 'lib/confuse/item.rb', line 22

def default(config)
  raise Errors::Undefined.new(@key) if @required && @default.nil?

  @default.respond_to?(:call) ? @default.call(config) : @default
end

#to_hash ⇒ Object 



37
38
39
40
41
42
 
# File 'lib/confuse/item.rb', line 37

def to_hash
  {
    :description => @description,
    :default => @default
  }
end

#to_s ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/confuse/item.rb', line 28

def to_s
  default = if @default && !@default.respond_to?(:call)
              "default: #{@default}"
            else
              ''
            end
  "#{@key}:\t#{description} #{default}"
end