console 1.29.2 → 1.30.0

data/lib/console/output/terminal.rb

@@ -14,48 +14,65 @@ require "stringio"
 
 module Console
 	module Output
+		# Represents a terminal output, and formats log messages for display.
 		class Terminal
+			# Represents an output buffer that formats lines with a prefix.
 			class Buffer < StringIO
+				# Create a new buffer with the given prefix.
+				#
+				# @parameter prefix [String] The prefix to use for each line.
 				def initialize(prefix = nil)
 					@prefix = prefix
 					
 					super()
 				end
 				
+				# @attribute [String] The prefix to use for each line.
 				attr :prefix
 				
-				def puts(*args, prefix: @prefix)
-					args.each do |arg|
+				# Write lines using the given prefix.
+				#
+				# @parameter lines [Array] The lines to write.
+				# @parameter prefix [String] The prefix to use for each line.
+				def puts(*lines, prefix: @prefix)
+					lines.each do |line|
 						self.write(prefix) if prefix
-						super(arg)
+						super(line)
 					end
 				end
 				
 				alias << puts
 			end
 			
-			# This, and all related methods, is considered private.
+			# The environment variable used to store the start time of the console terminal output.
 			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)
-				if time_string = environment[CONSOLE_START_AT]
+			# Exports CONSOLE_START_AT which can be used to synchronize the start times of all child processes when they log using delta time.
+			def self.start_at!(env = ENV)
+				if time_string = env[CONSOLE_START_AT]
 					start_at = Time.parse(time_string) rescue nil
 				end
 				
 				unless start_at
 					start_at = Time.now
-					environment[CONSOLE_START_AT] = start_at.to_s
+					env[CONSOLE_START_AT] = start_at.to_s
 				end
 				
 				return start_at
 			end
 			
-			def initialize(output, verbose: nil, start_at: Terminal.start_at!, format: nil, **options)
-				@io = output
+			# Create a new terminal output.
+			#
+			# @parameter stream [IO] The output stream.
+			# @parameter verbose [Boolean] Whether to print verbose output.
+			# @parameter start_at [Time] The start time of the terminal output.
+			# @parameter format [Console::Terminal::Format] The format to use for terminal output.
+			# @parameter options [Hash] Additional options to customize the output.
+			def initialize(stream, verbose: nil, start_at: Terminal.start_at!, format: nil, **options)
+				@stream = stream
 				@start_at = start_at
 				
-				@terminal = format.nil? ? Console::Terminal.for(@io) : format.new(@io)
+				@terminal = format.nil? ? Console::Terminal.for(@stream) : format.new(@stream)
 				
 				if verbose.nil?
 					@verbose = !@terminal.colors?
@@ -78,22 +95,31 @@ module Console
 				self.register_formatters
 			end
 			
-			# This a final output that then writes to an IO object.
+			# This a final output.
 			def last_output
 				self
 			end
 			
-			attr :io
+			# @attribute [IO] The output stream.
+			attr :stream
 			
+			# @attribute [Boolean] Whether to print verbose output.
 			attr_accessor :verbose
 			
+			# @attribute [Time] The start time of the terminal output.
 			attr :start
+			
+			# @attribute [Console::Terminal::Format] The format to use for terminal output.
 			attr :terminal
 			
+			# Set the verbose output.
+			#
+			# @parameter value [Boolean] Whether to print verbose output.
 			def verbose!(value = true)
 				@verbose = value
 			end
 			
+			# Register all formatters in the given namespace.
 			def register_formatters(namespace = Console::Terminal::Formatter)
 				namespace.constants.each do |name|
 					formatter = namespace.const_get(name)
@@ -101,8 +127,20 @@ module Console
 				end
 			end
 			
+			# The default severity for log messages, if not specified.
 			UNKNOWN = :unknown
 			
