console 1.24.0 → 1.25.0

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

@@ -1,53 +1,61 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Robert Schulze.
 
-require_relative '../buffer'
-require_relative '../event'
 require_relative '../clock'
-
-require_relative 'text'
-require_relative 'xterm'
+require_relative '../terminal'
 
 require 'json'
 require 'fiber'
 require 'fiber/annotation'
+require 'stringio'
 
 module Console
-	module Terminal
-		# This, and all related methods, is considered private.
-		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]
-				start_at = Time.parse(time_string) rescue nil
+	module Output
+		class Terminal
+			class Buffer < StringIO
+				def initialize(prefix = nil)
+					@prefix = prefix
+					
+					super()
+				end
+				
+				attr :prefix
+				
+				def puts(*args, prefix: @prefix)
+					args.each do |arg|
+						self.write(prefix) if prefix
+						super(arg)
+					end
+				end
+				
+				alias << puts
 			end
 			
-			unless start_at
-				start_at = Time.now
-				environment[CONSOLE_START_AT] = start_at.to_s
-			end
+			# This, and all related methods, is considered private.
+			CONSOLE_START_AT = 'CONSOLE_START_AT'
 			
-			return start_at
-		end
-		
-		def self.for(io)
-			if io.isatty
-				XTerm.new(io)
-			else
-				Text.new(io)
+			# 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]
+					start_at = Time.parse(time_string) rescue nil
+				end
+				
+				unless start_at
+					start_at = Time.now
+					environment[CONSOLE_START_AT] = start_at.to_s
+				end
+				
+				return start_at
 			end
-		end
-		
-		class Logger
-			def initialize(io = $stderr, verbose: nil, start_at: Terminal.start_at!, format: nil, **options)
-				@io = io
+			
+			def initialize(output, verbose: nil, start_at: Terminal.start_at!, format: nil, **options)
+				@io = output
 				@start_at = start_at
 				
-				@terminal = format.nil? ? Terminal.for(io) : format.new(io)
+				@terminal = format.nil? ? Console::Terminal.for(@io) : format.new(@io)
 				
 				if verbose.nil?
 					@verbose = !@terminal.colors?
@@ -66,7 +74,8 @@ module Console
 				@terminal[:annotation] = @terminal.reset
 				@terminal[:value] = @terminal.style(:blue)
 				
-				self.register_defaults(@terminal)
+				@formatters = {}
+				self.register_formatters
 			end
 			
 			attr :io
@@ -80,20 +89,23 @@ module Console
 				@verbose = value
 			end
 			
-			def register_defaults(terminal)
-				Event.constants.each do |constant|
-					klass = Event.const_get(constant)
-					klass.register(terminal)
+			def register_formatters(namespace = Console::Terminal::Formatter)
+				namespace.constants.each do |name|
+					formatter = namespace.const_get(name)
+					@formatters[formatter::KEY] = formatter.new(@terminal)
 				end
 			end
 			
 			UNKNOWN = :unknown
 			
-			def call(subject = nil, *arguments, name: nil, severity: UNKNOWN, **options, &block)
+			def call(subject = nil, *arguments, name: nil, severity: UNKNOWN, event: nil, **options, &block)
+				width = @terminal.width
+				
 				prefix = build_prefix(name || severity.to_s)
 				indent = " " * prefix.size
 				
 				buffer = Buffer.new("#{indent}| ")
+				indent_size = buffer.prefix.size
 				
 				format_subject(severity, prefix, subject, buffer)
 				
@@ -109,6 +121,10 @@ module Console
 					end
 				end
 				
+				if event
+					format_event(event, buffer, width - indent_size)
+				end
+				
 				if options&.any?
 					format_options(options, buffer)
 				end
@@ -118,20 +134,24 @@ module Console
 			
 			protected
 			
+			def format_event(event, buffer, width)
+				event = event.to_hash
+				type = event[:type]
+				
+				if formatter = @formatters[type]
+					formatter.format(event, buffer, verbose: @verbose, width: width)
+				else
+					format_value(::JSON.pretty_generate(event), buffer)
+				end
+			end
+			
 			def format_options(options, output)
 				format_value(::JSON.pretty_generate(options), output)
 			end
 			
 			def format_argument(argument, output)
-				case argument
-				when Exception
-					Event::Failure.for(argument).format(output, @terminal, @verbose)
-				when Event::Generic
-					argument.format(output, @terminal, @verbose)
-				else
-					argument.to_s.each_line do |line|
-						output.puts line
-					end
+				argument.to_s.each_line do |line|
+					output.puts line
 				end
 			end
 			
@@ -216,5 +236,17 @@ module Console
 				end
 			end
 		end
