dry-logger 1.0.0.rc2 → 1.0.1

data/lib/dry/logger/formatters/colors.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Dry
+  module Logger
+    module Formatters
+      # Shell colorizer
+      #
+      # This was ported from hanami-utils
+      #
+      # @since 1.0.0
+      # @api private
+      class Colors
+        # Unknown color code error
+        #
+        # @since 1.0.0
+        class UnknownColorCodeError < StandardError
+          def initialize(code)
+            super("Unknown color code: `#{code.inspect}'")
+          end
+        end
+
+        # Escapes codes for terminals to output strings in colors
+        #
+        # @since 1.2.0
+        # @api private
+        COLORS = {black: 30,
+                  red: 31,
+                  green: 32,
+                  yellow: 33,
+                  blue: 34,
+                  magenta: 35,
+                  cyan: 36,
+                  gray: 37}.freeze
+
+        # @api private
+        def self.evaluate(input)
+          COLORS.keys.reduce(input.dup) { |output, color|
+            output.gsub!("<#{color}>", start(color))
+            output.gsub!("</#{color}>", stop)
+            output
+          }
+        end
+
+        # Colorizes output
+        # 8 colors available: black, red, green, yellow, blue, magenta, cyan, and gray
+        #
+        # @param input [#to_s] the string to colorize
+        # @param color [Symbol] the color
+        #
+        # @raise [UnknownColorError] if the color code is unknown
+        #
+        # @return [String] the colorized string
+        #
+        # @since 1.0.0
+        # @api private
+        def self.call(color, input)
+          "#{start(color)}#{input}#{stop}"
+        end
+
+        # @since 1.0.0
+        # @api private
+        def self.start(color)
+          "\e[#{self[color]}m"
+        end
+
+        # @since 1.0.0
+        # @api private
+        def self.stop
+          "\e[0m"
+        end
+
+        # Helper method to translate between color names and terminal escape codes
+        #
+        # @since 1.0.0
+        # @api private
+        #
+        # @raise [UnknownColorError] if the color code is unknown
+        def self.[](code)
+          COLORS.fetch(code) { raise UnknownColorCodeError, code }
+        end
+      end
+    end
+  end
+end

data/lib/dry/logger/formatters/json.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "json"
+
+require "dry/logger/constants"
 require "dry/logger/formatters/structured"
 
 module Dry
@@ -16,7 +18,31 @@ module Dry
         # @since 0.1.0
         # @api private
         def format(entry)
-          "#{::JSON.generate(entry.as_json)}#{NEW_LINE}"
+          hash = format_values(entry).compact
+          hash.update(hash.delete(:exception)) if entry.exception?
+          ::JSON.dump(hash)
+        end
+
+        # @since 0.1.0
+        # @api private
+        def format_severity(value)
+          value.upcase
+        end
+
+        # @since 0.1.0
+        # @api private
+        def format_exception(value)
+          {
+            exception: value.class,
+            message: value.message,
+            backtrace: value.backtrace || EMPTY_ARRAY
+          }
+        end
+
+        # @since 0.1.0
+        # @api private
+        def format_time(value)
+          value.getutc.iso8601
         end
       end
     end

data/lib/dry/logger/formatters/rack.rb

@@ -12,10 +12,18 @@ module Dry
       #
       # @see String
       class Rack < String
+        # @see String#initialize
         # @since 1.0.0
         # @api private
-        def format_entry(entry)
-          [*entry.payload.except(:params).values, entry[:params]].compact.join(SEPARATOR)
+        def initialize(**options)
+          super
+          @template = Template[Logger.templates[:rack]]
+        end
+
+        # @api 1.0.0
+        # @api private
+        def format_params(value)
+          return value unless value.empty?
         end
       end
     end

data/lib/dry/logger/formatters/string.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-require "dry/logger/formatters/structured"
+require "set"
+
+require_relative "template"
+require_relative "structured"
 
 module Dry
   module Logger
