sus 0.10.3 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6150fc65498872a9502ff62dbaa6e377ad47b0412e7f5109646dc6b0331d4a3
-  data.tar.gz: fb632958567ea9539e1eea8a1b6bc81ad567f8834cc82495a9ec626c86ad2ae5
+  metadata.gz: 4e158f43458d5d3c2bc5835ab0493b22d4c09c8f2c733cb8e42095ed5b7566a0
+  data.tar.gz: 4ef00aa6fe64b16271a8d219ee8f20bab23064ab5546e64885f040bf9cc5a180
 SHA512:
-  metadata.gz: e3c430dd6e1fb26da0c3da657fe39677f2301db6fc312a0dc27f8078bfc7bcd3f666685fdd02d5a5bbcefd0e40fda4bcb7b704654e97e169658c82ea60f88d70
-  data.tar.gz: c740efacfa31ee8306a81a15d2b5ed1573fc10376752fe5a55cab4883a90e0d90315a11a4af0b39428e05b7d3e8aaa72ecd4e6efa767595d3e94a1065d83d7d4
+  metadata.gz: 88ec5c608a1e0131702bb1c2a530b0811072a9e47df858f46635dc94fade1855cad48e6005514329de5994a2c30882cb97a8b62b73787fad9bd30ec596d24937
+  data.tar.gz: 1e7551d9b5007a6158bd0b690743b1ab0c448fe0ed507692f0ba14fa1697ba61b49af781ce1b70a24a2c839f72ddfcc5a7de7bd46158f723a97044c1c1a0e6f5

data/lib/sus/be.rb

@@ -52,6 +52,8 @@ module Sus
 				Be.new(:===, value)
 			end
 		end
+		
+		NIL = Be.new(:nil?)
 	end
 	
 	class Base
@@ -66,5 +68,9 @@ module Sus
 		def be_a(klass)
 			Be.new(:is_a?, klass)
 		end
+		
+		def be_nil
+			Be::NIL
+		end
 	end
 end

data/lib/sus/clock.rb

@@ -7,6 +7,10 @@ module Sus
 	class Clock
 		include Comparable
 		
+		def self.start!
+			self.new.tap(&:start!)
+		end
+		
 		def initialize(duration = 0.0)
 			@duration = duration
 		end
@@ -40,6 +44,8 @@ module Sus
 				@duration += Process.clock_gettime(Process::CLOCK_MONOTONIC) - @start_time
 				@start_time = nil
 			end
+			
+			return @duration
 		end
 	end
 end

data/lib/sus/expect.rb

@@ -51,5 +51,9 @@ module Sus
 				Expect.new(@__assertions__, subject, **options)
 			end
 		end
+		
+		def is_expected
+			expect(subject)
+		end
 	end
 end

data/lib/sus/have.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
+
+module Sus
+	module Have
+		class Composite
+			def initialize(predicates)
+				@predicates = predicates
+			end
+			
+			def print(output)
+				first = true
+				output.write("have {")
+				@predicates.each do |predicate|
+					if first
+						first = false
+					else
+						output.write(", ")
+					end
+					
+					output.write(predicate)
+				end
+				output.write("}")
+			end
+			
+			def call(assertions, subject)
+				assertions.nested(self) do |assertions|
+					@predicates.each do |predicate|
+						predicate.call(assertions, subject)
+					end
+				end
+			end
+		end
+		
+		class Key
+			def initialize(name, predicate = nil)
+				@name = name
+				@predicate = predicate
+			end
+			
+			def print(output)
+				output.write("key ", :variable, @name.inspect, :reset, " ", @predicate, :reset)
+			end
+			
+			def call(assertions, subject)
+				assertions.nested(self) do |assertions|
+					assertions.assert(subject.key?(@name), "has key")
+					@predicate&.call(assertions, subject[@name])
+				end
+			end
+		end
+		
+		class Attribute
+			def initialize(name, predicate)
+				@name = name
+				@predicate = predicate
+			end
+			
+			def print(output)
+				output.write("attribute ", :variable, @name.to_s, :reset, " ", @predicate, :reset)
+			end
+			
+			def call(assertions, subject)
+				assertions.nested(self) do |assertions|
+					assertions.assert(subject.respond_to?(@name), "has attribute")
+					@predicate&.call(assertions, subject.send(@name))
+				end
+			end
+		end
+	end
+	
+	class Base
+		def have(*predicates)
+			Have::Composite.new(predicates)
+		end
+		
+		def have_keys(*keys)
+			predicates = []
+			
+			keys.each do |key|
+				if key.is_a?(Hash)
+					key.each do |key, predicate|
+						predicates << Have::Key.new(key, predicate)
+					end
+				else
+					predicates << Have::Key.new(key)
+				end
+			end
+			
+			Have::Composite.new(predicates)
+		end
+		
+		def have_attributes(**attributes)
+			predicates = attributes.map do |key, value|
+				Have::Attribute.new(key, value)
+			end
+			
+			Have::Composite.new(predicates)
+		end
+	end
+end

