Class: Canfig::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/canfig/config.rb

Direct Known Subclasses

OpenConfig

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth, *args, &block) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/canfig/config.rb', line 110

def method_missing(meth, *args, &block)
  if meth.to_s.match(/=\Z/)
    opt = meth.to_s.gsub(/=/,'').to_sym
    return set(opt, args.first) if allowed?(opt)
  else
    return get(meth, *args, &block) if allowed?(meth)
  end

  super
end

Instance Method Details

#[](key) ⇒ Object 



61
62
63
 
# File 'lib/canfig/config.rb', line 61

def [](key)
  get key
end

#[]=(key, val) ⇒ Object 



52
53
54
 
# File 'lib/canfig/config.rb', line 52

def []=(key, val)
  set key, val
end

#allowed?(opt) ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/canfig/config.rb', line 106

def allowed?(opt)
  @allowed.include?(opt)
end

#changed ⇒ Object 



69
70
71
 
# File 'lib/canfig/config.rb', line 69

def changed
  Hash[@allowed.map { |key| [key, [@saved_state[key], @state[key]]] if @saved_state[key] != @state[key] }.compact]
end

#changed?(key) ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/canfig/config.rb', line 73

def changed?(key)
  changed.key?(key)
end

#clear(*keys) ⇒ Object 



46
47
48
49
50
 
# File 'lib/canfig/config.rb', line 46

def clear(*keys)
  save_state! do
    keys.each { |key| @state[key] = nil }
  end
end

#configure(argh = {}, file = nil, &block) ⇒ Object 



4
5
6
7
8
9
10
11
 
# File 'lib/canfig/config.rb', line 4

def configure(argh={}, file=nil, &block)
  save_state! do
    configure_with_file file unless file.nil?
    configure_with_args argh
    configure_with_block &block
  end
  self
end

#configure_with_args(argh) ⇒ Object 



19
20
21
22
23
 
# File 'lib/canfig/config.rb', line 19

def configure_with_args(argh)
  save_state! do
    argh.symbolize_keys.each { |key,val| set(key, val) }
  end
end

#configure_with_block(&block) ⇒ Object 



25
26
27
28
29
 
# File 'lib/canfig/config.rb', line 25

def configure_with_block(&block)
  save_state! do
    instance_eval &block if block_given?
  end
end

#configure_with_file(file) ⇒ Object 



13
14
15
16
17
 
# File 'lib/canfig/config.rb', line 13

def configure_with_file(file)
  save_state! do
    configure_with_args(Canfig::YAML.new(file).load)
  end
end

#disable_state_saves! ⇒ Object 



98
99
100
 
# File 'lib/canfig/config.rb', line 98

def disable_state_saves!
  @save_state = false
end

#enable_state_saves! ⇒ Object 



94
95
96
 
# File 'lib/canfig/config.rb', line 94

def enable_state_saves!
  @save_state = true
end

#env(key, default = nil, &block) ⇒ Object 



39
40
41
42
43
44
 
# File 'lib/canfig/config.rb', line 39

def env(key, default=nil, &block)
  @state[key] ||= begin
    val = ENV.fetch(key.to_s.underscore.upcase, default, &block)
    val && ENV.key?(val.to_s) ? env(val, default, &block) : val
  end
end

#get(key, default = nil, &block) ⇒ Object

Raises:

  • (NoMethodError) 


56
57
58
59
 
# File 'lib/canfig/config.rb', line 56

def get(key, default=nil, &block)
  raise NoMethodError, "undefined method `#{key.to_s}' for #{self.to_s}" unless allowed?(key)
  @state[key] || (block_given? ? yield : default)
end

#save_state!(&block) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/canfig/config.rb', line 77

def save_state!(&block)
  if save_state?
    @saved_state = to_h

    if block_given?
      disable_state_saves!
      begin
        yield
      ensure
        enable_state_saves!
      end
    end
  else
    yield if block_given?
  end
end

#save_state? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/canfig/config.rb', line 102

def save_state?
  @save_state
end

#set(key, val) ⇒ Object

Raises:

  • (NoMethodError) 


31
32
33
34
35
36
37
 
# File 'lib/canfig/config.rb', line 31

def set(key, val)
  raise NoMethodError, "undefined method `#{key.to_s}=' for #{self.to_s}" unless allowed?(key)

  save_state! do
    @state[key] = val
  end
end

#to_h ⇒ Object 



65
66
67
 
# File 'lib/canfig/config.rb', line 65

def to_h
  Hash[@allowed.map { |key| [key, @state[key]] }]
end