console 1.24.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a62f7c19673292c5cd3c0d8b9d93350ca4b36ac0a5c0a0466deef6543b388ba
-  data.tar.gz: f382353a7b052c056936fdd2c95ad0bd20cfb8619db2f6d2af1ce7e9e0cd7967
+  metadata.gz: ea53f121a472d6011335a91ac4a96f4f3630c4524b1158166be906a51e4dd186
+  data.tar.gz: 20cdb45a16606315c9a0e054fb9e3460698e6fcccd190bd7668902f179c7b5fa
 SHA512:
-  metadata.gz: 6638ede52de5f0954a38adf71e910997eb643d2e39ef59645f320ce16ebefd4f804cb062e47e03472ac742fb46591c310217da72eb63eb87fe91d93090f8ee5f
-  data.tar.gz: 15f4929956b45e0c445e95774dfa3ac1c4bb485401e1b0003835c9ae5435a25ebda70b69ad475cf0e6b48131b0cc41258e3c5bb8c70121daaa9fe482c12b5404
+  metadata.gz: 42748b35f41a887222716d8bd0b9e55f92a5506f31fa7cb0a3e5ac5155341c55d6ca2849745b77d568b7b11e3d79faf0193377b9547fce98c5c16ca1043f9222
+  data.tar.gz: de9535e3fb41fcce945512f9d482329cfc695888c43da753d1f7c392e074e4b4b1e6584fbfd1c39b4851c25f00563b1e0ee3efbd5240294649ff4dc68519483d

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'
 
@@ -9,27 +9,45 @@ module Console
 	# A general sink which captures all events into a buffer.
 	class Capture
 		def initialize
-			@buffer = []
+			@records = []
 			@verbose = false
 		end
 		
-		attr :buffer
+		attr :records
+		
+		# @deprecated Use {#records} instead of {#buffer}.
+		alias buffer records
+		
+		alias to_a records
+		
 		attr :verbose
 		
-		def last
-			@buffer.last
+		def include?(pattern)
+			@records.any? do |record|
+				record[:subject].to_s&.match?(pattern) or record[:message].to_s&.match?(pattern)
+			end
 		end
 		
-		def include?(pattern)
-			JSON.dump(@buffer).include?(pattern)
+		def each(&block)
+			@records.each(&block)
+		end
+		
+		include Enumerable
+		
+		def first
+			@records.first
+		end
+		
+		def last
+			@records.last
 		end
 		
 		def clear
-			@buffer.clear
+			@records.clear
 		end
 		
 		def empty?
-			@buffer.empty?
+			@records.empty?
 		end
 		
 		def verbose!(value = true)
@@ -40,36 +58,42 @@ module Console
 			@verbose
 		end
 		
-		def call(subject = nil, *arguments, severity: UNKNOWN, **options, &block)
-			message = {
+		def call(subject = nil, *arguments, severity: UNKNOWN, event: nil,  **options, &block)
+			record = {
 				time: ::Time.now.iso8601,
 				severity: severity,
 				**options,
 			}
 			
 			if subject
-				message[:subject] = subject
+				record[:subject] = subject
+			end
+			
+			if event
+				record[:event] = event.to_hash
 			end
 			
 			if arguments.any?
-				message[:arguments] = arguments
+				record[:arguments] = arguments
 			end
 			
 			if annotation = Fiber.current.annotation
-				message[:annotation] = annotation
+				record[:annotation] = annotation
 			end
 			
 			if block_given?
 				if block.arity.zero?
-					message[:message] = yield
+					record[:message] = yield
 				else
 					buffer = StringIO.new
 					yield buffer
-					message[:message] = buffer.string
+					record[:message] = buffer.string
 				end
+			else
+				record[:message] = arguments.join(" ")
 			end
 			
-			@buffer << message
+			@records << record
 		end
 	end
 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,43 @@ 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 emit(*arguments, **options)
+				options[:severity] ||= :info
+				super
+			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,15 +1,13 @@
 # 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'
+	UNKNOWN = :unknown
 	
 	class Filter
 		if Object.const_defined?(:Ractor) and RUBY_VERSION >= '3.1'
@@ -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)
+							@output.call(subject, *arguments, severity: name, **@options, **options, &block)
 						end
 					end
 					
@@ -145,8 +143,13 @@ module Console
 			@subjects.delete(subject)
 		end
 		
-		def call(*arguments, **options, &block)
-			@output.call(*arguments, **options, &block)
+		def call(subject, *arguments, **options, &block)
+			severity = options[:severity] || UNKNOWN
+			level = self.class::LEVELS[severity]
+			
+			if self.enabled?(subject, level)
+				@output.call(subject, *arguments, **options, &block)
+			end
 		end
 	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