console 1.9.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79f9ed13eedb54202ce2111a451e6e7d744f97db971a6b619ba3decb5aa6c963
-  data.tar.gz: 8c77221c0e50be91b7c1857fde7b596ec7e48eebd67a43287bd01aa3f95e70b4
+  metadata.gz: ebadd29a9248f8a155c3bc22550a6433e53af806acae2112fe96a3924c92fb8d
+  data.tar.gz: fd23c8cb36efc9a36f688c2caa0383feb85fe7fdab2992d269239650faa8f92a
 SHA512:
-  metadata.gz: 021e0bd5c98d7019af39186b6fa06e49aed619cb5228051a85725bd43f3f05d8015b6d9bc84baf3a49f51a9b13ac62ed65cb20051f9561939d0fb72c791b8475
-  data.tar.gz: '029abdaded5a4d383e7e4b666c99e2b06c0aaabed87c1da9740c6925ca5e9308eb41b52d61835e0b6a3223efff9b25a98aac555fe43c2ca441ef48f5f27e6f3f'
+  metadata.gz: 02b4cecf9844a7d6bb733da31953805d89590b5a43b68e7d6cc379bde7e2660e3064438385d40b147cde4c89b50b7f7f9f4cf3f58aa69e1498e0085f56015a86
+  data.tar.gz: 3bba83e7c801994f6fdb6a1a248fbac746a8a9987f786d30df73c91ba7d79032226d4f78d3eed9fb1a5d0eb9c339f89864c15fcceb823a2f877e81fe90c977f7

data/lib/console/capture.rb

@@ -21,15 +21,20 @@
 require_relative 'filter'
 
 module Console
+	# A general sink which captures all events into a buffer.
 	class Capture
 		def initialize
-			@events = []
+			@buffer = []
 		end
 		
-		attr :events
+		attr :buffer
 		
 		def last
-			@events.last
+			@buffer.last
+		end
+		
+		def clear
+			@buffer.clear
 		end
 		
 		def verbose!(value = true)
@@ -37,7 +42,7 @@ module Console
 		
 		def call(subject = nil, *arguments, severity: UNKNOWN, **options, &block)
 			message = {
-				time: Time.now.iso8601,
+				time: ::Time.now.iso8601,
 				severity: severity,
 				**options,
 			}
@@ -60,7 +65,7 @@ module Console
 				end
 			end
 			
-			@events << message
+			@buffer << message
 		end
 	end
 end

data/lib/console/event.rb

@@ -20,4 +20,5 @@
 
 require_relative 'event/spawn'
 require_relative 'event/failure'
+require_relative 'event/metric'
 require_relative 'event/progress'

data/lib/console/event/failure.rb

@@ -49,6 +49,10 @@ module Console
 				terminal[:exception_backtrace] ||= terminal.style(:red)
 			end
 			
+			def to_h
+				{exception: @exception, root: @root}
+			end
+			
 			def format(output, terminal, verbose)
 				format_exception(@exception, nil, output, terminal, verbose)
 			end

data/lib/console/event/generic.rb

@@ -24,6 +24,13 @@ module Console
 			def self.register(terminal)
 			end
 			
+			def to_h
+			end
+			
+			def as_json
+				to_h
+			end
+			
 			def format(buffer, terminal)
 			end
 		end

data/lib/console/event/metric.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 'generic'
+
+module Console
+	module Event
+		class Metric < Generic
+			def self.[](**parameters)
+				parameters.map(&self.method(:new))
+			end
+			
+			def initialize(name, value, **tags)
+				@name = name
+				@value = value
+				@tags = tags
+			end
+			
+			attr :name
+			attr :value
+			attr :tags
+			
+			def to_h
+				{name: @name, value: @value, tags: @tags}
+			end
+			
+			def format(output, terminal, verbose)
+				output.puts "#{@name}=#{@value} #{@tags.inspect}"
+			end
+		end
+	end
+end

data/lib/console/event/progress.rb

@@ -63,7 +63,7 @@ module Console
 				terminal[:progress_bar] ||= terminal.style(:blue, :white)
 			end
 			
-			def as_json
+			def to_h
 				{current: @current, total: @total}
 			end
 			

data/lib/console/event/spawn.rb

@@ -24,6 +24,7 @@ module Console
 	module Event
 		class Spawn < Generic
 			def self.for(*arguments, **options)
+				# Extract out the command environment:
 				if arguments.first.is_a?(Hash)
 					self.new(*arguments, **options)
 				else
