console 1.19.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e68f107945b1831b98497a3a7d6a251b030788dfb0f85e212af7da334816f791
-  data.tar.gz: 0460616df8b87571a01eba8d41cdfa2c30ae2efb4c7847c322273cc1de8d74fd
+  metadata.gz: 36a5fff3c1cafc8686f77440fc2dcb09d3a94d1399b15b9bf6967e4b21e6a511
+  data.tar.gz: 3c7e6218667002f2a0f745bcfddbeec1dc8b126fdd1b81cec71fa03c53c3eba5
 SHA512:
-  metadata.gz: 9d7f4c0af841a44c643e24dec336bb1a71642fe292fe204382282e6ef1766a6fe6ec4390486c6e9b3bc6d841b5d603739711ed14848fc4024f6d9c2b169e2e09
-  data.tar.gz: 65399cb6f4c81c5bbe67a746797fa37a96d8a01f1b540abdb01cccad73ea174439a2c27131db84fa2ee80b6860a69150ed77a19e9d3a298cc22dc1e6ed4a97bf
+  metadata.gz: b4d6ebc41b6ea36a711f5f054a30a81ff4a29d06e0f4a2ef6a6554f6c94fd874439428df40e7a098f4bec25a8605452c2380987d1e275e38e6cf522254fdc3b8
+  data.tar.gz: 693ed3f6a7d6786a87aef0ff42d238a3cbd1fc267c0cafb1683b8236e0f878bb7a8dc316822f00ab84cdba7e6f58212e8474d0e85109d67ff59a65b3003548f3

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/filter.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 Robert Schulze.

data/lib/console/output/encoder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+module Console
+	module Output
+		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

data/lib/console/output/json.rb

@@ -4,12 +4,16 @@
 # Copyright, 2021-2022, by Samuel Williams.
 
 require_relative '../serialized/logger'
+require_relative 'encoder'
 
 module Console
 	module Output
 		module JSON
 			def self.new(output, **options)
-				Serialized::Logger.new(output, format: ::JSON, **options)
+				# The output encoder can prevent encoding issues (e.g. invalid UTF-8):
+				Output::Encoder.new(
+					Serialized::Logger.new(output, format: ::JSON, **options)
+				)
 			end
 		end
 	end

data/lib/console/output/split.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2022-2023, by Samuel Williams.
 
 module Console
 	module Output

data/lib/console/output.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 'output/default'
 require_relative 'output/json'

data/lib/console/progress.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2022, by Anton Sozontov.
 
 require_relative 'event/progress'
 require_relative 'clock'

data/lib/console/serialized/logger.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 '../buffer'
 require_relative '../filter'

data/lib/console/terminal/logger.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, 2021, by Robert Schulze.
 
 require_relative '../buffer'

data/lib/console/terminal/xterm.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 'io/console'
 

data/lib/console/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2023, by Samuel Williams.
 
 module Console
-	VERSION = "1.19.0"
+	VERSION = "1.21.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

data/license.md

@@ -1,12 +1,15 @@
 # MIT License
 
-Copyright, 2019-2022, by Samuel Williams.  
+Copyright, 2019-2023, by Samuel Williams.  
 Copyright, 2019-2021, by Bryan Powell.  
 Copyright, 2019, by Cyril Roelandt.  
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2020, by Michael Adams.  
 Copyright, 2021, by Cédric Boutillier.  
 Copyright, 2021, by Robert Schulze.  
+Copyright, 2022, by Anton Sozontov.  
+Copyright, 2022, by William T. Nelson.  
+Copyright, 2023, by Felix Yan.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -6,7 +6,7 @@ Provides beautiful console logging for Ruby applications. Implements fast, buffe
 
 ## Motivation
 
-When Ruby decided to reverse the order of exception backtraces, I finally gave up using the built in logging and decided restore sanity to the output of my programs once and for all!
+When Ruby decided to reverse the order of exception backtraces, I finally gave up using the built in logging and decided restore sanity to the output of my programs once and for all\!
 
 ## Features
 
@@ -29,3 +29,11 @@ We welcome contributions to this project.
 3.  Commit your changes (`git commit -am 'Add some feature'`).
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,16 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Samuel Williams
 - Robert Schulze
 - Bryan Powell
 - Michael Adams
+- Anton Sozontov
 - Cyril Roelandt
 - Cédric Boutillier
+- Felix Yan
 - Olle Jonsson
+- William T. Nelson
 autorequire:
 bindir: bin
 cert_chain:
@@ -43,22 +46,8 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: fiber-local
-  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'
 - !ruby/object:Gem::Dependency
   name: fiber-annotation
   requirement: !ruby/object:Gem::Requirement
@@ -74,89 +63,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-test-external
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
+  name: fiber-local
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.1
-- !ruby/object:Gem::Dependency
-  name: sus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
 description:
 email:
 executables: []
@@ -179,6 +98,7 @@ files:
 - 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
@@ -208,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.3
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="