sus 0.20.3 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a47f7f10111ec9ad45da1d73eced17433ac9cd5c3a7ccf5ab89e5b0d035b9715
-  data.tar.gz: 34d46a116559b3b41d991910fed083903f2074b18c5887ab0c84dc72a4a28707
+  metadata.gz: c8d9e361b911f82db22849e86d61769d01ed115b1137639f1dd323c1a7d9f7e8
+  data.tar.gz: c24ffc6bc111a1860b5bf01c97510a37d79a4efee8ca93c0f5718f40b23c3e25
 SHA512:
-  metadata.gz: c348795bf5c272968060506cd0db933724b4210a36bad55d60088371ee70731aabd66aa6bd07a5c9df4bc9e6a9a59c094e28f7415b9175ba379486f23ccf07d8
-  data.tar.gz: 920a983053b676658d1aafab0fcce16b178203e69c5d949f70426ed874d00ed2026fe30da2b97e0a36b904433206c3d0bd299f6d541564d2dc9610550825fbeb
+  metadata.gz: 2341975dbac7bbb46ed3758f2845158da81310cd9f518cf008c5a04f43da7ca397500db3e24316e3c4ae6918993d0580cb8df0c76c80245fc31b9c2e2a0f4b49
+  data.tar.gz: 04f25d46435a3d3eeb303926f8931857b6b4fc19788f393863de1b610d8eadc04ed96b9868502265c4dce74cac5ce4d22677845834d54fd90f6acd0c121e1946

data/bin/sus-host

@@ -15,12 +15,14 @@ count = Etc.nprocessors
 
 $stdout.sync = true
 
+require_relative '../lib/sus/output/structured'
+
 input = $stdin.dup
 $stdin.reopen(File::NULL)
 output = $stdout.dup
 $stdout.reopen($stderr)
 
-def failure_messages_for(assertions)
+def messages_for(assertions)
 	messages = []
 	
 	assertions.each_failure do |failure|
@@ -63,17 +65,19 @@ while line = input.gets
 						output.puts JSON.generate({started: job.identity})
 					end
 					
-					assertions = Sus::Assertions.new(measure: true)
+					structured_output = Sus::Output::Structured.buffered(output, job.identity)
+					
+					assertions = Sus::Assertions.new(output: structured_output, measure: true)
 					job.call(assertions)
 					results.push(assertions)
 					
 					guard.synchronize do
 						if assertions.passed?
-							output.puts JSON.generate({passed: job.identity, duration: assertions.clock.ms})
+							output.puts JSON.generate({passed: job.identity, messages: messages_for(assertions), duration: assertions.clock.ms})
 						elsif assertions.errored?
-							output.puts JSON.generate({errored: job.identity, messages: failure_messages_for(assertions), duration: assertions.clock.ms})
+							output.puts JSON.generate({errored: job.identity, messages: messages_for(assertions), duration: assertions.clock.ms})
 						else
-							output.puts JSON.generate({failed: job.identity, messages: failure_messages_for(assertions), duration: assertions.clock.ms})
+							output.puts JSON.generate({failed: job.identity, messages: messages_for(assertions), duration: assertions.clock.ms})
 						end
 					end
 				end

data/lib/sus/assertions.rb

@@ -187,13 +187,13 @@ module Sus
 				@passed << assert
 				
 				if !@orientation || @verbose
-					@output.puts(:indent, *pass_prefix, message || "assertion passed", backtrace)
+					@output.assert(condition, @orientation, message || "assertion passed", backtrace)
 				end
 			else
 				@failed << assert
 				
 				if @orientation || @verbose
-					@output.puts(:indent, *fail_prefix, message || "assertion failed", backtrace)
+					@output.assert(condition, @orientation, message || "assertion failed", backtrace)
 				end
 			end
 		end
@@ -222,12 +222,21 @@ module Sus
 		end
 		
 		def skip(reason)
-			@output.puts(:indent, :skipped, skip_prefix, reason)
+			@output.skip(reason, @identity&.scoped)
+			
 			@skipped << self
 		end
 		
-		def inform(message)
-			@output.puts(:indent, :inform, inform_prefix, message)
+		def inform(message = nil)
+			if message.nil? and block_given?
+				begin
+					message = yield
+				rescue => error
+					message = error.full_message
+				end
+			end
+			
+			@output.inform(message, @identity&.scoped)
 		end
 		
 		# Add deferred assertions.
@@ -275,15 +284,8 @@ module Sus
 			
 			@errored << Error.new(identity, error)
 			
-			lines = error.message.split(/\r?\n/)
-			
-			@output.puts(:indent, *error_prefix, error.class, ": ", lines.shift)
-			
-			lines.each do |line|
-				@output.puts(:indent, line)
-			end
-				
-			@output.write(Output::Backtrace.for(error, @identity))
+			# TODO consider passing `identity`.
+			@output.error(error, @identity)
 		end
 		
 		def nested(target, identity: nil, isolated: false, distinct: false, inverted: false, **options)
@@ -402,36 +404,5 @@ module Sus
 			# 	@output.puts
 			# end
 		end
-		
-		PASSED_PREFIX = [:passed, "✓ "].freeze
-		FAILED_PREFIX = [:failed, "✗ "].freeze
-		
-		def pass_prefix
-			if @orientation
-				PASSED_PREFIX
-			else
-				FAILED_PREFIX
-			end
-		end
-		
-		def fail_prefix
-			if @orientation
-				FAILED_PREFIX
-			else
-				PASSED_PREFIX
-			end
-		end
-		
-		def inform_prefix
-			"ℹ "
-		end
-		
-		def skip_prefix
-			"⏸ "
-		end
-		
-		def error_prefix
-			[:errored, "⚠ "]
-		end
 	end
 end

