Module: Uniword::Loggable

Defined in:
lib/uniword/loggable.rb

Overview

A mixin module that provides logging capabilities to classes.

Classes that include this module gain access to logging methods that delegate to the global Uniword logger.

Examples:

class MyClass
  include Uniword::Loggable

  def do_something
    log_debug("Starting operation")
    # ... do work ...
    log_info("Operation completed")
  rescue => e
    log_error("Operation failed: #{e.message}")
  end
end

Instance Method Summary collapse

Instance Method Details

#log_debug(message) ⇒ Object

Log a debug message

Parameters:

  • message (String) —

    The message to log



32
33
34
 
# File 'lib/uniword/loggable.rb', line 32

def log_debug(message)
  logger.debug(message)
end

#log_error(message) ⇒ Object

Log an error message

Parameters:

  • message (String) —

    The message to log



53
54
55
 
# File 'lib/uniword/loggable.rb', line 53

def log_error(message)
  logger.error(message)
end

#log_info(message) ⇒ Object

Log an info message

Parameters:

  • message (String) —

    The message to log



39
40
41
 
# File 'lib/uniword/loggable.rb', line 39

def log_info(message)
  logger.info(message)
end

#log_warn(message) ⇒ Object

Log a warning message

Parameters:

  • message (String) —

    The message to log



46
47
48
 
# File 'lib/uniword/loggable.rb', line 46

def log_warn(message)
  logger.warn(message)
end

#logger ⇒ Logger

Returns the Uniword logger instance

Returns:

  • (Logger) —

    The Uniword logger



25
26
27
 
# File 'lib/uniword/loggable.rb', line 25

def logger
  Uniword.logger
end