Class: ApiAdaptor::NullLogger

Inherits:
Object
  • Object
show all
Defined in:
lib/api_adaptor/null_logger.rb

Overview

Null logger that discards all log messages.

This logger implements the Logger interface but does nothing with the messages, sending them to the metaphorical /dev/null. Useful for testing or when logging is not desired.

Examples:

Basic usage

logger = NullLogger.new
logger.info("This message is discarded")

Service pattern with optional logging

class SomeService
  def initialize(options = {})
    @logger = options[:logger] || NullLogger.new
  end

  def perform
    @logger.debug { "do some work here" }
    # Work happens...
    @logger.info { "finished working" }
  end
end

# With logging
service = SomeService.new(logger: Logger.new($stdout))
service.perform

# Silent (no logging)
silent = SomeService.new  # Uses NullLogger by default
silent.perform

Instance Method Summary collapse

Instance Method Details

#debug(*_args) ⇒ nil

Logs a debug message (discarded)

Parameters:

  • _args (Array) —

    Message arguments (ignored)

Returns:

  • (nil) 


99
100
101
 
# File 'lib/api_adaptor/null_logger.rb', line 99

def debug(*_args)
  nil
end

#debug? ⇒ Boolean

Returns false (debug logging is never enabled).

Returns:

  • (Boolean) —

    false (debug logging is never enabled)



104
105
106
 
# File 'lib/api_adaptor/null_logger.rb', line 104

def debug?
  false
end

#error(*_args) ⇒ nil

Logs an error message (discarded)

Parameters:

  • _args (Array) —

    Message arguments (ignored)

Returns:

  • (nil) 


60
61
62
 
# File 'lib/api_adaptor/null_logger.rb', line 60

def error(*_args)
  nil
end

#error? ⇒ Boolean

Returns false (error logging is never enabled).

Returns:

  • (Boolean) —

    false (error logging is never enabled)



65
66
67
 
# File 'lib/api_adaptor/null_logger.rb', line 65

def error?
  false
end

#fatal(*_args) ⇒ nil

Logs a fatal message (discarded)

Parameters:

  • _args (Array) —

    Message arguments (ignored)

Returns:

  • (nil) 


47
48
49
 
# File 'lib/api_adaptor/null_logger.rb', line 47

def fatal(*_args)
  nil
end

#fatal? ⇒ Boolean

Returns false (fatal logging is never enabled).

Returns:

  • (Boolean) —

    false (fatal logging is never enabled)



52
53
54
 
# File 'lib/api_adaptor/null_logger.rb', line 52

def fatal?
  false
end

#info(*_args) ⇒ nil

Logs an info message (discarded)

Parameters:

  • _args (Array) —

    Message arguments (ignored)

Returns:

  • (nil) 


86
87
88
 
# File 'lib/api_adaptor/null_logger.rb', line 86

def info(*_args)
  nil
end

#info? ⇒ Boolean

Returns false (info logging is never enabled).

Returns:

  • (Boolean) —

    false (info logging is never enabled)



91
92
93
 
# File 'lib/api_adaptor/null_logger.rb', line 91

def info?
  false
end

#unknown(*_args) ⇒ nil

Logs an unknown severity message (discarded)

Parameters:

  • _args (Array) —

    Message arguments (ignored)

Returns:

  • (nil) 


39
40
41
 
# File 'lib/api_adaptor/null_logger.rb', line 39

def unknown(*_args)
  nil
end

#warn(*_args) ⇒ nil

Logs a warning message (discarded)

Parameters:

  • _args (Array) —

    Message arguments (ignored)

Returns:

  • (nil) 


73
74
75
 
# File 'lib/api_adaptor/null_logger.rb', line 73

def warn(*_args)
  nil
end

#warn? ⇒ Boolean

Returns false (warn logging is never enabled).

Returns:

  • (Boolean) —

    false (warn logging is never enabled)



78
79
80
 
# File 'lib/api_adaptor/null_logger.rb', line 78

def warn?
  false
end