module OmfCommon::DefaultLogging

Public Instance Methods

debug(*args, &block) click to toggle source

@see info

# File lib/omf_common/default_logging.rb, line 33
def debug(*args, &block)
  get_logger(args[1]).debug(args[0], &block)
end
error(*args, &block) click to toggle source

@see info

# File lib/omf_common/default_logging.rb, line 38
def error(*args, &block)
  get_logger(args[1]).error(args[0], &block)
end
fatal(*args, &block) click to toggle source

@see info

# File lib/omf_common/default_logging.rb, line 43
def fatal(*args, &block)
  get_logger(args[1]).fatal(args[0], &block)
end
info(*args, &block) click to toggle source

Alias logging method using default logger

@example

info 'Information'
# Additional logger name will generate a new child logger in the context of default logger
info 'Information', 'logger name'
# File lib/omf_common/default_logging.rb, line 28
def info(*args, &block)
  get_logger(args[1]).info(args[0], &block)
end
warn(*args, &block) click to toggle source

@see info

# File lib/omf_common/default_logging.rb, line 48
def warn(*args, &block)
  get_logger(args[1]).warn(args[0], &block)
end
warn_deprecation(deprecated_name, *suggest_names) click to toggle source

Log a warning message for deprecated methods

# File lib/omf_common/default_logging.rb, line 53
def warn_deprecation(deprecated_name, *suggest_names)
  logger.warn "[DEPRECATION] '#{deprecated_name}' is deprecated. Please use '#{suggest_names.join(', ')}' instead."
end
warn_removed(deprecated_name) click to toggle source
# File lib/omf_common/default_logging.rb, line 57
def warn_removed(deprecated_name)
  define_method(deprecated_name) do |*args, &block|
    logger.warn "[DEPRECATION] '#{deprecated_name}' is deprecated and not supported. Please do not use it."
  end
end

Private Instance Methods

get_logger(name = nil) click to toggle source
# File lib/omf_common/default_logging.rb, line 65
def get_logger(name = nil)
  name.nil? ? logger : Logging::Logger["#{logger.name}::#{name.to_s}"]
end