+		
+		module Text
+			def self.new(output, **options)
+				Terminal.new(output, format: Console::Terminal::Text, **options)
+			end
+		end
+		
+		module XTerm
+			def self.new(output, **options)
+				Terminal.new(output, format: Console::Terminal::XTerm, **options)
+			end
+		end
 	end
 end

data/lib/console/output/wrapper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+module Console
+	module Output
+		class Wrapper
+			def initialize(delegate, **options)
+				@delegate = delegate
+			end
+			
+			def verbose!(value = true)
+				@delegate.verbose!(value)
+			end
+			
+			def call(...)
+				@delegate.call(...)
+			end
+		end
+	end
+end

data/lib/console/output.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative 'output/default'
-require_relative 'output/json'
-require_relative 'output/text'
-require_relative 'output/xterm'
+require_relative 'output/serialized'
+require_relative 'output/terminal'
 require_relative 'output/null'
 
 module Console

data/lib/console/progress.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 # Copyright, 2022, by Anton Sozontov.
 
-require_relative 'event/progress'
 require_relative 'clock'
 
 module Console
@@ -13,9 +12,9 @@ module Console
 			Process.clock_gettime(Process::CLOCK_MONOTONIC)
 		end
 		
-		def initialize(output, subject, total = 0, minimum_output_duration: 0.1)
-			@output = output
+		def initialize(subject, total = 0, minimum_output_duration: 0.1, **options)
 			@subject = subject
+			@options = options
 			
 			@start_time = Progress.now
 			
@@ -54,11 +53,22 @@ module Console
 			end
 		end
 		
+		def to_hash
+			Hash.new.tap do |hash|
+				hash[:type] = :progress
+				hash[:current] = @current
+				hash[:total] = @total
+				
+				hash[:duration] = self.duration
+				hash[:estimated_remaining_time] = self.estimated_remaining_time
+			end
+		end
+		
 		def increment(amount = 1)
 			@current += amount
 			
 			if output?
-				@output.info(@subject, self) {Event::Progress.new(@current, @total)}
+				Console.call(@subject, self.to_s, event: self.to_hash, **@options)
 				@last_output_time = Progress.now
 			end
 			
@@ -68,14 +78,14 @@ module Console
 		def resize(total)
 			@total = total
 			
-			@output.info(@subject, self) {Event::Progress.new(@current, @total)}
+			Console.call(@subject, self.to_s, event: self.to_hash, **@options)
 			@last_output_time = Progress.now
 			
 			return self
 		end
 		
-		def mark(...)
-			@output.info(@subject, ...)
+		def mark(*arguments, **options)
+			Console.call(@subject, *arguments, **options, **@options)
 		end
 		
 		def to_s

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Console
+	module Terminal
+		module Formatter
+			class Failure
+				KEY = :failure
+				
+				def initialize(terminal)
+					@terminal = 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)
+				end
+				
+				def format(event, output, prefix: nil, verbose: false, width: 80)
+					title = event[:class]
+					message = event[:message]
+					backtrace = event[:backtrace]
+					root = event[:root]
+					
+					lines = message.lines.map(&:chomp)
+					
+					output.puts "  #{prefix}#{@terminal[:exception_title]}#{title}#{@terminal.reset}: #{lines.shift}"
+					
+					lines.each do |line|
+						output.puts "  #{@terminal[:exception_detail]}#{line}#{@terminal.reset}"
+					end
+					
+					root_pattern = /^#{root}\// if root
+					
+					backtrace&.each_with_index do |line, index|
+						path, offset, message = line.split(":", 3)
+						style = :exception_backtrace
+						
+						# Make the path a bit more readable:
+						if root_pattern and path.sub!(root_pattern, "").nil?
+							style = :exception_backtrace_other
+						end
+						
+						output.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)
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Console
+	module Terminal
+		module Formatter
+			class Progress
+				KEY = :progress
+				
+				BLOCK = [
+					" ",
+					"▏",
+					"▎",
+					"▍",
+					"▌",
+					"▋",
+					"▊",
+					"▉",
+					"█",
+				]
+				
+				def initialize(terminal)
+					@terminal = terminal
+					@terminal[:progress_bar] ||= terminal.style(:blue, :white)
+				end
+				
+				def format(event, output, verbose: false, width: 80)
+					current = event[:current].to_f
+					total = event[:total].to_f
+					value = current / total
+					
+					# Clamp value to 1.0 to avoid rendering issues:
+					if value > 1.0
+						value = 1.0
+					end
+					
+					output.puts "#{@terminal[:progress_bar]}#{self.bar(value, width-10)}#{@terminal.reset} #{sprintf('%6.2f', value * 100)}%"
+				end
+				
+				private
+				
+				def bar(value, width)
+					blocks = width * value
+					full_blocks = blocks.floor
+					partial_block = ((blocks - full_blocks) * BLOCK.size).floor
+					
+					if partial_block.zero?
+						BLOCK.last * full_blocks
+					else
+						"#{BLOCK.last * full_blocks}#{BLOCK[partial_block]}"
+					end.ljust(width)
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
+
+module Console
+	module Terminal
+		module Formatter
+			# Format spawn events.
+			class Spawn
+				KEY = :spawn
+				
+				def initialize(terminal)
+					@terminal = terminal
+					@terminal[:spawn_command] ||= @terminal.style(:blue, nil, :bold)
+				end
+				
+				def format(event, output, 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)}"
+					
+					if verbose and environment
+						environment.each do |key, value|
+							output.puts "export #{key}=#{value}"
+						end
+					end
+				end
+				
+				private
+				
+				def chdir_string(options)
+					if options and chdir = options[:chdir]
+						" in #{chdir}"
+					end
+				end
+			end
+		end
+	end
+end

