dry-logger 1.0.0.rc2 → 1.0.1

data/lib/dry/logger.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "stringio"
-
+require "dry/logger/global"
 require "dry/logger/constants"
+require "dry/logger/clock"
 require "dry/logger/dispatcher"
 
 require "dry/logger/formatters/string"
@@ -42,74 +42,58 @@ module Dry
   #   logger.info(Hello: "World!")
   #   # {"progname":"my_app","severity":"INFO","time":"2022-11-06T10:11:29Z","Hello":"World!"}
   #
+  # @example Setting up multiple backends
+  #   logger = Dry.Logger(:my_app)
+  #     add_backend(formatter: :string, template: :details)
+  #     add_backend(formatter: :string, template: :details)
+  #
+  # @example Setting up conditional logging
+  #   logger = Dry.Logger(:my_app) { |setup|
+  #     setup.add_backend(formatter: :string, template: :details) { |b| b.log_if = :error?.to_proc }
+  #   }
+  #
+  # @param [String, Symbol] id The dispatcher id, can be used as progname in log entries
+  # @param [Hash] options Options for backends and formatters
+  # @option options [Symbol] :level (:info) The minimum level that should be logged,
+  # @option options [Symbol] :stream (optional) The output stream, default is $stdout
+  # @option options [Symbol, Class, #call] :formatter (:string) The default formatter or its id,
+  # @option options [String, Symbol] :template (:default) The default template that should be used
+  # @option options [Boolean] :colorize (false) Enable/disable colorized severity
+  # @option options [Hash<Symbol=>Symbol>] :severity_colors ({}) A severity=>color mapping
+  # @option options [#call] :on_crash (Dry::Logger::Dispatcher::ON_CRASH) A crash-handling proc.
+  #   This is used whenever logging crashes.
+  #
   # @since 1.0.0
-  # @return [Dispatcher]
   # @api public
-  def self.Logger(id, **opts, &block)
-    Logger::Dispatcher.setup(id, **opts, &block)
+  # @return [Dispatcher]
+  def self.Logger(id, **options, &block)
+    Logger::Dispatcher.setup(id, **options, &block)
   end
 
   module Logger
-    # Register a new formatter
-    #
-    # @example
-    #   class MyFormatter < Dry::Logger::Formatters::Structured
-    #     def format(entry)
-    #       "WOAH: #{entry.message}"
-    #     end
-    #   end
-    #
-    #   Dry::Logger.register_formatter(MyFormatter)
-    #
-    # @since 1.0.0
-    # @return [Hash]
-    # @api public
-    def self.register_formatter(name, formatter)
-      formatters[name] = formatter
-      formatters
-    end
-
-    # Build a logging backend instance
-    #
-    # @since 1.0.0
-    # @return [Backends::Stream]
-    # @api private
-    def self.new(stream: $stdout, **opts)
-      backend =
-        case stream
-        when IO, StringIO then Backends::IO
-        when String, Pathname then Backends::File
-        else
-          raise ArgumentError, "unsupported stream type #{stream.class}"
-        end
+    extend Global
 
-      formatter_opt = opts[:formatter]
-
-      formatter =
-        case formatter_opt
-        when Symbol then formatters.fetch(formatter_opt).new(**opts)
-        when Class then formatter_opt.new(**opts)
-        when NilClass then formatters[:string].new(**opts)
-        when ::Logger::Formatter then formatter_opt
-        else
-          raise ArgumentError, "unsupported formatter option #{formatter_opt.inspect}"
-        end
+    # Built-in formatters
+    register_formatter(:string, Formatters::String)
+    register_formatter(:rack, Formatters::Rack)
+    register_formatter(:json, Formatters::JSON)
 
-      backend_opts = opts.select { |key, _| BACKEND_OPT_KEYS.include?(key) }
+    # Built-in templates
+    register_template(:default, "%<message>s %<payload>s")
 
-      backend.new(stream: stream, **backend_opts, formatter: formatter)
-    end
+    register_template(:details, "[%<progname>s] [%<severity>s] [%<time>s] %<message>s %<payload>s")
 
-    # Internal formatters registry
-    #
-    # @since 1.0.0
-    # @api private
-    def self.formatters
-      @formatters ||= {}
-    end
+    register_template(:crash, <<~STR)
+      [%<progname>s] [%<severity>s] [%<time>s] Logging crashed
+        %<log_entry>s
+        %<message>s (%<exception>s)
+      %<backtrace>s
+    STR
 
-    register_formatter(:string, Formatters::String)
-    register_formatter(:rack, Formatters::Rack)
-    register_formatter(:json, Formatters::JSON)
+    register_template(:rack, <<~STR)
+      [%<progname>s] [%<severity>s] [%<time>s] \
+      %<verb>s %<status>s %<elapsed>s %<ip>s %<path>s %<length>s %<payload>s
+        %<params>s
+    STR
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2022-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -36,17 +36,23 @@ files:
 - README.md
 - dry-logger.gemspec
 - lib/dry/logger.rb
+- lib/dry/logger/backends/core.rb
 - lib/dry/logger/backends/file.rb
 - lib/dry/logger/backends/io.rb
+- lib/dry/logger/backends/proxy.rb
 - lib/dry/logger/backends/stream.rb
+- lib/dry/logger/clock.rb
 - lib/dry/logger/constants.rb
 - lib/dry/logger/dispatcher.rb
 - lib/dry/logger/entry.rb
 - lib/dry/logger/filter.rb
+- lib/dry/logger/formatters/colors.rb
 - lib/dry/logger/formatters/json.rb
 - lib/dry/logger/formatters/rack.rb
 - lib/dry/logger/formatters/string.rb
 - lib/dry/logger/formatters/structured.rb
+- lib/dry/logger/formatters/template.rb
+- lib/dry/logger/global.rb
 - lib/dry/logger/version.rb
 homepage: https://dry-rb.org/gems/dry-logger
 licenses:
@@ -67,9 +73,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: