sus 0.20.2 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abff2f6428b5b2a3b86b3ad54d32d73f9b78bf58cd1f81bf010cc7593e1c4bc2
-  data.tar.gz: 4fb6c173ac38b1c2e2053867d7f8ec768a9cfdd90ddfa8db366ef4af799a3211
+  metadata.gz: c8d9e361b911f82db22849e86d61769d01ed115b1137639f1dd323c1a7d9f7e8
+  data.tar.gz: c24ffc6bc111a1860b5bf01c97510a37d79a4efee8ca93c0f5718f40b23c3e25
 SHA512:
-  metadata.gz: 23f742731558ca0bb9b3a2a09bc3fb01a6f5d8fb2af4309c41d750866f3e3a9f25be059f1c186670132b1eeafb7896d40262cec04c20d0f8c41e2b73b9255136
-  data.tar.gz: e1e4ba8a789c2ca7c1c8391e975499185a0860afc738c3fc0b94dc380c3d22434daef20a0992a07179740f5568afb88a0dda4ef97c1485e96af56ac67d2cce57
+  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

@@ -16,7 +16,7 @@ module Sus
 		
 		# @parameter orientation [Boolean] Whether the assertions are positive or negative in general.
 		# @parameter inverted [Boolean] Whether the assertions are inverted with respect to the parent.
-		def initialize(identity: nil, target: nil, output: Output.buffered, inverted: false, orientation: true, isolated: false, measure: false, verbose: false)
+		def initialize(identity: nil, target: nil, output: Output.buffered, inverted: false, orientation: true, isolated: false, distinct: false, measure: false, verbose: false)
 			# In theory, the target could carry the identity of the assertion group, but it's not really necessary, so we just handle it explicitly and pass it into any nested assertions.
 			@identity = identity
 			@target = target
@@ -24,6 +24,7 @@ module Sus
 			@inverted = inverted
 			@orientation = orientation
 			@isolated = isolated
+			@distinct = distinct
 			@verbose = verbose
 			
 			if measure
@@ -46,13 +47,18 @@ module Sus
 		attr :output
 		attr :level
 		
-		# Whether this aset of assertions is inverted
+		# Whether this aset of assertions is inverted, i.e. the assertions are expected to fail relative to the parent. Used for grouping assertions and ensuring they are added to the parent passed/failed array correctly.
 		attr :inverted
 		
-		# The absolute orientation of this set of assertions:
+		# The absolute orientation of this set of assertions, i.e. whether the assertions are expected to pass or fail regardless of the parent. Used for correctly formatting the output.
 		attr :orientation
 		
+		# Whether this set of assertions is isolated from the parent. This is used to ensure taht any deferred assertions are competed before the parent is completed. This is used by `receive` assertions which are deferred until the user code of the test has completed.
 		attr :isolated
+		
+		# Distinct is used to identify a set of assertions as a single statement for the purpose of user feedback. It's used by top level ensure statements to ensure that error messages are captured and reported on those statements.
+		attr :distinct
+		
 		attr :verbose
 		
 		attr :clock
@@ -147,12 +153,14 @@ module Sus
 		end
 		
 		class Assert
-			def initialize(identity, assertions)
+			def initialize(identity, backtrace, assertions)
 				@identity = identity
+				@backtrace = backtrace
 				@assertions = assertions
 			end
 			
 			attr :identity
+			attr :backtrace
 			attr :assertions
 			
 			def each_failure(&block)
@@ -161,7 +169,8 @@ module Sus
 			
 			def message
 				{
-					text: assertions.output.string,
+					# It's possible that several Assert instances might share the same output text. This is because the output is buffered for each test and each top-level test expectation.
+					text: @assertions.output.string,
 					location: @identity&.to_location
 				}
 			end
@@ -170,30 +179,38 @@ module Sus
 		def assert(condition, message = nil)
 			@count += 1
 			
-			backtrace = Output::Backtrace.first(@identity)
 			identity = @identity&.scoped
+			backtrace = Output::Backtrace.first(identity)
+			assert = Assert.new(identity, backtrace, self)
 			
 			if condition
-				@passed << Assert.new(identity, self)
+				@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.new(identity, self)
+				@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
 		
+		def message
+			{
+				text: @output.string,
+				location: @identity&.to_location
+			}
+		end
+		
 		def each_failure(&block)
 			return to_enum(__method__) unless block_given?
 			
