console 1.30.2 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a3a941ea83d20a38ee9478245b0a7c7a0845b7aac0cc64311f081bef9fbc809
-  data.tar.gz: d2619ea91b4599616c5129c1880468e5d28250fc4756445b778a65b114a27b6d
+  metadata.gz: 51db72e147d6bbe3aa01e48b78ebc454cb34a719be4f936b58542c5623fb803d
+  data.tar.gz: 4ca2801323f3ee8149e6d967d1fe8920aff5958db3a6b37980251fde3e51fc61
 SHA512:
-  metadata.gz: dc3f9bee5ec9205e1a144606188da0629688a53ec59a82d5ed90987f78dffdb833d2ccee63cbf091c8e4c06d3d1ea535b1ebfc6c35314a624d7f01232704fbce
-  data.tar.gz: 0e65d355fceba6fc1ae152d5aa0a71e314fc21c5d558c9e23ee211fd3f62c764b9060d2d7f0b1fc90b3856a41a2f2d211b3531e90aa9e91d49df27cdbdc7ad9c
+  metadata.gz: 42b590f516d239a57d796b5ac8a8c3f3a40da40bc3430e0a797940ffa3f2bbaa47be07c3943ce9df1a94121ea70288c41615f7b71d166094e43bde91681ac1c4
+  data.tar.gz: 17fa1288f63cdb231f5c1c91e10098550b3418d6d2c1743939a15d5380d7fc68c7a95997327b417a28686bb0b9784196ce832615b2cd1d98bedf65cb29360c57

data/lib/console/capture.rb

@@ -18,9 +18,10 @@ module Console
 		# @attribute [Array(Hash)] All records captured by this buffer.
 		attr :records
 		
-		# @deprecated Use {#records} instead of {#buffer}.
+		# @deprecated Use {records} instead of {buffer}.
 		alias buffer records
 		
+		# @deprecated Use {records} instead of {to_a}.
 		alias to_a records
 		
 		# @attribute [Boolean] If true, the buffer will capture verbose messages.

data/lib/console/config.rb

@@ -30,12 +30,15 @@ module Console
 		# Load the default configuration.
 		# @returns [Config] The default configuration.
 		def self.default
-			@default ||= self.load(PATH)
+			@default ||= self.load(PATH).freeze
 		end
 		
 		# Set the default log level based on `$DEBUG` and `$VERBOSE`.
 		# 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.
+		#
+		# @parameter env [Hash] The environment to read the log level from.
+		# @returns [Integer | Symbol] The default log level.
 		def log_level(env = ENV)
 			Logger.default_log_level(env)
 		end

data/lib/console/event/generic.rb

@@ -7,6 +7,13 @@ module Console
 	module Event
 		# A generic event which can be used to represent structured data.
 		class Generic
+			# Convert the event to a hash suitable for JSON serialization.
+			#
+			# @returns [Hash] The hash representation of the event.
+			def to_hash
+				{}
+			end
+			
 			# Convert the event to a hash suitable for JSON serialization.
 			#
 			# @returns [Hash] The hash representation of the event.

data/lib/console/filter.rb

@@ -11,7 +11,7 @@ module Console
 	
 	# A log filter which can be used to filter log messages based on severity, subject, and other criteria.
 	class Filter
-		if Object.const_defined?(:Ractor) and RUBY_VERSION >= "3.1"
+		if Object.const_defined?(:Ractor) and RUBY_VERSION >= "3.4"
 			# Define a method which can be shared between ractors.
 			def self.define_immutable_method(name, &block)
 				block = Ractor.make_shareable(block)
@@ -70,10 +70,16 @@ module Console
 		# @parameter verbose [Boolean] Enable verbose output.
 		# @parameter level [Integer] The log level.
 		# @parameter options [Hash] Additional options.
-		def initialize(output, verbose: true, level: self.class::DEFAULT_LEVEL, **options)
+		def initialize(output, verbose: true, level: nil, **options)
 			@output = output
 			@verbose = verbose