@@ -12,10 +15,6 @@ module Dry
       # @since 1.0.0
       # @api public
       class String < Structured
-        # @since 1.0.0
-        # @api private
-        SEPARATOR = " "
-
         # @since 1.0.0
         # @api private
         HASH_SEPARATOR = ","
@@ -24,9 +23,16 @@ module Dry
         # @api private
         EXCEPTION_SEPARATOR = ": "
 
-        # @since 1.0.0
+        # @since 1.2.0
         # @api private
-        DEFAULT_TEMPLATE = "%<message>s"
+        DEFAULT_SEVERITY_COLORS = {
+          DEBUG => :cyan,
+          INFO => :magenta,
+          WARN => :yellow,
+          ERROR => :red,
+          FATAL => :red,
+          UNKNOWN => :blue
+        }.freeze
 
         # @since 1.0.0
         # @api private
@@ -34,47 +40,108 @@ module Dry
 
         # @since 1.0.0
         # @api private
-        def initialize(template: DEFAULT_TEMPLATE, **options)
+        def initialize(template: Logger.templates[:default], **options)
           super(**options)
-          @template = template
+          @template = Template[template]
+        end
+
+        # @since 1.0.0
+        # @api private
+        def colorize?
+          options[:colorize].equal?(true)
         end
 
         private
 
         # @since 1.0.0
         # @api private
-        def format(entry)
-          "#{template % entry.meta.merge(message: format_entry(entry))}#{NEW_LINE}"
+        def format_severity(value)
+          output = value.upcase
+
+          if colorize?
+            Colors.call(severity_colors[LEVELS[value]], output)
+          else
+            output
+          end
         end
 
         # @since 1.0.0
         # @api private
-        def format_entry(entry)
+        def format(entry)
           if entry.exception?
-            format_exception(entry)
-          elsif entry.message
-            if entry.payload.empty?
-              entry.message
-            else
-              "#{entry.message}#{SEPARATOR}#{format_payload(entry)}"
-            end
+            head = template % template_data(entry, exclude: %i[exception])
+            tail = format_exception(entry.exception)
+
+            "#{head}#{NEW_LINE}#{TAB}#{tail}"
           else
-            format_payload(entry)
+            template % template_data(entry)
           end
         end
 
         # @since 1.0.0
         # @api private
-        def format_exception(entry)
-          hash = entry.payload
-          message = hash.values_at(:error, :message).compact.join(EXCEPTION_SEPARATOR)
-          "#{message}#{NEW_LINE}#{hash[:backtrace].map { |line| "from #{line}" }.join(NEW_LINE)}"
+        def format_tags(value)
+          Array(value)
+            .map { |tag|
+              case tag
+              when Hash then format_payload(tag)
+              else
+                tag.to_s
+              end
+            }
+            .join(SEPARATOR)
+        end
+
+        # @since 1.0.0
+        # @api private
+        def format_exception(value)
+          [
+            "#{value.message} (#{value.class})",
+            format_backtrace(value.backtrace || EMPTY_BACKTRACE)
+          ].join(NEW_LINE)
+        end
+
+        # @since 1.0.0
+        # @api private
+        def format_payload(payload)
+          payload.map { |key, value| "#{key}=#{value.inspect}" }.join(SEPARATOR)
+        end
+
+        # @since 1.0.0
+        # @api private
+        def format_backtrace(value)
+          value.map { |line| "#{TAB}#{line}" }.join(NEW_LINE)
+        end
+
+        # @since 1.0.0
+        # @api private
+        def template_data(entry, exclude: EMPTY_ARRAY)
+          data = format_values(entry)
+          payload = data.except(:message, *entry.meta.keys, *template.tokens, *exclude)
+          data[:payload] = format_payload(payload)
+
+          if template.include?(:tags)
+            data[:tags] = format_tags(entry.tags)
+          end
+
+          if data[:message]
+            data.except(*payload.keys)
+          elsif template.include?(:message)
+            data[:message] = data.delete(:payload)
+            data[:payload] = nil
+            data
+          else
+            data
+          end
         end
 
         # @since 1.0.0
         # @api private
