sus 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb15dd70f3fd10ea7d5485648b632944450255950ecbbd0c02fbd10aa533933
-  data.tar.gz: 4cc4f588633c0dee5211f39dec34224f78f44a47c1720c74c4a3fc90df9c7671
+  metadata.gz: 68595280910704ed5eb41683985ffaff34df40eb30e72408da93667de742fb0c
+  data.tar.gz: fc0ac561eae164316247c381c0a20cb244c61c0af6b68891ea120fad2f7916c4
 SHA512:
-  metadata.gz: '0292a0378064908cfff1ca760f09f2bb64f1131835ca7fafae02e1120726af7cd0575a240516392b817133dde4c444e18b0962ac5e381c761c5b98c325696ce9'
-  data.tar.gz: 54c3cd3c3116562271bc4c1f68172bc9fa43a3a8881bca00033d94ebd26b9a633b39897631a00a9dc90e0fef1b2c82affde754a74f644a95680080379b16d258
+  metadata.gz: 1fa0de727817b73859de636f2414dcd08b6001cdd5d837cc9ca72caa3014bdfe08052a0d5c785c91127ee8632e21e64d1eb43817e00baeee2461e698975ab937
+  data.tar.gz: 2ce965a251d21411e22f8d5feb8ae5573805c18da2e8061ef47768e60600721ebd0d72cb2d8c9a6e1d6be6989dbddb32f12a8fd5a26d65e64c9cb3b47bc7d4ac

data/lib/sus/assertions.rb

@@ -14,12 +14,15 @@ module Sus
 			self.new(**options)
 		end
 		
-		def initialize(identity: nil, target: nil, output: Output.buffered, inverted: false, isolated: false, measure: false, verbose: false)
+		# @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)
 			# 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
 			@output = output
 			@inverted = inverted
+			@orientation = orientation
 			@isolated = isolated
 			@verbose = verbose
 			
@@ -39,7 +42,13 @@ module Sus
 		attr :target
 		attr :output
 		attr :level
+		
+		# Whether this aset of assertions is inverted
 		attr :inverted
+		
+		# The absolute orientation of this set of assertions:
+		attr :orientation
+		
 		attr :isolated
 		attr :verbose
 		
@@ -118,18 +127,22 @@ module Sus
 			if condition
 				@passed << self
 				
-				if @inverted || @verbose
-					@output.puts(:indent, :passed, pass_prefix, message || "assertion", Output::Backtrace.first(@identity))
+				if !@orientation || @verbose
+					@output.puts(:indent, *pass_prefix, message || "assertion", Output::Backtrace.first(@identity))
 				end
 			else
 				@failed << self
 				
-				if !@inverted || @verbose
-					@output.puts(:indent, :failed, fail_prefix, message || "assertion", Output::Backtrace.first(@identity))
+				if @orientation || @verbose
+					@output.puts(:indent, *fail_prefix, message || "assertion", Output::Backtrace.first(@identity))
 				end
 			end
 		end
 		
+		def skip(reason)
+			@output.puts(:indent, :skip, skip_prefix, reason)
+		end
+		
 		def inform(message)
 			@output.puts(:indent, :inform, inform_prefix, message)
 		end
@@ -158,7 +171,7 @@ module Sus
 			
 			lines = error.message.split(/\r?\n/)
 			
-			@output.puts(:indent, :error, fail_prefix, "Unhandled exception ", :value, error.class, ":", :reset, " ", lines.shift)
+			@output.puts(:indent, *fail_prefix, "Unhandled exception ", :value, error.class, ":", :reset, " ", lines.shift)
 			
 			lines.each do |line|
 				@output.puts(:indent, "| ", line)
@@ -177,9 +190,16 @@ module Sus
 				output = @output
 			end
 			
+			# Inverting a nested assertions causes the orientation to flip:
+			if inverted
+				orientation = !@orientation
+			else
+				orientation = @orientation
+			end
+			
 			output.puts(:indent, target)
 			
