console 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9f91e3e103d4d8999923473901b90855e7c8ee5a2f1bf5fa7be4b87a435e0e2
-  data.tar.gz: 78cc14aa29facd5ef1909fc08bcd255d11c251f1075dbe92692f26a249557cbf
+  metadata.gz: 9a62f7c19673292c5cd3c0d8b9d93350ca4b36ac0a5c0a0466deef6543b388ba
+  data.tar.gz: f382353a7b052c056936fdd2c95ad0bd20cfb8619db2f6d2af1ce7e9e0cd7967
 SHA512:
-  metadata.gz: bda52b2ed24d9825905e8e929809d9629ba61755059d7e00ef8ceb693839a191d98647bc13fd2c3a7699f8f664560e4f35c316e21bb9e37c24b8d1265c31dd91
-  data.tar.gz: 22a7f6c0be0617140c608b5063c25d3dd220670afc570860f0cd54fea36f889c3b128d168f9dd6bf92c01c271e335b4d73dfd06cfe918f2360911aa8991fcfba
+  metadata.gz: 6638ede52de5f0954a38adf71e910997eb643d2e39ef59645f320ce16ebefd4f804cb062e47e03472ac742fb46591c310217da72eb63eb87fe91d93090f8ee5f
+  data.tar.gz: 15f4929956b45e0c445e95774dfa3ac1c4bb485401e1b0003835c9ae5435a25ebda70b69ad475cf0e6b48131b0cc41258e3c5bb8c70121daaa9fe482c12b5404

data/lib/console/capture.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2023, by Samuel Williams.
 
 require_relative 'filter'
 
@@ -55,6 +55,10 @@ module Console
 				message[:arguments] = arguments
 			end
 			
+			if annotation = Fiber.current.annotation
+				message[:annotation] = annotation
+			end
+			
 			if block_given?
 				if block.arity.zero?
 					message[:message] = yield

data/lib/console/compatible/logger.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2023, by Samuel Williams.
 
 require 'logger'
 

data/lib/console/event/failure.rb

@@ -43,8 +43,18 @@ module Console
 				format_exception(@exception, nil, output, terminal, verbose)
 			end
 			
+			if Exception.method_defined?(:detailed_message)
+				def detailed_message(exception)
+					exception.detailed_message
+				end
+			else
+				def detailed_message(exception)
+					exception.message
+				end
+			end
+			
 			def format_exception(exception, prefix, output, terminal, verbose)
-				lines = exception.message.lines.map(&:chomp)
+				lines = detailed_message(exception).lines.map(&:chomp)
 				
 				output.puts "  #{prefix}#{terminal[:exception_title]}#{exception.class}#{terminal.reset}: #{lines.shift}"
 				
@@ -55,7 +65,7 @@ module Console
 				root_pattern = /^#{@root}\// if @root
 				
 				exception.backtrace&.each_with_index do |line, index|
-					path, offset, message = line.split(":")
+					path, offset, message = line.split(":", 3)
 					style = :exception_backtrace
 					
 					# Make the path a bit more readable

data/lib/console/filter.rb

@@ -12,6 +12,17 @@ module Console
 	UNKNOWN = 'unknown'
 	
 	class Filter
+		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)
+			end
+		else
+			def self.define_immutable_method(name, &block)
+				define_method(name, &block)
+			end
+		end
+		
 		def self.[] **levels
 			klass = Class.new(self)
 			minimum_level, maximum_level = levels.values.minmax
@@ -24,17 +35,17 @@ module Console
 				levels.each do |name, level|
 					const_set(name.to_s.upcase, level)
 					
-					define_method(name) do |subject = nil, *arguments, **options, &block|
+					define_immutable_method(name) do |subject = nil, *arguments, **options, &block|
 						if self.enabled?(subject, level)
 							self.call(subject, *arguments, severity: name, **options, **@options, &block)
 						end
 					end
 					
-					define_method("#{name}!") do
+					define_immutable_method("#{name}!") do
 						@level = level
 					end
 					
