console 1.27.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93187d6e4774eecaad627306d33a5f38bad4e123e029587d7f142a1265de6ec6
-  data.tar.gz: 9a5015df0b90995173414eecd2b5b6bff60fe07129db4089cad9c86bdbf1e84f
+  metadata.gz: 1fa166f5900ef3a9c90b337ce6dd57faa99527fd9746a47aa61bb7f7535e606d
+  data.tar.gz: c6d7d06fdd475006e000c3da6d65fdcd3a5c58e10c90afa8b380f795d45a16d1
 SHA512:
-  metadata.gz: d1bc5192624a8c15f464ceac4c5b7f6b3d4340df8a75aff4f5e20b6b42d340872135538b5abb4dd8a2e34f57048536898dee9e07a2c1a0e2e819a1c34b259cc5
-  data.tar.gz: d61a670deecf0418cd09ed9f1a4d800d2dd5d7b41bd02b3ce2aaa410b27178e62bb7071106a4d7ae89c57fcc4aeadd9ce478a37a1a7859bd20ac00c76c7e1c43
+  metadata.gz: 620b134d260d72d3b69a57e455584d556d611aa8a441fbd7624722b1cfaf3541015335717b82da8ea2aa0682f94e2898c9f28c4162fa5b5842297035f81bd5c0
+  data.tar.gz: be9318b5f775a9bd33f5c8951ffae4b921dbe0618f209080645a3eb12dcd096ef092d94f1239564e03497961ebbfbbb926d43294b8b524a94486e6b62a835b1a

data/bake/console.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 # Increase the verbosity of the logger to info.
 def info
-	require_relative '../lib/console'
+	require_relative "../lib/console"
 	
 	Console.logger.info!
 end
 
 # Increase the verbosity of the logger to debug.
 def debug
-	require_relative '../lib/console'
+	require_relative "../lib/console"
 	
 	Console.logger.debug!
 end

data/lib/console/capture.rb

@@ -3,7 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'filter'
+require_relative "filter"
+require_relative "output/failure"
 
 module Console
 	# A general sink which captures all events into a buffer.
@@ -58,7 +59,7 @@ module Console
 			@verbose
 		end
 		