@@ -51,6 +52,10 @@ module Console
 				terminal[:shell_command] ||= terminal.style(:blue, nil, :bold)
 			end
 			
+			def to_h
+				{environment: @environment, arguments: @arguments, options: @options}
+			end
+			
 			def format(output, terminal, verbose)
 				arguments = @arguments.flatten.collect(&:to_s)
 				

data/lib/console/filter.rb

@@ -46,7 +46,7 @@ module Console
 					end
 					
 					define_method("#{name}?") do
-						@level >= level
+						@level <= level
 					end
 				end
 			end

data/lib/console/logger.rb

@@ -19,7 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'filter'
-require_relative 'measure'
+require_relative 'progress'
 
 module Console
 	class Logger < Filter[debug: 0, info: 1, warn: 2, error: 3, fatal: 4]
@@ -29,8 +29,15 @@ module Console
 			super(output, **options)
 		end
 		
-		def measure(subject, total)
-			Measure.new(self, subject, total)
+		def progress(subject, total, **options)
+			Progress.new(self, subject, total, **options)
+		end
+		
+		# @deprecated Please use {progress}.
+		alias measure progress
+		
+		def failure(subject, exception, *arguments, &block)
+			fatal(subject, *arguments, Event::Failure.new(exception), &block)
 		end
 	end
 end

data/lib/console/{measure.rb → progress.rb}

@@ -18,26 +18,33 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'event/progress'
+
 module Console
-	class Measure
-		def initialize(output, subject, total = 0)
+	class Progress
+		def self.now
+			Process.clock_gettime(Process::CLOCK_MONOTONIC)
+		end
+		
+		def initialize(output, subject, total = 0, minimum_output_duration: 1.0)
 			@output = output
 			@subject = subject
 			
-			@start_time = Time.now
+			@start_time = Progress.now
+			
+			@last_output_time = nil
+			@minimum_output_duration = 0.1
 			
 			@current = 0
 			@total = total
 		end
 		
 		attr :subject
-		
 		attr :current
-		
 		attr :total
 		
 		def duration
-			Time.now - @start_time
+			Progress.now - @start_time
 		end
 		
 		def progress
@@ -63,7 +70,10 @@ module Console
 		def increment(amount = 1)
 			@current += amount
 			
-			@output.info(@subject, self) {Event::Progress.new(@current, @total)}
+			if output?
+				@output.info(@subject, self) {Event::Progress.new(@current, @total)}
+				@last_output_time = Progress.now
+			end
 			
 			return self
 		end
@@ -72,6 +82,7 @@ module Console
 			@total = total
 			
 			@output.info(@subject, self) {Event::Progress.new(@current, @total)}
+			@last_output_time = Progress.now
 			
 			return self
 		end
@@ -90,6 +101,20 @@ module Console
 		
 		private
 		
+		def duration_since_last_output
+			if @last_output_time
+				Progress.now - @last_output_time
+			end
+		end
+		
+		def output?
+			if 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"

data/lib/console/terminal/logger.rb

@@ -24,6 +24,8 @@ require_relative '../event'
 require_relative 'text'
 require_relative 'xterm'
 
+require 'json'
+
 module Console
 	module Terminal
 		# This, and all related methods, is considered private.
@@ -77,7 +79,9 @@ module Console
 			end
 			
 			attr :io
+			
 			attr_accessor :verbose
+			
 			attr :start
 			attr :terminal
 			
@@ -94,7 +98,7 @@ module Console
 			
 			UNKNOWN = 'unknown'
 			
-			def call(subject = nil, *arguments, name: nil, severity: UNKNOWN, &block)
+			def call(subject = nil, *arguments, name: nil, severity: UNKNOWN, **options, &block)
 				prefix = build_prefix(name || severity.to_s)
 				indent = " " * prefix.size
 				
@@ -104,6 +108,10 @@ module Console
 					format_subject(severity, prefix, subject, buffer)
 				end
 				
+				if options&.any?
+					format_options(options, buffer)
+				end
+				
 				arguments.each do |argument|
 					format_argument(argument, buffer)
 				end
@@ -121,6 +129,10 @@ module Console
 			
 			protected
 			
+			def format_options(options, output)
+				format_value(options.to_json, output)
+			end
+			
 			def format_argument(argument, output)
 				case argument
 				when Exception

data/lib/console/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -93,11 +93,12 @@ files:
 - lib/console/event.rb
 - lib/console/event/failure.rb
 - lib/console/event/generic.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
 - lib/console/split.rb