Class: Anyway::Config

Inherits:
Object
  • Object
show all
Includes:
DynamicConfig, OptparseConfig, Rails::Config
Defined in:
lib/anyway/config.rb

Overview

Base config class Provides ‘attr_config` method to describe configuration parameters and set defaults

Defined Under Namespace

Classes: BlockCallback, Error, NamedCallback, ValidationError

Constant Summary collapse

PARAM_NAME = 
/^[a-z_]([\w]+)?$/
RESERVED_NAMES =

List of names that couldn’t be used as config names (the class instance methods we use)

%i[
  config_name
  env_prefix
  values
  class
  clear
  deconstruct_keys
  dig
  dup
  initialize
  load
  load_from_sources
  option_parser
  pretty_print
  raise_validation_error
  reload
  resolve_config_path
  to_h
  to_source_trace
  write_config_attr
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DynamicConfig

included

Methods included from OptparseConfig

included, #option_parser, #parse_options!

Constructor Details

#initialize(overrides = nil) ⇒ Config

Instantiate config instance.

Example:

my_config = Anyway::Config.new()

# provide some values explicitly
my_config = Anyway::Config.new({some: :value})

Raises:

  • (ArgumentError) 


275
276
277
278
279
280
281
282
283
284
 
# File 'lib/anyway/config.rb', line 275

def initialize(overrides = nil)
  @config_name = self.class.config_name

  raise ArgumentError, "Config name is missing" unless @config_name

  @env_prefix = self.class.env_prefix
  @values = {}

  load(overrides)
end

Instance Attribute Details

#config_name ⇒ Object (readonly)

Returns the value of attribute config_name.



264
265
266
 
# File 'lib/anyway/config.rb', line 264

def config_name
  @config_name
end

#env_prefix ⇒ Object (readonly)

Returns the value of attribute env_prefix.



264
265
266
 
# File 'lib/anyway/config.rb', line 264

def env_prefix
  @env_prefix
end

Class Method Details

.attr_config(*args, **hargs) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/anyway/config.rb', line 81

def attr_config(*args, **hargs)
  new_defaults = hargs.deep_dup
  new_defaults.stringify_keys!

  defaults.merge! new_defaults

  new_keys = ((args + new_defaults.keys) - config_attributes)

  validate_param_names! new_keys.map(&:to_s)

  new_keys.map!(&:to_sym)

  unless (reserved_names = (new_keys & RESERVED_NAMES)).empty?
    raise ArgumentError, "Can not use the following reserved names as config attrubutes: " \
      "#{reserved_names.sort.map(&:to_s).join(", ")}"
  end

  config_attributes.push(*new_keys)

  define_config_accessor(*new_keys)

  # Define predicate methods ("param?") for attributes
  # having `true` or `false` as default values
  new_defaults.each do |key, val|
    next unless val.is_a?(TrueClass) || val.is_a?(FalseClass)
    alias_method :"#{key}?", :"#{key}"
  end
end

.config_attributes ⇒ Object 



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/anyway/config.rb', line 121

def config_attributes
  return @config_attributes if instance_variable_defined?(:@config_attributes)

  @config_attributes =
    if superclass < Anyway::Config
      superclass.config_attributes.dup
    else
      []
    end
end

.config_name(val = nil) ⇒ Object 



172
173
174
175
176
177
178
 
# File 'lib/anyway/config.rb', line 172

def config_name(val = nil)
  return (@explicit_config_name = val.to_s) unless val.nil?

  return @config_name if instance_variable_defined?(:@config_name)

  @config_name = explicit_config_name || build_config_name
end

.defaults ⇒ Object 



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

def defaults
  return @defaults if instance_variable_defined?(:@defaults)

  @defaults =
    if superclass < Anyway::Config
      superclass.defaults.deep_dup
    else
      new_empty_config
    end
end

.env_prefix(val = nil) ⇒ Object 



193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/anyway/config.rb', line 193

def env_prefix(val = nil)
  return (@env_prefix = val.to_s.upcase) unless val.nil?

  return @env_prefix if instance_variable_defined?(:@env_prefix)

  @env_prefix =
    if superclass < Anyway::Config && superclass.explicit_config_name?
      superclass.env_prefix
    else
      config_name.upcase
    end
end

.explicit_config_name ⇒ Object 



180
181
182
183
184
185
186
187
 
# File 'lib/anyway/config.rb', line 180

def explicit_config_name
  return @explicit_config_name if instance_variable_defined?(:@explicit_config_name)

  @explicit_config_name =
    if superclass.respond_to?(:explicit_config_name)
      superclass.explicit_config_name
    end
end

.explicit_config_name? ⇒ Boolean

Returns:

  • (Boolean) 


189
190
191
 
# File 'lib/anyway/config.rb', line 189

def explicit_config_name?
  !explicit_config_name.nil?
end

.load_callbacks ⇒ Object 



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/anyway/config.rb', line 161

def load_callbacks
  return @load_callbacks if instance_variable_defined?(:@load_callbacks)

  @load_callbacks =
    if superclass <= Anyway::Config
      superclass.load_callbacks.dup
    else
      []
    end
end

.new_empty_config ⇒ Object 



206
207
208
 
# File 'lib/anyway/config.rb', line 206

def new_empty_config
  {}
end

.on_load(*names, &block) ⇒ Object

Raises:

  • (ArgumentError) 


151
152
153
154
155
156
157
158
159
 
# File 'lib/anyway/config.rb', line 151

def on_load(*names, &block)
  raise ArgumentError, "Either methods or block should be specified, not both" if block_given? && !names.empty?

  if block_given?
    load_callbacks << BlockCallback.new(block)
  else
    load_callbacks.push(*names.map { NamedCallback.new(_1) })
  end
end

.required(*names) ⇒ Object 



132
133
134
135
136
137
138
 
# File 'lib/anyway/config.rb', line 132

def required(*names)
  unless (unknown_names = (names - config_attributes)).empty?
    raise ArgumentError, "Unknown config param: #{unknown_names.join(",")}"
  end

  required_attributes.push(*names)
end

.required_attributes ⇒ Object 



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/anyway/config.rb', line 140

def required_attributes
  return @required_attributes if instance_variable_defined?(:@required_attributes)

  @required_attributes =
    if superclass < Anyway::Config
      superclass.required_attributes.dup
    else
      []
    end
end

Instance Method Details

#clear ⇒ Object 



292
293
294
295
296
 
# File 'lib/anyway/config.rb', line 292

def clear
  values.clear
  @__trace__ = nil
  self
end

#deconstruct_keys(keys) ⇒ Object 



363
364
365
 
# File 'lib/anyway/config.rb', line 363

def deconstruct_keys(keys)
  values.deconstruct_keys(keys)
end

#dig(*keys) ⇒ Object 



342
343
344
 
# File 'lib/anyway/config.rb', line 342

def dig(*keys)
  values.dig(*keys)
end

#dup ⇒ Object 



350
351
352
353
354
355
356
357
 
# File 'lib/anyway/config.rb', line 350

def dup
  self.class.allocate.tap do |new_config|
    %i[config_name env_prefix __trace__].each do |ivar|
      new_config.instance_variable_set(:"@#{ivar}", send(ivar).dup)
    end
    new_config.instance_variable_set(:@values, values.deep_dup)
  end
end

#inspect ⇒ Object 



371
372
373
374
 
# File 'lib/anyway/config.rb', line 371

def inspect
  "#<#{self.class}:0x#{vm_object_id.rjust(16, "0")} config_name=\"#{config_name}\" env_prefix=\"#{env_prefix}\" " \
  "values=#{values.inspect}>"
end

#load(overrides = nil) ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/anyway/config.rb', line 298

def load(overrides = nil)
  base_config = self.class.defaults.deep_dup

  trace = Tracing.capture do
    Tracing.trace!(:defaults) { base_config }

    load_from_sources(
      base_config,
      name: config_name,
      env_prefix: env_prefix,
      config_path: resolve_config_path(config_name, env_prefix)
    )

    if overrides
      Tracing.trace!(:load) { overrides }

      base_config.deep_merge!(overrides)
    end
  end

  base_config.each do |key, val|
    write_config_attr(key.to_sym, val)
  end

  # Trace may contain unknown attributes
  trace&.keep_if { |key| self.class.config_attributes.include?(key.to_sym) }

  # Run on_load callbacks
  self.class.load_callbacks.each { _1.apply_to(self) }

  # Set trace after we write all the values to
  # avoid changing the source to accessor
  @__trace__ = trace

  self
end

#load_from_sources(base_config, **options) ⇒ Object 



335
336
337
338
339
340
 
# File 'lib/anyway/config.rb', line 335

def load_from_sources(base_config, **options)
  Anyway.loaders.each do |(_id, loader)|
    base_config.deep_merge!(loader.call(**options))
  end
  base_config
end

#pretty_print(q) ⇒ Object 



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/anyway/config.rb', line 376

def pretty_print(q)
  q.object_group self do
    q.nest(1) do
      q.breakable
      q.text "config_name=#{config_name.inspect}"
      q.breakable
      q.text "env_prefix=#{env_prefix.inspect}"
      q.breakable
      q.text "values:"
      q.pp __trace__
    end
  end
end

#reload(overrides = nil) ⇒ Object 



286
287
288
289
290
 
# File 'lib/anyway/config.rb', line 286

def reload(overrides = nil)
  clear
  load(overrides)
  self
end

#resolve_config_path(name, env_prefix) ⇒ Object 



359
360
361
 
# File 'lib/anyway/config.rb', line 359

def resolve_config_path(name, env_prefix)
  Anyway.env.fetch(env_prefix).delete("conf") || Settings.default_config_path.call(name)
end

#to_h ⇒ Object 



346
347
348
 
# File 'lib/anyway/config.rb', line 346

def to_h
  values.deep_dup.deep_freeze
end

#to_source_trace ⇒ Object 



367
368
369
 
# File 'lib/anyway/config.rb', line 367

def to_source_trace
  __trace__&.to_h
end