-			@level = level
+			
+			# Set the log level using the behaviour implemented in `level=`:
+			if level
+				self.level = level
+			else
+				@level = self.class::DEFAULT_LEVEL
+			end
 			
 			@subjects = {}
 			
@@ -156,7 +162,7 @@ module Console
 		#
 		# You can enable and disable logging for classes. This function checks if logging for a given subject is enabled.
 		#
-		# @parameter subject [Module] The subject to check.
+		# @parameter subject [Module | Object] The subject to check.
 		# @parameter level [Integer] The log level.
 		# @returns [Boolean] Whether logging is enabled.
 		def enabled?(subject, level = self.class::MINIMUM_LEVEL)

data/lib/console/output/default.rb

@@ -14,12 +14,13 @@ module Console
 			# Create a new output format based on the given stream.
 			#
 			# @parameter io [IO] The output stream.
+			# @parameter env [Hash] Environment variables (defaults to ENV for testing).
 			# @parameter options [Hash] Additional options to customize the output.
 			# @returns [Console::Output::Terminal | Console::Output::Serialized] The output instance, depending on whether the `io` is a terminal or not.
-			def self.new(stream, **options)
+			def self.new(stream, env: ENV, **options)
 				stream ||= $stderr
 				
-				if stream.tty?
+				if stream.tty? || mail?(env)
 					output = Terminal.new(stream, **options)
 				else
 					output = Serialized.new(stream, **options)
@@ -27,6 +28,17 @@ module Console
 				
 				return output
 			end
+			
+			private
+			
+			# Detect if we're running in a cron job or mail context where human-readable output is preferred.
+			# Cron jobs often have MAILTO set and lack TERM, or have minimal TERM values.
+			def self.mail?(env = ENV)
+				# Check for common cron environment indicators
+				return true if env.key?("MAILTO") && !env["MAILTO"].empty?
+				
+				false
+			end
 		end
 	end
 end

data/lib/console/output/serialized.rb

@@ -51,8 +51,9 @@ module Console
 				record = {
 					time: Time.now.iso8601,
 					severity: severity,
-					oid: subject.object_id,
 					pid: Process.pid,
+					oid: subject.object_id,
+					fiber_id: Fiber.current.object_id,
 				}
 				
 				# We want to log just a brief subject:

data/lib/console/output/terminal.rb

@@ -41,6 +41,7 @@ module Console
 					end
 				end
 				
+				# Write a line to the buffer.
 				alias << puts
 			end
 			

data/lib/console/terminal/text.rb

@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2019-2025, by Samuel Williams.
+# Copyright, 2025, by Patrik Wenger.
 
 require "io/console"
 
@@ -78,15 +79,19 @@ module Console
 				end
 			end
 			
-			# Write the given arguments to the output stream using the given style. The reset sequence is automatically appended.
+			# Write the given arguments to the output stream using the given style. The reset sequence is automatically
+			# appended at the end of each line.
 			#
 			# @parameter arguments [Array] The arguments to write, each on a new line.
 			# @parameter style [Symbol] The style to apply.
 			def puts(*arguments, style: nil)
 				if style and prefix = self[style]
-					@stream.write(prefix)
-					@stream.puts(*arguments)
-					@stream.write(self.reset)
+					arguments.each do |argument|
+						argument.to_s.lines.each do |line|
+							@stream.write(prefix, line.chomp)
+							@stream.puts(self.reset)
+						end
+					end
 				else
 					@stream.puts(*arguments)
 				end

data/lib/console/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2019-2025, by Samuel Williams.
 
 module Console
-	VERSION = "1.30.2"
+	VERSION = "1.32.0"
 end

data/license.md

@@ -10,7 +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.  
+Copyright, 2024-2025, by Patrik Wenger.  
 Copyright, 2025, by Shigeru Nakajima.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/readme.md

