console 1.22.0 → 1.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f868615689827a90fa20cb73c9408598bd6cfc9602b21ee939a318213a3aee1
-  data.tar.gz: 44927a1200deac00fab718aa995f0549eec0301b688a440da83ae13fd87edc33
+  metadata.gz: f053978f1ebc28b2973844d0ef018eeb200651ffb9bf00702a09ca3b04614fce
+  data.tar.gz: 4f8177c79c3e0d4f9b43e0e4b2c3f02e72837ca7d31e76a6eff308b41848e064
 SHA512:
-  metadata.gz: eabb7c42bcb625726e75a7ebc1e7f330b7dcb0b8936b012c96c79b8a5456f0ac2b3fea5d02cdb1511fde9bd696c7ba300b6394952138810824cb18bdbe8e8e6e
-  data.tar.gz: 1afa8d02eb8e56c81ac39f925e6a5df7edad41198c8aa255eb418847076913b6965b7d5794ba04ed6d5d35b08a1785e8825e12d32a8398f4203f7197584670c1
+  metadata.gz: 01bed9d6648e51ca76c7af4944f640eff416510bd7160ce9e9fd54c6c6397a213b45cfe8b4628d0e2071716b2651362e187f119d82053b85a7c4e5bb06d66fed
+  data.tar.gz: 80de59979995f867f791052666b20d5d1f50ed01a74af4529797b604934b3f18e064f113963b55014c5f90497b40be82ba124443036f8cb34414b48e6c6bc50b

data/lib/console/format/safe.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'json'
+
+module Console
+	module Format
+		# This class is used to safely dump objects.
+		# It will attempt to dump the object using the given format, but if it fails, it will generate a safe version of the object.
+		class Safe
+			def initialize(format: ::JSON, limit: 8, encoding: ::Encoding::UTF_8)
+				@format = format
+				@limit = limit
+				@encoding = encoding
+			end
+			
+			def dump(object)
+				@format.dump(object, @limit)
+			rescue SystemStackError, StandardError => error
+				@format.dump(safe_dump(object, error))
+			end
+			
+			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
+				
+				# 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)
+				end
+				
+				return frames
+			end
+			
+			def safe_dump(object, error)
+				object = safe_dump_recurse(object)
+				
+				object[:truncated] = true
+				object[:error] = {
+					class: safe_dump_recurse(error.class.name),
+					message: safe_dump_recurse(error.message),
+					backtrace: safe_dump_recurse(filter_backtrace(error)),
+				}
+				
+				return object
+			end
+			
+			def replacement_for(object)
+				case object
+				when Array
+					"[...]"
+				when Hash
+					"{...}"
+				else
+					"..."
+				end
+			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.
+			# Primitive values will be returned as-is.
+			# Other values will be converted using `as_json` if available, otherwise `to_s`.
+			def safe_dump_recurse(object, limit = @limit, objects = default_objects)
+				if limit <= 0 || objects[object]
+					return replacement_for(object)
+				end
+				
+				case object
+				when Hash
+					objects[object] = true
+					
+					object.to_h do |key, value|
+						[
+							String(key).encode(@encoding, invalid: :replace, undef: :replace),
+							safe_dump_recurse(value, limit - 1, objects)
+						]
+					end
+				when Array
+					objects[object] = true
+					
+					object.map do |value|
+						safe_dump_recurse(value, limit - 1, objects)
+					end
+				when String
+					object.encode(@encoding, invalid: :replace, undef: :replace)
+				when Numeric, TrueClass, FalseClass, NilClass
+					object
+				else
+					objects[object] = true
+					
+					# We could do something like this but the chance `as_json` will blow up.
+					# We'd need to be extremely careful about it.
+					# if object.respond_to?(:as_json)
+					# 	safe_dump_recurse(object.as_json, limit - 1, objects)
+					# else
+					
+					safe_dump_recurse(object.to_s, limit - 1, objects)
+				end
+			end
+		end
+	end
+end

data/lib/console/format.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require_relative 'format/safe'
+
+module Console
+	module Format
+		def self.default
+			Safe.new(format: ::JSON)
+		end
+		
+		def self.default_json
+			self.default
+		end
+	end
+end

data/lib/console/output/json.rb

@@ -8,94 +8,8 @@ require_relative '../serialized/logger'
 module Console
 	module Output
 		module JSON
