console 1.9.1 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebadd29a9248f8a155c3bc22550a6433e53af806acae2112fe96a3924c92fb8d
-  data.tar.gz: fd23c8cb36efc9a36f688c2caa0383feb85fe7fdab2992d269239650faa8f92a
+  metadata.gz: 149a9d0738e731ea3ef3159cd25a449f663070406dfa232538a5996fb93c9ce9
+  data.tar.gz: 212772395d4aef7dc7a510d6630e11dfabeb4c8cf2c70f5d272c279a3d2a32ef
 SHA512:
-  metadata.gz: 02b4cecf9844a7d6bb733da31953805d89590b5a43b68e7d6cc379bde7e2660e3064438385d40b147cde4c89b50b7f7f9f4cf3f58aa69e1498e0085f56015a86
-  data.tar.gz: 3bba83e7c801994f6fdb6a1a248fbac746a8a9987f786d30df73c91ba7d79032226d4f78d3eed9fb1a5d0eb9c339f89864c15fcceb823a2f877e81fe90c977f7
+  metadata.gz: d02021cfb6dbf99651d5f1b8653394dd59f2c830b0a62b8c394b70b275030cd2c066a786a9cb1281df55029f9a69455c00a73a1763785cba3a5ccf8769766654
+  data.tar.gz: be05f291ccae55c3a6cce6ed2e5e79fa968682d856bcc502693408c69cc85b563017e8505a0459f6cb0d628bbdc57b58efd28146b460e09b45695652e6263145

data/lib/console.rb

@@ -20,83 +20,24 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'console/version'
 require_relative 'console/logger'
-require_relative 'console/resolver'
-require_relative 'console/terminal/logger'
 
 module Console
-	class << self
-		attr_accessor :logger
-		
-		# Set the default log level based on `$DEBUG` and `$VERBOSE`.
-		# You can also specify CONSOLE_LEVEL=debug or CONSOLE_LEVEL=info in environment.
-		# https://mislav.net/2011/06/ruby-verbose-mode/ has more details about how it all fits together.
-		def default_log_level(env = ENV)
-			if level = (env['CONSOLE_LEVEL'] || env['CONSOLE_LOG_LEVEL'])
-				Logger::LEVELS[level.to_sym] || Logger.warn
-			elsif $DEBUG
-				Logger::DEBUG
-			elsif $VERBOSE.nil?
-				Logger::WARN
-			else
-				Logger::INFO
-			end
-		end
-		
-		# You can change the log level for different classes using CONSOLE_<LEVEL> env vars.
-		#
-		# e.g. `CONSOLE_WARN=Acorn,Banana CONSOLE_DEBUG=Cat` will set the log level for Acorn and Banana to warn and Cat to
-		# debug. This overrides the default log level.
-		#
-		# @param logger [Logger] A logger instance to set the logging levels on.
-		# @param env [Hash] Environment to read levels from.
-		#
-		# @return [nil] if there were no custom logging levels specified in the environment.
-		# @return [Resolver] if there were custom logging levels, then the created resolver is returned.
-		def default_resolver(logger, env = ENV)
-			# find all CONSOLE_<LEVEL> variables from environment
-			levels = Logger::LEVELS
-			.map { |label, level| [level, env["CONSOLE_#{label.to_s.upcase}"]&.split(',')] }
-			.to_h
-			.compact
-
-			# if we have any levels, then create a class resolver, and each time a class is resolved, set the log level for
-			# that class to the specified level
-			if levels.any?
-				resolver = Resolver.new
-				levels.each do |level, names|
-					resolver.bind(names) do |klass|
-						logger.enable(klass, level)
-					end
-				end
-				return resolver
-			end
-		end
-		
-		# Controls verbose output using `$VERBOSE`.
-		def verbose?
-			!$VERBOSE.nil?
-		end
-		
-		def build(output, verbose: self.verbose?, level: self.default_log_level)
-			terminal = Terminal::Logger.new(output, verbose: verbose)
-			
-			logger = Logger.new(terminal, verbose: verbose, level: level)
-			
-			return logger
-		end
+	def self.logger
+		Logger.instance
 	end
 	
-	# Create the logger instance:
-	@logger = self.build($stderr)
-	@resolver = self.default_resolver(@logger)
+	def self.logger= instance
+		Logger.instance= instance
+	end
 	
 	def logger= logger
 		@logger = logger
 	end
 	
 	def logger