@@ -34,6 +34,17 @@ Please see the [project documentation](https://socketry.github.io/console/) for
 
 Please see the [project releases](https://socketry.github.io/console/releases/index) for all releases.
 
+### v1.32.0
+
+  - Add `fiber_id` to serialized output records to help identify which fiber logged the message.
+  - Ractor support appears broken in older Ruby versions, so we now require Ruby 3.4 or later for Ractor compatibility, if you need Ractor support.
+
+### v1.31.0
+
+  - [Ractor compatibility.](https://socketry.github.io/console/releases/index#ractor-compatibility.)
+  - [Symbol log level compatibility.](https://socketry.github.io/console/releases/index#symbol-log-level-compatibility.)
+  - [Improved output format selection for cron jobs and email contexts.](https://socketry.github.io/console/releases/index#improved-output-format-selection-for-cron-jobs-and-email-contexts.)
+
 ### v1.30.0
 
   - [Introduce `Console::Config` for fine grained configuration.](https://socketry.github.io/console/releases/index#introduce-console::config-for-fine-grained-configuration.)

data/releases.md

@@ -1,5 +1,65 @@
 # Releases
 
+## v1.32.0
+
+  - Add `fiber_id` to serialized output records to help identify which fiber logged the message.
+  - Ractor support appears broken in older Ruby versions, so we now require Ruby 3.4 or later for Ractor compatibility, if you need Ractor support.
+
+## v1.31.0
+
+### Ractor compatibility.
+
+The console library now works correctly with Ruby's Ractor concurrency model. Previously, attempting to use console logging within Ractors would fail with errors about non-shareable objects. This has been fixed by ensuring the default configuration is properly frozen.
+
+``` ruby
+# This now works without errors:
+ractor = Ractor.new do
+  require 'console'
+  Console.info('Hello from Ractor!')
+  'Ractor completed successfully'
+end
+
+result = ractor.take
+puts result # => 'Ractor completed successfully'
+```
+
+The fix is minimal and maintains full backward compatibility while enabling safe parallel logging across multiple Ractors.
+
+### Symbol log level compatibility.
+
+Previously, returning symbols from custom `log_level` methods in configuration files would cause runtime errors like "comparison of Integer with :debug failed". This has been fixed to properly convert symbols to their corresponding integer values.
+
+``` ruby
+# config/console.rb - This now works correctly:
+def log_level(env = ENV)
+	:debug  # Automatically converted to Console::Logger::LEVELS[:debug]
+end
+```
+
+While this fix maintains backward compatibility, the recommended approach is still to use integer values directly:
+
+``` ruby
+# config/console.rb - Recommended approach:
+def log_level(env = ENV)
+	Console::Logger::LEVELS[:debug]  # Returns 0
+end
+```
+
+### Improved output format selection for cron jobs and email contexts.
+
+When `MAILTO` environment variable is set (typically in cron jobs), the console library now prefers human-readable terminal output instead of JSON serialized output, even when the output stream is not a TTY. This ensures that cron job output sent via email is formatted in a readable way for administrators.
+
+``` ruby
+# Previously in cron jobs (non-TTY), this would output JSON:
+# {"time":"2025-06-07T10:30:00Z","severity":"info","subject":"CronJob","message":["Task completed"]}
+
+# Now with MAILTO set, it outputs human-readable format:
+#   0.1s     info: CronJob
+#                | Task completed
+```
+
+This change is conservative and only affects environments where `MAILTO` is explicitly set, ensuring compatibility with existing deployments.
+
 ## v1.30.0
 
 ### Introduce `Console::Config` for fine grained configuration.

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.30.2
+  version: 1.32.0
 platform: ruby
 authors:
 - Samuel Williams
 - Robert Schulze
 - Bryan Powell
 - Michael Adams
+- Patrik Wenger
 - Anton Sozontov
 - Cyril Roelandt
 - Cédric Boutillier
 - Felix Yan
 - Olle Jonsson
-- Patrik Wenger
 - Shigeru Nakajima
 - William T. Nelson
 bindir: bin
@@ -47,7 +47,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-03-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiber-annotation
@@ -146,14 +146,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Beautiful logging for Ruby.
 test_files: []