data/lib/console/terminal/text.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require 'io/console'
 
@@ -26,6 +26,10 @@ module Console
 				false
 			end
 			
+			def width
+				80
+			end
+			
 			def style(foreground, background = nil, *attributes)
 			end
 			

data/lib/console/terminal/xterm.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 'io/console'
 
@@ -41,6 +41,13 @@ module Console
 			
 			def size
 				@output.winsize
+			rescue Errno::ENOTTY
+				# Fake it...
+				[24, 80]
+			end
+			
+			def width
+				size.last
 			end
 			
 			def style(foreground, background = nil, *attributes)

data/lib/console/terminal.rb

@@ -1,6 +1,23 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'terminal/logger'
+require_relative 'terminal/text'
+require_relative 'terminal/xterm'
+
+require_relative 'terminal/formatter/progress'
+require_relative 'terminal/formatter/failure'
+require_relative 'terminal/formatter/spawn'
+
+module Console
+	module Terminal
+		def self.for(io)
+			if io.tty?
+				XTerm.new(io)
+			else
+				Text.new(io)
+			end
+		end
+	end
+end

data/lib/console/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 module Console
-	VERSION = "1.24.0"
+	VERSION = "1.25.0"
 end

data/lib/console.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.
 # Copyright, 2019, by Bryan Powell.
 # Copyright, 2020, by Michael Adams.
 # Copyright, 2021, by Cédric Boutillier.
@@ -43,12 +43,4 @@ module Console
 			Logger.instance.call(...)
 		end
 	end
-	
-	def logger= logger
-		warn "Setting logger on #{self} is deprecated. Use Console.logger= instead.", uplevel: 1
-	end
-	
-	def logger
-		Logger.instance
-	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -46,7 +46,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiber-annotation
@@ -66,16 +66,16 @@ dependencies:
   name: fiber-local
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -99,14 +99,12 @@ files:
 - bake/console.rb
 - lib/console.rb
 - lib/console/adapter.rb
-- lib/console/buffer.rb
 - lib/console/capture.rb
 - lib/console/clock.rb
 - lib/console/compatible/logger.rb
 - lib/console/event.rb
 - lib/console/event/failure.rb
 - lib/console/event/generic.rb
-- lib/console/event/progress.rb
 - lib/console/event/spawn.rb
 - lib/console/filter.rb
 - lib/console/format.rb
@@ -114,27 +112,28 @@ files:
 - lib/console/logger.rb
 - lib/console/output.rb
 - lib/console/output/default.rb
-- lib/console/output/json.rb
 - lib/console/output/null.rb
 - lib/console/output/sensitive.rb
+- lib/console/output/serialized.rb
 - lib/console/output/split.rb
-- lib/console/output/text.rb
-- lib/console/output/xterm.rb
+- lib/console/output/terminal.rb
+- lib/console/output/wrapper.rb
 - lib/console/progress.rb
 - lib/console/resolver.rb
-- lib/console/serialized/logger.rb
-- lib/console/split.rb
 - lib/console/terminal.rb
-- lib/console/terminal/logger.rb
+- lib/console/terminal/formatter/failure.rb
+- lib/console/terminal/formatter/progress.rb
+- lib/console/terminal/formatter/spawn.rb
 - lib/console/terminal/text.rb
 - lib/console/terminal/xterm.rb
 - lib/console/version.rb
 - license.md
 - readme.md
-homepage: https://socketry.github.io/console/
+homepage: https://socketry.github.io/console
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/console/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -143,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/console/buffer.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
-
-require 'stringio'
-
-module Console
-	class Buffer < StringIO
-		def initialize(prefix = nil)
-			@prefix = prefix
-			
-			super()
-		end
-		
-		def puts(*args, prefix: @prefix)
-			args.each do |arg|
-				self.write(prefix) if prefix
-				super(arg)
-			end
-		end
-		
-		alias << puts
-	end
-end