+			# Log a message with the given severity.
+			#
+			# @parameter subject [String] The subject of the log message.
+			# @parameter arguments [Array] The arguments to log.
+			# @parameter name [String | Nil] The optional name of the log message, used as a prefix, otherwise defaults to the severity name.
+			# @parameter severity [Symbol] The severity of the log message.
+			# @parameter event [Hash] The event to log.
+			# @parameter options [Hash] Additional options.
+			# @yields {|buffer, terminal| ...} An optional block used to generate the log message.
+			# 	@parameter buffer [Console::Output::Terminal::Buffer] The output buffer.
+			# 	@parameter terminal [Console::Terminal] The terminal instance.
 			def call(subject = nil, *arguments, name: nil, severity: UNKNOWN, event: nil, **options, &block)
 				width = @terminal.width
 				
@@ -134,7 +172,7 @@ module Console
 					format_options(options, buffer)
 				end
 				
-				@io.write buffer.string
+				@stream.write buffer.string
 			end
 			
 			protected
@@ -242,13 +280,27 @@ module Console
 			end
 		end
 		
+		# Terminal text output.
 		module Text
+			# Create a new terminal output.
+			#
+			# @parameter output [IO] The output stream.
+			# @parameter options [Hash] Additional options to customize the output.
+			# @returns [Console::Output::Terminal] The terminal output instance.
 			def self.new(output, **options)
 				Terminal.new(output, format: Console::Terminal::Text, **options)
 			end
 		end
 		
+		# Terminal XTerm output.
 		module XTerm
+			# Create a new terminal output.
+			#
+			# You can use this to force XTerm output on a non-TTY output streams that support XTerm escape codes.
+			#
+			# @parameter output [IO] The output stream.
+			# @parameter options [Hash] Additional options to customize the output.
+			# @returns [Console::Output::Terminal] The terminal output instance.
 			def self.new(output, **options)
 				Terminal.new(output, format: Console::Terminal::XTerm, **options)
 			end

data/lib/console/output/wrapper.rb

@@ -5,21 +5,32 @@
 
 module Console
 	module Output
+		# A generic wrapper for output handling.
 		class Wrapper
+			# Create a new wrapper output.
+			#
+			# @parameter delegate [Console::Output] The output to delegate to.
+			# @parameter options [Hash] Additional options to customize the output.
 			def initialize(delegate, **options)
 				@delegate = delegate
 			end
 			
+			# @attribute [Console::Output] The output to delegate to.
 			attr :delegate
 			
+			# The last output is the last output of the delegate.
 			def last_output
 				@delegate.last_output
 			end
 			
+			# Set the verbose flag for the delegate.
+			#
+			# @parameter value [Boolean] The new value.
 			def verbose!(value = true)
 				@delegate.verbose!(value)
 			end
 			
+			# Invoke the delegate.
 			def call(...)
 				@delegate.call(...)
 			end

data/lib/console/output.rb

@@ -9,7 +9,18 @@ require_relative "output/terminal"
 require_relative "output/null"
 
 module Console
+	# Output handling.
 	module Output
+		# Create a new output based on the environment.
+		#
+		# The environment variable `CONSOLE_OUTPUT` can be used to specify a list of output classes to wrap around the output. If not specified the {Default} output is used.
+		#
+		# The output argument is deliberately unders-specified but can be an IO object or an instance of {Output}.
+		#
+		# @parameter output [Console::Output] The output to wrap OR an IO object.
+		# @parameter env [Hash] The environment to read configuration from.
+		# @parameter options [Hash] Additional options to customize the output.
+		# @returns [Console::Output] The output instance.
 		def self.new(output = nil, env = ENV, **options)
 			if names = env["CONSOLE_OUTPUT"]
 				names = names.split(",").reverse

data/lib/console/progress.rb

@@ -7,16 +7,24 @@
 require_relative "clock"
 
 module Console
+	# A simple progress indicator
 	class Progress
+		# @deprecated Use {Clock.now} instead.
 		def self.now
-			Process.clock_gettime(Process::CLOCK_MONOTONIC)
+			Clock.now
 		end
 		
+		# Create a new progress indicator.
+		#
+		# @parameter subject [Object] The subject of the progress indicator.
+		# @parameter total [Integer] The total number of steps.
+		# @parameter minimum_output_duration [Numeric] The minimum duration between outputs.
+		# @parameter options [Hash] Additional options to customize the output.
 		def initialize(subject, total = 0, minimum_output_duration: 0.1, **options)
 			@subject = subject
 			@options = options
 			
