ougai-formatters-customizable 1.0.0 → 1.0.1

data/lib/ougai/formatters/colors.rb

@@ -1,91 +1,91 @@
-# frozen_string_literal: true
-
-module Ougai
-  module Formatters
-    # List of useful ANSI escape sequences for terminal font formatting. Source
-    # is https://gist.github.com/chrisopedia/8754917.
-    module Colors
-      # -- Comments compared to Ougai initial coloring --
-      # Non-bold font colors do not use \e[0;{value}m because it seems to be
-      # incompatible with background colors: \e[41m\e[0;34mtext\e[0m does not print
-      # background red while \e[41m\e[34mtext\e[0m works. However, to put font in
-      # bold/bright mode, \e[41m\e[1;34mtext\e[0m works
-      # => Tested on Windows PowerShell and MinGW64
-      #
-      # Colors values cannot be frozen as .concat is called upon them
-
-      # Reset formatting. To be appended after every formatted text
-      RESET             = "\e[0m"
-      # Font black color
-      BLACK             = "\e[30m"
-      # Font red color
-      RED               = "\e[31m"
-      # Font green color
-      GREEN             = "\e[32m"
-      # Font yello color
-      YELLOW            = "\e[33m"
-      # Font blue color
-      BLUE              = "\e[34m"
-      # Font purple color
-      PURPLE            = "\e[35m"
-      # Font cyan color
-      CYAN              = "\e[36m"
-      # Font white color
-      WHITE             = "\e[37m"
-      # Font bright/bold red color
-      BOLD_RED          = "\e[1;31m"
-      # Font bright/bold green color
-      BOLD_GREEN        = "\e[1;32m"
-      # Font bright/bold yellow color
-      BOLD_YELLOW       = "\e[1;33m"
-      # Font bright/bold blue color
-      BOLD_BLUE         = "\e[1;34m"
-      # Font bright/bold purple color
-      BOLD_PURPLE       = "\e[1;35m"
-      # Font bright/bold cyan color
-      BOLD_CYAN         = "\e[1;36m"
-      # Font bright/bold white color
-      BOLD_WHITE        = "\e[1;37m"
-      # Background black color
-      BG_BLACK          = "\e[40m"
-      # Background red color
-      BG_RED            = "\e[41m"
-      # Background green color
-      BG_GREEN          = "\e[42m"
-      # Background yellow color
-      BG_YELLOW         = "\e[43m"
-      # Background blue color
-      BG_BLUE           = "\e[44m"
-      # Background purple color
-      BG_PURPLE         = "\e[45m"
-      # Background cyan color
-      BG_CYAN           = "\e[46m"
-      # Background white color
-      BG_WHITE          = "\e[47m"
-
-      class << self
-        # Color a text by prepending a font styling escape sequence and
-        # appending a reset sequence. This method does a pure String concatenation
-        # and does not check the values are properly escaped. This allows
-        # customization, depending on user's terminal, to use custom escape
-        # sequences.
-        # 
-        # @param [String] color color to prepend. Color can be from the list
-        #         above or have a complete custom String value depending on the
-        #         terminal. If +nil+, text is not modified.
-        # @param [String] text text to be colored
-        # @param [String] reset reset font styling escape sequence
-        #
-        # @return [String] colored or uncolored text
-        def color_text(color, text, reset = Ougai::Formatters::Colors::RESET)
-          return text if color.nil?
-
-          # .concat is preferred in Ruby:
-          # https://coderwall.com/p/ac5j9g/or-concat-what-is-faster-for-appending-string-in-ruby
-          ''.dup.concat(color).concat(text).concat(reset)
-        end
-      end
-
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Ougai
+  module Formatters
+    # List of useful ANSI escape sequences for terminal font formatting. Source
+    # is https://gist.github.com/chrisopedia/8754917.
+    module Colors
+      # -- Comments compared to Ougai initial coloring --
+      # Non-bold font colors do not use \e[0;{value}m because it seems to be
+      # incompatible with background colors: \e[41m\e[0;34mtext\e[0m does not print
+      # background red while \e[41m\e[34mtext\e[0m works. However, to put font in
+      # bold/bright mode, \e[41m\e[1;34mtext\e[0m works
+      # => Tested on Windows PowerShell and MinGW64
+      #
+      # Colors values cannot be frozen as .concat is called upon them
+
+      # Reset formatting. To be appended after every formatted text
+      RESET             = "\e[0m"
+      # Font black color
+      BLACK             = "\e[30m"
+      # Font red color
+      RED               = "\e[31m"
+      # Font green color
+      GREEN             = "\e[32m"
+      # Font yello color
+      YELLOW            = "\e[33m"
+      # Font blue color
+      BLUE              = "\e[34m"
+      # Font purple color
+      PURPLE            = "\e[35m"
+      # Font cyan color
+      CYAN              = "\e[36m"
+      # Font white color
+      WHITE             = "\e[37m"
+      # Font bright/bold red color
+      BOLD_RED          = "\e[1;31m"
+      # Font bright/bold green color
+      BOLD_GREEN        = "\e[1;32m"
+      # Font bright/bold yellow color
+      BOLD_YELLOW       = "\e[1;33m"
+      # Font bright/bold blue color
+      BOLD_BLUE         = "\e[1;34m"
+      # Font bright/bold purple color
+      BOLD_PURPLE       = "\e[1;35m"
+      # Font bright/bold cyan color
+      BOLD_CYAN         = "\e[1;36m"
+      # Font bright/bold white color
+      BOLD_WHITE        = "\e[1;37m"
+      # Background black color
+      BG_BLACK          = "\e[40m"
+      # Background red color
+      BG_RED            = "\e[41m"
+      # Background green color
+      BG_GREEN          = "\e[42m"
+      # Background yellow color
+      BG_YELLOW         = "\e[43m"
+      # Background blue color
+      BG_BLUE           = "\e[44m"
+      # Background purple color
+      BG_PURPLE         = "\e[45m"
+      # Background cyan color
+      BG_CYAN           = "\e[46m"
+      # Background white color
+      BG_WHITE          = "\e[47m"
+
+      class << self
+        # Color a text by prepending a font styling escape sequence and
+        # appending a reset sequence. This method does a pure String concatenation
+        # and does not check the values are properly escaped. This allows
+        # customization, depending on user's terminal, to use custom escape
+        # sequences.
+        # 
+        # @param [String] color color to prepend. Color can be from the list
+        #         above or have a complete custom String value depending on the
+        #         terminal. If +nil+, text is not modified.
+        # @param [String] text text to be colored
+        # @param [String] reset reset font styling escape sequence
+        #
+        # @return [String] colored or uncolored text
+        def color_text(color, text, reset = Ougai::Formatters::Colors::RESET)
+          return text if color.nil?
+
+          # .concat is preferred in Ruby:
+          # https://coderwall.com/p/ac5j9g/or-concat-what-is-faster-for-appending-string-in-ruby
+          ''.dup.concat(color).concat(text).concat(reset)
+        end
+      end
+
+    end
+  end
+end

