Class: Webdrivers::Logger

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Logger::Severity
Defined in:
lib/webdrivers/logger.rb

Overview

Examples:

Enable full logging

Webdrivers.logger.level = :debug

Log to file

Webdrivers.logger.output = 'webdrivers.log'

Use logger manually

Webdrivers.logger.info('This is info message')
Webdrivers.logger.warn('This is warning message')

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Logger

Returns a new instance of Logger.



32
33
34
 
# File 'lib/webdrivers/logger.rb', line 32

def initialize
  @logger = create_logger($stdout)
end

Instance Method Details

#deprecate(old, new) ⇒ Object

Marks code as deprecated with replacement.

Parameters:

  • old (String)
  • new (String) 


94
95
96
 
# File 'lib/webdrivers/logger.rb', line 94

def deprecate(old, new)
  warn "[DEPRECATION] #{old} is deprecated. Use #{new} instead."
end

#io ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns IO object used by logger internally.

Normally, we would have never needed it, but we want to use it as IO object for all child processes to ensure their output is redirected there.

It is only used in debug level, in other cases output is suppressed.



84
85
86
 
# File 'lib/webdrivers/logger.rb', line 84

def io
  @logger.instance_variable_get(:@logdev).instance_variable_get(:@dev)
end

#level=(severity) ⇒ Object

For Ruby < 2.3 compatibility Based on github.com/ruby/ruby/blob/ruby_2_3/lib/logger.rb#L250



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/webdrivers/logger.rb', line 50

def level=(severity)
  if severity.is_a?(Integer)
    @logger.level = severity
  else
    case severity.to_s.downcase
    when 'debug'
      @logger.level = DEBUG
    when 'info'
      @logger.level = INFO
    when 'warn'
      @logger.level = WARN
    when 'error'
      @logger.level = ERROR
    when 'fatal'
      @logger.level = FATAL
    when 'unknown'
      @logger.level = UNKNOWN
    else
      raise ArgumentError, "invalid log level: #{severity}"
    end
  end
end

#output=(io) ⇒ Object 



36
37
38
39
40
41
42
43
 
# File 'lib/webdrivers/logger.rb', line 36

def output=(io)
  # `Logger#reopen` was added in Ruby 2.3
  if @logger.respond_to?(:reopen)
    @logger.reopen(io)
  else
    @logger = create_logger(io)
  end
end