-			@start_time = Progress.now
+			@start_time = Clock.now
 			
 			@last_output_time = nil
 			@minimum_output_duration = minimum_output_duration
@@ -25,34 +33,53 @@ module Console
 			@total = total
 		end
 		
+		# @attribute [Object] The subject of the progress indicator.
 		attr :subject
+		
+		# @attribute [Numeric] The minimum duration between outputs.
+		attr :minimum_output_duration
+		
+		# @attribute [Time] The time the progress indicator was started.
+		attr :start_time
+		
+		# @attribute [Numeric] The current number of steps completed.
 		attr :current
+		
+		# @attribute [Numeric] The total number of steps.
 		attr :total
 		
+		# @returns [Numeric] The duration since the progress indicator was started.
 		def duration
-			Progress.now - @start_time
+			Clock.now - @start_time
 		end
 		
+		# @returns [Rational] The ratio of steps completed to total steps.
 		def ratio
 			Rational(@current.to_f, @total.to_f)
 		end
 		
+		# @returns [Numeric] The number of steps remaining.
 		def remaining
 			@total - @current
 		end
 		
+		# @returns [Numeric | Nil] The average duration per step, or `nil` if no steps have been completed.
 		def average_duration
 			if @current > 0
 				duration / @current
 			end
 		end
 		
+		# @returns [Numeric | Nil] The estimated remaining time, or `nil` if no steps have been completed.
 		def estimated_remaining_time
 			if average_duration = self.average_duration
 				average_duration * remaining
 			end
 		end
 		
+		# Generate an appropriate event for the progress indicator.
+		#
+		# @returns [Hash] The progress indicator as a hash.
 		def to_hash
 			Hash.new.tap do |hash|
 				hash[:type] = :progress
@@ -64,30 +91,44 @@ module Console
 			end
 		end
 		
+		# Increment the progress indicator by the given amount.
+		#
+		# @parameter amount [Numeric] The amount to increment by.
+		# @returns [Progress] The progress indicator itself.
 		def increment(amount = 1)
 			@current += amount
 			
 			if output?
 				Console.call(@subject, self.to_s, event: self.to_hash, **@options)
-				@last_output_time = Progress.now
+				@last_output_time = Clock.now
 			end
 			
 			return self
 		end
 		
+		# Resize the progress indicator to the given total.
+		#
+		# @parameter total [Numeric] The new total number of steps.
+		# @returns [Progress] The progress indicator itself.
 		def resize(total)
 			@total = total
 			
 			Console.call(@subject, self.to_s, event: self.to_hash, **@options)
-			@last_output_time = Progress.now
+			@last_output_time = Clock.now
 			
 			return self
 		end
 		
-		def mark(*arguments, **options)
-			Console.call(@subject, *arguments, **options, **@options)
+		# Augment the progress indicator with additional information.
+		#
+		# @parameter *arguments [Array] The arguments to log.
+		# @parameter **options [Hash] Additional options to log.
+		# @parameter &block [Proc] An optional block used to generate the log message.
+		def mark(*arguments, **options, &block)
+			Console.call(@subject, *arguments, **options, **@options, &block)
 		end
 		
+		# @returns [String] A human-readable representation of the progress indicator.
 		def to_s
 			if estimated_remaining_time = self.estimated_remaining_time
 				"#{@current}/#{@total} completed in #{Clock.formatted_duration(self.duration)}, #{Clock.formatted_duration(estimated_remaining_time)} remaining."
@@ -98,12 +139,18 @@ module Console
 		
 		private
 		
+		# Compute a time delta since the last output, used for rate limiting the output.
+		#
+		# @returns [Numeric | Nil] The duration since the last output.
 		def duration_since_last_output
 			if @last_output_time
-				Progress.now - @last_output_time
+				Clock.now - @last_output_time
 			end
 		end
 		
+		# Whether an output should be generated at this time, taking into account the remaining steps, and the duration since the last output.
+		#
+		# @returns [Boolean] Whether an output should be generated.
 		def output?
 			if remaining.zero?
 				return true

data/lib/console/resolver.rb

@@ -7,6 +7,7 @@
 require_relative "filter"
 
 module Console
