Class: Anyway::Config

Inherits:
Object
  • Object
show all
Extended by:
RBSGenerator
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
  tap
  to_h
  to_source_trace
  write_config_attr
  __type_caster__
].freeze

Constants included from RBSGenerator

RBSGenerator::TYPE_TO_CLASS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from RBSGenerator

to_rbs

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) 


305
306
307
308
309
310
311
312
313
314
 
# File 'lib/anyway/config.rb', line 305

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.



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

def config_name
  @config_name
end

#env_prefix ⇒ Object (readonly)

Returns the value of attribute env_prefix.



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

def env_prefix
  @env_prefix
end

Class Method Details

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



80
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
 
# File 'lib/anyway/config.rb', line 80

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

.coerce_types(mapping) ⇒ Object 



200
201
202
 
# File 'lib/anyway/config.rb', line 200

def coerce_types(mapping)
  coercion_mapping.deep_merge!(mapping)
end

.coercion_mapping ⇒ Object 



204
205
206
207
208
209
210
211
212
 
# File 'lib/anyway/config.rb', line 204

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

  @coercion_mapping = if superclass < Anyway::Config
    superclass.coercion_mapping.deep_dup
  else
    {}
  end
end

.config_attributes ⇒ Object 



119
120
121
122
123
124
125
126
127
 
# File 'lib/anyway/config.rb', line 119

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 



167
168
169
170
171
172
173
 
# File 'lib/anyway/config.rb', line 167

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 



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

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

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

.disable_auto_cast! ⇒ Object 



237
238
239
 
# File 'lib/anyway/config.rb', line 237

def disable_auto_cast!
  @fallback_type_caster = ::Anyway::NoCast
end

.env_prefix(val = nil) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/anyway/config.rb', line 186

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 



175
176
177
178
179
180
181
182
 
# File 'lib/anyway/config.rb', line 175

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) 


184
 
# File 'lib/anyway/config.rb', line 184

def explicit_config_name?() = !explicit_config_name.nil?

.fallback_type_caster(val = nil) ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/anyway/config.rb', line 225

def fallback_type_caster(val = nil)
  return (@fallback_type_caster = val) unless val.nil?

  return @fallback_type_caster if instance_variable_defined?(:@fallback_type_caster)

  @fallback_type_caster = if superclass < Anyway::Config
    superclass.fallback_type_caster.deep_dup
  else
    ::Anyway::AutoCast
  end
end

.load_callbacks ⇒ Object 



157
158
159
160
161
162
163
164
165
 
# File 'lib/anyway/config.rb', line 157

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 



198
 
# File 'lib/anyway/config.rb', line 198

def new_empty_config() = {}

.on_load(*names, &block) ⇒ Object

Raises:

  • (ArgumentError) 


147
148
149
150
151
152
153
154
155
 
# File 'lib/anyway/config.rb', line 147

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

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

.required(*names) ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/anyway/config.rb', line 129

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 



137
138
139
140
141
142
143
144
145
 
# File 'lib/anyway/config.rb', line 137

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

.type_caster(val = nil) ⇒ Object 



214
215
216
217
218
219
220
221
222
223
 
# File 'lib/anyway/config.rb', line 214

def type_caster(val = nil)
  return @type_caster unless val.nil?

  @type_caster ||=
    if coercion_mapping.empty?
      fallback_type_caster
    else
      ::Anyway::TypeCaster.new(coercion_mapping, fallback: fallback_type_caster)
    end
end

Instance Method Details

#clear ⇒ Object 



322
323
324
325
326
 
# File 'lib/anyway/config.rb', line 322

def clear
  values.clear
  @__trace__ = nil
  self
end

#deconstruct_keys(keys) ⇒ Object 



386
 
# File 'lib/anyway/config.rb', line 386

def deconstruct_keys(keys) = values.deconstruct_keys(keys)

#dig(*keys) ⇒ Object 



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

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

#dup ⇒ Object 



373
374
375
376
377
378
379
380
 
# File 'lib/anyway/config.rb', line 373

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 



390
391
392
393
 
# File 'lib/anyway/config.rb', line 390

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 



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/anyway/config.rb', line 328

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

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

    config_path = resolve_config_path(config_name, env_prefix)

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

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

      Utils.deep_merge!(base_config, 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 



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

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

#pretty_print(q) ⇒ Object 



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/anyway/config.rb', line 395

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 



316
317
318
319
320
 
# File 'lib/anyway/config.rb', line 316

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

#resolve_config_path(name, env_prefix) ⇒ Object 



382
383
384
 
# File 'lib/anyway/config.rb', line 382

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

#to_h ⇒ Object 



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

def to_h() = values.deep_dup.deep_freeze

#to_source_trace ⇒ Object 



388
 
# File 'lib/anyway/config.rb', line 388

def to_source_trace() = __trace__&.to_h