console 1.20.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d974c867b670b89c2b04c83f640f46217e9836e3eec7f92903bc062e6c59458c
-  data.tar.gz: 4bc1d803689cad17d85a36d7da8c172a63ea869e6fa060f9c85702c1da365b90
+  metadata.gz: 9f868615689827a90fa20cb73c9408598bd6cfc9602b21ee939a318213a3aee1
+  data.tar.gz: 44927a1200deac00fab718aa995f0549eec0301b688a440da83ae13fd87edc33
 SHA512:
-  metadata.gz: 1db5693110b3a7f48b17abdf58eb74ac5269f4748d0746df057c7dbe01ddee228db5bcc74bd581c1e9bddf94602943682feb4cf50c7b14312d23db47e5209206
-  data.tar.gz: 3209fa49d39e7de2040610187599b7b22e41af0da3c2749b7a7c939ce40d07c2101472fec9a47a20de754d216f780ab59f508a3b4ddc17dd5c251d4a94e215f3
+  metadata.gz: eabb7c42bcb625726e75a7ebc1e7f330b7dcb0b8936b012c96c79b8a5456f0ac2b3fea5d02cdb1511fde9bd696c7ba300b6394952138810824cb18bdbe8e8e6e
+  data.tar.gz: 1afa8d02eb8e56c81ac39f925e6a5df7edad41198c8aa255eb418847076913b6965b7d5794ba04ed6d5d35b08a1785e8825e12d32a8398f4203f7197584670c1

data/lib/console/compatible/logger.rb

@@ -29,7 +29,7 @@ module Console
 				end
 			end
 
-			def initialize(subject, output)
+			def initialize(subject, output = Console)
 				super(nil)
 				
 				@progname = subject

data/lib/console/output/encoder.rb

@@ -5,6 +5,7 @@
 
 module Console
 	module Output
+		# @deprecated With no replacement.
 		class Encoder
 			def initialize(output, encoding = ::Encoding::UTF_8)
 				@output = output

data/lib/console/output/json.rb

@@ -4,16 +4,98 @@
 # Copyright, 2021-2022, by Samuel Williams.
 
 require_relative '../serialized/logger'
-require_relative 'encoder'
 
 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)
-				# The output encoder can prevent encoding issues (e.g. invalid UTF-8):
-				Output::Encoder.new(
-					Serialized::Logger.new(output, format: ::JSON, **options)
-				)
+				Serialized::Logger.new(output, format: Safe.new, **options)
 			end
 		end
 	end

data/lib/console/version.rb

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

data/lib/console.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.
 # Copyright, 2019, by Bryan Powell.
 # Copyright, 2020, by Michael Adams.
 # Copyright, 2021, by Cédric Boutillier.
@@ -10,23 +10,45 @@ require_relative 'console/version'
 require_relative 'console/logger'
 
 module Console
-	def self.logger
-		Logger.instance
-	end
-	
-	def self.logger= instance
-		Logger.instance= instance
+	class << self
+		def logger
+			Logger.instance
+		end
+		
+		def logger= instance
+			Logger.instance= instance
+		end
+		
+		def debug(...)
+			Logger.instance.debug(...)
+		end
+		
+		def info(...)
+			Logger.instance.info(...)
+		end
+		
+		def warn(...)
+			Logger.instance.warn(...)
+		end
+		
+		def error(...)
+			Logger.instance.error(...)
+		end
+		
+		def fatal(...)
+			Logger.instance.fatal(...)
+		end
+		
+		def call(...)
+			Logger.instance.call(...)
+		end
 	end
 	
 	def logger= logger
-		@logger = logger
+		warn "Setting logger on #{self} is deprecated. Use Console.logger= instead.", uplevel: 1
 	end
 	
 	def logger
-		@logger || Logger.instance
-	end
-	
-	def self.extended(klass)
-		klass.instance_variable_set(:@logger, nil)
+		Logger.instance
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -46,7 +46,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-08-03 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiber-annotation