module R10K::Logging

Constants

LOG_LEVELS

Attributes

formatter[R]

@!attribute [r] formatter

@api private
@return [Log4r::Formatter]
level[R]

@!attribute [r] level

@return [Integer] The current log level. Lower numbers correspond
  to more verbose log levels.
outputter[R]

@!attribute [r] outputter

@api private
@return [Log4r::Outputter]

Public Class Methods

debug_formatter() click to toggle source
# File lib/r10k/logging.rb, line 94
def debug_formatter
  Log4r::PatternFormatter.new(:pattern => '[%d - %l] %m')
end
default_formatter() click to toggle source
# File lib/r10k/logging.rb, line 90
def default_formatter
  Log4r::PatternFormatter.new(:pattern => '%l\t -> %m')
end
default_outputter() click to toggle source
# File lib/r10k/logging.rb, line 98
def default_outputter
  R10K::Logging::TerminalOutputter.new('terminal', $stderr, :level => self.level, :formatter => formatter)
end
level=(val) click to toggle source
# File lib/r10k/logging.rb, line 57
def level=(val)
  level = parse_level(val)
  if level.nil?
    raise ArgumentError, _("Invalid log level '%{val}'. Valid levels are %{log_levels}") % {val: val, log_levels: LOG_LEVELS.map(&:downcase).inspect}
  end
  outputter.level = level
  @level = level

  if level < Log4r::INFO
    outputter.formatter = debug_formatter
  else
    outputter.formatter = default_formatter
  end
end
parse_level(input) click to toggle source

Convert the input to a valid Log4r log level

@param input [String, TrueClass] The level to parse. If TrueClass then

Log4r::INFO will be returned (indicating a generic raised verbosity),
if a string it will be parsed either as a numeric value or a textual
log level.

@api private @return [Integer, NilClass] The numeric log level, or nil if the log

level is invalid.
# File lib/r10k/logging.rb, line 40
def parse_level(input)
  case input
  when TrueClass
    Log4r::INFO
  when /\A\d+\Z/
    Integer(input)
  when String
    const_name = input.upcase
    if LOG_LEVELS.include?(const_name)
      begin
        Log4r.const_get(const_name.to_sym)
      rescue NameError
      end
    end
  end
end

Public Instance Methods

logger() click to toggle source
# File lib/r10k/logging.rb, line 16
def logger
  if @logger.nil?
    name = logger_name
    if Log4r::Logger[name]
      @logger = Log4r::Logger[name]
    else
      @logger = Log4r::Logger.new(name)
      @logger.add(R10K::Logging.outputter)
    end
  end
  @logger
end
logger_name() click to toggle source
# File lib/r10k/logging.rb, line 12
def logger_name
  self.class.to_s
end