-			# This is a safe JSON serializer that will not raise exceptions.
-			class Safe
-				def initialize(limit: 8, encoding: ::Encoding::UTF_8)
-					@limit = limit
-					@encoding = encoding
-				end
-				
-				def dump(object)
-					::JSON.dump(object, @limit)
-				rescue => error
-					::JSON.dump(safe_dump(object, error))
-				end
-				
-				private
-				
-				def default_objects
-					Hash.new.compare_by_identity
-				end
-				
-				def safe_dump(object, error)
-					object = safe_dump_recurse(object)
-					
-					object[:truncated] = true
-					object[:error] = {
-						class: safe_dump_recurse(error.class.name),
-						message: safe_dump_recurse(error.message),
-					}
-					
-					return object
-				end
-				
-				def replacement_for(object)
-					case object
-					when Array
-						"[...]"
-					when Hash
-						"{...}"
-					else
-						"..."
-					end
-				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.
-				# Primitive values will be returned as-is.
-				# Other values will be converted using `as_json` if available, otherwise `to_s`.
-				def safe_dump_recurse(object, limit = @limit, objects = default_objects)
-					if limit <= 0 || objects[object]
-						return replacement_for(object)
-					end
-					
-					case object
-					when Hash
-						objects[object] = true
-						
-						object.to_h do |key, value|
-							[
-								String(key).encode(@encoding, invalid: :replace, undef: :replace),
-								safe_dump_recurse(value, limit - 1, objects)
-							]
-						end
-					when Array
-						objects[object] = true
-						
-						object.map do |value|
-							safe_dump_recurse(value, limit - 1, objects)
-						end
-					when String
-						object.encode(@encoding, invalid: :replace, undef: :replace)
-					when Numeric, TrueClass, FalseClass, NilClass
-						object
-					else
-						objects[object] = true
-						
-						# We could do something like this but the chance `as_json` will blow up.
-						# We'd need to be extremely careful about it.
-						# if object.respond_to?(:as_json)
-						# 	safe_dump_recurse(object.as_json, limit - 1, objects)
-						# else
-						
-						safe_dump_recurse(object.to_s, limit - 1, objects)
-					end
-				end
-			end
-			
 			def self.new(output, **options)
-				Serialized::Logger.new(output, format: Safe.new, **options)
+				Serialized::Logger.new(output, format: Format.default_json, **options)
 			end
 		end
 	end

data/lib/console/serialized/logger.rb

@@ -5,16 +5,16 @@
 
 require_relative '../buffer'
 require_relative '../filter'
+require_relative '../format'
 
 require 'time'
-require 'json'
 
 require 'fiber/annotation'
 
 module Console
 	module Serialized
 		class Logger
-			def initialize(io = $stderr, format: JSON, verbose: false, **options)
+			def initialize(io = $stderr, format: Format.default, verbose: false, **options)
 				@io = io
 				@start = Time.now
 				@format = format

data/lib/console/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -95,10 +95,11 @@ files:
 - lib/console/event/progress.rb
 - lib/console/event/spawn.rb
 - lib/console/filter.rb
+- lib/console/format.rb
+- lib/console/format/safe.rb
 - lib/console/logger.rb
 - lib/console/output.rb
 - lib/console/output/default.rb
-- lib/console/output/encoder.rb
 - lib/console/output/json.rb
 - lib/console/output/null.rb
 - lib/console/output/sensitive.rb

data/lib/console/output/encoder.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
-
-module Console
-	module Output
-		# @deprecated With no replacement.
-		class Encoder
-			def initialize(output, encoding = ::Encoding::UTF_8)
-				@output = output
-				@encoding = encoding
-			end
-			
-			attr :output
-			
-			attr :encoding
-			
-			def call(subject = nil, *arguments, **options, &block)
-				subject = encode(subject)
-				arguments = encode(arguments)
-				options = encode(options)
-				
-				@output.call(subject, *arguments, **options, &block)
-			end
-			
-			def encode(value)
-				case value
-				when String
-					value.encode(@encoding, invalid: :replace, undef: :replace)
-				when Array
-					value.map{|item| encode(item)}
-				when Hash
-					value.transform_values{|item| encode(item)}
-				else
-					value
-				end
-			end
-		end
-	end
-end