-			assertions = self.class.new(identity: identity, target: target, output: output, isolated: isolated, inverted: inverted, verbose: @verbose, **options)
+			assertions = self.class.new(identity: identity, target: target, output: output, isolated: isolated, inverted: inverted, orientation: orientation, verbose: @verbose, **options)
 			
 			output.indented do
 				begin
@@ -264,17 +284,32 @@ 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
 	end
 end

data/lib/sus/be.rb

@@ -72,5 +72,9 @@ module Sus
 		def be_nil
 			Be::NIL
 		end
+		
+		def be_equal(other)
+			Be.new(:equal?, other)
+		end
 	end
 end

data/lib/sus/be_truthy.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2022, by Samuel Williams.
+
+module Sus
+	module BeTruthy
+		def self.print(output)
+			output.write("be truthy")
+		end
+		
+		def self.call(assertions, subject)
+			assertions.nested(self) do |assertions|
+				assertions.assert(subject, self)
+			end
+		end
+	end
+	
+	module BeFalsey
+		def self.print(output)
+			output.write("be falsey")
+		end
+		
+		def self.call(assertions, subject)
+			assertions.nested(self) do |assertions|
+				assertions.assert(!subject, self)
+			end
+		end
+	end
+	
+	class Base
+		def be_truthy
+			BeTruthy
+		end
+		
+		def be_falsey
+			BeFalsey
+		end
+	end
+end

data/lib/sus/expect.rb

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

data/lib/sus/file.rb

