Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
contextual_logger (0.4.0)
contextual_logger (0.5.0)
activesupport
json

Expand Down
2 changes: 1 addition & 1 deletion contextual_logger.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Gem::Specification.new do |spec|
spec.name = 'contextual_logger'
spec.version = '0.4.0'
spec.version = '0.5.0'
spec.license = 'MIT'
spec.date = '2018-10-12'
spec.summary = 'Add context to your logger'
Expand Down
23 changes: 23 additions & 0 deletions lib/contextual_logger.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,29 @@ class << self
def new(logger)
logger.extend(LoggerMixin)
end

def normalize_log_level(log_level)
if log_level.is_a?(Integer) && (Logger::Severity::DEBUG..Logger::Severity::UNKNOWN).include?(log_level)
log_level
else
case log_level.to_s.downcase
when 'debug'
Logger::Severity::DEBUG
when 'info'
Logger::Severity::INFO
when 'warn'
Logger::Severity::WARN
when 'error'
Logger::Severity::ERROR
when 'fatal'
Logger::Severity::FATAL
when 'unknown'
Logger::Severity::UNKNOWN
else
raise ArgumentError, "invalid log level: #{log_level.inspect}"
end
end
end
end

module LoggerMixin
Expand Down
22 changes: 1 addition & 21 deletions lib/contextual_logger/logger_with_context.rb
Original file line number Diff line number Diff line change
Expand Up @@ -22,27 +22,7 @@ def level
end

def level=(override_level)
@override_level =
if (Logger::Severity::DEBUG..Logger::Severity::UNKNOWN).include?(override_level) || override_level.nil?
override_level
else
case override_level.to_s.downcase
when 'debug'
Logger::Severity::DEBUG
when 'info'
Logger::Severity::INFO
when 'warn'
Logger::Severity::WARN
when 'error'
Logger::Severity::ERROR
when 'fatal'
Logger::Severity::FATAL
when 'unknown'
Logger::Severity::UNKNOWN
else
raise ArgumentError, "invalid log level: #{override_level.inspect}"
end
end
@override_level = (ContextualLogger.normalize_log_level(override_level) if override_level)
end

def write_entry_to_log(severity, timestamp, progname, message, context:)
Expand Down
53 changes: 53 additions & 0 deletions spec/lib/contextual_logger_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -298,4 +298,57 @@ def expect_log_line_to_be_written(log_line)
expect(log_stream.string).to match(/\{"message":"info message","severity":"INFO","timestamp":".*"\}/)
end
end

LOG_LEVEL_STRINGS_TO_CONSTANTS =
{
"DEBUG" => Logger::Severity::DEBUG,
"INFO" => Logger::Severity::INFO,
"WARN" => Logger::Severity::WARN,
"ERROR" => Logger::Severity::ERROR,
"FATAL" => Logger::Severity::FATAL,
"UNKNOWN" => Logger::Severity::UNKNOWN
}.freeze

describe 'module methods' do
describe "normalize_log_level" do
it "raises an exception on invalid values" do
[nil, "", "ABC", 3.5].each do |invalid_value|
expect { ContextualLogger.normalize_log_level(invalid_value) }.to raise_exception(ArgumentError, /invalid log level:/), invalid_value
end
end

it "accepts Severity constants" do
LOG_LEVEL_STRINGS_TO_CONSTANTS.each do |_uppercase_string_level, constant_level|
expect(ContextualLogger.normalize_log_level(constant_level)).to eq(constant_level)
end
end

it "accepts uppercase strings" do
LOG_LEVEL_STRINGS_TO_CONSTANTS.each do |uppercase_string_level, constant_level|
expect(ContextualLogger.normalize_log_level(uppercase_string_level)).to eq(constant_level)
end
end

it "accepts uppercase symbols" do
LOG_LEVEL_STRINGS_TO_CONSTANTS.each do |uppercase_string_level, constant_level|
uppercase_symbol_level = uppercase_string_level.to_sym
expect(ContextualLogger.normalize_log_level(uppercase_symbol_level)).to eq(constant_level)
end
end

it "accepts lowercase strings" do
LOG_LEVEL_STRINGS_TO_CONSTANTS.each do |uppercase_string_level, constant_level|
lowercase_string_level = uppercase_string_level.downcase
expect(ContextualLogger.normalize_log_level(lowercase_string_level)).to eq(constant_level)
end
end

it "accepts lowercase symbols" do
LOG_LEVEL_STRINGS_TO_CONSTANTS.each do |uppercase_string_level, constant_level|
lowercase_symbol_level = uppercase_string_level.downcase.to_sym
expect(ContextualLogger.normalize_log_level(lowercase_symbol_level)).to eq(constant_level)
end
end
end
end
end