console 1.15.3 → 1.17.0

data/lib/console/progress.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 require_relative 'event/progress'
 require_relative 'clock'
@@ -29,14 +12,14 @@ module Console
 			Process.clock_gettime(Process::CLOCK_MONOTONIC)
 		end
 		
-		def initialize(output, subject, total = 0, minimum_output_duration: 1.0)
+		def initialize(output, subject, total = 0, minimum_output_duration: 0.1)
 			@output = output
 			@subject = subject
 			
 			@start_time = Progress.now
 			
 			@last_output_time = nil
-			@minimum_output_duration = 0.1
+			@minimum_output_duration = minimum_output_duration
 			
 			@current = 0
 			@total = total
@@ -50,8 +33,8 @@ module Console
 			Progress.now - @start_time
 		end
 		
-		def progress
-			@current.to_f / @total.to_f
+		def ratio
+			Rational(@current.to_f, @total.to_f)
 		end
 		
 		def remaining
@@ -90,8 +73,8 @@ module Console
 			return self
 		end
 		
-		def mark(*arguments)
-			@output.info(@subject, *arguments)
+		def mark(...)
+			@output.info(@subject, ...)
 		end
 		
 		def to_s

data/lib/console/resolver.rb

@@ -1,24 +1,8 @@
 # frozen_string_literal: true
 
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2021, by Robert Schulze.
 
 require_relative 'filter'
 

data/lib/console/serialized/logger.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
 
 require_relative '../buffer'
 require_relative '../filter'
@@ -26,6 +9,8 @@ require_relative '../filter'
 require 'time'
 require 'json'
 
+require 'fiber/annotation'
+
 module Console
 	module Serialized
 		class Logger
@@ -61,6 +46,10 @@ module Console
 					record[:subject] = subject
 				end
 				
+				if annotation = Fiber.current.annotation
+					record[:annotation] = annotation
+				end
+				
 				message = arguments
 				
 				if block_given?

data/lib/console/split.rb

@@ -1,43 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
+
+require_relative 'output/split'
 
 module Console
-	class Split
-		def self.[] *outputs
-			self.new(outputs)
-		end
-		
-		def initialize(outputs)
-			@outputs = outputs
-		end
-		
-		def verbose!(value = true)
-			@outputs.each{|output| output.verbose!(value)}
-		end
-		
-		def call(level, subject = nil, *arguments, **options, &block)
-			@outputs.each do |output|
-				output.call(level, subject, *arguments, **options, &block)
-			end
-		end
-	end
+	Split = Output::Split
 end

data/lib/console/terminal/logger.rb

@@ -1,33 +1,19 @@
 # frozen_string_literal: true
 
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2021, by Robert Schulze.
 
 require_relative '../buffer'
 require_relative '../event'
+require_relative '../clock'
 
 require_relative 'text'
 require_relative 'xterm'
 
 require 'json'
 require 'fiber'
+require 'fiber/annotation'
 
 module Console
 	module Terminal
@@ -77,6 +63,9 @@ module Console
 				@terminal[:error] = @terminal.style(:red)
 				@terminal[:fatal] = @terminal[:error]
 				
+				@terminal[:annotation] = @terminal.style(:blue)
+				@terminal[:value] = @terminal.style(:blue)
+				
 				self.register_defaults(@terminal)
 			end
 			
@@ -106,18 +95,16 @@ module Console
 				
 				buffer = Buffer.new("#{indent}| ")
 				
-				if subject
-					format_subject(severity, prefix, subject, buffer)
+				format_subject(severity, prefix, subject, buffer)
+				
+				arguments.each do |argument|
+					format_argument(argument, buffer)
 				end
 				
 				if options&.any?
 					format_options(options, buffer)
 				end
 				
-				arguments.each do |argument|
-					format_argument(argument, buffer)
-				end
-				
 				if block_given?
 					if block.arity.zero?
 						format_argument(yield, buffer)
@@ -142,7 +129,9 @@ module Console
 				when Event::Generic
 					argument.format(output, @terminal, @verbose)
 				else
-					format_value(argument, output)
+					argument.to_s.each_line do |line|
+						output.puts line
+					end
 				end
 			end
 			
@@ -157,13 +146,23 @@ module Console
 			end
 			
 			def default_suffix(object = nil)
-				buffer = +" #{@terminal[:logger_suffix]}"
+				buffer = +" "
+				
+				if @verbose
+					if annotation = Fiber.current.annotation and annotation.size > 0
+						buffer << "(#{@terminal[:annotation]}#{annotation})#{@terminal.reset} "
+					end
+				end
+				
+				buffer << @terminal[:logger_suffix].to_s
 				
 				if object
 					buffer << "[oid=0x#{object.object_id.to_s(16)}] "
 				end
 				
 				buffer << "[ec=0x#{Fiber.current.object_id.to_s(16)}] [pid=#{Process.pid}] [#{::Time.now}]#{@terminal.reset}"
+				
+				return buffer
 			end
 			
 			def format_object_subject(severity, prefix, subject, output)
@@ -194,7 +193,7 @@ module Console
 				string = value.to_s
 				
 				string.each_line do |line|
-					output.puts "#{line}"
+					output.puts "#{@terminal[:value]}#{line}#{@terminal.reset}"
 				end
 			end
 			

data/lib/console/terminal/text.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
 
 require 'io/console'
 

data/lib/console/terminal/xterm.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
 
 require 'io/console'
 
@@ -38,7 +21,7 @@ module Console
 				cyan: 6,
 				white: 7,
 				default: 9,
-			}
+			}.freeze
 			
 			ATTRIBUTES = {
 				normal: 0,
@@ -50,7 +33,7 @@ module Console
 				blink: 5,
 				reverse: 7,
 				hidden: 8,
-			}
+			}.freeze
 			
 			def colors?
 				true

data/lib/console/terminal.rb

@@ -1,23 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
 
 require_relative 'terminal/logger'

data/lib/console/version.rb

@@ -1,25 +1,8 @@
 # frozen_string_literal: true
 
-# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
 
 module Console
-	VERSION = "1.15.3"
+	VERSION = "1.17.0"
 end

data/lib/console.rb

@@ -1,25 +1,10 @@
 # frozen_string_literal: true
 
-#
-# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019, by Bryan Powell.
+# Copyright, 2020, by Michael Adams.
+# Copyright, 2021, by Cédric Boutillier.
 
 require_relative 'console/version'
 require_relative 'console/logger'

data/license.md

@@ -0,0 +1,27 @@
+# MIT License
+
+Copyright, 2019-2022, 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.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,31 @@
+# Console
+
+Provides beautiful console logging for Ruby applications. Implements fast, buffered log output.
+
+[![Development Status](https://github.com/socketry/console/workflows/Test/badge.svg)](https://github.com/socketry/console/actions?workflow=Test)
+
+## 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!
+
+## Features
+
+  - Thread safe global logger with per-fiber context.
+  - Carry along context with nested loggers.
+  - Enable/disable log levels per-class.
+  - Detailed logging of exceptions.
+  - Beautiful logging to the terminal or structured logging using JSON.
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/console).
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+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.