Class: Chamber::Settings
- Inherits:
-
Object
- Object
- Chamber::Settings
- Defined in:
- lib/chamber/settings.rb
Instance Attribute Summary collapse
-
#namespaces ⇒ Object
readonly
Returns the value of attribute namespaces.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Internal: Determines whether a Settings is equal to another hash-like object.
-
#eql?(other) ⇒ Boolean
Internal: Determines whether a Settings is equal to another Settings.
-
#initialize(options = {}) ⇒ Settings
constructor
A new instance of Settings.
- #insecure ⇒ Object
-
#merge(other) ⇒ Object
Internal: Merges a Settings object with another Settings object or a hash-like object.
- #method_missing(name, *args) ⇒ Object
- #respond_to_missing?(name, include_private = false) ⇒ Boolean
- #securable ⇒ Object
- #secure ⇒ Object
- #to_concatenated_name_hash(hierarchical_separator = '_') ⇒ Object
-
#to_environment ⇒ Object
Internal: Converts a Settings object into a hash that is compatible as an environment variable hash.
-
#to_flattened_name_hash(hash = data, parent_keys = []) ⇒ Object
Internal: Returns a hash which contains the flattened name hierarchy of the setting as the keys and the values of each setting as the value.
-
#to_hash ⇒ Object
Internal: Returns the Settings data as a Hash for easy manipulation.
-
#to_s(options = {}) ⇒ Object
Internal: Converts a Settings object into a String with a format that will work well when working with the shell.
Constructor Details
#initialize(options = {}) ⇒ Settings
Returns a new instance of Settings.
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# File 'lib/chamber/settings.rb', line 20 def initialize( = {}) self.namespaces = [:namespaces] || [] self.raw_data = [:settings] || {} self.decryption_key = [:decryption_key] self.encryption_key = [:encryption_key] self.pre_filters = [:pre_filters] || [ Filters::NamespaceFilter, ] self.post_filters = [:post_filters] || [ Filters::DecryptionFilter, Filters::EnvironmentFilter, Filters::FailedDecryptionFilter, Filters::BooleanConversionFilter, Filters::TranslateSecureKeysFilter, ] end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(name, *args) ⇒ Object
273 274 275 276 277 |
# File 'lib/chamber/settings.rb', line 273 def method_missing(name, *args) return data.public_send(name, *args) if data.respond_to?(name) super end |
Instance Attribute Details
#namespaces ⇒ Object
Returns the value of attribute namespaces.
18 19 20 |
# File 'lib/chamber/settings.rb', line 18 def namespaces @namespaces end |
Instance Method Details
#==(other) ⇒ Object
Internal: Determines whether a Settings is equal to another hash-like object.
Returns a Boolean
198 199 200 |
# File 'lib/chamber/settings.rb', line 198 def ==(other) to_hash == other.to_hash end |
#eql?(other) ⇒ Boolean
Internal: Determines whether a Settings is equal to another Settings.
Returns a Boolean
207 208 209 210 211 |
# File 'lib/chamber/settings.rb', line 207 def eql?(other) other.is_a?(Chamber::Settings) && data == other.data && namespaces == other.namespaces end |
#insecure ⇒ Object
226 227 228 229 230 231 |
# File 'lib/chamber/settings.rb', line 226 def insecure Settings.new(.merge( settings: raw_data, pre_filters: [Filters::InsecureFilter], post_filters: [Filters::TranslateSecureKeysFilter])) end |
#merge(other) ⇒ Object
Internal: Merges a Settings object with another Settings object or a hash-like object.
Also, if merging Settings, it will merge all other Settings data as well.
Example:
settings = Settings.new settings: { my_setting: 'my value' }
other_settings = Settings.new settings: { my_other_setting: 'my other value' }
settings.merge other_settings
settings
# => {
'my_setting' => 'my value',
'my_other_setting' => 'my other value',
}
Returns a new Settings object
178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/chamber/settings.rb', line 178 def merge(other) other_settings = if other.is_a? Settings other elsif other.is_a? Hash Settings.new(settings: other) end Settings.new( encryption_key: encryption_key || other_settings.encryption_key, decryption_key: decryption_key || other_settings.decryption_key, namespaces: (namespaces + other_settings.namespaces), settings: raw_data.merge(other_settings.raw_data)) end |
#respond_to_missing?(name, include_private = false) ⇒ Boolean
279 280 281 |
# File 'lib/chamber/settings.rb', line 279 def respond_to_missing?(name, include_private = false) data.respond_to?(name, include_private) end |
#securable ⇒ Object
213 214 215 216 217 |
# File 'lib/chamber/settings.rb', line 213 def securable Settings.new(.merge( settings: raw_data, pre_filters: [Filters::SecureFilter])) end |
#secure ⇒ Object
219 220 221 222 223 224 |
# File 'lib/chamber/settings.rb', line 219 def secure Settings.new(.merge( settings: raw_data, pre_filters: [Filters::EncryptionFilter], post_filters: [Filters::TranslateSecureKeysFilter])) end |
#to_concatenated_name_hash(hierarchical_separator = '_') ⇒ Object
145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/chamber/settings.rb', line 145 def to_concatenated_name_hash(hierarchical_separator = '_') concatenated_name_hash = {} to_flattened_name_hash.each_pair do |flattened_name, value| concatenated_name = flattened_name.join(hierarchical_separator) concatenated_name_hash[concatenated_name] = value end concatenated_name_hash.sort end |
#to_environment ⇒ Object
Internal: Converts a Settings object into a hash that is compatible as an environment variable hash.
Example:
settings = Settings.new settings: {
my_setting: 'my value',
my_sub_setting: {
my_sub_sub_setting_1: 'my sub value 1',
my_sub_sub_setting_2: 'my sub value 2',
}
settings.to_environment
# => {
'MY_SETTING' => 'my value',
'MY_SUB_SETTING_MY_SUB_SUB_SETTING_1' => 'my sub value 1',
'MY_SUB_SETTING_MY_SUB_SUB_SETTING_2' => 'my sub value 2',
}
Returns a Hash sorted alphabetically by the names of the keys
58 59 60 61 62 |
# File 'lib/chamber/settings.rb', line 58 def to_environment to_concatenated_name_hash('_').each_with_object({}) do |pair, env_hash| env_hash[pair[0].upcase] = pair[1].to_s end end |
#to_flattened_name_hash(hash = data, parent_keys = []) ⇒ Object
Internal: Returns a hash which contains the flattened name hierarchy of the setting as the keys and the values of each setting as the value.
Examples:
Settings.new(settings: {
my_setting: 'value',
there: 'was not that easy?',
level_1: {
level_2: {
some_setting: 'hello',
another: 'goodbye',
},
body: 'gracias',
},
}).to_flattened_name_hash
# => {
['my_setting'] => 'value',
['there'] => 'was not that easy?',
['level_1', 'level_2', 'some_setting'] => 'hello',
['level_1', 'level_2', 'another'] => 'goodbye',
['level_1', 'body'] => 'gracias',
}
Returns a Hash
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/chamber/settings.rb', line 128 def to_flattened_name_hash(hash = data, parent_keys = []) flattened_name_hash = {} hash.each_pair do |key, value| flattened_name_components = parent_keys.dup.push(key) if value.respond_to?(:each_pair) flattened_name_hash.merge! to_flattened_name_hash(value, flattened_name_components) else flattened_name_hash[flattened_name_components] = value end end flattened_name_hash end |
#to_hash ⇒ Object
Internal: Returns the Settings data as a Hash for easy manipulation. Changes made to the hash will not be reflected in the original Settings object.
Returns a Hash
98 99 100 |
# File 'lib/chamber/settings.rb', line 98 def to_hash data.to_hash end |
#to_s(options = {}) ⇒ Object
76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/chamber/settings.rb', line 76 def to_s( = {}) hierarchical_separator = [:hierarchical_separator] || '_' pair_separator = [:pair_separator] || ' ' value_surrounder = [:value_surrounder] || '"' name_value_separator = [:name_value_separator] || '=' concatenated_name_hash = to_concatenated_name_hash(hierarchical_separator) pairs = concatenated_name_hash.to_a.map do |key, value| "#{key.upcase}#{name_value_separator}#{value_surrounder}#{value}#{value_surrounder}" end pairs.join(pair_separator) end |