Class: LearnLab::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/learn_lab/configuration.rb

Overview

Interface for dealing with persisted configuration file in YAML format.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path, data, **options) ⇒ Configuration

Returns a new instance of Configuration.

[View source]

20
21
22
23
24
# File 'lib/learn_lab/configuration.rb', line 20

def initialize(path, data, **options)
  @path = path
  @fs = options.fetch(:fs) { LearnLab.file_system }
  @email = data[:email]
end

Instance Attribute Details

#emailObject

Returns the value of attribute email.


8
9
10
# File 'lib/learn_lab/configuration.rb', line 8

def email
  @email
end

#fsObject (readonly)

Returns the value of attribute fs.


7
8
9
# File 'lib/learn_lab/configuration.rb', line 7

def fs
  @fs
end

#pathObject (readonly)

Returns the value of attribute path.


7
8
9
# File 'lib/learn_lab/configuration.rb', line 7

def path
  @path
end

Class Method Details

.open(filename = 'enterprise.yml', **options) ⇒ Object

[View source]

10
11
12
13
14
15
16
17
18
# File 'lib/learn_lab/configuration.rb', line 10

def self.open(filename='enterprise.yml', **options)
  fs = options.fetch(:fs) { LearnLab.file_system }
  path = fs.join(fs.home, '.flatiron-school', filename)
  data = fs.read_yaml_file(path)
  new(path, data)
rescue ConfigurationError
  path = fs.join(fs.home, '.flatiron-school', 'enterprise.yml')
  new(path, {})
end

Instance Method Details

#save!Object

[View source]

26
27
28
29
30
# File 'lib/learn_lab/configuration.rb', line 26

def save!
  directory = fs.dirname(path)
  fs.mkdir(directory) unless fs.directory?(directory)
  fs.write_yaml_file(path, payload, mode: 'w')
end

#valid?Boolean

Returns:

  • (Boolean)
[View source]

32
33
34
# File 'lib/learn_lab/configuration.rb', line 32

def valid?
  !email.nil?
end