Class: BBK::Utils::Config

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

Defined Under Namespace

Classes: BooleanCaster, KeyError

Constant Summary collapse

PREFIX_SEP = 
'_'
FILTERED_VALUE = 
'[FILTERED]'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: nil, prefix: nil, parent: nil) ⇒ Config

Returns a new instance of Config.



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/bbk/utils/config.rb', line 54

def initialize(name: nil, prefix: nil, parent: nil)
  @name = name
  @store = {}
  @parent = parent
  @subconfigs = []
  @prefix = normalize_key(prefix)
  @prefixes = if parent.nil?
    [@prefix]
  else
    parent.prefixes.dup + [@prefix]
  end.compact
  @env_prefix = normalize_key(@prefixes.join(PREFIX_SEP))
end

Instance Attribute Details

#env_prefix ⇒ Object (readonly)

Returns the value of attribute env_prefix.



11
12
13
 
# File 'lib/bbk/utils/config.rb', line 11

def env_prefix
  @env_prefix
end

#name ⇒ Object

Returns the value of attribute name.



10
11
12
 
# File 'lib/bbk/utils/config.rb', line 10

def name
  @name
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



11
12
13
 
# File 'lib/bbk/utils/config.rb', line 11

def parent
  @parent
end

#prefix ⇒ Object (readonly)

Returns the value of attribute prefix.



11
12
13
 
# File 'lib/bbk/utils/config.rb', line 11

def prefix
  @prefix
end

#store ⇒ Object

Returns the value of attribute store.



10
11
12
 
# File 'lib/bbk/utils/config.rb', line 10

def store
  @store
end

Class Method Details

.instance(prefix: nil) ⇒ Object 



38
39
40
 
# File 'lib/bbk/utils/config.rb', line 38

def self.instance(prefix: nil)
  @instance ||= new(prefix: prefix)
end

.parse_bool_value(value) ⇒ Object 



42
43
44
 
# File 'lib/bbk/utils/config.rb', line 42

def self.parse_bool_value(value)
  BooleanCaster.cast(value)
end

Instance Method Details

#[](key) ⇒ Object 



136
137
138
 
# File 'lib/bbk/utils/config.rb', line 136

def [](key)
  self.get(key, search_up: true, search_down: true)[:value]
end

#[]=(key, value) ⇒ Object 



140
141
142
 
# File 'lib/bbk/utils/config.rb', line 140

def []=(key, value)
  @store[normalize_key(key)][:value] = value
end

#as_json(*_args) ⇒ Object 



181
182
183
184
185
186
187
188
189
 
# File 'lib/bbk/utils/config.rb', line 181

def as_json(*_args)
  values = store_with_subconfigs.values.sort_by do |item|
    [item[:file].present? ? 0 : 1, item[:required] ? 0 : 1]
  end.reduce({}) do |ret, item|
    ret.merge(item[:env] => item)
  end

  @name ? { @name => values } : values
end

#content(key) ⇒ Object 



144
145
146
147
148
149
150
151
 
# File 'lib/bbk/utils/config.rb', line 144

def content(key)
  item = @store[normalize_key(key)]
  if (file = item[:file])
    File.read(file)
  else
    item[:value]
  end
end

#fetch(key, default = nil) ⇒ Object 



153
154
155
156
157
158
159
160
161
 
# File 'lib/bbk/utils/config.rb', line 153

def fetch(key, default = nil)
  if (rec = self.get(key, search_up: true, search_down: true)) && rec.key?(:value)
    rec[:value]
  else
    default
  end
rescue KeyError
  default
end

#map(env, file, required: true, desc: nil, bool: false, key: nil, rewrite: true) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/bbk/utils/config.rb', line 68

def map(env, file, required: true, desc: nil, bool: false, key: nil, rewrite: true)
  conf_key = full_prefixed_key(env)
  return if @store.key?(conf_key) && !rewrite

  @store[conf_key] = {
    env:      full_prefixed_key(key || env),
    file:     file,
    required: required,
    desc:     desc,
    bool:     bool,
    type:     nil
  }
end

#optional(env, default: nil, desc: nil, bool: false, type: nil, key: nil, rewrite: true, secure: false) ⇒ Object

Raises:

  • (ArgumentError) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/bbk/utils/config.rb', line 100

def optional(env, default: nil, desc: nil, bool: false, type: nil, key: nil, rewrite: true, secure: false)
  raise ArgumentError.new('Specified type and bool') if bool && type.present?

  type = BBK::Utils::Config::BooleanCaster.singleton_method(:cast) if bool
  conf_key = full_prefixed_key(env)
  return if @store.key?(conf_key) && !rewrite

  @store[conf_key] = {
    env:      full_prefixed_key(key || env),
    file:     nil,
    required: false,
    default:  default,
    desc:     desc,
    bool:     true,
    type:     type,
    secure:   secure
  }
end

#require(env, desc: nil, bool: false, type: nil, key: nil, rewrite: true, secure: false) ⇒ Object

Raises:

  • (ArgumentError) 


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/bbk/utils/config.rb', line 82

def require(env, desc: nil, bool: false, type: nil, key: nil, rewrite: true, secure: false)
  raise ArgumentError.new('Specified type and bool') if bool && type.present?

  type = BBK::Config::BooleanCaster.singleton_method(:cast) if bool
  conf_key = full_prefixed_key(env)
  return if @store.key?(conf_key) && !rewrite

  @store[conf_key] = {
    env:      full_prefixed_key(key || env),
    file:     nil,
    required: true,
    desc:     desc,
    bool:     bool,
    type:     type,
    secure:   secure
  }
end

#root? ⇒ Boolean

Returns:

  • (Boolean) 


199
200
201
 
# File 'lib/bbk/utils/config.rb', line 199

def root?
  @parent.nil?
end

#run!(source = ENV) ⇒ Object 



119
120
121
122
123
124
125
 
# File 'lib/bbk/utils/config.rb', line 119

def run!(source = ENV)
  @store.each_value do |item|
    process(source, item)
  end
  @subconfigs.each {|sub| sub.run!(source) }
  nil
end

#subconfig(prefix:, name: nil) {|sub| ... } ⇒ Object

Yields:

  • (sub)

Raises:

  • (ArgumentError) 


127
128
129
130
131
132
133
134
 
# File 'lib/bbk/utils/config.rb', line 127

def subconfig(prefix:, name: nil)
  raise ArgumentError.new("Subconfig with prefix #{prefix} already exists") if @subconfigs.any? {|sub| sub.prefix == prefix.to_s }

  sub = self.class.new(name: name, prefix: prefix, parent: self)
  @subconfigs << sub
  yield sub if block_given?
  sub
end

#to_json(*_args) ⇒ Object 



191
192
193
 
# File 'lib/bbk/utils/config.rb', line 191

def to_json(*_args)
  JSON.pretty_generate(as_json)
end

#to_s ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/bbk/utils/config.rb', line 163

def to_s
  result = StringIO.new
  result.puts "Environment variables#{@name ? " for #{@name}" : ''}:"
  padding = ' ' * 3
  sorted = store_with_subconfigs.values.sort_by do |item|
    [item[:file].present? ? 0 : 1, item[:required] ? 0 : 1]
  end

  sorted.each do |item|
    if item[:file]
      result.puts print_file_item(item, padding)
    else
      result.puts print_item(item, padding)
    end
  end
  result.string
end

#to_yaml(*_args) ⇒ Object 



195
196
197
 
# File 'lib/bbk/utils/config.rb', line 195

def to_yaml(*_args)
  JSON.parse(to_json).to_yaml
end