console 1.23.1 → 1.23.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f053978f1ebc28b2973844d0ef018eeb200651ffb9bf00702a09ca3b04614fce
-  data.tar.gz: 4f8177c79c3e0d4f9b43e0e4b2c3f02e72837ca7d31e76a6eff308b41848e064
+  metadata.gz: dd6108c241ee21f1f785bd0686d958e586d647c0320b0edfcbae7fdaff275155
+  data.tar.gz: eac618496cbeedb26503082d99a1e34904229b00bd213e38acaf2d5044af7a2c
 SHA512:
-  metadata.gz: 01bed9d6648e51ca76c7af4944f640eff416510bd7160ce9e9fd54c6c6397a213b45cfe8b4628d0e2071716b2651362e187f119d82053b85a7c4e5bb06d66fed
-  data.tar.gz: 80de59979995f867f791052666b20d5d1f50ed01a74af4529797b604934b3f18e064f113963b55014c5f90497b40be82ba124443036f8cb34414b48e6c6bc50b
+  metadata.gz: 3b0335cc888c818b29cc1f12fbb62228107b7838e526481110383abb896c7f46bd006e324781a08a872bf90f047bcbf3507a6c638f4bda2b32008b1e10765315
+  data.tar.gz: 3e7db728a24bc033c6e2c8338996efc19d8cfdecc8f3d9f22857112500c99f00633483f2ec5ebd6a935aaece3f02ca1d7033a3e7c9c3987de60b81517bae5777

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/format/safe.rb

@@ -24,22 +24,38 @@ module Console
 			
 			private
 			
-			def default_objects
-				Hash.new.compare_by_identity
-			end
-			
-			# The first N frames, noting that the last frame is a placeholder for all the skipped frames:
-			FIRST_N_FRAMES = 10 + 1
-			LAST_N_FRAMES = 20
-			MAXIMUM_FRAMES = FIRST_N_FRAMES + LAST_N_FRAMES
-			
 			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
 				
-				# Select only the first and last few frames:
-				if frames.size > MAXIMUM_FRAMES
-					frames[FIRST_N_FRAMES-1] = "[... #{frames.size - (MAXIMUM_FRAMES-1)} frames ...]"
-					frames.slice!(FIRST_N_FRAMES...-LAST_N_FRAMES)
+				if skipped && filtered_count > 1
+					skipped.replace("[... #{filtered_count} frames skipped ...]")
 				end
 				
 				return frames
@@ -69,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

@@ -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
 				

data/lib/console/version.rb

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

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
 
@@ -37,3 +43,9 @@ 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.
+
+## 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.1
+  version: 1.23.3
 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: 2023-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiber-annotation
@@ -117,7 +117,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 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Beautiful logging for Ruby.