data/lib/ougai/formatters/colors/configuration.rb

@@ -1,119 +1,119 @@
-# frozen_string_literal: true
-
-require 'ougai/formatters/colors'
-
-module Ougai
-  module Formatters
-    module Colors
-      # Handle the colorization of output, mainly aimed at console formatting.
-      # The configuration,split by subject such as +level+, +msg+,
-      # or +datetime+ is basically a Hash: +config+ with the subject as key
-      # and values. Values can be have three types:
-      #
-      # - +String+: the color escape sequence for the subject
-      # - +Hash+: the color escape sequence per severity. If not all severities
-      #   are defined, a +:default+ value must be defined
-      # - +Symbol+: refers to another key and same coloring is applied
-      class Configuration
-        class << self
-          # list default color configuration
-          # @note 'any' severity label decided in 
-          #       +Ougai::Logging::Severity#to_label+
-          # @note values are copied from +Ougai::Formatters::Readable+ coloring
-          #       values
-          # @return [Hash] default color configuration is severities only
-          def default_configuration
-            {
-              severity: {
-                trace:  Ougai::Formatters::Colors::BLUE,
-                debug:  Ougai::Formatters::Colors::WHITE,
-                info:   Ougai::Formatters::Colors::CYAN,
-                warn:   Ougai::Formatters::Colors::YELLOW,
-                error:  Ougai::Formatters::Colors::RED,
-                fatal:  Ougai::Formatters::Colors::PURPLE,
-                any:    Ougai::Formatters::Colors::GREEN
-              }
-            }
-          end
-        end
-
-        # Configuration accept following keys:
-        # - +:load_default_config+ If true, then default configuration
-        #   values is fetched to fill missing value from the provided 
-        #   configuration. Default is true.
-        # - any remaining key is considered to be color-related and is translated
-        #   into a *subject => color rule* mapping
-        #
-        # @param [Hash] configuration color configuration. Cannot be nil
-        def initialize(configuration = {})
-          # check if loading or not from default configuration
-          if configuration.fetch(:load_default_config) { true }
-            @config = Configuration.default_configuration
-          else
-            @config = {}
-          end
-
-          configuration.each do |key, val|
-            default_val = @config[key]
-            # default value is a Hash AND input value is a Hash => merge
-            if val.is_a?(Hash) && default_val.is_a?(Hash)
-              @config[key] = default_val.merge(val)
-            # Input value is assigned because one of the follow
-            # 1) input value is not defined in default configuration
-            # 2) input value is not a Hash which overrides the default value
-            # 3) default value is not a Hash and input is a Hash => Arbitrary
-            else
-              @config[key] = val
-            end
-          end
-        end
-
-        # Convenience method to color a subject for a given log severity
-        #
-        # @param [Symbol] subject_key to fetch the color to color the text
-        # @param [String] text to be colored text
-        # @param [Symbol] severity log level
-        #
-        # @return [String] a colored text depending on the subject
-        def color(subject_key, text, severity)
-          color = get_color_for(subject_key, severity)
-          Ougai::Formatters::Colors.color_text(color, text)
-        end
-
-        # Return the color for a given suject and a given severity. This color
-        # can then be applied to any text via
-        # +Ougai::Formatters::Colors.color_text+
-        #
-        # +get_color_for+ handles color inheritance: if a subject inherit color
-        # from another subject, subject value is the symbol refering to the
-        # other subject.
-        #
-        # @note !!WARNING!!: Circular references are not checked and lead to infinite
-        # loop  
-        #
-        # @param [Symbol] subject_key to define the color to color the text
-        # @param [Symbol] severity log level
-        #
-        # @return [String,nil] requested color String value or +nil+ if not colored
-        def get_color_for(subject_key, severity)
-          # no colorization
-          return nil unless @config.key?(subject_key)
-
-          # no severity dependence nor inheritance
-          color = @config[subject_key]
-          return color if color.is_a? String
-
-          # inheritance from another subject
-          return get_color_for(color, severity) if color.is_a? Symbol
-
-          # severity dependent but not inherited value or return +nil+ if
-          # configuration is incorrect
-          severity = severity.downcase.to_sym
-          color.fetch(severity) { color[:default] }
-        end
-
-      end
-
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'ougai/formatters/colors'
+
+module Ougai
+  module Formatters
+    module Colors
+      # Handle the colorization of output, mainly aimed at console formatting.
+      # The configuration,split by subject such as +level+, +msg+,
+      # or +datetime+ is basically a Hash: +config+ with the subject as key
+      # and values. Values can be have three types:
+      #
+      # - +String+: the color escape sequence for the subject
+      # - +Hash+: the color escape sequence per severity. If not all severities
+      #   are defined, a +:default+ value must be defined
+      # - +Symbol+: refers to another key and same coloring is applied
+      class Configuration
+        class << self
+          # list default color configuration
+          # @note 'any' severity label decided in 
+          #       +Ougai::Logging::Severity#to_label+
+          # @note values are copied from +Ougai::Formatters::Readable+ coloring
+          #       values
+          # @return [Hash] default color configuration is severities only
+          def default_configuration
+            {
+              severity: {
+                trace:  Ougai::Formatters::Colors::BLUE,
+                debug:  Ougai::Formatters::Colors::WHITE,
+                info:   Ougai::Formatters::Colors::CYAN,
+                warn:   Ougai::Formatters::Colors::YELLOW,
+                error:  Ougai::Formatters::Colors::RED,
+                fatal:  Ougai::Formatters::Colors::PURPLE,
+                any:    Ougai::Formatters::Colors::GREEN
+              }
+            }
+          end
+        end
+
+        # Configuration accept following keys:
+        # - +:load_default_config+ If true, then default configuration
+        #   values is fetched to fill missing value from the provided 
+        #   configuration. Default is true.
+        # - any remaining key is considered to be color-related and is translated
+        #   into a *subject => color rule* mapping
+        #
+        # @param [Hash] configuration color configuration. Cannot be nil
+        def initialize(configuration = {})
+          # check if loading or not from default configuration
+          if configuration.fetch(:load_default_config) { true }
+            @config = Configuration.default_configuration
+          else
+            @config = {}
+          end
+
+          configuration.each do |key, val|
+            default_val = @config[key]
+            # default value is a Hash AND input value is a Hash => merge
+            if val.is_a?(Hash) && default_val.is_a?(Hash)
+              @config[key] = default_val.merge(val)
+            # Input value is assigned because one of the follow
+            # 1) input value is not defined in default configuration
+            # 2) input value is not a Hash which overrides the default value
+            # 3) default value is not a Hash and input is a Hash => Arbitrary
+            else
+              @config[key] = val
+            end
+          end
+        end
+
+        # Convenience method to color a subject for a given log severity
+        #
+        # @param [Symbol] subject_key to fetch the color to color the text
+        # @param [String] text to be colored text
+        # @param [Symbol] severity log level
+        #
+        # @return [String] a colored text depending on the subject
+        def color(subject_key, text, severity)
+          color = get_color_for(subject_key, severity)
+          Ougai::Formatters::Colors.color_text(color, text)
+        end
+
+        # Return the color for a given suject and a given severity. This color
+        # can then be applied to any text via
+        # +Ougai::Formatters::Colors.color_text+
+        #
+        # +get_color_for+ handles color inheritance: if a subject inherit color
+        # from another subject, subject value is the symbol refering to the
+        # other subject.
+        #
+        # @note !!WARNING!!: Circular references are not checked and lead to infinite
+        # loop  
+        #
+        # @param [Symbol] subject_key to define the color to color the text
+        # @param [Symbol] severity log level
+        #
+        # @return [String,nil] requested color String value or +nil+ if not colored
+        def get_color_for(subject_key, severity)
+          # no colorization
+          return nil unless @config.key?(subject_key)
+
+          # no severity dependence nor inheritance
+          color = @config[subject_key]
+          return color if color.is_a? String
+
+          # inheritance from another subject
+          return get_color_for(color, severity) if color.is_a? Symbol
+
+          # severity dependent but not inherited value or return +nil+ if
+          # configuration is incorrect
+          severity = severity.downcase.to_sym
+          color.fetch(severity) { color[:default] }
+        end
+
+      end
+
+    end
+  end
+end

