console 1.19.0 → 1.29.0

data/lib/console/progress.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2022, by Anton Sozontov.
 
-require_relative 'event/progress'
-require_relative 'clock'
+require_relative "clock"
 
 module Console
 	class Progress
@@ -12,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
 			
@@ -53,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
 			
@@ -67,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/resolver.rb

@@ -1,10 +1,10 @@
 # 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 'filter'
+require_relative "filter"
 
 module Console
 	class Resolver
@@ -22,12 +22,12 @@ module Console
 		def self.default_resolver(logger, env = ENV)
 			# Find all CONSOLE_$LEVEL variables from environment:
 			levels = logger.class::LEVELS
-				.map{|label, level| [level, env["CONSOLE_#{label.upcase}"]&.split(',')]}
+				.map{|label, level| [level, env["CONSOLE_#{label.upcase}"]&.split(",")]}
 				.to_h
 				.compact
 			
-			off_klasses = env['CONSOLE_OFF']&.split(',')
-			on_klasses = env['CONSOLE_ON']&.split(',')
+			off_klasses = env["CONSOLE_OFF"]&.split(",")
+			on_klasses = env["CONSOLE_ON"]&.split(",")
 			
 			resolver = nil
 			

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, 2020-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,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
-require 'io/console'
+require "io/console"
 
 module Console
 	# Styled terminal output.
@@ -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,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
-require 'io/console'
+require "io/console"
 
-require_relative 'text'
+require_relative "text"
 
 module Console
 	# Styled terminal output.
@@ -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-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 module Console
-	VERSION = "1.19.0"
+	VERSION = "1.29.0"
 end

data/lib/console/warn.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# 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
+		# Redirect warnings to {Console.warn}.
+		def warn(message, **options)
+			fiber = Fiber.current
+			
+			# We do this to be extra pendantic about avoiding infinite recursion.
+			return super if fiber.console_warn
+			
+			begin
+				fiber.console_warn = true
+				message.chomp!
+				
+				Console::Logger.instance.warn(message, **options)
+			ensure
+				fiber.console_warn = false
+			end
+		end
+	end
+	
+	::Warning.extend(Warn)
+end

data/lib/console.rb

@@ -1,32 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, 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.
 
-require_relative 'console/version'
-require_relative 'console/logger'
+require_relative "console/version"
+require_relative "console/interface"
 
 module Console
-	def self.logger
-		Logger.instance
-	end
-	
-	def self.logger= instance
-		Logger.instance= instance
-	end
-	
-	def logger= logger
-		@logger = logger
-	end
-	
-	def logger
-		@logger || Logger.instance
-	end
-	
-	def self.extended(klass)
-		klass.instance_variable_set(:@logger, nil)
-	end
+	Console.extend(Interface)
 end

data/license.md

@@ -1,12 +1,16 @@
 # MIT License
 
-Copyright, 2019-2022, by Samuel Williams.  
+Copyright, 2019-2024, by Samuel Williams.  
 Copyright, 2019-2021, by Bryan Powell.  
 Copyright, 2019, by Cyril Roelandt.  
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2020, by Michael Adams.  
 Copyright, 2021, by Cédric Boutillier.  
 Copyright, 2021, by Robert Schulze.  
+Copyright, 2022, by Anton Sozontov.  
+Copyright, 2022, by William T. Nelson.  
+Copyright, 2023, by Felix Yan.  
+Copyright, 2024, by Patrik Wenger.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -6,7 +6,7 @@ Provides beautiful console logging for Ruby applications. Implements fast, buffe
 
 ## Motivation
 
-When Ruby decided to reverse the order of exception backtraces, I finally gave up using the built in logging and decided restore sanity to the output of my programs once and for all!
+When Ruby decided to reverse the order of exception backtraces, I finally gave up using the built in logging and decided restore sanity to the output of my programs once and for all\!
 
 ## Features
 
@@ -18,7 +18,29 @@ When Ruby decided to reverse the order of exception backtraces, I finally gave u
 
 ## Usage
 
-Please see the [project documentation](https://socketry.github.io/console).
+Please see the [project documentation](https://socketry.github.io/console/) for more details.
+
+  - [Getting Started](https://socketry.github.io/console/guides/getting-started/index) - This guide explains how to use `console` for logging.
+
+  - [Command Line](https://socketry.github.io/console/guides/command-line/index) - This guide explains how the `console` gem can be controlled using environment variables.
+
+  - [Integration](https://socketry.github.io/console/guides/integration/index) - This guide explains how to integrate the `console` output into different systems.
+
+  - [Events](https://socketry.github.io/console/guides/events/index) - This guide explains how to log structured events with a well-defined schema.
+
+## Releases
+
+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`.
 
 ## Contributing
 
@@ -29,3 +51,18 @@ We welcome contributions to this project.
 3.  Commit your changes (`git commit -am 'Add some feature'`).
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.
+
+## See Also
+
+  - [console-adapter-rails](https://github.com/socketry/console-adapter-rails)
+  - [console-adapter-sidekiq](https://github.com/socketry/console-adapter-sidekiq)
+  - [console-output-datadog](https://github.com/socketry/console-output-datadog)
+  - [sus-fixtures-console](https://github.com/sus-rb/sus-fixtures-console)

data/releases.md

@@ -0,0 +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`.