console 1.28.1 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c1e55ddfff39c11445d128d77669db8d27047b5bb52451c0dcd41986b9efe99
-  data.tar.gz: 314cd06dc220bc184899c393d68ef8e0387e92bbeb39522b2ec9ab11b408cb01
+  metadata.gz: 1fa166f5900ef3a9c90b337ce6dd57faa99527fd9746a47aa61bb7f7535e606d
+  data.tar.gz: c6d7d06fdd475006e000c3da6d65fdcd3a5c58e10c90afa8b380f795d45a16d1
 SHA512:
-  metadata.gz: e2b5c3d3d01818a45f7680e07417c5c6bb805caa81c5a598d7a4c83fa77363cdbf241eb5f00327ff835c130ebe53994f34c923c50304c972d01b714fba638263
-  data.tar.gz: 6cc85f8a898133e9af736f89b0d12cda37fdc46f2467131e89b6784842a8cdff9757f0981cf18c7ae0cbf1b21d005aaf4f7b9f647c891ec96b790833446c4fcd
+  metadata.gz: 620b134d260d72d3b69a57e455584d556d611aa8a441fbd7624722b1cfaf3541015335717b82da8ea2aa0682f94e2898c9f28c4162fa5b5842297035f81bd5c0
+  data.tar.gz: be9318b5f775a9bd33f5c8951ffae4b921dbe0618f209080645a3eb12dcd096ef092d94f1239564e03497961ebbfbbb926d43294b8b524a94486e6b62a835b1a

data/lib/console/capture.rb

@@ -4,6 +4,7 @@
 # Copyright, 2019-2024, by Samuel Williams.
 
 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/event/failure.rb

@@ -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

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

@@ -6,6 +6,8 @@
 # Copyright, 2021, by Robert Schulze.
 
 require_relative "output"
+require_relative "output/failure"
+
 require_relative "filter"
 require_relative "event"
 require_relative "resolver"
@@ -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

@@ -5,6 +5,7 @@
 
 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/serialized.rb

@@ -10,11 +10,16 @@ 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

@@ -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/version.rb

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

data/lib/console/warn.rb

@@ -3,35 +3,31 @@
 # 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
-		def warn(*arguments, uplevel: nil, **options)
+		# Redirect warnings to {Console.warn}.
+		def warn(message, **options)
 			fiber = Fiber.current
 			
-			# We do this to be extra pendantic about avoiding infinite recursion, i.e. if `Console.warn` some how calls `Kernel.warn` again, it would potentially cause infinite recursion. I'm not sure if this is a problem in practice, but I'd rather not find out the hard way...
+			# We do this to be extra pendantic about avoiding infinite recursion.
 			return super if fiber.console_warn
 			
-			if uplevel
-				options[:backtrace] = caller(uplevel, 1)
-			end
-			
-			if arguments.last.is_a?(Exception)
-				exception = arguments.pop
+			begin
+				fiber.console_warn = true
+				message.chomp!
 				
-				Console::Event::Failure.for(exception).emit(*arguments, severity: :warn)
-			else
-				begin
-					fiber.console_warn = true
-					Console.warn(*arguments, **options)
-				ensure
-					fiber.console_warn = false
-				end
+				Console::Logger.instance.warn(message, **options)
+			ensure
+				fiber.console_warn = false
 			end
 		end
 	end
 	
-	::Kernel.prepend(Warn)
+	::Warning.extend(Warn)
 end

data/lib/console.rb

@@ -7,41 +7,8 @@
 # Copyright, 2021, by Cédric Boutillier.
 
 require_relative "console/version"
-require_relative "console/logger"
-require_relative "console/warn"
+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

@@ -32,6 +32,12 @@ Please see the [project documentation](https://socketry.github.io/console/) for
 
 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`.

data/releases.md

@@ -1,5 +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.28.1
+  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-11-05 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