-		@logger || Console.logger
+		@logger || Logger.instance
 	end
 	
 	def self.extended(klass)

data/lib/console/clock.rb

@@ -0,0 +1,50 @@
+# Copyright, 2021, 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.
+
+module Console
+	module Clock
+		def self.formatted_duration(duration)
+			if duration < 60.0
+				return "#{duration.round(2)}s"
+			end
+			
+			duration /= 60.0
+			
+			if duration < 60.0
+				return "#{duration.round}m"
+			end
+			
+			duration /= 60.0
+			
+			if duration < 60.0
+				return "#{duration.round(1)}h"
+			end
+			
+			duration /= 24.0
+			
+			return "#{duration.round(1)}d"
+		end
+		
+		# Get the current elapsed monotonic time.
+		def self.now
+			::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+		end
+	end
+end

data/lib/console/event/failure.rb

@@ -47,6 +47,8 @@ module Console
 				terminal[:exception_title] ||= terminal.style(:red, nil, :bold)
 				terminal[:exception_detail] ||= terminal.style(:yellow)
 				terminal[:exception_backtrace] ||= terminal.style(:red)
+				terminal[:exception_backtrace_other] ||= terminal.style(:red, nil, :faint)
+				terminal[:exception_message] ||= terminal.style(:default)
 			end
 			
 			def to_h
@@ -66,13 +68,18 @@ module Console
 					output.puts "  #{terminal[:exception_detail]}#{line}#{terminal.reset}"
 				end
 				
+				root_pattern = /^#{@root}\// if @root
+				
 				exception.backtrace&.each_with_index do |line, index|
 					path, offset, message = line.split(":")
+					style = :exception_backtrace
 					
 					# Make the path a bit more readable