-        def format_payload(entry)
-          entry.map { |key, value| "#{key}=#{value.inspect}" }.join(HASH_SEPARATOR)
+        def severity_colors
+          @severity_colors ||= DEFAULT_SEVERITY_COLORS.merge(
+            (options[:severity_colors] || EMPTY_HASH)
+              .to_h { |key, value| [LEVELS[key.to_s], value] }
+          )
         end
       end
     end

data/lib/dry/logger/formatters/structured.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "logger"
+
+require "dry/logger/constants"
 require "dry/logger/filter"
 
 module Dry
@@ -8,6 +10,8 @@ module Dry
     module Formatters
       # Default structured formatter which receives {Logger::Entry} from the backends.
       #
+      # This class can be used as the base class for your custom formatters.
+      #
       # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Formatter.html
       #
       # @since 1.0.0
@@ -21,10 +25,6 @@ module Dry
         # @api private
         NOOP_FILTER = -> message { message }
 
-        # @since 1.0.0
-        # @api private
-        NEW_LINE = $/ # rubocop:disable Style/SpecialGlobalVars
-
         # @since 1.0.0
         # @api private
         attr_reader :filter
@@ -52,7 +52,7 @@ module Dry
         # @return [String]
         # @api public
         def call(_severity, _time, _progname, entry)
-          format(entry.filter(filter))
+          format(entry.filter(filter)) + NEW_LINE
         end
 
         # Format entry into a loggable object
@@ -63,7 +63,18 @@ module Dry
         # @return [Entry]
         # @api public
         def format(entry)
+          format_values(entry)
+        end
+
+        # @since 1.0.0
+        # @api private
+        def format_values(entry)
           entry
+            .to_h
+            .map { |key, value|
+              [key, respond_to?(meth = "format_#{key}", true) ? __send__(meth, value) : value]
+            }
+            .to_h
         end
       end
     end

data/lib/dry/logger/formatters/template.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "set"
+require "dry/logger/constants"
+require_relative "colors"
+
+module Dry
+  module Logger
+    module Formatters
+      # Basic string formatter.
+      #
+      # This formatter returns log entries in key=value format.
+      #
+      # @since 1.0.0
+      # @api public
+      class Template
+        # @since 1.0.0
+        # @api private
+        TOKEN_REGEXP = /%<(\w*)>s/.freeze
+
+        # @since 1.0.0
+        # @api private
+        MESSAGE_TOKEN = "%<message>s"
+
+        # @since 1.0.0
+        # @api private
+        attr_reader :value
+
+        # @since 1.0.0
+        # @api private
+        attr_reader :tokens
+
+        # @since 1.0.0
+        # @api private
+        def self.[](value)
+          cache.fetch(value) {
+            cache[value] = (colorized?(value) ? Template::Colorized : Template).new(value)
+          }
+        end
+
+        # @since 1.0.0
+        # @api private
+        private_class_method def self.colorized?(value)
+          Colors::COLORS.keys.any? { |color| value.include?("<#{color}>") }
+        end
+
+        # @since 1.0.0
+        # @api private
+        private_class_method def self.cache
+          @cache ||= {}
+        end
+
+        # @since 1.0.0
+        # @api private
+        class Colorized < Template
+          # @since 1.0.0
+          # @api private
+          def initialize(value)
+            super(Colors.evaluate(value))
+          end
+        end
+
+        # @since 1.0.0
+        # @api private
+        def initialize(value)
+          @value = value
+          @tokens = value.scan(TOKEN_REGEXP).flatten(1).map(&:to_sym).to_set
+        end
+
+        # @since 1.0.0
+        # @api private
+        def %(tokens)
+          output = value % tokens
+          output.strip!
+          output.split(NEW_LINE).map(&:rstrip).join(NEW_LINE)
+        end
+
+        # @since 1.0.0
+        # @api private
+        def colorize(color, input)
+          "\e[#{Colors[color.to_sym]}m#{input}\e[0m"
+        end
+
+        # @since 1.0.0
+        # @api private
+        def include?(token)
+          tokens.include?(token)
+        end
+      end
+    end
+  end
+end