@@ -11,7 +11,7 @@ Sus::TOPLEVEL_CLASS_EVAL = ->(klass, path){klass.class_eval(::File.read(path), p
 module Sus
 	module File
 		extend Context
-				
+		
 		def self.extended(base)
 			base.children = Hash.new
 		end

data/lib/sus/have/all.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
+
+module Sus
+	module Have
+		class All
+			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
+	end
+end

data/lib/sus/have/any.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
+
+module Sus
+	module Have
+		class Any
+			def initialize(predicates)
+				@predicates = predicates
+			end
+			
+			def print(output)
+				first = true
+				output.write("have any {")
+				@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
+					
+					if assertions.passed.any?
+						# We don't care about any failures in this case, as long as one of the values passed:
+						assertions.failed.clear
+					else
+						# Nothing passed, so we failed:
+						assertions.assert(false, "could not find any matching value")
+					end
+				end
+			end
+		end
+	end
+end

data/lib/sus/have.rb

@@ -3,37 +3,11 @@
 # Released under the MIT License.
 # Copyright, 2022, by Samuel Williams.
 
+require_relative 'have/all'
+require_relative 'have/any'
+
 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
@@ -69,11 +43,29 @@ module Sus
 				end
 			end
 		end
+		
+		class Value
+			def initialize(predicate)
+				@predicate = predicate
+			end
+			
+			def print(output)
+				output.write("value ", @predicate, :reset)
+			end
+			
+			def call(assertions, subject)
+				subject.each_with_index do |value, index|
+					assertions.nested("[#{index}] = #{value.inspect}") do |assertions|
+						@predicate&.call(assertions, value)
+					end
+				end
+			end
+		end
 	end
 	
 	class Base
 		def have(*predicates)
-			Have::Composite.new(predicates)
+			Have::All.new(predicates)
 		end
 		
 		def have_keys(*keys)
@@ -89,7 +81,7 @@ module Sus
 				end
 			end
 			
-			Have::Composite.new(predicates)
+			Have::All.new(predicates)
 		end
 		
 		def have_attributes(**attributes)
@@ -97,7 +89,15 @@ module Sus
 				Have::Attribute.new(key, value)
 			end
 			
-			Have::Composite.new(predicates)
+			Have::All.new(predicates)
+		end
+		
+		def have_any(*predicates)
+			Have::Any.new(predicates)
+		end
+		
+		def have_value(predicate)
+			Have::Any.new([Have::Value.new(predicate)])
 		end
 	end
 end

data/lib/sus/it.rb

@@ -39,10 +39,20 @@ module Sus
 				instance = self.new(assertions)
 				
 				instance.around do
-					instance.call
+					handle_skip(instance, assertions)
 				end
 			end
 		end
+		
+		def handle_skip(instance, assertions)
+			reason = catch(:skip) do
+				return instance.call
+			end
+			
+			assertions.skip(reason)
+			
+			return nil
+		end
 	end
 	
 	module Context
@@ -50,4 +60,10 @@ module Sus
 			add It.build(self, ...)
 		end
 	end
+	
+	class Base
+		def skip(reason)
+			throw :skip, reason
+		end
+	end
 end

data/lib/sus/it_behaves_like.rb

@@ -11,12 +11,18 @@ module Sus
 		
 		attr_accessor :shared
 		
-		def self.build(parent, shared, unique: false)
+		def self.build(parent, shared, unique: false, &block)
 			base = Class.new(parent)
 			base.singleton_class.prepend(ItBehavesLike)
 			base.children = Hash.new
 			base.description = shared.name
 			base.identity = Identity.nested(parent.identity, base.description, unique: unique)
+
+			# User provided block is evaluated first, so that it can provide default behaviour for the shared context:
+			if block_given?
+				base.class_exec(&block)
+			end
+
 			base.class_exec(&shared.block)
 			return base
 		end
@@ -28,8 +34,8 @@ module Sus
 	end
 	
 	module Context
-		def it_behaves_like(shared, **options)
-			add ItBehavesLike.build(self, shared, **options)
+		def it_behaves_like(shared, **options, &block)
+			add ItBehavesLike.build(self, shared, **options, &block)
 		end
 	end
 end

data/lib/sus/output/progress.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2021-2022, by Samuel Williams.
 
 require_relative 'bar'
 require_relative 'status'

data/lib/sus/output/status.rb

@@ -14,7 +14,6 @@ module Sus
 			def initialize(state = :free, context = nil)
 				@state = state
 				@context = context
-				@index = 0
 			end
 			
 			INDICATORS = {
@@ -36,8 +35,6 @@ module Sus
 			end
 			
 			def print(output)
-				message = @message
-				
 				output.write(
 					@state, self.indicator, " "
 				)

data/lib/sus/output/text.rb

@@ -19,6 +19,8 @@ module Sus
 				@styles[:indent] = @indent
 			end
 			
+			attr :styles
+			
 			def buffered
 				Buffered.new(self)
 			end

data/lib/sus/output.rb

@@ -40,6 +40,7 @@ module Sus
 			output[:passed] = output.style(:green)
 			output[:failed] = output.style(:red)
 			output[:error] = output.style(:red)
+			output[:skip] = output.style(:blue)
 			# output[:inform] = output.style(nil, nil, :bold)
 			
 			return output

data/lib/sus/raise_exception.rb

@@ -26,7 +26,7 @@ module Sus
 				rescue @exception_class => exception
 					# Did it have the right message?
 					if @message
-						assertions.assert(@message === exception.message, "raised with message")
+						@message.call(assertions, exception.message)
 					else
 						assertions.assert(true, "raised")
 					end

data/lib/sus/receive.rb

@@ -24,31 +24,40 @@ module Sus
 			output.write("receive ", :variable, @method.to_s, :reset, " ")
 		end
 		
-		def with_arguments(*arguments)
-			@arguments = WithArguments.new(arguments)
+		def with_arguments(predicate)
+			@arguments = WithArguments.new(predicate)
 			return self
 		end
-
-		def with_options(*options)
-			@options = WithOptions.new(options)
+		
+		def with_options(predicate)
+			@options = WithOptions.new(predicate)
 			return self
 		end
-
-		def with_block
-			@block = WithBlock.new
+		
+		def with_block(predicate = Be.new(:!=, nil))
+			@block = WithBlock.new(predicate)
 			return self
 		end
-
+		
+		def with(*arguments, **options)
+			with_arguments(Be.new(:==, arguments)) if arguments.any?
+			with_options(Be.new(:==, options)) if options.any?
+			return self
+		end
+		
 		def once
 			@times = Times.new(Be.new(:==, 1))
+			return self
 		end
 		
 		def twice
 			@times = Times.new(Be.new(:==, 2))
+			return self
 		end
 		
 		def with_call_count(predicate)
 			@times = Times.new(predicate)
+			return self
 		end
 		
 		def and_return(*returning)
@@ -101,44 +110,49 @@ module Sus
 		end
 		
 		class WithArguments
-			def initialize(arguments)
-				@arguments = arguments
+			def initialize(predicate)
+				@predicate = predicate
 			end
 			
 			def print(output)
-				output.write("with arguments ", :variable, @arguments.inspect)
+				output.write("with arguments ", @predicate)
 			end
 			
 			def call(assertions, subject)
 				assertions.nested(self) do |assertions|
-					Expect.new(assertions, subject).to(Be == @arguments)
+					@predicate.call(assertions, subject)
 				end
 			end
 		end
 
 		class WithOptions
-			def initialize(options)
-				@options = options
+			def initialize(predicate)
+				@predicate = predicate
 			end
 			
 			def print(output)
-				output.write("with options ", :variable, @options.inspect)
+				output.write("with options ", @predicate)
 			end
 			
 			def call(assertions, subject)
 				assertions.nested(self) do |assertions|
-					Expect.new(assertions, subject).to(Be.new(:include?, @options))
+					@predicate.call(assertions, subject)
 				end
 			end
 		end
 		
 		class WithBlock
+			def initialize(predicate)
+				@predicate = predicate
+			end
+			
 			def print(output)
-				output.write("with block")
+				output.write("with block", @predicate)
 			end
 
 			def call(assertions, subject)
 				assertions.nested(self) do |assertions|
+					
 					Expect.new(assertions, subject).not.to(Be == nil)
 				end
 			end

data/lib/sus/registry.rb

@@ -19,6 +19,8 @@ require_relative 'let'
 
 module Sus
 	class Registry
+		DIRECTORY_GLOB = "**/*.rb"
+		
 		# Create a top level scope with self as the instance:
 		def initialize(base = Sus.base(self))
 			@base = base
@@ -31,9 +33,21 @@ module Sus
 		end
 		
 		def load(path)
+			if ::File.directory?(path)
+				load_directory(path)
+			else
+				load_file(path)
+			end
+		end
+		
+		private def load_file(path)
 			@base.file(path)
 		end
 		
+		private def load_directory(path)
+			::Dir.glob(::File.join(path, DIRECTORY_GLOB), &self.method(:load_file))
+		end
+		
 		def call(assertions = Assertions.default)
 			@base.call(assertions)
 			

data/lib/sus/version.rb

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

data/lib/sus.rb

@@ -10,6 +10,7 @@ require_relative 'sus/assertions'
 
 require_relative 'sus/expect'
 require_relative 'sus/be'
+require_relative 'sus/be_truthy'
 require_relative 'sus/be_within'
 
 require_relative 'sus/mock'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2022-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake-test
@@ -95,6 +95,7 @@ files:
 - lib/sus/assertions.rb
 - lib/sus/base.rb
 - lib/sus/be.rb
+- lib/sus/be_truthy.rb
 - lib/sus/be_within.rb
 - lib/sus/clock.rb
 - lib/sus/config.rb
@@ -105,6 +106,8 @@ files:
 - lib/sus/filter.rb
 - lib/sus/fixtures.rb
 - lib/sus/have.rb
+- lib/sus/have/all.rb
+- lib/sus/have/any.rb
 - lib/sus/have_duration.rb
 - lib/sus/identity.rb
 - lib/sus/include_context.rb