console 1.29.2 → 1.36.0

data/releases.md

@@ -1,11 +1,125 @@
 # Releases
 
+## v1.36.0
+
+  - Add a `size_limit` to `Console::Format::Safe` (default 16KiB) which rebuilds oversized records field-by-field, keeping as many top-level fields as fit within the limit.
+  - Degraded fields are recorded in a `truncated` object that maps each field name to why it was truncated: `true` (dropped for size) or the error (the value could not be serialized directly and a safe representation was kept in its place).
+  - Rename `Console::Format::Safe`'s `limit:` to `depth_limit:` (with a deprecated `limit:` alias) to clarify its purpose alongside the new `size_limit:`.
+
+## v1.35.0
+
+  - Fix handling of `Errno::ENODEV` errors when calculating the width of a terminal that was been re-opened to `File::NULL`.
+
+## v1.34.1
+
+  - Add `process_id` to serialized output records for clarity (`pid` is still included for backwards compatibility).
+      - Add `object_id` to serialized output records **only** when the subject is not a string or class/module.
+
+## v1.34.0
+
+  - Allow `Console::Compatible::Logger#add` to accept `**options`.
+
+## 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.
+
+Introduced a new explicit configuration interface via config/console.rb to enhance logging setup in complex applications. This update gives the application code an opportunity to load files if required and control aspects such as log level, output, and more. Users can override default behaviors (e.g., make\_output, make\_logger, and log\_level) for improved customization.
+
+``` ruby
+# config/console.rb
+def log_level(env = ENV)
+	# Set a custom log level, e.g., force debug mode:
+	:debug
+end
+
+def make_logger(output = $stderr, env = ENV, **options)
+	# Custom logger configuration with verbose output:
+	options[:verbose] = true
+	
+	Logger.new(output, **options)
+end
+```
+
+This approach provides a standard way to hook into the log setup process, allowing tailored adjustments for reliable and customizable logging behavior.
+
+## v1.29.3
+
+  - Serialized output now uses `IO#write` with a single string to reduce the chance of interleaved output.
+
+## v1.29.2
+
+  - Always return `nil` from `Console::Filter` logging methods.
+
+## v1.29.1
+
+  - Fix logging `exception:` keyword argument when the value was not an exception.
+
 ## 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
+### 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:
 

metadata

@@ -1,21 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.29.2
+  version: 1.36.0
 platform: ruby
 authors:
 - Samuel Williams
 - Robert Schulze
 - Bryan Powell
 - Michael Adams
+- Patrik Wenger
+- William T. Nelson
 - Anton Sozontov
+- Copilot
 - Cyril Roelandt
 - Cédric Boutillier
 - Felix Yan
 - Olle Jonsson
-- Patrik Wenger
-- William T. Nelson
-autorequire:
+- Shigeru Nakajima
+- Yasha Krasnou
 bindir: bin
 cert_chain:
 - |
@@ -47,7 +49,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-12-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiber-annotation
@@ -91,18 +93,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - bake/console.rb
+- context/command-line.md
+- context/configuration.md
+- context/events.md
+- context/getting-started.md
+- context/index.yaml
+- context/integration.md
 - lib/console.rb
 - lib/console/adapter.rb
 - lib/console/capture.rb
 - lib/console/clock.rb
 - lib/console/compatible/logger.rb
+- lib/console/config.rb
 - lib/console/event.rb
 - lib/console/event/failure.rb
 - lib/console/event/generic.rb
@@ -124,6 +131,7 @@ files:
 - lib/console/progress.rb
 - lib/console/resolver.rb
 - lib/console/terminal.rb
+- lib/console/terminal/formatter.rb
 - lib/console/terminal/formatter/failure.rb
 - lib/console/terminal/formatter/progress.rb
 - lib/console/terminal/formatter/spawn.rb
@@ -134,12 +142,13 @@ files:
 - license.md
 - readme.md
 - releases.md
-homepage: https://socketry.github.io/console
+homepage: https://github.com/socketry/console
 licenses:
 - MIT
 metadata:
   documentation_uri: https://socketry.github.io/console/
-post_install_message:
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/console.git
 rdoc_options: []
 require_paths:
 - lib
@@ -147,15 +156,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Beautiful logging for Ruby.
 test_files: []