-					path.gsub!(/^#{@root}\//, "./") if @root
+					if root_pattern and path.sub!(root_pattern, "").nil?
+						style = :exception_backtrace_other
+					end
 					
-					output.puts "  #{index == 0 ? "→" : " "} #{terminal[:exception_backtrace]}#{path}:#{offset}#{terminal.reset} #{message}"
+					output.puts "  #{index == 0 ? "→" : " "} #{terminal[style]}#{path}:#{offset}#{terminal[:exception_message]} #{message}#{terminal.reset}"
 				end
 				
 				if exception.cause

data/lib/console/event/measure.rb

@@ -0,0 +1,42 @@
+# 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.
+
+require_relative 'metric'
+require_relative '../clock'
+
+module Console
+	module Event
+		class Enter < Generic
+			def initialize(name)
+				@name = name
+			end
+			
+			def format(output, terminal, verbose)
+				output.puts "→ #{@name}"
+			end
+		end
+		
+		class Exit < Metric
+			def value_string
+				"← #{@name} took #{Clock.formatted_duration(@value)}"
+			end
+		end
+	end
+end

data/lib/console/event/metric.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'generic'
+require_relative '../clock'
 
 module Console
 	module Event
@@ -41,8 +42,16 @@ module Console
 				{name: @name, value: @value, tags: @tags}
 			end
 			
+			def value_string
+				"#{@name}: #{@value}"
+			end
+			
 			def format(output, terminal, verbose)
-				output.puts "#{@name}=#{@value} #{@tags.inspect}"
+				if @tags&.any?
+					output.puts "#{value_string} #{@tags.inspect}"
+				else
+					output.puts value_string
+				end
 			end
 		end
 	end

data/lib/console/logger.rb

@@ -19,10 +19,51 @@
 # THE SOFTWARE.
 
 require_relative 'filter'
+require_relative 'measure'
 require_relative 'progress'
 
+require_relative 'resolver'
+require_relative 'terminal/logger'
+
+require 'fiber/local'
+
 module Console
 	class Logger < Filter[debug: 0, info: 1, warn: 2, error: 3, fatal: 4]
+		extend Fiber::Local
+		
+		# Set the default log level based on `$DEBUG` and `$VERBOSE`.
+		# You can also specify CONSOLE_LEVEL=debug or CONSOLE_LEVEL=info in environment.
+		# https://mislav.net/2011/06/ruby-verbose-mode/ has more details about how it all fits together.
+		def self.default_log_level(env = ENV)
+			if level = (env['CONSOLE_LEVEL'] || env['CONSOLE_LOG_LEVEL'])
+				LEVELS[level.to_sym] || level.to_i
+			elsif $DEBUG
+				DEBUG
+			elsif $VERBOSE.nil?
+				WARN
+			else
+				INFO
+			end
+		end
+		
+		# Controls verbose output using `$VERBOSE`.
+		def self.verbose?(env = ENV)
+			!$VERBOSE.nil? || env['CONSOLE_VERBOSE']
+		end
+		
+		def self.default_logger(output, verbose: self.verbose?, level: self.default_log_level)
+			terminal = Terminal::Logger.new(output, verbose: verbose)
+			
+			logger = self.new(terminal, verbose: verbose, level: level)
+			Resolver.default_resolver(logger)
+			
+			return logger
+		end
+		
+		def self.local
+			self.default_logger($stderr)
+		end
+		
 		DEFAULT_LEVEL = 1
 		
 		def initialize(output, **options)
@@ -33,8 +74,15 @@ module Console
 			Progress.new(self, subject, total, **options)
 		end
 		
-		# @deprecated Please use {progress}.
-		alias measure progress
+		def measure(subject, name = "block", **tags, &block)
+			measure = Measure.new(self, subject, **tags)
+			
+			if block_given?
+				return measure.duration(name, &block)
+			else
+				return measure
+			end
+		end
 		
 		def failure(subject, exception, *arguments, &block)
 			fatal(subject, *arguments, Event::Failure.new(exception), &block)

data/lib/console/measure.rb

@@ -0,0 +1,49 @@
+# 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.
+
+require_relative 'event/measure'
+require_relative 'clock'
+
+module Console
+	class Measure
+		def initialize(output, subject, **tags)
+			@output = output
+			@subject = subject
+			@tags = tags
+		end
+		
+		attr :tags
+		
+		# Measure the execution of a block of code.
+		def duration(name, &block)
+			@output.info(@subject) {Event::Enter.new(name)}
+			
+			start_time = Clock.now
+			
+			result = yield(self)
+			
+			duration = Clock.now - start_time
+			
+			@output.info(@subject) {Event::Exit.new(name, duration, **@tags)}
+			
+			return result
+		end
+	end
+end

data/lib/console/progress.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'event/progress'
+require_relative 'clock'
 
 module Console
 	class Progress
@@ -93,7 +94,7 @@ module Console
 		
 		def to_s
 			if estimated_remaining_time = self.estimated_remaining_time
-				"#{@current}/#{@total} completed in #{self.formatted_duration self.duration}, #{self.formatted_duration estimated_remaining_time} remaining."
+				"#{@current}/#{@total} completed in #{Clock.formatted_duration(self.duration)}, #{Clock.formatted_duration(estimated_remaining_time)} remaining."
 			else
 				"#{@current}/#{@total} completed, waiting for estimate..."
 			end
@@ -108,33 +109,13 @@ module Console
 		end
 		
 		def output?
-			if duration = duration_since_last_output
+			if remaining.zero?
+				return true
+			elsif duration = duration_since_last_output
 				return duration > @minimum_output_duration
 			else
 				return true
 			end
 		end
-		
-		def formatted_duration(duration)
-			if duration < 60.0
-				return "#{duration.round(2)}s"
-			end
-			
-			duration /= 60.0
-			
-			if duration < 60.0
-				return "#{duration.round}m"
-			end
-			
-			duration /= 60.0
-			
-			if duration < 60.0
-				return "#{duration.round(1)}h"
-			end
-			
-			duration /= 24.0
-			
-			return "#{duration.round(1)}d"
-		end
 	end
 end

data/lib/console/resolver.rb

@@ -22,6 +22,36 @@ require_relative 'filter'
 
 module Console
 	class Resolver
+		# You can change the log level for different classes using CONSOLE_<LEVEL> env vars.
+		#
+		# e.g. `CONSOLE_WARN=Acorn,Banana CONSOLE_DEBUG=Cat` will set the log level for the classes Acorn and Banana to `warn` and Cat to `debug`. This overrides the default log level.
+		#
+		# @parameter logger [Logger] A logger instance to set the logging levels on.
+		# @parameter env [Hash] The environment to read levels from.
+		#
+		# @returns [Nil] If there were no custom logging levels specified in the environment.
+		# @returns [Resolver] If there were custom logging levels, then the created resolver is returned.
+		def self.default_resolver(logger, env = ENV)
+			# Find all CONSOLE_<LEVEL> variables from environment:
+			levels = Logger::LEVELS
+				.map{|label, level| [level, env["CONSOLE_#{label.upcase}"]&.split(',')]}
+				.to_h
+				.compact
+			
+			# If we have any levels, then create a class resolver, and each time a class is resolved, set the log level for that class to the specified level:
+			if levels.any?
+				resolver = Resolver.new
+				
+				levels.each do |level, names|
+					resolver.bind(names) do |klass|
+						logger.enable(klass, level)
+					end
+				end
+				
+				return resolver
+			end
+		end
+		
 		def initialize
 			@names = {}
 			

data/lib/console/terminal/logger.rb

@@ -25,6 +25,7 @@ require_relative 'text'
 require_relative 'xterm'
 
 require 'json'
+require 'fiber'
 
 module Console
 	module Terminal
@@ -66,7 +67,6 @@ module Console
 					@verbose = verbose
 				end
 				
-				@terminal[:logger_prefix] ||= @terminal.style(nil, nil, nil)
 				@terminal[:logger_suffix] ||= @terminal.style(:white, nil, :faint)
 				@terminal[:subject] ||= @terminal.style(nil, nil, :bold)
 				@terminal[:debug] = @terminal.style(:cyan)
@@ -136,7 +136,7 @@ module Console
 			def format_argument(argument, output)
 				case argument
 				when Exception
-					Event::Failure.new(argument).format(output, @terminal, @verbose)
+					Event::Failure.for(argument).format(output, @terminal, @verbose)
 				when Event::Generic
 					argument.format(output, @terminal, @verbose)
 				else
@@ -154,11 +154,21 @@ module Console
 				end
 			end
 			
+			def default_suffix(object = nil)
+				buffer = +" #{@terminal[:logger_suffix]}"
+				
+				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}"
+			end
+			
 			def format_object_subject(severity, prefix, subject, output)
 				prefix_style = @terminal[severity]
 				
 				if @verbose