data/lib/dry/logger/global.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "stringio"
+
+module Dry
+  module Logger
+    # Global setup methods
+    #
+    # @api public
+    module Global
+      # Register a new formatter
+      #
+      # @example
+      #   class MyFormatter < Dry::Logger::Formatters::Structured
+      #     def format_message(value)
+      #       "WOAH: #{message}"
+      #     end
+      #
+      #     def format_time(value)
+      #       Time.now.strftime("%Y-%m-%d %H:%M:%S")
+      #     end
+      #   end
+      #
+      #   Dry::Logger.register_formatter(:my_formatter, MyFormatter)
+      #
+      #   logger = Dry.Logger(:app, formatter: :my_formatter, template: :details)
+      #
+      #   logger.info "Hello World"
+      #   # [test] [INFO] [2022-11-15 10:06:29] WOAH: Hello World
+      #
+      # @since 1.0.0
+      # @return [Hash]
+      # @api public
+      def register_formatter(name, formatter)
+        formatters[name] = formatter
+        formatters
+      end
+
+      # Register a new template
+      #
+      # @example basic template
+      #   Dry::Logger.register_template(:request, "[%<severity>s] %<verb>s %<path>s")
+      #
+      #   logger = Dry.Logger(:my_app, template: :request)
+      #
+      #   logger.info(verb: "GET", path: "/users")
+      #   # [INFO] GET /users
+      #
+      # @example template with colors
+      #   Dry::Logger.register_template(
+      #     :request, "[%<severity>s] <green>%<verb>s</green> <blue>%<path>s</blue>"
+      #   )
+      #
+      # @since 1.0.0
+      # @return [Hash]
+      # @api public
+      def register_template(name, template)
+        templates[name] = template
+        templates
+      end
+
+      # Build a logging backend instance
+      #
+      # @since 1.0.0
+      # @return [Backends::Stream]
+      # @api private
+      def new(stream: $stdout, **options)
+        backend =
+          case stream
+          when IO, StringIO then Backends::IO
+          when String, Pathname then Backends::File
+          else
+            raise ArgumentError, "unsupported stream type #{stream.class}"
+          end
+
+        formatter_spec = options[:formatter]
+        template_spec = options[:template]
+
+        template =
+          case template_spec
+          when Symbol then templates.fetch(template_spec)
+          when String then template_spec
+          when nil then templates[:default]
+          else
+            raise ArgumentError,
+                  ":template option must be a Symbol or a String (`#{template_spec}` given)"
+          end
+
+        formatter_options = {**options, template: template}
+
+        formatter =
+          case formatter_spec
+          when Symbol then formatters.fetch(formatter_spec).new(**formatter_options)
+          when Class then formatter_spec.new(**formatter_options)
+          when nil then formatters[:string].new(**formatter_options)
+          when ::Logger::Formatter then formatter_spec
+          else
+            raise ArgumentError, "Unsupported formatter option #{formatter_spec.inspect}"
+          end
+
+        backend_options = options.select { |key, _| BACKEND_OPT_KEYS.include?(key) }
+
+        backend.new(stream: stream, **backend_options, formatter: formatter)
+      end
+
+      # Internal formatters registry
+      #
+      # @since 1.0.0
+      # @api private
+      def formatters
+        @formatters ||= {}
+      end
+
+      # Internal templates registry
+      #
+      # @since 1.0.0
+      # @api private
+      def templates
+        @templates ||= {}
+      end
+    end
+  end
+end

data/lib/dry/logger/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Logger
-    VERSION = "1.0.0.rc2"
+    VERSION = "1.0.1"
   end
 end