-			# if self.failed? and @identity
-			# 	yield self
-			# end
+			if self.failed? and @distinct
+				return yield(self)
+			end
 			
 			@failed.each do |assertions|
 				assertions.each_failure(&block)
@@ -205,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.
@@ -247,33 +273,26 @@ module Sus
 			
 			def message
 				{
-					text: @error.message,
+					text: @error.full_message,
 					location: @identity&.to_location
 				}
 			end
 		end
 		
 		def error!(error)
-			identity = @identity.scoped(error.backtrace_locations)
+			identity = @identity&.scoped(error.backtrace_locations)
 			
 			@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: @identity, isolated: false, buffered: false, inverted: false, **options)
+		def nested(target, identity: nil, isolated: false, distinct: false, inverted: false, **options)
 			result = nil
 			
 			# Isolated assertions need to have buffered output so they can be replayed if they fail:
-			if isolated or buffered
+			if isolated or distinct
 				output = @output.buffered
 			else
 				output = @output
@@ -288,7 +307,7 @@ module Sus
 			
 			output.puts(:indent, target)
 			
-			assertions = self.class.new(identity: identity, target: target, output: output, isolated: isolated, inverted: inverted, orientation: orientation, verbose: @verbose, **options)
+			assertions = self.class.new(identity: identity, target: target, output: output, isolated: isolated, inverted: inverted, orientation: orientation, distinct: distinct, verbose: @verbose, **options)
 			
 			output.indented do
 				begin
@@ -309,15 +328,17 @@ module Sus
 			# All child assertions should be resolved by this point:
 			raise "Nested assertions must be fully resolved!" if assertions.deferred?
 			
-			if assertions.isolated or assertions.inverted
+			if assertions.append?
 				# If we are isolated, we merge all child assertions into the parent as a single entity:
-				merge!(assertions)
+				append!(assertions)
 			else
 				# Otherwise, we append all child assertions into the parent assertions:
-				append!(assertions)
+				merge!(assertions)
 			end
 		end
 		
+		protected
+		
 		def resolve_into(parent)
 			# If the assertions should be an isolated group, make sure any deferred assertions are resolved:
 			if @isolated and self.deferred?
@@ -339,9 +360,14 @@ module Sus
 			end
 		end
 		
+		# Whether the child assertions should be merged into the parent assertions.
+		def append?
+			@isolated || @inverted || @distinct
+		end
+		
 		private
 		
-		def merge!(assertions)
+		def append!(assertions)
 			@count += assertions.count
 			
 			if assertions.errored?
@@ -363,7 +389,8 @@ module Sus
 			end
 		end
 		
-		def append!(assertions)
+		# Concatenate the child assertions into this instance.
+		def merge!(assertions)
 			@count += assertions.count
 			@passed.concat(assertions.passed)
 			@failed.concat(assertions.failed)
@@ -377,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/expect.rb

@@ -5,16 +5,15 @@
 
 module Sus
 	class Expect
-		def initialize(assertions, subject, inverted: false, buffered: false)
+		def initialize(assertions, subject, inverted: false, distinct: false)
 			@assertions = assertions
 			@subject = subject
 			@inverted = inverted
-			@buffered = buffered
+			@distinct = true
 		end
 		
 		attr :subject
 		attr :inverted
-		attr :assertions
 		
 		def not
 			self.dup.tap do |expect|
@@ -36,7 +35,7 @@ module Sus
 			# This gets the identity scoped to the current call stack, which ensures that any failures are logged at this point in the code.
 			identity = @assertions.identity&.scoped
 			
-			@assertions.nested(self, inverted: @inverted, buffered: @buffered, identity: identity) do |assertions|
+			@assertions.nested(self, inverted: @inverted, identity: identity, distinct: @distinct) do |assertions|
 				predicate.call(assertions, @subject)
 			end
 			
@@ -51,9 +50,9 @@ module Sus
 	class Base
 		def expect(subject = nil, &block)
 			if block_given?
-				Expect.new(@__assertions__, block, buffered: true)
+				Expect.new(@__assertions__, block, distinct: true)
 			else
-				Expect.new(@__assertions__, subject, buffered: true)
+				Expect.new(@__assertions__, subject, distinct: true)
 			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.2"
+	VERSION = "0.21.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.20.2
+  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
@@ -160,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: A fast and scalable test runner.