Class: Confset::Options

Inherits:
OpenStruct
  • Object
show all
Includes:
Validation::Validate, Enumerable
Defined in:
lib/confset/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!].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 



145
146
147
148
149
150
 
# File 'lib/confset/options.rb', line 145

def method_missing(method_name, *args)
  if Confset.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
 
# File 'lib/confset/options.rb', line 122

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

#[]=(param, value) ⇒ Object 



127
128
129
 
# File 'lib/confset/options.rb', line 127

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

#add_source!(source) ⇒ Object 



20
21
22
23
24
25
26
27
 
# File 'lib/confset/options.rb', line 20

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 



98
99
100
 
# File 'lib/confset/options.rb', line 98

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

#each(*args, &block) ⇒ Object 



89
90
91
 
# File 'lib/confset/options.rb', line 89

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

#empty? ⇒ Boolean 



16
17
18
 
# File 'lib/confset/options.rb', line 16

def empty?
  marshal_dump.empty?
end

#has_key?(key) ⇒ Boolean 



141
142
143
 
# File 'lib/confset/options.rb', line 141

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

#key?(key) ⇒ Boolean 



137
138
139
 
# File 'lib/confset/options.rb', line 137

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

#keys ⇒ Object 



12
13
14
 
# File 'lib/confset/options.rb', line 12

def keys
  marshal_dump.keys
end

#merge!(hash) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/confset/options.rb', line 102

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

#prepend_source!(source) ⇒ Object 



29
30
31
32
33
34
35
 
# File 'lib/confset/options.rb', line 29

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



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

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:       Confset.knockout_prefix,
                            overwrite_arrays:      Confset.overwrite_arrays,
                            merge_nil_values:      Confset.merge_nil_values,
                            merge_hash_arrays:     Confset.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 



68
69
70
71
 
# File 'lib/confset/options.rb', line 68

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

#respond_to_missing?(*args) ⇒ Boolean 



152
153
154
 
# File 'lib/confset/options.rb', line 152

def respond_to_missing?(*args)
  super
end

#to_hash ⇒ Object Also known as: to_h 



73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/confset/options.rb', line 73

def to_hash
  result = {}
  marshal_dump.each do |k, v|
    if v.instance_of? Confset::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 



93
94
95
96
 
# File 'lib/confset/options.rb', line 93

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