console 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a62f7c19673292c5cd3c0d8b9d93350ca4b36ac0a5c0a0466deef6543b388ba
-  data.tar.gz: f382353a7b052c056936fdd2c95ad0bd20cfb8619db2f6d2af1ce7e9e0cd7967
+  metadata.gz: f91958a87f7e55b773b421ba83cedd33c65d8668fc9be859b8a49af0ed93dcd4
+  data.tar.gz: fe5c31ba8acb886bbdde2c28b8b958f64dd0bc376d76fa89c79685a5239ab267
 SHA512:
-  metadata.gz: 6638ede52de5f0954a38adf71e910997eb643d2e39ef59645f320ce16ebefd4f804cb062e47e03472ac742fb46591c310217da72eb63eb87fe91d93090f8ee5f
-  data.tar.gz: 15f4929956b45e0c445e95774dfa3ac1c4bb485401e1b0003835c9ae5435a25ebda70b69ad475cf0e6b48131b0cc41258e3c5bb8c70121daaa9fe482c12b5404
+  metadata.gz: bddf649708410d79d0d979342bdd98c1c4bb1687ddbe79c8b0f1da8de36aab881872bb3b086256083044e366627c111fd642146c6781d4bc669f9d26511cc4a4
+  data.tar.gz: 49a2cc984ba416722d712eaf8133e1ce1e8be95fd36f056e57a157539b6e1033f6a1a9074b9b7283510c2fa8214db3ba8bfa70de4971bd9fe0227e15a6dab32d

data/lib/console/adapter.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
 module Console
+	# This namespace is reserved for logging adapters provided by other gems.
 	module Adapter
 	end
 end

data/lib/console/capture.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'filter'
 
@@ -40,7 +40,7 @@ module Console
 			@verbose
 		end
 		