data/lib/sus/it.rb

@@ -45,13 +45,9 @@ module Sus
 		end
 		
 		def handle_skip(instance, assertions)
-			reason = catch(:skip) do
+			catch(:skip) do
 				return instance.call
 			end
-			
-			assertions.skip(reason)
-			
-			return nil
 		end
 	end
 	
@@ -62,7 +58,10 @@ module Sus
 	end
 	
 	class Base
+		# Skip the current test with a reason.
+		# @parameter reason [String] The reason for skipping the test.
 		def skip(reason)
+			@__assertions__.skip(reason)
 			throw :skip, reason
 		end
 	end

data/lib/sus/output/buffered.rb

@@ -75,6 +75,26 @@ module Sus
 				@chunks << [:puts, *arguments]
 				@tee&.puts(*arguments)
 			end
+			
+			def assert(*arguments)
+				@chunks << [:assert, *arguments]
+				@tee&.assert(*arguments)
+			end
+			
+			def skip(*arguments)
+				@chunks << [:skip, *arguments]
+				@tee&.skip(*arguments)
+			end
+			
+			def error(*arguments)
+				@chunks << [:error, *arguments]
+				@tee&.error(*arguments)
+			end
+			
+			def inform(*arguments)
+				@chunks << [:inform, *arguments]
+				@tee&.inform(*arguments)
+			end
 		end
 	end
 end

data/lib/sus/output/messages.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+module Sus
+	# Styled output output.
+	module Output
+		module Messages
+			PASSED_PREFIX = [:passed, "✓ "].freeze
+			FAILED_PREFIX = [:failed, "✗ "].freeze
+			
+			def pass_prefix(orientation)
+				if orientation
+					PASSED_PREFIX
+				else
+					FAILED_PREFIX
+				end
+			end
+			
+			def fail_prefix(orientation)
+				if orientation
+					FAILED_PREFIX
+				else
+					PASSED_PREFIX
+				end
+			end
+			
+			# If the orientation is true, and the test passed, then it is a successful outcome.
+			# If the orientation is false, and the test failed, then it is a successful outcome.
+			# Otherwise, it is a failed outcome.
+			# 
+			# @parameter condition [Boolean] The result of the test.
+			# @parameter orientation [Boolean] The orientation of the assertions.
+			# @parameter message [String] The message to display.
+			# @parameter backtrace [Array] The backtrace to display.
+			def assert(condition, orientation, message, backtrace)
+				if condition
+					self.puts(:indent, *pass_prefix(orientation), message, backtrace)
+				else
+					self.puts(:indent, *fail_prefix(orientation), message, backtrace)
+				end
+			end
+			
+			def skip_prefix
+				"⏸ "
+			end
+			
+			def skip(reason, identity)
+				self.puts(:indent, :skipped, skip_prefix, reason)
+			end
+			
+			def error_prefix
+				[:errored, "⚠ "]
+			end
+			
+			def error(error, identity)
+				lines = error.message.split(/\r?\n/)
+			
+				self.puts(:indent, *error_prefix, error.class, ": ", lines.shift)
+				
+				lines.each do |line|
+					self.puts(:indent, line)
+				end
+					
+				self.write(Output::Backtrace.for(error, identity))
+			end
+			
+			def inform_prefix
+				"ℹ "
+			end
+			
+			def inform(message, identity)
+				self.puts(:indent, :inform, inform_prefix, message)
+			end
+		end
+	end
+end

data/lib/sus/output/null.rb

@@ -3,13 +3,14 @@
 # Released under the MIT License.
 # Copyright, 2021-2022, by Samuel Williams.
 
-require 'io/console'
-require 'stringio'
+require_relative 'messages'
 
 module Sus
 	# Styled output output.
 	module Output
 		class Null
+			include Messages
+			
 			def initialize
 			end
 			

data/lib/sus/output/structured.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require_relative 'null'
+
+module Sus
+	# Styled output output.
+	module Output
+		class Structured < Null
+			def self.buffered(...)
+				Buffered.new(self.new(...))
+			end
+			
+			def initialize(io, identity = nil)
+				@io = io
+				@identity = identity
+			end
+			
+			def skip(reason, identity)
+				inform(reason.to_s, identity)
+			end
+			
+			def inform(message, identity)
+				unless message.is_a?(String)
+					message = message.inspect
+				end
+				
+				@io.puts(JSON.generate({
+					inform: @identity,
+					message: {
+						text: message,
+						location: identity&.to_location,
+					}
+				}))
+				
+				@io.flush
+			end
+		end
+	end
+end

data/lib/sus/output/text.rb

@@ -3,13 +3,14 @@
 # Released under the MIT License.
 # Copyright, 2021-2022, by Samuel Williams.
 
-require 'io/console'
+require_relative 'messages'
 require_relative 'buffered'
 
 module Sus
-	# Styled io io.
 	module Output
 		class Text
+			include Messages
+			
 			def initialize(io)
 				@io = io
 				

data/lib/sus/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2021-2022, by Samuel Williams.
 
 module Sus
-	VERSION = "0.20.3"
+	VERSION = "0.21.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.20.3
+  version: 0.21.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake-test
@@ -125,9 +125,11 @@ files:
 - lib/sus/output/bar.rb
 - lib/sus/output/buffered.rb
 - lib/sus/output/lines.rb
+- lib/sus/output/messages.rb
 - lib/sus/output/null.rb
 - lib/sus/output/progress.rb
 - lib/sus/output/status.rb
+- lib/sus/output/structured.rb
 - lib/sus/output/text.rb
 - lib/sus/output/xterm.rb
 - lib/sus/raise_exception.rb