console 1.26.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea53f121a472d6011335a91ac4a96f4f3630c4524b1158166be906a51e4dd186
-  data.tar.gz: 20cdb45a16606315c9a0e054fb9e3460698e6fcccd190bd7668902f179c7b5fa
+  metadata.gz: cf762e4b31732049aa1f34fcc17bdb2430489efd671c74f435bfa214ef6290a5
+  data.tar.gz: 97ba24a40404eebfd1e2bf6544a673b5131628167ff82e7c933a05322ae5e0bf
 SHA512:
-  metadata.gz: 42748b35f41a887222716d8bd0b9e55f92a5506f31fa7cb0a3e5ac5155341c55d6ca2849745b77d568b7b11e3d79faf0193377b9547fce98c5c16ca1043f9222
-  data.tar.gz: de9535e3fb41fcce945512f9d482329cfc695888c43da753d1f7c392e074e4b4b1e6584fbfd1c39b4851c25f00563b1e0ee3efbd5240294649ff4dc68519483d
+  metadata.gz: d0c1e8fec40b694b8d98f37a4525017e45171160338272c4ca586b58d62575f117e8a36b80226246c43a8476b66d354d56650af70aa96f00489ba8dc8e7e8963
+  data.tar.gz: f2f2197d633d2427c4ac9b29706fe59555bbf16bfce0036470c265c0acc86dab8d52884fc844eb7f041ba29c7c330f9d341cbd813859fe4297f59decb56716d7

data/bake/console.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 # Increase the verbosity of the logger to info.
 def info
-	require_relative '../lib/console'
+	require_relative "../lib/console"
 	
 	Console.logger.info!
 end
 
 # Increase the verbosity of the logger to debug.
 def debug
-	require_relative '../lib/console'
+	require_relative "../lib/console"
 	
 	Console.logger.debug!
 end

data/lib/console/capture.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'filter'
+require_relative "filter"
 
 module Console
 	# A general sink which captures all events into a buffer.

data/lib/console/compatible/logger.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require 'logger'
+require "logger"
 
 module Console
 	module Compatible

data/lib/console/event/failure.rb

@@ -3,8 +3,9 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Robert Schulze.
+# Copyright, 2024, by Patrik Wenger.
 
-require_relative 'generic'
+require_relative "generic"
 
 module Console
 	module Event
@@ -27,7 +28,9 @@ module Console
 			def self.log(subject, exception, **options)
 				Console.error(subject, **self.for(exception).to_hash, **options)
 			end
-			
+
+			attr_reader :exception
+
 			def initialize(exception, root = Dir.getwd)
 				@exception = exception
 				@root = root
@@ -56,7 +59,7 @@ module Console
 					message = exception.detailed_message
 					
 					# We want to remove the trailling exception class as we format it differently:
-					message.sub!(/\s*\(.*?\)$/, '')
+					message.sub!(/\s*\(.*?\)$/, "")
 					
 					hash[:message] = message
 				else

data/lib/console/event/spawn.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'generic'
-require_relative '../clock'
+require_relative "generic"
+require_relative "../clock"
 
 module Console
 	module Event

data/lib/console/event.rb

@@ -3,5 +3,5 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'event/spawn'
-require_relative 'event/failure'
+require_relative "event/spawn"
+require_relative "event/failure"

data/lib/console/filter.rb

@@ -10,7 +10,7 @@ module Console
 	UNKNOWN = :unknown
 	
 	class Filter
-		if Object.const_defined?(:Ractor) and RUBY_VERSION >= '3.1'
+		if Object.const_defined?(:Ractor) and RUBY_VERSION >= "3.1"
 			def self.define_immutable_method(name, &block)
 				block = Ractor.make_shareable(block)
 				self.define_method(name, &block)

data/lib/console/format/safe.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
-require 'json'
+require "json"
 
 module Console
 	module Format

data/lib/console/format.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Samuel Williams.
 
-require_relative 'format/safe'
+require_relative "format/safe"
 
 module Console
 	module Format

data/lib/console/logger.rb

@@ -5,13 +5,13 @@
 # Copyright, 2021, by Bryan Powell.
 # Copyright, 2021, by Robert Schulze.
 
-require_relative 'output'
-require_relative 'filter'
-require_relative 'event'
-require_relative 'resolver'
-require_relative 'progress'
+require_relative "output"
+require_relative "filter"
+require_relative "event"
+require_relative "resolver"
+require_relative "progress"
 
-require 'fiber/local'
+require "fiber/local"
 
 module Console
 	class Logger < Filter[debug: 0, info: 1, warn: 2, error: 3, fatal: 4]
@@ -21,7 +21,7 @@ module Console
 		# You can also specify CONSOLE_LEVEL=debug or CONSOLE_LEVEL=info in environment.
 		# https://mislav.net/2011/06/ruby-verbose-mode/ has more details about how it all fits together.
 		def self.default_log_level(env = ENV)
-			if level = env['CONSOLE_LEVEL']
+			if level = env["CONSOLE_LEVEL"]
 				LEVELS[level.to_sym] || level.to_i
 			elsif $DEBUG
 				DEBUG
@@ -34,7 +34,7 @@ module Console
 		
 		# Controls verbose output using `$VERBOSE`.
 		def self.verbose?(env = ENV)
-			!$VERBOSE.nil? || env['CONSOLE_VERBOSE']
+			!$VERBOSE.nil? || env["CONSOLE_VERBOSE"]
 		end
 		
 		def self.default_logger(output = $stderr, env = ENV, **options)