-					define_method("#{name}?") do
+					define_immutable_method("#{name}?") do
 						@level <= level
 					end
 				end

data/lib/console/format/safe.rb

@@ -18,14 +18,47 @@ module Console
 			
 			def dump(object)
 				@format.dump(object, @limit)
-			rescue => error
+			rescue SystemStackError, StandardError => error
 				@format.dump(safe_dump(object, error))
 			end
 			
 			private
 			
-			def default_objects
-				Hash.new.compare_by_identity
+			def filter_backtrace(error)
+				frames = error.backtrace
+				filtered = {}
+				filtered_count = nil
+				skipped = nil
+				
+				frames = frames.filter_map do |frame|
+					if filtered[frame]
+						if filtered_count == nil
+							filtered_count = 1
+							skipped = frame.dup
+						else
+							filtered_count += 1
+							nil
+						end
+					else
+						if skipped
+							if filtered_count > 1
+								skipped.replace("[... #{filtered_count} frames skipped ...]")
+							end
+							
+							filtered_count = nil
+							skipped = nil
+						end
+						
+						filtered[frame] = true
+						frame
+					end
+				end
+				
+				if skipped && filtered_count > 1
+					skipped.replace("[... #{filtered_count} frames skipped ...]")
+				end
+				
+				return frames
 			end
 			
 			def safe_dump(object, error)
@@ -35,6 +68,7 @@ module Console
 				object[:error] = {
 					class: safe_dump_recurse(error.class.name),
 					message: safe_dump_recurse(error.message),
+					backtrace: safe_dump_recurse(filter_backtrace(error)),
 				}
 				
 				return object
@@ -51,6 +85,10 @@ module Console
 				end
 			end
 			
+			def default_objects
+				Hash.new.compare_by_identity
+			end
+			
 			# This will recursively generate a safe version of the object.
 			# Nested hashes and arrays will be transformed recursively.
 			# Strings will be encoded with the given encoding.

data/lib/console/output/json.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative '../serialized/logger'
 

data/lib/console/terminal/logger.rb

@@ -119,7 +119,7 @@ module Console
 			protected
 			
 			def format_options(options, output)
-				format_value(options.to_json, output)
+				format_value(::JSON.pretty_generate(options), output)
 			end
 			
 			def format_argument(argument, output)
@@ -149,8 +149,14 @@ module Console
 				buffer = +""
 				
 				if @verbose
-					if annotation = Fiber.current.annotation and annotation.size > 0
-						buffer << ": #{@terminal[:annotation]}#{annotation}#{@terminal.reset}"
+					if annotation = Fiber.current.annotation
+						# While typically annotations should be strings, that is not always the case.
+						annotation = annotation.to_s
+						
+						# If the annotation is empty, we don't want to print it, as it will look like a formatting bug.
+						if annotation.size > 0
+							buffer << ": #{@terminal[:annotation]}#{annotation}#{@terminal.reset}"
+						end
 					end
 				end
 				
@@ -193,6 +199,7 @@ module Console
 				string = value.to_s
 				
 				string.each_line do |line|
+					line.chomp!
 					output.puts "#{@terminal[:value]}#{line}#{@terminal.reset}"
 				end
 			end

data/lib/console/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2019-2023, by Samuel Williams.
 
 module Console
-	VERSION = "1.23.0"
+	VERSION = "1.24.0"
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2019-2023, 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.  

data/readme.md

@@ -18,7 +18,13 @@ 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.
 
 ## Contributing
 
@@ -36,4 +42,10 @@ This project uses the [Developer Certificate of Origin](https://developercertifi
 
 ### Contributor Covenant
 
-This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+
+## 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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -46,7 +46,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiber-annotation
@@ -76,6 +76,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 executables: []
@@ -117,7 +131,7 @@ files:
 - lib/console/version.rb
 - license.md
 - readme.md
-homepage: https://github.com/socketry/console
+homepage: https://socketry.github.io/console/
 licenses:
 - MIT
 metadata: {}
@@ -136,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Beautiful logging for Ruby.