data/lib/sus/it.rb

@@ -7,7 +7,7 @@ require_relative 'context'
 
 module Sus
 	module It
-		def self.build(parent, description, &block)
+		def self.build(parent, description = nil, &block)
 			base = Class.new(parent)
 			base.extend(It)
 			base.description = description
@@ -26,7 +26,12 @@ module Sus
 		
 		def print(output)
 			self.superclass.print(output)
-			output.write(" it ", :it, self.description, :reset, " ", :identity, self.identity.to_s, :reset)
+			
+			if description = self.description
+				output.write(" it ", :it, description, :reset, " ", :identity, self.identity.to_s, :reset)
+			else
+				output.write(" and ", :identity, self.identity.to_s, :reset)
+			end
 		end
 		
 		def call(assertions)

data/lib/sus/output/backtrace.rb

@@ -13,7 +13,9 @@ module Sus
 			end
 			
 			def self.for(exception, identity = nil)
-				self.new(exception.backtrace_locations, identity&.path)
+				# I've disabled the root filter here, because partial backtraces are not very useful.
+				# We might want to do something to improve presentation of the backtrace based on the root instead.
+				self.new(exception.backtrace_locations) # , identity&.path)
 			end
 			
 			def initialize(stack, root = nil, limit = nil)

data/lib/sus/raise_exception.rb

@@ -8,6 +8,12 @@ module Sus
 		def initialize(exception_class = nil, message: nil)
 			@exception_class = exception_class
 			@message = message
+			@predicate = nil
+		end
+		
+		def and(predicate)
+			@predicate = predicate
+			return self
 		end
 		
 		def call(assertions, subject)
@@ -16,14 +22,16 @@ module Sus
 					subject.call
 					
 					# Didn't throw any exception, so the expectation failed:
-					assertions.assert(false, self)
+					assertions.assert(false, "raised")
 				rescue @exception_class => exception
 					# Did it have the right message?
 					if @message
-						assertions.assert(@message === exception.message)
+						assertions.assert(@message === exception.message, "raised with message")
 					else
-						assertions.assert(true, self)
+						assertions.assert(true, "raised")
 					end
+					
+					@predicate&.call(assertions, exception)
 				end
 			end
 		end
@@ -38,6 +46,10 @@ module Sus
 			if @message
 				output.write(" with message ", :variable, @message, :reset)
 			end
+			
+			if @predicate
+				output.write(" and ", @predicate)
+			end
 		end
 	end
 	

data/lib/sus/version.rb

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

data/lib/sus.rb

@@ -17,5 +17,6 @@ require_relative 'sus/receive'
 
 require_relative 'sus/raise_exception'
 require_relative 'sus/have_duration'
+require_relative 'sus/have'
 
 require_relative 'sus/filter'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.11.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2022-08-27 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -62,6 +62,7 @@ files:
 - lib/sus/file.rb
 - lib/sus/filter.rb
 - lib/sus/fixtures.rb
+- lib/sus/have.rb
 - lib/sus/have_duration.rb
 - lib/sus/identity.rb
 - lib/sus/include_context.rb