sus 0.18.0 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77921dd1b6bbde6e2a47db7f4a2f0c421c3f517eb04b7d4273538a5891f51ad2
-  data.tar.gz: 204c68cd216e6ddb74e469bbdc01ce042f4d4d0d9fab9b3b897d2ebbcce7fec6
+  metadata.gz: 7368b0ed0e288959f59f0fe6c2c5dd93ff90ba52f423b1365406e8de260536c1
+  data.tar.gz: 10fe5fec8209ce9cea739f580a3f4bd1b36be3b6e384f6ff85ad813fad32d0f2
 SHA512:
-  metadata.gz: a9e50aa174880249cd96f519242d59396315475972432b60dd41e6b2c35d5025a7dfb7824fc538a1bee5199c2d93686c0673e4d72de7126f512a1c237041c8ad
-  data.tar.gz: 8580ec8e113b18c6e61f14c3f31804d76663cfa6288e965fb44d4a06238283461b856d593abb83bee4d270d32da865c609fc253a840d6f58d3ac49a8a7d9cc66
+  metadata.gz: 1456e34138bea3c5952ababab2950ac946ddce0a3f55879ed1bedb9828c536ffb5c4ced7b9a35f4e80ad1879e230dd26b0fc120b7258e218710530165d9233e5
+  data.tar.gz: b1ea6d027ec46f0aa72e74fd6cb169a71b5209a57791b52b7f41c1a1f2fc7d70353e08e73ebfef2d7262e67a7be10702500d07ee99f18499d898de5b0ad917ed

data/bin/sus-host

@@ -20,6 +20,16 @@ $stdin.reopen(File::NULL)
 output = $stdout.dup
 $stdout.reopen($stderr)
 
+def failure_messages_for(assertions)
+	messages = []
+	
+	assertions.each_failure do |failure|
+		messages << failure.message
+	end
+	
+	return messages
+end
+
 while line = input.gets
 	message = JSON.parse(line)
 	
@@ -55,14 +65,15 @@ while line = input.gets
 					
 					assertions = Sus::Assertions.new(measure: true)
 					job.call(assertions)
-					
 					results.push(assertions)
 					
 					guard.synchronize do
 						if assertions.passed?
-							output.puts JSON.generate({passed: job.identity, message: assertions.output.string, duration: assertions.clock.ms})
+							output.puts JSON.generate({passed: job.identity, duration: assertions.clock.ms})
+						elsif assertions.errored?
+							output.puts JSON.generate({errored: job.identity, messages: failure_messages_for(assertions), duration: assertions.clock.ms})
 						else
-							output.puts JSON.generate({failed: job.identity, message: assertions.output.string, duration: assertions.clock.ms})
+							output.puts JSON.generate({failed: job.identity, messages: failure_messages_for(assertions), duration: assertions.clock.ms})
 						end
 					end
 				end

data/lib/sus/assertions.rb

@@ -41,6 +41,7 @@ module Sus
 			@count = 0
 		end
 		
+		attr :identity
 		attr :target
 		attr :output
 		attr :level
@@ -75,6 +76,13 @@ module Sus
 			"\#<#{self.class} #{@passed.size} passed #{@failed.size} failed #{@deferred.size} deferred #{@skipped.size} skipped #{@errored.size} errored>"
 		end
 		
+		def message
+			{
+				text: @output.string,
+				location: @identity&.to_location
+			}
+		end
+		
 		def total
 			@passed.size + @failed.size + @deferred.size + @skipped.size + @errored.size
 		end
@@ -139,35 +147,64 @@ module Sus
 		end
 		
 		class Assert
-			def initialize(location, message)
-				@location = location
+			def initialize(identity, message)
+				@identity = identity
 				@message = message
 			end
 			
-			attr :location
+			attr :identity
 			attr :message
+			
+			def each_failure(&block)
+				yield self
+			end
+			
+			def message
+				{
+					text: @message,
+					location: @identity&.to_location
+				}
+			end
 		end
 		
 		def assert(condition, message = nil)
 			@count += 1
