sus 0.20.2 → 0.20.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abff2f6428b5b2a3b86b3ad54d32d73f9b78bf58cd1f81bf010cc7593e1c4bc2
-  data.tar.gz: 4fb6c173ac38b1c2e2053867d7f8ec768a9cfdd90ddfa8db366ef4af799a3211
+  metadata.gz: a47f7f10111ec9ad45da1d73eced17433ac9cd5c3a7ccf5ab89e5b0d035b9715
+  data.tar.gz: 34d46a116559b3b41d991910fed083903f2074b18c5887ab0c84dc72a4a28707
 SHA512:
-  metadata.gz: 23f742731558ca0bb9b3a2a09bc3fb01a6f5d8fb2af4309c41d750866f3e3a9f25be059f1c186670132b1eeafb7896d40262cec04c20d0f8c41e2b73b9255136
-  data.tar.gz: e1e4ba8a789c2ca7c1c8391e975499185a0860afc738c3fc0b94dc380c3d22434daef20a0992a07179740f5568afb88a0dda4ef97c1485e96af56ac67d2cce57
+  metadata.gz: c348795bf5c272968060506cd0db933724b4210a36bad55d60088371ee70731aabd66aa6bd07a5c9df4bc9e6a9a59c094e28f7415b9175ba379486f23ccf07d8
+  data.tar.gz: 920a983053b676658d1aafab0fcce16b178203e69c5d949f70426ed874d00ed2026fe30da2b97e0a36b904433206c3d0bd299f6d541564d2dc9610550825fbeb

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,17 +179,18 @@ 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)
 				end
 			else
-				@failed << Assert.new(identity, self)
+				@failed << assert
 				
 				if @orientation || @verbose
 					@output.puts(:indent, *fail_prefix, message || "assertion failed", backtrace)
@@ -188,12 +198,19 @@ module Sus
 			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)
@@ -247,14 +264,14 @@ 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)
 			
@@ -269,11 +286,11 @@ module Sus
 			@output.write(Output::Backtrace.for(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 +305,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 +326,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 +358,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 +387,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)

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.20.2
+  version: 0.20.3
 platform: ruby
 authors:
 - Samuel Williams
@@ -160,7 +160,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.