console 1.10.2 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a777953a8fd749c475d101a185f5f45ab11005574c3f23e413c16058e22500b
-  data.tar.gz: 778b3da976350ffc23d5aad6d142a9398ffbd0be6c8e5931c8c5c9b4f3c49f63
+  metadata.gz: 5928a2a5d4c07c44e8ad937edbab2b8fa326ff13553ffb4bf89c0854184f1bd8
+  data.tar.gz: e0495d1933a3a0991b23193aae3988fb679389f02514d57c9a15ce7ccbf73497
 SHA512:
-  metadata.gz: '0280c9d59cd23431f0c2ede8da258795790af325c64dacc63dc791a0682baad85348ddbd04ef954ad17ade370958a606b6f83e42ae4c8873eaea4bc11f4a409a'
-  data.tar.gz: eb013fb3e45477510bf1cdf40fbfbba739be5cb3fda1f8366eb97c3898d31a7eb932a3c72c8a668e6e78f0ea57cc0d813207f50567168d0e6ea723ef09898533
+  metadata.gz: e69af353f0397d3620654d9108b2cb7fffe4d601e4a4f9feea7cdf09a7cd40aa3f310faded79abfc8de5735c257b59713bb9d5a91d5320a1dca15d0df4a92804
+  data.tar.gz: c46ec0e33e56260345710facc882d89edb4782179ccdb7ec97ed70c3d83087465b4758ceecdaa7f8ac4e2508dc18f46968974bee19a694c62c5314157a8402fe

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,15 +68,18 @@ module Console
 					output.puts "  #{terminal[:exception_detail]}#{line}#{terminal.reset}"
 				end
 				
-				root_expr = /^#{@root}\// if @root
-
+				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.sub!(root_expr, "./") if root_expr
-
-					output.puts "  #{index == 0 ? "→" : " "} #{terminal[:exception_backtrace]}#{path}:#{offset}#{terminal.reset} #{message}"
+					if root_pattern and path.sub!(root_pattern, "").nil?
+						style = :exception_backtrace_other
+					end
+					
+					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,6 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'filter'
+require_relative 'measure'
 require_relative 'progress'
 
 require_relative 'resolver'
@@ -73,8 +74,15 @@ module Console
 			Progress.new(self, subject, total, **options)
 		end
 		
-		# @deprecated Please use {progress}.
-		alias measure progress
+		def measure(subject, name = "block", **options, &block)
+			measure = Measure.new(self, subject)
+			
+			if block_given?
+				measure.duration(name, **options, &block)
+			end
+			
+			return measure
+		end
 		
 		def failure(subject, exception, *arguments, &block)
 			fatal(subject, *arguments, Event::Failure.new(exception), &block)

data/lib/console/measure.rb

@@ -0,0 +1,46 @@
+# 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)
+			@output = output
+			@subject = subject
+		end
+		
+		# Measure the execution of a block of code.
+		def duration(name, **tags, &block)
+			@output.info(@subject) {Event::Enter.new(name)}
+			
+			start_time = Clock.now
+			
+			yield
+			
+			duration = Clock.now - start_time
+			
+			@output.info(@subject) {Event::Exit.new(name, duration, **tags)}
+			
+			return duration
+		end
+	end
+end

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.10.2"
+	VERSION = "1.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.10.2
+  version: 1.11.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-27 00:00:00.000000000 Z
+date: 2021-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiber-local
@@ -104,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