Class: Chamber::File

Inherits:
Pathname
  • Object
show all
Defined in:
lib/chamber/file.rb

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ File

Internal: Creates a settings file representing a path to a file on the filesystem.

Optionally, namespaces may be passed in which will be passed to the Settings object for consideration of which data will be parsed (see the Settings object’s documentation for details on how this works).

Examples:

###
# It can be created by passing namespaces
#
settings_file = Chamber::File.new path:       '/tmp/settings.yml',
                                  namespaces: {
                                    environment: ENV['RAILS_ENV'] }
# => <Chamber::File>

settings_file.to_settings
# => <Chamber::Settings>

###
# It can also be created without passing any namespaces
#
Chamber::File.new path: '/tmp/settings.yml'
# => <Chamber::File>



39
40
41
42
43
44
45
 
# File 'lib/chamber/file.rb', line 39

def initialize(options = {})
  self.namespaces     = options[:namespaces] || {}
  self.decryption_key = options[:decryption_key]
  self.encryption_key = options[:encryption_key]

  super options.fetch(:path)
end

Instance Method Details

#secure ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/chamber/file.rb', line 73

def secure
  insecure_settings = to_settings.insecure.to_flattened_name_hash
  secure_settings   = to_settings.insecure.secure.to_flattened_name_hash
  file_contents     = self.read

  insecure_settings.each_pair do |name_pieces, value|
    secure_value = secure_settings[name_pieces]

    file_contents.
      sub!(
        /^(\s*)_secure_#{name_pieces.last}(\s*):(\s*)['"]?#{value}['"]?$/,
        "\\1_secure_#{name_pieces.last}\\2:\\3#{secure_value}")
  end

  self.write(file_contents)
end

#to_settings ⇒ Object

Internal: Extracts the data from the file on disk. First passing it through ERB to generate any dynamic properties and then passing the resulting data through YAML.

Therefore if a settings file contains something like:

“‘erb test:

my_dynamic_value: <%= 1 + 1 %>

“‘

then the resulting settings object would have:

“‘ruby settings[:my_dynamic_value] # => 2 “`



66
67
68
69
70
71
 
# File 'lib/chamber/file.rb', line 66

def to_settings
  @data ||= Settings.new(settings:        file_contents_hash,
                         namespaces:      namespaces,
                         decryption_key:  decryption_key,
                         encryption_key:  encryption_key)
end