semantic_logger 4.2.0 → 4.2.1

data/lib/semantic_logger/formatters.rb

@@ -20,18 +20,16 @@ module SemanticLogger
     # - Proc
     # - Any object that responds to :call
     def self.factory(formatter)
-      case
-      when formatter.is_a?(Symbol)
+      if formatter.is_a?(Symbol)
         SemanticLogger::Utils.constantize_symbol(formatter, 'SemanticLogger::Formatters').new
-      when formatter.is_a?(Hash) && formatter.size > 0
+      elsif formatter.is_a?(Hash) && formatter.size.positive?
         fmt, options = formatter.first
         SemanticLogger::Utils.constantize_symbol(fmt.to_sym, 'SemanticLogger::Formatters').new(options)
-      when formatter.respond_to?(:call)
+      elsif formatter.respond_to?(:call)
         formatter
       else
         raise(ArgumentError, "Unknown formatter: #{formatter.inspect}")
       end
     end
-
   end
 end

data/lib/semantic_logger/formatters/base.rb

@@ -8,7 +8,7 @@ module SemanticLogger
       # JRuby 9.1.8.0 supports microseconds
       PRECISION   =
         if defined?(JRuby)
-          if (JRUBY_VERSION.to_f >= 9.1)
+          if JRUBY_VERSION.to_f >= 9.1
             maint = JRUBY_VERSION.match(/\A\d+\.\d+\.(\d+)\./)[1].to_i
             (maint >= 8) || (JRUBY_VERSION.to_f > 9.1) ? 6 : 3
           else
@@ -17,7 +17,7 @@ module SemanticLogger
         else
           6
         end
-      TIME_FORMAT = "%Y-%m-%d %H:%M:%S.%#{PRECISION}N"
+      TIME_FORMAT = "%Y-%m-%d %H:%M:%S.%#{PRECISION}N".freeze
 
       # Parameters
       #   time_format: [String|Symbol|nil]
@@ -56,7 +56,6 @@ module SemanticLogger
           time.strftime(time_format)
         end
       end
-
     end
   end
 end

data/lib/semantic_logger/formatters/color.rb

@@ -2,6 +2,7 @@
 begin
   require 'awesome_print'
 rescue LoadError
+  nil
 end
 
 module SemanticLogger
@@ -13,7 +14,14 @@ module SemanticLogger
       class ColorMap
         attr_accessor :trace, :debug, :info, :warn, :error, :fatal, :bold, :clear
 
-        def initialize(trace: AnsiColors::MAGENTA, debug: AnsiColors::GREEN, info: AnsiColors::CYAN, warn: AnsiColors::BOLD, error: AnsiColors::RED, fatal: AnsiColors::RED, bold: AnsiColors::BOLD, clear: AnsiColors::CLEAR)
+        def initialize(trace: AnsiColors::MAGENTA,
+                       debug: AnsiColors::GREEN,
+                       info: AnsiColors::CYAN,
+                       warn: AnsiColors::BOLD,
+                       error: AnsiColors::RED,
+                       fatal: AnsiColors::RED,
+                       bold: AnsiColors::BOLD,
+                       clear: AnsiColors::CLEAR)
           @trace = trace
           @debug = debug
           @info  = info
@@ -50,7 +58,11 @@ module SemanticLogger
       #
       #  color_map: [Hash | SemanticLogger::Formatters::Color::ColorMap]
       #    ColorMaps each of the log levels to a color
-      def initialize(ap: {multiline: false}, color_map: ColorMap.new, time_format: TIME_FORMAT, log_host: false, log_application: false)
+      def initialize(ap: {multiline: false},
+                     color_map: ColorMap.new,
+                     time_format: TIME_FORMAT,
+                     log_host: false,
+                     log_application: false)
         @ai_options = ap
         @color_map  = color_map.is_a?(ColorMap) ? color_map : ColorMap.new(color_map)
         super(time_format: time_format, log_host: log_host, log_application: log_application)
@@ -66,11 +78,12 @@ module SemanticLogger
 
       # Named Tags
       def named_tags
-        if (named_tags = log.named_tags) && !named_tags.empty?
-          list = []
-          named_tags.each_pair { |name, value| list << "#{color}#{name}: #{value}#{color_map.clear}" }
-          "{#{list.join(', ')}}"
-        end
+        named_tags = log.named_tags
+        return if named_tags.nil? || named_tags.empty?
+
+        list = []
+        named_tags.each_pair { |name, value| list << "#{color}#{name}: #{value}#{color_map.clear}" }
+        "{#{list.join(', ')}}"
       end
 
       def duration