+			
+			message ||= self.output.string
 			backtrace = Output::Backtrace.first(@identity)
+			identity = @identity&.scoped
 			
 			if condition
-				@passed << Assert.new(message, backtrace)
+				@passed << Assert.new(identity, message)
 				
 				if !@orientation || @verbose
-					@output.puts(:indent, *pass_prefix, message || "assertion", backtrace)
+					@output.puts(:indent, *pass_prefix, message, backtrace)
 				end
 			else
-				
-				@failed << Assert.new(message, backtrace)
+				@failed << Assert.new(identity, message)
 				
 				if @orientation || @verbose
-					@output.puts(:indent, *fail_prefix, message || "assertion", backtrace)
+					@output.puts(:indent, *fail_prefix, message, backtrace)
 				end
 			end
 		end
 		
+		def each_failure(&block)
+			return to_enum(__method__) unless block_given?
+			
+			# if self.failed? and @identity
+			# 	yield self
+			# end
+			
+			@failed.each do |assertions|
+				assertions.each_failure(&block)
+			end
+			
+			@errored.each do |assertions|
+				assertions.each_failure(&block)
+			end
+		end
+		
 		def skip(reason)
 			@output.puts(:indent, :skipped, skip_prefix, reason)
 			@skipped << self
@@ -196,8 +233,31 @@ module Sus
 			end
 		end
 		
+		class Error
+			def initialize(identity, error)
+				@identity = identity
+				@error = error
+			end
+			
+			attr :identity
+			attr :error
+			
+			def each_failure(&block)
+				yield self
+			end
+			
+			def message
+				{
+					text: @error.message,
+					location: @identity&.to_location
+				}
+			end
+		end
+		
 		def error!(error)
-			@errored << self
+			identity = @identity.scoped(error.backtrace_locations)
+			
+			@errored << Error.new(identity, error)
 			
 			lines = error.message.split(/\r?\n/)
 			
@@ -210,11 +270,11 @@ module Sus
 			@output.write(Output::Backtrace.for(error, @identity))
 		end
 		
-		def nested(target, identity: @identity, isolated: false, inverted: false, **options)
+		def nested(target, identity: @identity, isolated: false, buffered: false, inverted: false, **options)
 			result = nil
 			
 			# Isolated assertions need to have buffered output so they can be replayed if they fail:
-			if isolated
+			if isolated or buffered
 				output = @output.buffered
 			else
 				output = @output

data/lib/sus/base.rb

@@ -45,7 +45,7 @@ module Sus
 		base.extend(Context)
 		base.identity = Identity.new(root) if root
 		base.description = description
-				
+		
 		return base
 	end
 end

data/lib/sus/expect.rb

@@ -5,10 +5,11 @@
 
 module Sus
 	class Expect
-		def initialize(assertions, subject, inverted: false)
+		def initialize(assertions, subject, inverted: false, buffered: false)
 			@assertions = assertions
 			@subject = subject
 			@inverted = inverted
+			@buffered = buffered
 		end
 		
 		attr :subject
@@ -32,13 +33,16 @@ module Sus
 		end
 		
 		def to(predicate)
-			@assertions.nested(self, inverted: @inverted) do |assertions|
+			# 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|
 				predicate.call(assertions, @subject)
 			end
 			
 			return self
 		end
-
+		
 		def and(predicate)
 			return to(predicate)
 		end
@@ -47,9 +51,9 @@ module Sus
 	class Base
 		def expect(subject = nil, &block)
 			if block_given?
-				Expect.new(@__assertions__, block)
+				Expect.new(@__assertions__, block, buffered: true)
 			else
-				Expect.new(@__assertions__, subject)
+				Expect.new(@__assertions__, subject, buffered: true)
 			end
 		end
 	end

data/lib/sus/file.rb

@@ -9,6 +9,17 @@ require_relative 'context'
 # This has to be done at the top level. It allows us to define constants within the given class while still retaining top-level constant resolution.
 Sus::TOPLEVEL_CLASS_EVAL = ->(__klass__, __path__){__klass__.class_eval(::File.read(__path__), __path__)}
 