-		def call(subject = nil, *arguments, severity: UNKNOWN, event: nil,  **options, &block)
+		def call(subject = nil, *arguments, severity: UNKNOWN, event: nil, **options, &block)
 			record = {
 				time: ::Time.now.iso8601,
 				severity: severity,

data/lib/console/compatible/logger.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require 'logger'
+require "logger"
 
 module Console
 	module Compatible

data/lib/console/event/failure.rb

@@ -5,7 +5,7 @@
 # Copyright, 2021, by Robert Schulze.
 # Copyright, 2024, by Patrik Wenger.
 
-require_relative 'generic'
+require_relative "generic"
 
 module Console
 	module Event
@@ -28,9 +28,9 @@ module Console
 			def self.log(subject, exception, **options)
 				Console.error(subject, **self.for(exception).to_hash, **options)
 			end
-
+			
 			attr_reader :exception
-
+			
 			def initialize(exception, root = Dir.getwd)
 				@exception = exception
 				@root = root
@@ -59,7 +59,7 @@ module Console
 					message = exception.detailed_message
 					
 					# We want to remove the trailling exception class as we format it differently:
-					message.sub!(/\s*\(.*?\)$/, '')
+					message.sub!(/\s*\(.*?\)$/, "")
 					
 					hash[:message] = message
 				else

data/lib/console/event/spawn.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'generic'
-require_relative '../clock'
+require_relative "generic"
+require_relative "../clock"
 
 module Console
 	module Event

data/lib/console/event.rb

@@ -3,5 +3,5 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'event/spawn'
-require_relative 'event/failure'
+require_relative "event/spawn"
+require_relative "event/failure"

data/lib/console/filter.rb

@@ -10,7 +10,7 @@ module Console
 	UNKNOWN = :unknown
 	
 	class Filter
-		if Object.const_defined?(:Ractor) and RUBY_VERSION >= '3.1'
+		if Object.const_defined?(:Ractor) and RUBY_VERSION >= "3.1"
 			def self.define_immutable_method(name, &block)
 				block = Ractor.make_shareable(block)
 				self.define_method(name, &block)

data/lib/console/format/safe.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
-require 'json'
+require "json"
 
 module Console
 	module Format

data/lib/console/format.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Samuel Williams.
 
-require_relative 'format/safe'
+require_relative "format/safe"
 
 module Console
 	module Format

data/lib/console/interface.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright 2024, by Samuel Williams.
+
+require_relative "logger"
+
+module Console
+	# The public logger interface.
+	module Interface
+		# Get the current logger instance.
+		def logger
+			Logger.instance
+		end
+		
+		# Set the current logger instance.
+		#
+		# The current logger instance is assigned per-fiber.
+		def logger= instance
+			Logger.instance= instance
+		end
+		
+		# Emit a debug log message.
+		def debug(...)
+			Logger.instance.debug(...)
+		end
+		
+		# Emit an informational log message.
+		def info(...)
+			Logger.instance.info(...)
+		end
+		
+		# Emit a warning log message.
+		def warn(...)
+			Logger.instance.warn(...)
+		end
+		
+		# Emit an error log message.
+		def error(...)
+			Logger.instance.error(...)
+		end
+		
+		# Emit a fatal log message.
+		def fatal(...)
+			Logger.instance.fatal(...)
+		end
+		
+		# Emit a log message with arbitrary arguments and options.
+		def call(...)
+			Logger.instance.call(...)
+		end
+	end
+end

data/lib/console/logger.rb

@@ -5,13 +5,15 @@
 # Copyright, 2021, by Bryan Powell.
 # Copyright, 2021, by Robert Schulze.
 
-require_relative 'output'
-require_relative 'filter'
-require_relative 'event'
-require_relative 'resolver'
-require_relative 'progress'
+require_relative "output"
+require_relative "output/failure"
 
-require 'fiber/local'
+require_relative "filter"
+require_relative "event"
+require_relative "resolver"
+require_relative "progress"
+
+require "fiber/local"
 
 module Console
 	class Logger < Filter[debug: 0, info: 1, warn: 2, error: 3, fatal: 4]
@@ -21,7 +23,7 @@ module Console
 		# You can also specify CONSOLE_LEVEL=debug or CONSOLE_LEVEL=info in environment.
 		# https://mislav.net/2011/06/ruby-verbose-mode/ has more details about how it all fits together.
 		def self.default_log_level(env = ENV)
-			if level = env['CONSOLE_LEVEL']
+			if level = env["CONSOLE_LEVEL"]
 				LEVELS[level.to_sym] || level.to_i
 			elsif $DEBUG
 				DEBUG
@@ -34,7 +36,7 @@ module Console
 		
 		# Controls verbose output using `$VERBOSE`.
 		def self.verbose?(env = ENV)
-			!$VERBOSE.nil? || env['CONSOLE_VERBOSE']
+			!$VERBOSE.nil? || env["CONSOLE_VERBOSE"]
 		end
 		
 		def self.default_logger(output = $stderr, env = ENV, **options)
@@ -47,6 +49,7 @@ module Console
 			end
 			
 			output = Output.new(output, env, **options)
+			
 			logger = self.new(output, **options)
 			
 			Resolver.default_resolver(logger)
@@ -61,6 +64,9 @@ module Console
 		DEFAULT_LEVEL = 1
 		
 		def initialize(output, **options)
+			# This is the expected default behaviour, but it may be nice to have a way to override it.
+			output = Output::Failure.new(output, **options)
+			
 			super(output, **options)
 		end
 		
@@ -69,20 +75,5 @@ module Console
 			
 			Progress.new(subject, total, **options)
 		end
-		
-		def error(subject, *arguments, **options, &block)
-			# This is a special case where we want to create a failure event from an exception.
-			# It's common to see `Console.error(self, exception)` in code.
-			if arguments.first.is_a?(Exception)
-				exception = arguments.shift
-				options[:event] = Event::Failure.for(exception)
-			end
-			
-			super
-		end
-		
-		def failure(subject, exception, **options)
-			error(subject, event: Event::Failure.for(exception), **options)
-		end
 	end
 end

data/lib/console/output/default.rb

@@ -3,8 +3,9 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'terminal'
-require_relative 'serialized'
+require_relative "terminal"
+require_relative "serialized"
+require_relative "failure"
 
 module Console
 	module Output
@@ -13,10 +14,12 @@ module Console
 				output ||= $stderr
 				
 				if output.tty?
-					Terminal.new(output, **options)
+					output = Terminal.new(output, **options)
 				else
-					Serialized.new(output, **options)
+					output = Serialized.new(output, **options)
 				end
+				
+				return output
 			end
 		end
 	end

data/lib/console/output/failure.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+require_relative "wrapper"
+require_relative "../event/failure"
+
+module Console
+	module Output
+		# A wrapper for outputting failure messages, which can include exceptions.
+		class Failure < Wrapper
+			def initialize(output, **options)
+				super(output, **options)
+			end
+			
+			# The exception must be either the last argument or passed as an option.
+			def call(subject = nil, *arguments, exception: nil, **options, &block)
+				if exception.nil?
+					last = arguments.last
+					if last.is_a?(Exception)
+						options[:event] = Event::Failure.for(last)
+					end
+				else
+					options[:event] = Event::Failure.for(exception)
+				end
+				
+				super(subject, *arguments, **options)
+			end
+		end
+	end
+end

data/lib/console/output/null.rb

@@ -9,6 +9,10 @@ module Console
 			def initialize(...)
 			end
 			
+			def last_output
+				self
+			end
+			
 			def call(...)
 				# Do nothing.
 			end

data/lib/console/output/sensitive.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'wrapper'
+require_relative "wrapper"
 
 module Console
 	module Output

data/lib/console/output/serialized.rb

@@ -3,18 +3,23 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative '../format'
-require 'time'
-require 'fiber/annotation'
+require_relative "../format"
+require "time"
+require "fiber/annotation"
 
 module Console
 	module Output
 		class Serialized
-			def initialize(output, format: Format.default, **options)
-				@io = output
+			def initialize(io, format: Format.default, **options)
+				@io = io
 				@format = format
 			end
 			
+			# This a final output that then writes to an IO object.
+			def last_output
+				self
+			end
+			
 			attr :io
 			attr :format
 			

data/lib/console/output/terminal.rb

@@ -4,13 +4,13 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Robert Schulze.
 
-require_relative '../clock'
-require_relative '../terminal'
+require_relative "../clock"
+require_relative "../terminal"
 
-require 'json'
-require 'fiber'
-require 'fiber/annotation'
-require 'stringio'
+require "json"
+require "fiber"
+require "fiber/annotation"
+require "stringio"
 
 module Console
 	module Output
@@ -35,7 +35,7 @@ module Console
 			end
 			
 			# This, and all related methods, is considered private.
-			CONSOLE_START_AT = 'CONSOLE_START_AT'
+			CONSOLE_START_AT = "CONSOLE_START_AT"
 			
 			# Exports CONSOLE_START which can be used to synchronize the start times of all child processes when they log using delta time.
 			def self.start_at!(environment = ENV)
@@ -78,6 +78,11 @@ module Console
 				self.register_formatters
 			end
 			
+			# This a final output that then writes to an IO object.
+			def last_output
+				self
+			end
+			
 			attr :io
 			
 			attr_accessor :verbose

data/lib/console/output/wrapper.rb

@@ -10,6 +10,12 @@ module Console
 				@delegate = delegate
 			end
 			
+			attr :delegate
+			
+			def last_output
+				@delegate.last_output
+			end
+			
 			def verbose!(value = true)
 				@delegate.verbose!(value)
 			end

data/lib/console/output.rb

@@ -3,16 +3,16 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'output/default'
-require_relative 'output/serialized'
-require_relative 'output/terminal'
-require_relative 'output/null'
+require_relative "output/default"
+require_relative "output/serialized"
+require_relative "output/terminal"
+require_relative "output/null"
 
 module Console
 	module Output
 		def self.new(output = nil, env = ENV, **options)
-			if names = env['CONSOLE_OUTPUT']
-				names = names.split(',').reverse
+			if names = env["CONSOLE_OUTPUT"]
+				names = names.split(",").reverse
 				
 				names.inject(output) do |output, name|
 					Output.const_get(name).new(output, **options)

data/lib/console/progress.rb

@@ -4,7 +4,7 @@
 # Copyright, 2020-2024, by Samuel Williams.
 # Copyright, 2022, by Anton Sozontov.
 
-require_relative 'clock'
+require_relative "clock"
 
 module Console
 	class Progress

data/lib/console/resolver.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Robert Schulze.
 
-require_relative 'filter'
+require_relative "filter"
 
 module Console
 	class Resolver
@@ -22,12 +22,12 @@ module Console
 		def self.default_resolver(logger, env = ENV)
 			# Find all CONSOLE_$LEVEL variables from environment:
 			levels = logger.class::LEVELS
-				.map{|label, level| [level, env["CONSOLE_#{label.upcase}"]&.split(',')]}
+				.map{|label, level| [level, env["CONSOLE_#{label.upcase}"]&.split(",")]}
 				.to_h
 				.compact
 			
-			off_klasses = env['CONSOLE_OFF']&.split(',')
-			on_klasses = env['CONSOLE_ON']&.split(',')
+			off_klasses = env["CONSOLE_OFF"]&.split(",")
+			on_klasses = env["CONSOLE_ON"]&.split(",")
 			
 			resolver = nil
 			

data/lib/console/terminal/text.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require 'io/console'
+require "io/console"
 
 module Console
 	# Styled terminal output.

data/lib/console/terminal/xterm.rb

@@ -3,9 +3,9 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require 'io/console'
+require "io/console"
 
-require_relative 'text'
+require_relative "text"
 
 module Console
 	# Styled terminal output.

data/lib/console/terminal.rb

@@ -3,12 +3,12 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'terminal/text'
-require_relative 'terminal/xterm'
+require_relative "terminal/text"
+require_relative "terminal/xterm"
 
-require_relative 'terminal/formatter/progress'
-require_relative 'terminal/formatter/failure'
-require_relative 'terminal/formatter/spawn'
+require_relative "terminal/formatter/progress"
+require_relative "terminal/formatter/failure"
+require_relative "terminal/formatter/spawn"
 
 module Console
 	module Terminal

data/lib/console/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2019-2024, by Samuel Williams.
 
 module Console
-	VERSION = "1.27.0"
+	VERSION = "1.29.0"
 end

data/lib/console/warn.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative "logger"
+
+module Console
+	# Whether the current fiber is emitting a warning.
+	Fiber.attr_accessor :console_warn
+	
+	# Redirect warnings to Console.warn.
+	module Warn
+		# Redirect warnings to {Console.warn}.
+		def warn(message, **options)
+			fiber = Fiber.current
+			
+			# We do this to be extra pendantic about avoiding infinite recursion.
+			return super if fiber.console_warn
+			
+			begin
+				fiber.console_warn = true
+				message.chomp!
+				
+				Console::Logger.instance.warn(message, **options)
+			ensure
+				fiber.console_warn = false
+			end
+		end
+	end
+	
+	::Warning.extend(Warn)
+end

data/lib/console.rb

@@ -6,41 +6,9 @@
 # Copyright, 2020, by Michael Adams.
 # Copyright, 2021, by Cédric Boutillier.
 
-require_relative 'console/version'
-require_relative 'console/logger'
+require_relative "console/version"
+require_relative "console/interface"
 
 module Console
-	class << self
-		def logger
-			Logger.instance
-		end
-		
-		def logger= instance
-			Logger.instance= instance
-		end
-		
-		def debug(...)
-			Logger.instance.debug(...)
-		end
-		
-		def info(...)
-			Logger.instance.info(...)
-		end
-		
-		def warn(...)
-			Logger.instance.warn(...)
-		end
-		
-		def error(...)
-			Logger.instance.error(...)
-		end
-		
-		def fatal(...)
-			Logger.instance.fatal(...)
-		end
-		
-		def call(...)
-			Logger.instance.call(...)
-		end
-	end
+	Console.extend(Interface)
 end

data/readme.md

@@ -26,6 +26,22 @@ Please see the [project documentation](https://socketry.github.io/console/) for
 
   - [Integration](https://socketry.github.io/console/guides/integration/index) - This guide explains how to integrate the `console` output into different systems.
 
+  - [Events](https://socketry.github.io/console/guides/events/index) - This guide explains how to log structured events with a well-defined schema.
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/console/releases/index) for all releases.
+
+### v1.29.0
+
+  - Don't make `Kernel#warn` redirection to `Console.warn` the default behavior, you must `require 'console/warn'` to enable it.
+  - Remove deprecated `Console::Logger#failure`.
+  - [Consistent Handling of Exceptions](https://socketry.github.io/console/releases/index#consistent-handling-of-exceptions)
+
+### v1.28.0
+
+  - Add support for `Kernel#warn` redirection to `Console.warn`.
+
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -0,0 +1,25 @@
+# Releases
+
+## v1.29.0
+
+  - Don't make `Kernel#warn` redirection to `Console.warn` the default behavior, you must `require 'console/warn'` to enable it.
+  - Remove deprecated `Console::Logger#failure`.
+
+### Consistent Handling of Exceptions
+
+`Console.call` and all wrapper methods will now consistently handle exceptions that are the last positional argument or keyword argument. This means that the following code will work as expected:
+
+``` ruby
+begin
+rescue => error
+	# Last positional argument:
+	Console.warn(self, "There may be an issue", error)
+	
+	# Keyword argument (preferable):
+	Console.error(self, "There is an issue", exception: error)
+end
+```
+
+## v1.28.0
+
+  - Add support for `Kernel#warn` redirection to `Console.warn`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.27.0
+  version: 1.29.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -47,7 +47,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiber-annotation
@@ -110,9 +110,11 @@ files:
 - lib/console/filter.rb
 - lib/console/format.rb
 - lib/console/format/safe.rb
+- lib/console/interface.rb
 - lib/console/logger.rb
 - lib/console/output.rb
 - lib/console/output/default.rb
+- lib/console/output/failure.rb
 - lib/console/output/null.rb
 - lib/console/output/sensitive.rb
 - lib/console/output/serialized.rb
@@ -128,8 +130,10 @@ files:
 - lib/console/terminal/text.rb
 - lib/console/terminal/xterm.rb
 - lib/console/version.rb
+- lib/console/warn.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://socketry.github.io/console
 licenses:
 - MIT