data/lib/ougai/formatters/customizable.rb

@@ -1,160 +1,160 @@
-# frozen_string_literal: true
-
-require 'ougai/formatters/base'
-require 'ougai/formatters/colors/configuration'
-
-module Ougai
-  module Formatters
-    # Ougai log printing can be split in three components:
-    # 1. Main log message: usually with timestamp, log severity and a single
-    #    line message
-    # 2. Log data: the structured logging component. Can be represented by
-    #    a Hash
-    # 3. Errors: errors require specific log formatting
-    #
-    # Customizable offers a flexible way to handle each component
-    # independently by assigning a proc to the following keys:
-    #
-    # 1. +:format_msg+ Format message. Proc arguments are +|level, datetime, progname, data|+. This block must remove the key +:msg+ from +data+
-    # 2. +:format_data+ Format data. Proc argument is +|data|+.
-    # 3. +:format_err+ Format err. Proc argument is +|data|+. The proc must  remove the key +:err+
-    class Customizable < Ougai::Formatters::Base
-      class << self
-        # Define the default main log message formatting to use. A non-null
-        # color configuration has to be provided. The configuration can however
-        # be empty
-        #
-        # @param [Ougai::Formatters::Colors::Configuration] color_config the 
-        #         color configuration to use
-        #
-        # @return [Proc] main message formatter
-        def default_msg_format(color_config)
-          proc do |severity, datetime, _progname, data|
-            msg = data.delete(:msg)
-            severity  = color_config.color(:severity, severity, severity)
-            datetime  = color_config.color(:datetime, datetime, severity)
-            msg       = color_config.color(:msg, msg, severity)
-
-            "[#{datetime}] #{severity}: #{msg}"
-          end
-        end
-
-        # Define the default error formatting to use which handles field
-        # exclusion and plain mode for awesome-print
-        #
-        # @param [Array<Symbol>] excluded_fields list of key to exclude from
-        #         +data+ before printing logs
-        # @param [Boolean] plain parameter to define if Awesome-Print renders
-        #         in plain mode or not
-        #
-        # @return [Proc] data formatter
-        def default_data_format(excluded_fields, plain)
-          proc do |data|
-            excluded_fields.each { |field| data.delete(field) }
-            next nil if data.empty?
-
-            data.ai(plain: plain)
-          end
-        end
-
-        # Define the default error formatting to use.
-        #
-        # @param [Integer] trace_indent space indentation to prepend before 
-        #         trace content
-        #
-        # @return [Proc] error formatter
-        def default_err_format(trace_indent = 4)
-          proc do |data|
-            next nil unless data.key?(:err)
-
-            err = data.delete(:err)
-            err_str = "  #{err[:name]} (#{err[:message]}):"
-            err_str += "\n" + (' ' * trace_indent) + err[:stack] if err.key?(:stack)
-            err_str
-          end
-        end
-      end
-
-      # Intialize a formatter
-      #
-      # @param [String] app_name application name (execution program name if nil)
-      # @param [String] hostname hostname (hostname if nil)
-      # @param [Hash] opts the initial values of attributes
-      # @option opts [String] :trace_max_lines (100) the value of 
-      #         trace_max_lines attribute
-      # @option opts [String] :plain (false) the value of plain attribute
-      # @option opts [String] :excluded_fields ([]) the value of 
-      #         excluded_fields attribute
-      # @option opts [Ougai::Formatters::Colors::Configuration] :color_config
-      #         assign a color configuration.
-      # @option opts [Proc] :format_msg main message formatter
-      # @option opts [Proc] :format_data data formatter
-      # @option opts [Proc] :format_err error formatter
-      def initialize(app_name = nil, hostname = nil, opts = {})
-        aname, hname, opts = Base.parse_new_params([app_name, hostname, opts])
-        super(aname, hname, opts)
-
-        # Message logging
-        color_config = opts.fetch(:color_config) {
-          color_config = Ougai::Formatters::Colors::Configuration.new({})
-        }
-        @format_msg = opts.fetch(:format_msg) {
-          Customizable.default_msg_format(color_config)
-        }
-
-        # Data logging
-        plain = opts.fetch(:plain) { false }
-        excluded_fields = opts[:excluded_fields] || []
-        @format_data = opts.fetch(:format_data) {
-          Customizable.default_data_format(excluded_fields, plain)
-        }
-
-        # Error logging
-        trace_indent = opts.fetch(:trace_indent) { 4 }
-        @format_err = opts.fetch(:format_err) {
-          Customizable.default_err_format(trace_indent)
-        }
-
-        # Ensure dependency are present
-        load_dependent
-      end
-
-      # Format a log entry
-      #
-      # @param [String] severity log severity, in capital letters
-      # @param [Time] time timestamp of the log. Is formatted by +strftime+
-      # @param [String] progname optional program name
-      # @param [Hash] data log data. Main message is stored under the key +:msg+
-      #         while errors are logged under the key +:err+.
-      # 
-      # @return [String] log text, ready to be printed out
-      def _call(severity, time, progname, data)
-        strs = ''.dup
-        # Main message
-        dt =  format_datetime(time)
-        msg_str = @format_msg.call(severity, dt, progname, data)
-        strs.concat(msg_str)
-
-        # Error: displayed before additional data
-        err_str = @format_err.call(data)
-        strs.concat("\n").concat(err_str) unless err_str.nil?
-
-        # Additional data
-        data_str = @format_data.call(data)
-        strs.concat("\n").concat(data_str) unless data_str.nil?
-
-        strs.concat("\n")
-      end
-
-      protected
-
-      # Ensure +awesompe_print+ is loaded
-      def load_dependent
-        require 'awesome_print'
-      rescue LoadError
-        puts 'You must install the awesome_print gem to use this output.'
-        raise
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'ougai/formatters/base'
+require 'ougai/formatters/colors/configuration'
+
+module Ougai
+  module Formatters
+    # Ougai log printing can be split in three components:
+    # 1. Main log message: usually with timestamp, log severity and a single
+    #    line message
+    # 2. Log data: the structured logging component. Can be represented by
+    #    a Hash
+    # 3. Errors: errors require specific log formatting
+    #
+    # Customizable offers a flexible way to handle each component
+    # independently by assigning a proc to the following keys:
+    #
+    # 1. +:format_msg+ Format message. Proc arguments are +|level, datetime, progname, data|+. This block must remove the key +:msg+ from +data+
+    # 2. +:format_data+ Format data. Proc argument is +|data|+.
+    # 3. +:format_err+ Format err. Proc argument is +|data|+. The proc must  remove the key +:err+
+    class Customizable < Ougai::Formatters::Base
+      class << self
+        # Define the default main log message formatting to use. A non-null
+        # color configuration has to be provided. The configuration can however
+        # be empty
+        #
+        # @param [Ougai::Formatters::Colors::Configuration] color_config the
+        #         color configuration to use
+        #
+        # @return [Proc] main message formatter
+        def default_msg_format(color_config)
+          proc do |severity, datetime, _progname, data|
+            msg = data.delete(:msg)
+            severity  = color_config.color(:severity, severity, severity)
+            datetime  = color_config.color(:datetime, datetime, severity)
+            msg       = color_config.color(:msg, msg, severity)
+
+            "[#{datetime}] #{severity}: #{msg}"
+          end
+        end
+
+        # Define the default error formatting to use which handles field
+        # exclusion and plain mode for amazing-print
+        #
+        # @param [Array<Symbol>] excluded_fields list of key to exclude from
+        #         +data+ before printing logs
+        # @param [Boolean] plain parameter to define if Amazing-Print renders
+        #         in plain mode or not
+        #
+        # @return [Proc] data formatter
+        def default_data_format(excluded_fields, plain)
+          proc do |data|
+            excluded_fields.each { |field| data.delete(field) }
+            next nil if data.empty?
+
+            data.ai(plain: plain)
+          end
+        end
+
+        # Define the default error formatting to use.
+        #
+        # @param [Integer] trace_indent space indentation to prepend before
+        #         trace content
+        #
+        # @return [Proc] error formatter
+        def default_err_format(trace_indent = 4)
+          proc do |data|
+            next nil unless data.key?(:err)
+
+            err = data.delete(:err)
+            err_str = "  #{err[:name]} (#{err[:message]}):"
+            err_str += "\n" + (' ' * trace_indent) + err[:stack] if err.key?(:stack)
+            err_str
+          end
+        end
+      end
+
+      # Intialize a formatter
+      #
+      # @param [String] app_name application name (execution program name if nil)
+      # @param [String] hostname hostname (hostname if nil)
+      # @param [Hash] opts the initial values of attributes
+      # @option opts [String] :trace_max_lines (100) the value of
+      #         trace_max_lines attribute
+      # @option opts [String] :plain (false) the value of plain attribute
+      # @option opts [String] :excluded_fields ([]) the value of
+      #         excluded_fields attribute
+      # @option opts [Ougai::Formatters::Colors::Configuration] :color_config
+      #         assign a color configuration.
+      # @option opts [Proc] :format_msg main message formatter
+      # @option opts [Proc] :format_data data formatter
+      # @option opts [Proc] :format_err error formatter
+      def initialize(app_name = nil, hostname = nil, opts = {})
+        aname, hname, opts = Base.parse_new_params([app_name, hostname, opts])
+        super(aname, hname, opts)
+
+        # Message logging
+        color_config = opts.fetch(:color_config) {
+          color_config = Ougai::Formatters::Colors::Configuration.new({})
+        }
+        @format_msg = opts.fetch(:format_msg) {
+          Customizable.default_msg_format(color_config)
+        }
+
+        # Data logging
+        plain = opts.fetch(:plain) { false }
+        excluded_fields = opts[:excluded_fields] || []
+        @format_data = opts.fetch(:format_data) {
+          Customizable.default_data_format(excluded_fields, plain)
+        }
+
+        # Error logging
+        trace_indent = opts.fetch(:trace_indent) { 4 }
+        @format_err = opts.fetch(:format_err) {
+          Customizable.default_err_format(trace_indent)
+        }
+
+        # Ensure dependency are present
+        load_dependent
+      end
+
+      # Format a log entry
+      #
+      # @param [String] severity log severity, in capital letters
+      # @param [Time] time timestamp of the log. Is formatted by +strftime+
+      # @param [String] progname optional program name
+      # @param [Hash] data log data. Main message is stored under the key +:msg+
+      #         while errors are logged under the key +:err+.
+      #
+      # @return [String] log text, ready to be printed out
+      def _call(severity, time, progname, data)
+        strs = ''.dup
+        # Main message
+        dt =  format_datetime(time)
+        msg_str = @format_msg.call(severity, dt, progname, data)
+        strs.concat(msg_str)
+
+        # Error: displayed before additional data
+        err_str = @format_err.call(data)
+        strs.concat("\n").concat(err_str) unless err_str.nil?
+
+        # Additional data
+        data_str = @format_data.call(data)
+        strs.concat("\n").concat(data_str) unless data_str.nil?
+
+        strs.concat("\n")
+      end
+
+      protected
+
+      # Ensure +awesompe_print+ is loaded
+      def load_dependent
+        require 'amazing_print'
+      rescue LoadError
+        puts 'You must install the amazing_print gem to use this output.'
+        raise
+      end
+    end
+  end
+end