+	# Represents a class resolver that can be used to set log levels for different classes as they become available.
 	class Resolver
 		# You can change the log level for different classes using CONSOLE_$LEVEL env vars.
 		#
@@ -16,7 +17,6 @@ module Console
 		#
 		# @parameter logger [Logger] A logger instance to set the logging levels on.
 		# @parameter env [Hash] The environment to read levels from.
-		#
 		# @returns [Nil] If there were no custom logging levels specified in the environment.
 		# @returns [Resolver] If there were custom logging levels, then the created resolver is returned.
 		def self.default_resolver(logger, env = ENV)
@@ -59,12 +59,21 @@ module Console
 			return resolver
 		end
 		
+		# Create a new class resolver.
 		def initialize
 			@names = {}
 			
 			@trace_point = TracePoint.new(:class, &self.method(:resolve))
 		end
 		
+		# Bind the given class names to the given block. When the class name is resolved into an actual class, the block will be called with the class as an argument.
+		#
+		# If the class is already defined, the block will be called immediately.
+		#
+		# If the class is not defined, the block will be called when the class is defined, using a trace point.
+		#
+		# @parameter names [Array(String)] The class names to bind.
+		# @parameter block [Proc] The block to call when the class is resolved.
 		def bind(names, &block)
 			names.each do |name|
 				if klass = Object.const_get(name) rescue nil
@@ -81,10 +90,18 @@ module Console
 			end
 		end
 		
+		# @returns [Boolean] True if the resolver is waiting for classes to be defined.
 		def waiting?
 			@trace_point.enabled?
 		end
 		
+		# Invoked by the trace point when a class is defined.
+		#
+		# This will call the block associated with the class name, if any, and remove it from the list of names to resolve.
+		#
+		# If the list of names is empty, the trace point will be disabled.
+		#
+		# @parameter trace_point [TracePoint] The trace point that triggered the event.
 		def resolve(trace_point)
 			if block = @names.delete(trace_point.self.to_s)
 				block.call(trace_point.self)

data/lib/console/terminal/formatter/failure.rb

@@ -6,9 +6,14 @@
 module Console
 	module Terminal
 		module Formatter
+			# Format a failure event, including the exception message and backtrace.
 			class Failure
+				# The key used to identify this formatter.
 				KEY = :failure
 				
+				# Create a new failure formatter.
+				#
+				# @param terminal [Terminal::Text] The terminal to use for formatting.
 				def initialize(terminal)
 					@terminal = terminal
 					
@@ -19,7 +24,14 @@ module Console
 					@terminal[:exception_message] ||= @terminal.style(:default)
 				end
 				
-				def format(event, output, prefix: nil, verbose: false, width: 80)
+				# Format the given event.
+				#
+				# @parameter event [Hash] The event to format.
+				# @parameter stream [IO] The stream to write the formatted event to.
+				# @parameter prefix [String] The prefix to use before the title.
+				# @parameter verbose [Boolean] Whether to include additional information.
+				# @parameter options [Hash] Additional options.
+				def format(event, stream, prefix: nil, verbose: false, **options)
 					title = event[:class]
 					message = event[:message]
 					backtrace = event[:backtrace]
@@ -27,10 +39,10 @@ module Console
 					
 					lines = message.lines.map(&:chomp)
 					
-					output.puts "  #{prefix}#{@terminal[:exception_title]}#{title}#{@terminal.reset}: #{lines.shift}"
+					stream.puts "  #{prefix}#{@terminal[:exception_title]}#{title}#{@terminal.reset}: #{lines.shift}"
 					
 					lines.each do |line|
-						output.puts "  #{@terminal[:exception_detail]}#{line}#{@terminal.reset}"
+						stream.puts "  #{@terminal[:exception_detail]}#{line}#{@terminal.reset}"
 					end
 					
 					root_pattern = /^#{root}\// if root
@@ -44,11 +56,11 @@ module Console
 							style = :exception_backtrace_other
 						end
 						
-						output.puts "  #{index == 0 ? "→" : " "} #{@terminal[style]}#{path}:#{offset}#{@terminal[:exception_message]} #{message}#{@terminal.reset}"
+						stream.puts "  #{index == 0 ? "→" : " "} #{@terminal[style]}#{path}:#{offset}#{@terminal[:exception_message]} #{message}#{@terminal.reset}"
 					end
 					
 					if cause = event[:cause]
