piotrmurach/tty-logger

# frozen_string_literal: true

require_relative "handlers/console"

module TTY
  class Logger
    class Config
      FILTERED = "[FILTERED]"

      # The format used for date display. uses strftime format
      attr_accessor :date_format

      # The format used for time display. uses strftime format
      attr_accessor :time_format

      # The format used for displaying structured data
      attr_accessor :formatter

      # The handlers used to display logging info. Defaults to [:console]
      attr_accessor :handlers

      # The level to log messages at. Default to :info
      attr_accessor :level

      # The maximum message size to be logged in bytes. Defaults to 8192
      attr_accessor :max_bytes

      # The maximum depth for formatting array and hash objects. Defaults to 3
      attr_accessor :max_depth

      # The meta info to display, can be :date, :time, :file, :pid. Defaults to []
      attr_accessor :metadata

      # The output for the log messages. Defaults to `stderr`
      attr_accessor :output

      # The new custom log types. Defaults to `{}`
      attr_accessor :types

      # Create a configuration instance
      #
      # @api private
      def initialize(**options)
        @max_bytes = options.fetch(:max_bytes) { 2**13 }
        @max_depth = options.fetch(:max_depth) { 3 }
        @level = options.fetch(:level) { :info }
        @metadata = options.fetch(:metadata) { [] }
        @handlers = options.fetch(:handlers) { [:console] }
        @formatter = options.fetch(:formatter) { :text }
        @date_format = options.fetch(:date_format) { "%F" }
        @time_format = options.fetch(:time_format) { "%T.%3N" }
        @output = options.fetch(:output) { $stderr }
        @types = options.fetch(:types) { {} }
      end

      class FiltersProvider
        attr_accessor :message, :data, :mask

        def initialize
          @message = []
          @data = []
          @mask = FILTERED
        end

        def to_h
          { message: @message, data: @data, mask: @mask }
        end

        def to_s
          to_h.inspect
        end
      end

      # The filters to hide sensitive data from the message(s) and data.
      #
      # @return [FiltersProvider]
      #
      # @api public
      def filters
        @filters ||= FiltersProvider.new
      end

      # Allow to overwirte filters
      attr_writer :filters

      # Clone settings
      #
      # @api public
      def to_proc
        -> (config) {
          config.date_format = @date_format.dup
          config.time_format = @time_format.dup
          config.filters = @filters.dup
          config.formatter = @formatter
          config.handlers = @handlers.dup
          config.level =  @level
          config.max_bytes = @max_bytes
          config.max_depth = @max_depth
          config.metadata = @metadata.dup
          config.output = @output.dup
          config.types = @types.dup
          config
        }
      end

      # Hash representation of this config
      #
      # @return [Hash[Symbol]]
      #
      # @api public
      def to_h
        {
          date_format: date_format,
          filters: filters.to_h,
          formatter: formatter,
          handlers: handlers,
          level: level,
          max_bytes: max_bytes,
          max_depth: max_depth,
          metadata: metadata,
          output: output,
          time_format: time_format,
          types: types
        }
      end
    end # Config
  end # Logger
end # TTY