Class: Config::Options

Inherits:
OpenStruct
  • Object
show all
Includes:
Validation::Validate, Enumerable
Defined in:
lib/config/options.rb

Constant Summary collapse

SETTINGS_RESERVED_NAMES =

Some keywords that don’t play nicely with OpenStruct

%w[select collect test count zip min max exit! table].freeze
RAILS_RESERVED_NAMES =

Some keywords that don’t play nicely with Rails 7.*

%w[maximum minimum].freeze

Instance Method Summary collapse

Methods included from Validation::Validate

#validate!

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args) ⇒ Object 



152
153
154
155
156
157
 
# File 'lib/config/options.rb', line 152

def method_missing(method_name, *args)
  if Config.fail_on_missing && method_name !~ /.*(?==\z)/m
    raise KeyError, "key not found: #{method_name.inspect}" unless key?(method_name)
  end
  super
end

Instance Method Details

#[](param) ⇒ Object

An alternative mechanism for property access. This let’s you do foo along with foo.bar.



122
123
124
125
126
 
# File 'lib/config/options.rb', line 122

def [](param)
  return super if SETTINGS_RESERVED_NAMES.include?(param)
  return super if RAILS_RESERVED_NAMES.include?(param)
  public_send("#{param}")
end

#[]=(param, value) ⇒ Object 



128
129
130
 
# File 'lib/config/options.rb', line 128

def []=(param, value)
  send("#{param}=", value)
end

#add_source!(source) ⇒ Object 



17
18
19
20
21
22
23
24
 
# File 'lib/config/options.rb', line 17

def add_source!(source)
  # handle yaml file paths
  source = (Sources::YAMLSource.new(source)) if source.is_a?(String) || source.is_a?(Pathname)
  source = (Sources::HashSource.new(source)) if source.is_a?(Hash)

  @config_sources ||= []
  @config_sources << source
end

#as_json(options = nil) ⇒ Object 



95
96
97
 
# File 'lib/config/options.rb', line 95

def as_json(options = nil)
  to_hash.as_json(options)
end

#each(*args, &block) ⇒ Object 



86
87
88
 
# File 'lib/config/options.rb', line 86

def each(*args, &block)
  marshal_dump.each(*args, &block)
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/config/options.rb', line 13

def empty?
  marshal_dump.empty?
end

#has_key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


148
149
150
 
# File 'lib/config/options.rb', line 148

def has_key?(key)
  @table.has_key?(key)
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/config/options.rb', line 144

def key?(key)
  @table.key?(key)
end

#keys ⇒ Object 



9
10
11
 
# File 'lib/config/options.rb', line 9

def keys
  marshal_dump.keys
end

#merge!(hash) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/config/options.rb', line 99

def merge!(hash)
  current = to_hash
  DeepMerge.deep_merge!(
                        hash.dup,
                        current,
                        preserve_unmergeables: false,
                        knockout_prefix:       Config.knockout_prefix,
                        overwrite_arrays:      Config.overwrite_arrays,
                        merge_nil_values:      Config.merge_nil_values,
                        merge_hash_arrays:     Config.merge_hash_arrays
                       )
  marshal_load(__convert(current).marshal_dump)
  self
end

#prepend_source!(source) ⇒ Object 



26
27
28
29
30
31
32
 
# File 'lib/config/options.rb', line 26

def prepend_source!(source)
  source = (Sources::YAMLSource.new(source)) if source.is_a?(String) || source.is_a?(Pathname)
  source = (Sources::HashSource.new(source)) if source.is_a?(Hash)

  @config_sources ||= []
  @config_sources.unshift(source)
end

#reload! ⇒ Object Also known as: load!

look through all our sources and rebuild the configuration



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/config/options.rb', line 35

def reload!
  conf = {}
  @config_sources.each do |source|
    source_conf = source.load

    if conf.empty?
      conf = source_conf
    else
      DeepMerge.deep_merge!(
                            source_conf,
                            conf,
                            preserve_unmergeables: false,
                            knockout_prefix:       Config.knockout_prefix,
                            overwrite_arrays:      Config.overwrite_arrays,
                            merge_nil_values:      Config.merge_nil_values,
                            merge_hash_arrays:     Config.merge_hash_arrays
                           )
    end
  end

  # swap out the contents of the OStruct with a hash (need to recursively convert)
  marshal_load(__convert(conf).marshal_dump)

  validate!

  self
end

#reload_from_files(*files) ⇒ Object 



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

def reload_from_files(*files)
  Config.load_and_set_settings(files)
  reload!
end

#respond_to_missing?(*args) ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/config/options.rb', line 159

def respond_to_missing?(*args)
  super
end

#to_hash ⇒ Object Also known as: to_h 



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/config/options.rb', line 70

def to_hash
  result = {}
  marshal_dump.each do |k, v|
    if v.instance_of? Config::Options
      result[k] = v.to_hash
    elsif v.instance_of? Array
      result[k] = descend_array(v)
    else
      result[k] = v
    end
  end
  result
end

#to_json(*args) ⇒ Object 



90
91
92
93
 
# File 'lib/config/options.rb', line 90

def to_json(*args)
  require "json" unless defined?(JSON)
  to_hash.to_json(*args)
end