Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add the ability to yield a message. #6306

Closed
wants to merge 1 commit into from
Closed

Add the ability to yield a message. #6306

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 19 additions & 14 deletions lib/jekyll/log_adapter.rb
View file
Open in desktop
Expand Up @@ -48,8 +48,8 @@ def adjust_verbosity(options = {})
# message - the message detail
#
# Returns nothing
def debug(topic, message = nil)
writer.debug(message(topic, message))
def debug(topic, message = nil, &block)
writer.debug(message(topic, message, &block))
end

# Public: Print a message
Expand All @@ -58,8 +58,8 @@ def debug(topic, message = nil)
# message - the message detail
#
# Returns nothing
def info(topic, message = nil)
writer.info(message(topic, message))
def info(topic, message = nil, &block)
writer.info(message(topic, message, &block))
end

# Public: Print a message
Expand All @@ -69,7 +69,7 @@ def info(topic, message = nil)
#
# Returns nothing
def warn(topic, message = nil)
writer.warn(message(topic, message))
writer.warn(message(topic, message, &block))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to add this to the method signature on line 71 (&block)

end

# Public: Print an error message
Expand All @@ -79,7 +79,7 @@ def warn(topic, message = nil)
#
# Returns nothing
def error(topic, message = nil)
writer.error(message(topic, message))
writer.error(message(topic, message, &block))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to add this to the method signature on line 81

end

# Public: Print an error message and immediately abort the process
Expand All @@ -88,8 +88,8 @@ def error(topic, message = nil)
# message - the message detail (can be omitted)
#
# Returns nothing
def abort_with(topic, message = nil)
error(topic, message)
def abort_with(topic, message = nil, &block)
error(topic, message, &block)
abort
end

Expand All @@ -99,19 +99,24 @@ def abort_with(topic, message = nil)
# message - the message detail
#
# Returns the formatted message
def message(topic, message)
msg = formatted_topic(topic) + message.to_s.gsub(%r!\s+!, " ")
messages << msg
msg
def message(topic, message = nil, &block)
raise ArgumentError, "block or message, not both" if block_given? && message

message = block.call if block_given?
message = message.to_s.gsub(%r!\s+!, " ")
topic = formatted_topic(topic, block_given?)
out = topic + message
messages << out
out
end

# Internal: Format the topic
#
# topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
#
# Returns the formatted topic statement
def formatted_topic(topic)
"#{topic} ".rjust(20)
def formatted_topic(topic, colon = false)
"#{topic}#{colon ? ": " : " "}".rjust(20)
end
end
end