@@ -82,25 +95,29 @@ module SemanticLogger
       end
 
       def payload
-        return unless log.has_payload?
+        return unless log.payload?
 
         if !defined?(AwesomePrint) || !log.payload.respond_to?(:ai)
           super
         else
-          "-- #{log.payload.ai(@ai_options)}" rescue super
+          begin
+            "-- #{log.payload.ai(@ai_options)}"
+          rescue StandardError
+            super
+          end
         end
       end
 
       def exception
-        "-- Exception: #{color}#{log.exception.class}: #{log.exception.message}#{color_map.clear}\n#{log.backtrace_to_s}" if log.exception
+        return unless log.exception
+
+        "-- Exception: #{color}#{log.exception.class}: #{log.exception.message}#{color_map.clear}\n#{log.backtrace_to_s}"
       end
 
       def call(log, logger)
         self.color = color_map[log.level]
         super(log, logger)
       end
-
     end
   end
 end
-

data/lib/semantic_logger/formatters/default.rb

@@ -24,11 +24,12 @@ module SemanticLogger
 
       # Named Tags
       def named_tags
-        if (named_tags = log.named_tags) && !named_tags.empty?
-          list = []
-          named_tags.each_pair { |name, value| list << "#{name}: #{value}" }
-          "{#{list.join(', ')}}"
-        end
+        named_tags = log.named_tags
+        return if named_tags.nil? || named_tags.empty?
+
+        list = []
+        named_tags.each_pair { |name, value| list << "#{name}: #{value}" }
+        "{#{list.join(', ')}}"
       end
 
       # Duration
@@ -48,9 +49,10 @@ module SemanticLogger
 
       # Payload
       def payload
-        if pl = log.payload_to_s
-          "-- #{pl}"
-        end
+        pl = log.payload_to_s
+        return unless pl
+
+        "-- #{pl}"
       end
 
       # Exception
@@ -67,8 +69,6 @@ module SemanticLogger
 
         [time, level, process_info, tags, named_tags, duration, name, message, payload, exception].compact.join(' ')
       end
-
     end
   end
 end
-

data/lib/semantic_logger/formatters/json.rb

@@ -11,8 +11,6 @@ module SemanticLogger
       def call(log, logger)
         super(log, logger).to_json
       end
-
     end
   end
 end
-

data/lib/semantic_logger/formatters/one_line.rb

@@ -7,11 +7,11 @@ module SemanticLogger
     # * Exceptions only include the class and message, the stack trace is not shown.
     class OneLine < Default
       def message
-        "-- #{log.message.gsub("\n", '')}" if log.message
+        "-- #{log.message.delete("\n")}" if log.message
       end
 
       def exception
-        "-- Exception: #{log.exception.class}: #{log.exception.message.gsub("\n", '')}" if log.exception
+        "-- Exception: #{log.exception.class}: #{log.exception.message.delete("\n")}" if log.exception
       end
     end
   end

data/lib/semantic_logger/formatters/raw.rb

@@ -2,7 +2,6 @@ require 'json'
 module SemanticLogger
   module Formatters
     class Raw < Base
-
       # Fields are added by populating this hash.
       attr_accessor :hash, :log, :logger, :time_key
 
@@ -35,14 +34,14 @@ module SemanticLogger
 
       # Process info
       def process_info
-        hash[:pid]    = $$
+        hash[:pid]    = $PROCESS_ID
         hash[:thread] = log.thread_name
 
         file, line = log.file_name_and_line
-        if file
-          hash[:file] = file
-          hash[:line] = line.to_i
-        end
+        return unless file
+
+        hash[:file] = file
+        hash[:line] = line.to_i
       end
 
       # Tags
@@ -75,7 +74,7 @@ module SemanticLogger
 
       # Payload
       def payload
-        hash[:payload] = log.payload if log.payload && log.payload.respond_to?(:empty?) && !log.payload.empty?
+        hash[:payload] = log.payload if log.payload&.respond_to?(:empty?) && !log.payload.empty?
       end
 
       # Exception
@@ -83,7 +82,7 @@ module SemanticLogger
         return unless log.exception
         root = hash
         log.each_exception do |exception, i|
