Parent

Files

Class/Module Index [+]

Quicksearch

Jekyll::LogAdapter

Constants

LOG_LEVELS

Attributes

writer[R]

Public Class Methods

new(writer, level = :info) click to toggle source

Public: Create a new instance of Jekyll’s log writer

writer - Logger compatible instance log_level - (optional, symbol) the log level

Returns nothing

# File lib/jekyll/log_adapter.rb, line 18
def initialize(writer, level = :info)
  @writer = writer
  self.log_level = level
end

Public Instance Methods

abort_with(topic, message = nil) click to toggle source

Public: Print a Jekyll error message and immediately abort the process

topic - the topic of the message, e.g. “Configuration file”, “Deprecation”, etc. message - the message detail (can be omitted)

Returns nothing

# File lib/jekyll/log_adapter.rb, line 78
def abort_with(topic, message = nil)
  error(topic, message)
  abort
end
debug(topic, message = nil) click to toggle source

Public: Print a jekyll debug message

topic - the topic of the message, e.g. “Configuration file”, “Deprecation”, etc. message - the message detail

Returns nothing

# File lib/jekyll/log_adapter.rb, line 38
def debug(topic, message = nil)
  writer.debug(message(topic, message))
end
error(topic, message = nil) click to toggle source

Public: Print a jekyll error message

topic - the topic of the message, e.g. “Configuration file”, “Deprecation”, etc. message - the message detail

Returns nothing

# File lib/jekyll/log_adapter.rb, line 68
def error(topic, message = nil)
  writer.error(message(topic, message))
end
formatted_topic(topic) click to toggle source

Internal: Format the topic

topic - the topic of the message, e.g. “Configuration file”, “Deprecation”, etc.

Returns the formatted topic statement

# File lib/jekyll/log_adapter.rb, line 98
def formatted_topic(topic)
  "#{topic} ".rjust(20)
end
info(topic, message = nil) click to toggle source

Public: Print a jekyll message

topic - the topic of the message, e.g. “Configuration file”, “Deprecation”, etc. message - the message detail

Returns nothing

# File lib/jekyll/log_adapter.rb, line 48
def info(topic, message = nil)
  writer.info(message(topic, message))
end
log_level=(level) click to toggle source

Public: Set the log level on the writer

level - (symbol) the log level

Returns nothing

# File lib/jekyll/log_adapter.rb, line 28
def log_level=(level)
  writer.level = LOG_LEVELS.fetch(level)
end
message(topic, message) click to toggle source

Internal: Build a Jekyll topic method

topic - the topic of the message, e.g. “Configuration file”, “Deprecation”, etc. message - the message detail

Returns the formatted message

# File lib/jekyll/log_adapter.rb, line 89
def message(topic, message)
  formatted_topic(topic) + message.to_s.gsub(/\s+/, ' ')
end
warn(topic, message = nil) click to toggle source

Public: Print a jekyll message

topic - the topic of the message, e.g. “Configuration file”, “Deprecation”, etc. message - the message detail

Returns nothing

# File lib/jekyll/log_adapter.rb, line 58
def warn(topic, message = nil)
  writer.warn(message(topic, message))
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.