-		def call(subject = nil, *arguments, severity: UNKNOWN, **options, &block)
+		def call(subject = nil, *arguments, severity: UNKNOWN, event: nil,  **options, &block)
 			message = {
 				time: ::Time.now.iso8601,
 				severity: severity,
@@ -51,6 +51,10 @@ module Console
 				message[:subject] = subject
 			end
 			
+			if event
+				message[:event] = event.to_hash
+			end
+			
 			if arguments.any?
 				message[:arguments] = arguments
 			end

data/lib/console/compatible/logger.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 require 'logger'
 
 module Console
 	module Compatible
+		# A compatible interface for {::Logger} which can be used with {Console}.
 		class Logger < ::Logger
 			class LogDevice
 				def initialize(subject, output)

data/lib/console/event/failure.rb

@@ -1,83 +1,74 @@
 # 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 'generic'
 
 module Console
 	module Event
+		# Represents a failure event.
+		#
+		# ```ruby
+		# Console::Event::Failure.for(exception).emit(self)
+		# ```
 		class Failure < Generic
-			def self.current_working_directory
+			def self.default_root
 				Dir.getwd
 			rescue # e.g. Errno::EMFILE
 				nil
 			end
 			
 			def self.for(exception)
-				self.new(exception, self.current_working_directory)
+				self.new(exception, self.default_root)
 			end
 			
-			def initialize(exception, root = nil)
+			def self.log(subject, exception, **options)
+				Console.error(subject, **self.for(exception).to_hash, **options)
+			end
+			
+			def initialize(exception, root = Dir.getwd)
 				@exception = exception
 				@root = root
 			end
 			
-			attr :exception
-			attr :root
-			
-			def self.register(terminal)
-				terminal[:exception_title] ||= terminal.style(:red, nil, :bold)
-				terminal[:exception_detail] ||= terminal.style(:yellow)
-				terminal[:exception_backtrace] ||= terminal.style(:red)
-				terminal[:exception_backtrace_other] ||= terminal.style(:red, nil, :faint)
-				terminal[:exception_message] ||= terminal.style(:default)
+			def to_hash
+				Hash.new.tap do |hash|
+					hash[:type] = :failure
+					hash[:root] = @root if @root
+					extract(@exception, hash)
+				end
 			end
 			
-			def to_h
-				{exception: @exception, root: @root}
+			def emit(*arguments, **options)
+				options[:severity] ||= :error
+				
+				super
 			end
 			
-			def format(output, terminal, verbose)
-				format_exception(@exception, nil, output, terminal, verbose)
-			end
+			private
 			
-			if Exception.method_defined?(:detailed_message)
-				def detailed_message(exception)
-					exception.detailed_message
-				end
-			else
-				def detailed_message(exception)
-					exception.message
-				end
-			end
-			
-			def format_exception(exception, prefix, output, terminal, verbose)
-				lines = detailed_message(exception).lines.map(&:chomp)
-				
-				output.puts "  #{prefix}#{terminal[:exception_title]}#{exception.class}#{terminal.reset}: #{lines.shift}"
-				
-				lines.each do |line|
-					output.puts "  #{terminal[:exception_detail]}#{line}#{terminal.reset}"
-				end
+			def extract(exception, hash)
+				hash[:class] = exception.class.name
 				
-				root_pattern = /^#{@root}\// if @root
-				
-				exception.backtrace&.each_with_index do |line, index|
-					path, offset, message = line.split(":", 3)
-					style = :exception_backtrace
+				if exception.respond_to?(:detailed_message)
+					message = exception.detailed_message
 					
-					# Make the path a bit more readable
-					if root_pattern and path.sub!(root_pattern, "").nil?
-						style = :exception_backtrace_other
-					end
+					# We want to remove the trailling exception class as we format it differently:
+					message.sub!(/\s*\(.*?\)$/, '')
 					
-					output.puts "  #{index == 0 ? "→" : " "} #{terminal[style]}#{path}:#{offset}#{terminal[:exception_message]} #{message}#{terminal.reset}"
+					hash[:message] = message
+				else
+					hash[:message] = exception.message
 				end
 				
-				if exception.cause
-					format_exception(exception.cause, "Caused by ", output, terminal, verbose)
+				hash[:backtrace] = exception.backtrace
+				
+				if cause = exception.cause
+					hash[:cause] = Hash.new.tap do |cause_hash|
+						extract(cause, cause_hash)
+					end
 				end
 			end
 		end

data/lib/console/event/generic.rb

@@ -1,22 +1,25 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 module Console
 	module Event
 		class Generic
-			def self.register(terminal)
+			def as_json(...)
+				to_hash
 			end
 			
-			def to_h
+			def to_json(...)
+				JSON.generate(as_json, ...)
 			end
 			
-			def to_json(*arguments)
-				JSON.generate([self.class, to_h], *arguments)
+			def to_s
+				to_json
 			end
 			
-			def format(buffer, terminal)
+			def emit(*arguments, **options)
+				Console.call(*arguments, event: self, **options)
 			end
 		end
 	end

data/lib/console/event/spawn.rb

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'generic'
+require_relative '../clock'
 
 module Console
 	module Event
+		# Represents a spawn event.
+		#
+		# ```ruby
+		# Console.info(self, **Console::Event::Spawn.for("ls", "-l"))
+		#
+		# event = Console::Event::Spawn.for("ls", "-l")
+		# event.status = Process.wait
+		# ```
 		class Spawn < Generic
 			def self.for(*arguments, **options)
 				# Extract out the command environment:
@@ -22,44 +31,38 @@ module Console
 				@environment = environment
 				@arguments = arguments
 				@options = options
+				
+				@start_time = Clock.now
+				
+				@end_time = nil
+				@status = nil
 			end
 			
-			attr :environment
-			attr :arguments
-			attr :options
-			
-			def chdir_string(options)
-				if options and chdir = options[:chdir]
-					" in #{chdir}"
+			def duration
+				if @end_time
+					@end_time - @start_time
 				end
 			end
 			
-			def self.register(terminal)
-				terminal[:shell_command] ||= terminal.style(:blue, nil, :bold)
-			end
-			
-			def to_h
+			def to_hash
 				Hash.new.tap do |hash|
+					hash[:type] = :spawn
 					hash[:environment] = @environment if @environment&.any?
 					hash[:arguments] = @arguments if @arguments&.any?
 					hash[:options] = @options if @options&.any?
+					
+					hash[:status] = @status.to_i if @status
+					
+					if duration = self.duration
+						hash[:duration] = duration
+					end
 				end
 			end
 			
-			def format(output, terminal, verbose)
-				arguments = @arguments.flatten.collect(&:to_s)
-				
-				output.puts "  #{terminal[:shell_command]}#{arguments.join(' ')}#{terminal.reset}#{chdir_string(options)}"
-				
-				if verbose and @environment
-					@environment.each do |key, value|
-						output.puts "    export #{key}=#{value}"
-					end
-				end
+			def status=(status)
+				@end_time = Time.now
+				@status = status
 			end
 		end
 	end
-	
-	# Deprecated.
-	Shell = Event::Spawn
 end

data/lib/console/event.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'event/spawn'
 require_relative 'event/failure'
-require_relative 'event/progress'

data/lib/console/filter.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2019, by Bryan Powell.
 # Copyright, 2020, by Michael Adams.
 # Copyright, 2021, by Robert Schulze.
 
-require_relative 'buffer'
-
 module Console
 	UNKNOWN = 'unknown'
 	
@@ -37,7 +35,7 @@ module Console
 					
 					define_immutable_method(name) do |subject = nil, *arguments, **options, &block|
 						if self.enabled?(subject, level)
-							self.call(subject, *arguments, severity: name, **options, **@options, &block)
+							self.call(subject, *arguments, severity: name, **@options, **options, &block)
 						end
 					end
 					

data/lib/console/format.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
 require_relative 'format/safe'
 
@@ -10,9 +10,5 @@ module Console
 		def self.default
 			Safe.new(format: ::JSON)
 		end
-		
-		def self.default_json
-			self.default
-		end
 	end
 end

data/lib/console/logger.rb

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Bryan Powell.
 # Copyright, 2021, by Robert Schulze.
 
 require_relative 'output'
 require_relative 'filter'
-require_relative 'progress'
-
+require_relative 'event'
 require_relative 'resolver'
-require_relative 'terminal/logger'
-require_relative 'serialized/logger'
+require_relative 'progress'
 
 require 'fiber/local'
 
@@ -67,12 +65,24 @@ module Console
 		end
 		
 		def progress(subject, total, **options)
-			Progress.new(self, subject, total, **options)
+			options[:severity] ||= :info
+			
+			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
 		
-		# @deprecated Use `fatal` instead.
-		def failure(subject, exception, *arguments, &block)
-			self.fatal(subject, exception, *arguments, &block)
+		def failure(subject, exception, **options)
+			error(subject, event: Event::Failure.for(exception), **options)
 		end
 	end
 end

data/lib/console/output/default.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'xterm'
-require_relative 'json'
+require_relative 'terminal'
+require_relative 'serialized'
 
 module Console
 	module Output
@@ -13,9 +13,9 @@ module Console
 				output ||= $stderr
 				
 				if output.tty?
-					XTerm.new(output, **options)
+					Terminal.new(output, **options)
 				else
-					JSON.new(output, **options)
+					Serialized.new(output, **options)
 				end
 			end
 		end

data/lib/console/output/null.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
 module Console
 	module Output

data/lib/console/output/sensitive.rb

@@ -1,17 +1,13 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require_relative '../serialized/logger'
+require_relative 'wrapper'
 
 module Console
 	module Output
-		class Sensitive
-			def initialize(output, **options)
-				@output = output
-			end
-			
+		class Sensitive < Wrapper
 			REDACT = /
 				  phone
 				| email
@@ -38,8 +34,14 @@ module Console
 				| password
 			/xi
 			
+			def initialize(output, redact: REDACT, **options)
+				super(output, **options)
+				
+				@redact = redact
+			end
+			
 			def redact?(text)
-				text.match?(REDACT)
+				text.match?(@redact)
 			end
 			
 			def redact_hash(arguments, filter)
@@ -96,7 +98,7 @@ module Console
 					arguments = redact_array(arguments, filter)
 				end
 				
-				@output.call(subject, *arguments, **options)
+				super(subject, *arguments, **options)
 			end
 		end
 	end

data/lib/console/{serialized/logger.rb → output/serialized.rb}

@@ -1,34 +1,23 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
-require_relative '../buffer'
-require_relative '../filter'
 require_relative '../format'
-
 require 'time'
-
 require 'fiber/annotation'
 
 module Console
-	module Serialized
-		class Logger
-			def initialize(io = $stderr, format: Format.default, verbose: false, **options)
-				@io = io
-				@start = Time.now
+	module Output
+		class Serialized
+			def initialize(output, format: Format.default, **options)
+				@io = output
 				@format = format
-				@verbose = verbose
 			end
 			
 			attr :io
-			attr :start
 			attr :format
 			
-			def verbose!(value = true)
-				@verbose = true
-			end
-			
 			def dump(record)
 				@format.dump(record)
 			end
@@ -72,41 +61,12 @@ module Console
 					record[:message] = message
 				end
 				
-				if exception = find_exception(message)
-					record[:error] = {
-						kind: exception.class,
-						message: exception.message,
-						stack: format_stack(exception)
-					}
-				end
-				
 				record.update(options)
 				
 				@io.puts(self.dump(record))
 			end
-			
-			private
-			
-			def find_exception(message)
-				message.find{|part| part.is_a?(Exception)}
-			end
-			
-			def format_stack(exception)
-				buffer = StringIO.new
-				format_backtrace(exception, buffer)
-				return buffer.string
-			end
-			
-			def format_backtrace(exception, buffer)
-				buffer.puts exception.backtrace
-				
-				if exception = exception.cause
-					buffer.puts
-					buffer.puts "Caused by: #{exception.class} #{exception.message}"
-
-					format_backtrace(exception, buffer)
-				end
-			end
 		end
+		
+		JSON = Serialized
 	end
 end

data/lib/console/output/split.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 module Console
 	module Output
@@ -18,9 +18,9 @@ module Console
 				@outputs.each{|output| output.verbose!(value)}
 			end
 			
-			def call(level, subject = nil, *arguments, **options, &block)
+			def call(...)
 				@outputs.each do |output|
-					output.call(level, subject, *arguments, **options, &block)
+					output.call(...)
 				end
 			end
 		end