-          name       = i == 0 ? :exception : :cause
+          name       = i.zero? ? :exception : :cause
           root[name] = {
             name:        exception.class.name,
             message:     exception.message,
@@ -108,8 +107,6 @@ module SemanticLogger
         host; application; time; level; process_info; duration; tags; named_tags; name; message; payload; exception; metric
         hash
       end
-
     end
   end
 end
-

data/lib/semantic_logger/formatters/signalfx.rb

@@ -30,13 +30,12 @@ module SemanticLogger
       #   Strip leading '/'
       #   Convert remaining '/' to '.'
       def metric
+        name = log.metric.to_s.sub(/\A\/+/, '')
         if log.dimensions
-          name = log.metric.to_s.sub(/\A\/+/, '')
-          name.gsub!('/', '.')
+          name.tr!('/', '.')
           hash[:metric] = name
         else
           # Extract class and action from metric name
-          name  = log.metric.to_s.sub(/\A\/+/, '')
           names = name.split('/')
           h     = (hash[:dimensions] ||= {})
           if names.size > 1
@@ -75,7 +74,7 @@ module SemanticLogger
             name  = name.to_sym
             value = value.to_s
             next if value.empty?
-            h[name] = value if dimensions && dimensions.include?(name)
+            h[name] = value if dimensions&.include?(name)
           end
         end
         h[:host]        = logger.host if log_host && logger.host
@@ -163,7 +162,6 @@ module SemanticLogger
             (item[:dimensions] == metric[:dimensions])
         end
       end
-
     end
   end
 end

data/lib/semantic_logger/formatters/syslog.rb

@@ -1,7 +1,7 @@
 begin
   require 'syslog_protocol'
 rescue LoadError
-  raise 'Gem syslog_protocol is required for remote logging using the Syslog protol. Please add the gem "syslog_protocol" to your Gemfile.'
+  raise 'Gem syslog_protocol is required for remote logging using the Syslog protocol. Please add the gem "syslog_protocol" to your Gemfile.'
 end
 
 module SemanticLogger
@@ -73,7 +73,7 @@ module SemanticLogger
         packet          = SyslogProtocol::Packet.new
         packet.hostname = logger.host
         packet.facility = facility
-        packet.tag      = logger.application.gsub(' ', '')
+        packet.tag      = logger.application.delete(' ')
         packet.content  = message
         packet.time     = log.time
         packet.severity = level_map[log.level]
@@ -82,4 +82,3 @@ module SemanticLogger
     end
   end
 end
-

data/lib/semantic_logger/formatters/syslog_cee.rb

@@ -1,7 +1,7 @@
 begin
   require 'syslog_protocol'
 rescue LoadError
-  raise 'Gem syslog_protocol is required for remote logging using the Syslog protol. Please add the gem "syslog_protocol" to your Gemfile.'
+  raise 'Gem syslog_protocol is required for remote logging using the Syslog protocol. Please add the gem "syslog_protocol" to your Gemfile.'
 end
 
 module SemanticLogger
@@ -45,7 +45,7 @@ module SemanticLogger
         packet          = SyslogProtocol::Packet.new
         packet.hostname = logger.host
         packet.facility = facility
-        packet.tag      = logger.application.gsub(' ', '')
+        packet.tag      = logger.application.delete(' ')
         packet.content  = message
         packet.time     = log.time
         packet.severity = level_map[log.level]
@@ -54,4 +54,3 @@ module SemanticLogger
     end
   end
 end
-

data/lib/semantic_logger/jruby/garbage_collection_logger.rb

@@ -5,7 +5,7 @@ module SemanticLogger
 
       # Only log the garbage collection if the number of microseconds exceeds
       # this value
-      def initialize(min_microseconds = 10000)
+      def initialize(min_microseconds = 10_000)
         @min_microseconds = min_microseconds
       end
 
@@ -17,11 +17,14 @@ module SemanticLogger
         info     = Java::ComSunManagement::GarbageCollectionNotificationInfo.from(notification.user_data)
         gc_info  = info.gc_info
         duration = gc_info.duration
-        if duration >= @min_microseconds
-          SemanticLogger['GarbageCollector'].measure_warn "Garbage Collection completed: #{info.gc_name} ##{gc_info.id}", duration: duration.to_f / 1000
-        end
+
+        return unless duration >= @min_microseconds
+
+        SemanticLogger['GarbageCollector'].measure_warn(
+          "Garbage Collection completed: #{info.gc_name} ##{gc_info.id}",
+          duration: duration.to_f / 1000
+        )
       end
     end
-
   end
 end

data/lib/semantic_logger/log.rb

@@ -97,6 +97,7 @@ module SemanticLogger
           self.message = "#{message} -- Exception: #{exception.class}: #{exception.message}"
         when nil, :none
           # Log the message without the exception that was raised
+          nil
         else
           raise(ArgumentError, "Invalid value:#{log_exception.inspect} for argument :log_exception")
         end
@@ -119,7 +120,7 @@ module SemanticLogger
         self.dimensions    = dimensions
       end
 
-      self.payload = payload if payload && (payload.size > 0)
+      self.payload = payload if payload&.size&.positive?
       true
     end
 
@@ -150,7 +151,7 @@ module SemanticLogger
           assign(message: message, payload: payload, exception: exception)
         elsif message.nil? && result.is_a?(Hash)
           assign(result)
-        elsif payload && payload.respond_to?(:merge)
+        elsif payload&.respond_to?(:merge)
           assign(message: message, payload: payload.merge(result), exception: exception)
         else
           assign(message: message, payload: result, exception: exception)
@@ -167,7 +168,7 @@ module SemanticLogger
       depth      = 0
       exceptions = []
       ex         = exception
-      while ex != nil && !exceptions.include?(ex) && exceptions.length < MAX_EXCEPTIONS_TO_UNWRAP
+      while !ex.nil? && !exceptions.include?(ex) && exceptions.length < MAX_EXCEPTIONS_TO_UNWRAP
         exceptions << ex
         yield(ex, depth)
 
@@ -187,7 +188,7 @@ module SemanticLogger
     def backtrace_to_s
       trace = ''
       each_exception do |exception, i|
-        if i == 0
+        if i.zero?
           trace = (exception.backtrace || []).join("\n")
         else
           trace << "\nCause: #{exception.class.name}: #{exception.message}\n#{(exception.backtrace || []).join("\n")}"
@@ -206,7 +207,7 @@ module SemanticLogger
     else
       def duration_to_s
         return unless duration
-        duration < 10.0 ? "#{'%.3f' % duration}ms" : "#{'%.1f' % duration}ms"
+        duration < 10.0 ? "#{format('%.3f', duration)}ms" : "#{format('%.1f', duration)}ms"
       end
     end
 
@@ -214,14 +215,14 @@ module SemanticLogger
     def duration_human
       return nil unless duration
       seconds = duration / 1000
-      if seconds >= 86400.0 # 1 day
-        "#{(seconds / 86400).to_i}d #{Time.at(seconds).strftime('%-Hh %-Mm')}"
+      if seconds >= 86_400.0 # 1 day
+        "#{(seconds / 86_400).to_i}d #{Time.at(seconds).strftime('%-Hh %-Mm')}"
       elsif seconds >= 3600.0 # 1 hour
         Time.at(seconds).strftime('%-Hh %-Mm')
       elsif seconds >= 60.0 # 1 minute
         Time.at(seconds).strftime('%-Mm %-Ss')
       elsif seconds >= 1.0 # 1 second
-        "#{'%.3f' % seconds}s"
+        "#{format('%.3f', seconds)}s"
       else
         duration_to_s
       end
@@ -239,7 +240,7 @@ module SemanticLogger
       file, line = file_name_and_line(true)
       file_name  = " #{file}:#{line}" if file
 
-      "#{$$}:#{"%.#{thread_name_length}s" % thread_name}#{file_name}"
+      "#{$PROCESS_ID}:#{format("%.#{thread_name_length}s", thread_name)}#{file_name}"
     end
 
     CALLER_REGEXP = /^(.*):(\d+).*/
@@ -253,10 +254,8 @@ module SemanticLogger
     # Returns [String, String] the file_name and line_number from the backtrace supplied
     # in either the backtrace or exception
     def file_name_and_line(short_name = false)
-      if backtrace || (exception && exception.backtrace)
-        stack = backtrace || exception.backtrace
-        extract_file_and_line(stack, short_name) if stack && stack.size > 0
-      end
+      stack = backtrace || exception&.backtrace
+      extract_file_and_line(stack, short_name) if stack&.size&.positive?
     end
 
     # Strip the standard Rails colorizing from the logged message
@@ -267,14 +266,17 @@ module SemanticLogger
     # Return the payload in text form
     # Returns nil if payload is missing or empty
     def payload_to_s
-      payload.inspect if has_payload?
+      payload.inspect if payload?
     end
 
     # Returns [true|false] whether the log entry has a payload
-    def has_payload?
+    def payload?
       !(payload.nil? || (payload.respond_to?(:empty?) && payload.empty?))
     end
 
+    # DEPRECATED
+    alias has_payload? payload?
+
     # DEPRECATED
     def formatted_time
       time.strftime(Formatters::Base::TIME_FORMAT)
@@ -297,7 +299,5 @@ module SemanticLogger
     def metric_only?
       metric && message.nil? && exception.nil? && payload.nil?
     end
-
   end
-
 end