-						format(cause, output, prefix: "Caused by ", verbose: verbose, width: width)
+						format(cause, stream, prefix: "Caused by ", verbose: verbose, **options)
 					end
 				end
 			end

data/lib/console/terminal/formatter/progress.rb

@@ -6,9 +6,12 @@
 module Console
 	module Terminal
 		module Formatter
+			# Format a progress event, including the current progress and total.
 			class Progress
+				# The key used to identify this formatter.
 				KEY = :progress
 				
+				# The block characters used to render the progress bar.
 				BLOCK = [
 					" ",
 					"▏",
@@ -21,12 +24,21 @@ module Console
 					"█",
 				]
 				
+				# Create a new progress formatter.
+				#
+				# @param terminal [Terminal::Text] The terminal to use for formatting.
 				def initialize(terminal)
 					@terminal = terminal
 					@terminal[:progress_bar] ||= terminal.style(:blue, :white)
 				end
 				
-				def format(event, output, verbose: false, width: 80)
+				# Format the given event.
+				#
+				# @parameter event [Hash] The event to format.
+				# @parameter stream [IO] The stream to write the formatted event to.
+				# @parameter verbose [Boolean] Whether to include additional information.
+				# @parameter width [Integer] The width of the progress bar.
+				def format(event, stream, verbose: false, width: 80)
 					current = event[:current].to_f
 					total = event[:total].to_f
 					value = current / total
@@ -36,11 +48,12 @@ module Console
 						value = 1.0
 					end
 					
-					output.puts "#{@terminal[:progress_bar]}#{self.bar(value, width-10)}#{@terminal.reset} #{sprintf('%6.2f', value * 100)}%"
+					stream.puts "#{@terminal[:progress_bar]}#{self.bar(value, width-10)}#{@terminal.reset} #{sprintf('%6.2f', value * 100)}%"
 				end
 				
 				private
 				
+				# Render a progress bar with the given value and width.
 				def bar(value, width)
 					blocks = width * value
 					full_blocks = blocks.floor

data/lib/console/terminal/formatter/spawn.rb

@@ -6,31 +6,42 @@
 module Console
 	module Terminal
 		module Formatter
-			# Format spawn events.
+			# Format a spawn event, including the command and arguments.
 			class Spawn
+				# The key used to identify this formatter.
 				KEY = :spawn
 				
+				# Create a new spawn formatter.
+				#
+				# @param terminal [Terminal::Text] The terminal to use for formatting.
 				def initialize(terminal)
 					@terminal = terminal
 					@terminal[:spawn_command] ||= @terminal.style(:blue, nil, :bold)
 				end
 				
-				def format(event, output, verbose: false, width: 80)
+				# Format the given event.
+				#
+				# @parameter event [Hash] The event to format.
+				# @parameter stream [IO] The stream to write the formatted event to.
+				# @parameter verbose [Boolean] Whether to include additional information.
+				# @parameter width [Integer] The width of the progress bar.
+				def format(event, stream, verbose: false, width: 80)
 					environment, arguments, options = event.values_at(:environment, :arguments, :options)
 					
 					arguments = arguments.flatten.collect(&:to_s)
 					
-					output.puts "#{@terminal[:spawn_command]}#{arguments.join(' ')}#{@terminal.reset}#{chdir_string(options)}"
+					stream.puts "#{@terminal[:spawn_command]}#{arguments.join(' ')}#{@terminal.reset}#{chdir_string(options)}"
 					
 					if verbose and environment
 						environment.each do |key, value|
-							output.puts "export #{key}=#{value}"
+							stream.puts "export #{key}=#{value}"
 						end
 					end
 				end
 				
 				private
 				
+				# Generate a string to represent the working directory.
 				def chdir_string(options)
 					if options and chdir = options[:chdir]
 						" in #{chdir}"

data/lib/console/terminal/formatter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "formatter/progress"
+require_relative "formatter/failure"
+require_relative "formatter/spawn"
+
+module Console
+	module Terminal
+		# Formatters for various types of events.
+		module Formatter
+		end
+	end
+end