data/lib/console/output/default.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'terminal'
-require_relative 'serialized'
+require_relative "terminal"
+require_relative "serialized"
 
 module Console
 	module Output

data/lib/console/output/sensitive.rb

@@ -3,13 +3,13 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'wrapper'
+require_relative "wrapper"
 
 module Console
 	module Output
 		class Sensitive < Wrapper
 			REDACT = /
-				  phone
+				phone
 				| email
 				| full_?name
 				| first_?name

data/lib/console/output/serialized.rb

@@ -3,9 +3,9 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative '../format'
-require 'time'
-require 'fiber/annotation'
+require_relative "../format"
+require "time"
+require "fiber/annotation"
 
 module Console
 	module Output

data/lib/console/output/terminal.rb

@@ -4,13 +4,13 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Robert Schulze.
 
-require_relative '../clock'
-require_relative '../terminal'
+require_relative "../clock"
+require_relative "../terminal"
 
-require 'json'
-require 'fiber'
-require 'fiber/annotation'
-require 'stringio'
+require "json"
+require "fiber"
+require "fiber/annotation"
+require "stringio"
 
 module Console
 	module Output
@@ -35,7 +35,7 @@ module Console
 			end
 			
 			# This, and all related methods, is considered private.
-			CONSOLE_START_AT = 'CONSOLE_START_AT'
+			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)

data/lib/console/output.rb

@@ -3,16 +3,16 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'output/default'
-require_relative 'output/serialized'
-require_relative 'output/terminal'
-require_relative 'output/null'
+require_relative "output/default"
+require_relative "output/serialized"
+require_relative "output/terminal"
+require_relative "output/null"
 
 module Console
 	module Output
 		def self.new(output = nil, env = ENV, **options)
-			if names = env['CONSOLE_OUTPUT']
-				names = names.split(',').reverse
+			if names = env["CONSOLE_OUTPUT"]
+				names = names.split(",").reverse
 				
 				names.inject(output) do |output, name|
 					Output.const_get(name).new(output, **options)

data/lib/console/progress.rb

@@ -4,7 +4,7 @@
 # Copyright, 2020-2024, by Samuel Williams.
 # Copyright, 2022, by Anton Sozontov.
 
-require_relative 'clock'
+require_relative "clock"
 
 module Console
 	class Progress

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/progress.rb

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

data/lib/console/terminal/text.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require 'io/console'
+require "io/console"
 
 module Console
 	# Styled terminal output.

data/lib/console/terminal/xterm.rb

@@ -3,9 +3,9 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require 'io/console'
+require "io/console"
 
-require_relative 'text'
+require_relative "text"
 
 module Console
 	# Styled terminal output.

data/lib/console/terminal.rb

@@ -3,12 +3,12 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'terminal/text'
-require_relative 'terminal/xterm'
+require_relative "terminal/text"
+require_relative "terminal/xterm"
 
-require_relative 'terminal/formatter/progress'
-require_relative 'terminal/formatter/failure'
-require_relative 'terminal/formatter/spawn'
+require_relative "terminal/formatter/progress"
+require_relative "terminal/formatter/failure"
+require_relative "terminal/formatter/spawn"
 
 module Console
 	module Terminal

data/lib/console/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2019-2024, by Samuel Williams.
 
 module Console
-	VERSION = "1.26.0"
+	VERSION = "1.28.0"
 end

data/lib/console/warn.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Console
+	# Whether the current fiber is emitting a warning.
+	Fiber.attr_accessor :console_warn
+	
+	module Warn
+		def warn(*arguments, uplevel: nil, **options)
+			fiber = Fiber.current
+			
+			# We do this to be extra pendantic about avoiding infinite recursion, i.e. if `Console.warn` some how calls `Kernel.warn` again, it would potentially cause infinite recursion. I'm not sure if this is a problem in practice, but I'd rather not find out the hard way...
+			return super if fiber.console_warn
+			
+			if uplevel
+				options[:backtrace] = caller(uplevel, 1)
+			end
+			
+			begin
+				fiber.console_warn = true
+				Console.warn(*arguments, **options)
+			ensure
+				fiber.console_warn = false
+			end
+		end
+	end
+	
+	::Kernel.prepend(Warn)
+end

data/lib/console.rb

@@ -6,8 +6,9 @@
 # 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/logger"
+require_relative "console/warn"
 
 module Console
 	class << self

data/license.md

@@ -10,6 +10,7 @@ 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

@@ -26,6 +26,8 @@ Please see the [project documentation](https://socketry.github.io/console/) for
 
   - [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.
+
 ## Contributing
 
 We welcome contributions to this project.
@@ -38,14 +40,15 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+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.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+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,5 @@
+# Releases
+
+## v1.28.0
+
+  - Add support for `Kernel#warn` redirection to `Console.warn`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -13,6 +13,7 @@ authors:
 - Cédric Boutillier
 - Felix Yan
 - Olle Jonsson
+- Patrik Wenger
 - William T. Nelson
 autorequire:
 bindir: bin
@@ -46,7 +47,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-07-17 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiber-annotation
@@ -127,8 +128,10 @@ files:
 - lib/console/terminal/text.rb
 - lib/console/terminal/xterm.rb
 - lib/console/version.rb
+- lib/console/warn.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://socketry.github.io/console
 licenses:
 - MIT