-					suffix = " #{@terminal[:logger_suffix]}[oid=0x#{subject.object_id.to_s(16)}] [pid=#{Process.pid}] [#{Time.now}]#{@terminal.reset}"
+					suffix = default_suffix(subject)
 				end
 				
 				prefix = "#{prefix_style}#{prefix}:#{@terminal.reset} "
@@ -170,7 +180,7 @@ module Console
 				prefix_style = @terminal[severity]
 				
 				if @verbose
-					suffix = " #{@terminal[:logger_suffix]}[pid=#{Process.pid}] [#{Time.now}]#{@terminal.reset}"
+					suffix = default_suffix
 				end
 				
 				prefix = "#{prefix_style}#{prefix}:#{@terminal.reset} "
@@ -187,15 +197,7 @@ module Console
 			end
 			
 			def time_offset_prefix
-				offset = Time.now - @start_at
-				minutes = (offset/60).floor
-				seconds = (offset - (minutes*60))
-				
-				if minutes > 0
-					"#{minutes}m#{seconds.floor}s"
-				else
-					"#{seconds.round(2)}s"
-				end.rjust(6)
+				Clock.formatted_duration(Time.now - @start_at).rjust(6)
 			end
 			
 			def build_prefix(name)

data/lib/console/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Console
-	VERSION = "1.9.1"
+	VERSION = "1.11.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.11.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2021-04-10 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: bake
   requirement: !ruby/object:Gem::Requirement
@@ -90,14 +104,17 @@ files:
 - lib/console.rb
 - lib/console/buffer.rb
 - lib/console/capture.rb
+- lib/console/clock.rb
 - lib/console/event.rb
 - lib/console/event/failure.rb
 - lib/console/event/generic.rb
+- lib/console/event/measure.rb
 - lib/console/event/metric.rb
 - lib/console/event/progress.rb
 - lib/console/event/spawn.rb
 - lib/console/filter.rb
 - lib/console/logger.rb
+- lib/console/measure.rb
 - lib/console/progress.rb
 - lib/console/resolver.rb
 - lib/console/serialized/logger.rb
@@ -126,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Beautiful logging for Ruby.