+# This is a hack to allow us to get the line number of a syntax error.
+unless SyntaxError.method_defined?(:lineno)
+	class SyntaxError
+		def lineno
+			if message =~ /:(\d+):/
+				$1.to_i
+			end
+		end
+	end
+end
+
 module Sus
 	module File
 		extend Context
@@ -19,11 +30,17 @@ module Sus
 		
 		def self.build(parent, path)
 			base = Class.new(parent)
+			
 			base.extend(File)
 			base.description = path
-			base.identity = Identity.new(path)
+			base.identity = Identity.file(parent.identity, path)
 			
-			TOPLEVEL_CLASS_EVAL.call(base, path)
+			begin
+				TOPLEVEL_CLASS_EVAL.call(base, path)
+			rescue StandardError, LoadError, SyntaxError => error
+				# We add this as a child of the base class so that it is included in the tree under the file rather than completely replacing it, which can be confusing:
+				base.add FileLoadError.build(self, path, error)
+			end
 			
 			return base
 		end
@@ -35,7 +52,16 @@ module Sus
 	
 	class FileLoadError
 		def self.build(parent, path, error)
-			self.new(Identity.new(path), path, error)
+			identity = Identity.file(parent.identity, path)
+			
+			# This is a mess.
+			if error.is_a?(SyntaxError) and error.path == path
+				identity = identity.with_line(error.lineno)
+			else
+				identity = identity.scoped(error.backtrace_locations)
+			end
+			
+			self.new(identity, path, error)
 		end
 		
 		def initialize(identity, path, error)
@@ -45,17 +71,22 @@ module Sus
 		end
 		
 		attr :identity
+		attr :error
 		
 		def leaf?
 			true
 		end
 		
-		EMPTY = Array.new.freeze
+		EMPTY = Hash.new.freeze
 		
 		def children
 			EMPTY
 		end
 		
+		def description
+			@path
+		end
+		
 		def print(output)
 			output.write("file ", :path, @identity)
 		end
@@ -72,8 +103,6 @@ module Sus
 	module Context
 		def file(path)
 			add File.build(self, path)
-		rescue StandardError, LoadError, SyntaxError => error
-			add FileLoadError.build(self, path, error)
 		end
 	end
 end

data/lib/sus/identity.rb

@@ -5,6 +5,10 @@
 
 module Sus
 	class Identity
+		def self.file(parent, path, name = path, **options)
+			self.new(path, name, nil, nil, **options)
+		end
+		
 		def self.nested(parent, name, location = nil, **options)
 			location ||= caller_locations(3...4).first
 			
@@ -22,6 +26,10 @@ module Sus
 			@key = nil
 		end
 		
+		def with_line(line)
+			self.class.new(@path, @name, line, @parent, unique: @unique)
+		end
+		
 		attr :path
 		attr :name
 		attr :line
@@ -32,6 +40,13 @@ module Sus
 			self.key
 		end
 		
+		def to_location
+			{
+				path: ::File.expand_path(@path),
+				line: @line,
+			}
+		end
+		
 		def inspect
 			"\#<#{self.class} #{self.to_s}>"
 		end
@@ -69,6 +84,27 @@ module Sus
 			return @key
 		end
 		
+		# Given a set of locations, find the first one which matches this identity and return a new identity with the updated line number. This can be used to extract a location from a backtrace.
+		def scoped(locations = nil)
+			if locations
+				# This code path is normally taken if we've got an exception with a backtrace:
+				locations.each do |location|
+					if location.path == @path
+						return self.with_line(location.lineno)
+					end
+				end
+			else
+				# In theory this should be a bit faster:
+				Thread.each_caller_location do |location|
+					if location.path == @path
+						return self.with_line(location.lineno)
+					end
+				end
+			end
+			
+			return self
+		end
+		
 		protected
 		
 		def append_unique_key(key, unique = @unique)

data/lib/sus/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-02-19 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake-test