Class: WarningsLogger::Configuration

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

Defined Under Namespace

Classes: NotConfiguredError

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



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

def initialize
  @project_name = nil
  @project_directory = nil
end

Instance Attribute Details

#project_name ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/warnings_logger/configuration.rb', line 16

def project_name
  if @project_name
    @project_name
  else
    raise NotConfiguredError.new(<<~EXAMPLE)
      WarningsLogger.configure do |config|
        config.project_name = "your_project_name"
      end
    EXAMPLE
  end
end

Instance Method Details

#project_directory ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/warnings_logger/configuration.rb', line 28

def project_directory
  if @project_directory
    @project_directory
  else
    raise NotConfiguredError.new(<<~EXAMPLE)
      WarningsLogger.configure do |config|
        config.project_directory = "/path/to/your/project/directory"
      end
    EXAMPLE
  end
end

#project_directory=(path) ⇒ Object 



40
41
42
 
# File 'lib/warnings_logger/configuration.rb', line 40

def project_directory=(path)
  @project_directory = Pathname.new(path)
end

#update! {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



12
13
14
 
# File 'lib/warnings_logger/configuration.rb', line 12

def update!
  yield self
end