sus 0.21.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8653cb936d27d9e33250698daac7861a3235699ae90e6263a6d79d33dd24b4bd
-  data.tar.gz: '0516931df8c4f34c61ab56cd75d65e29adc414e8d39797d79e8ba273af356e6e'
+  metadata.gz: 49e0b28d22be1c2142e9868d47de8e0e39447874bb5e17a4a9c513c723656617
+  data.tar.gz: 85e6348661715455dcec9ea552e59b788dd7637d79b32126c3e456e68b4d6998
 SHA512:
-  metadata.gz: 8c8a8fd1d650280a873af340909fc55bfe3a3fa6fc510fb55dfc42a696a58beee78450d88d11340785d084e94c9a5bfedb85751f9f13cc0d61697cb7bfb2738c
-  data.tar.gz: ebb26520158d23db914fc931afd6e001e2839fcaeff3f20b6734ab2f0a0c7d644a61f1f74f84ccf3af2f7e302954aa1244d792320e25dcc5f30e7e866b3e38a6
+  metadata.gz: f079bb5a6e5d3ff4f9f27f25f93675111754fbcc92f95b59209d981a370adbe2008ecb07acd7fb280db0f0d47705ae3254d55791f473e78891552cfebf7ba044
+  data.tar.gz: 99dde477c93576abf2ff664a3fd8bc31eda8be9280c6cd79aa6f831d68f4ae004ef9a6815ce6bcd49e718c64d4745a0b040c90b0b67fcb1be7886664823c6769

data/lib/sus/assertions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative 'output'
 require_relative 'clock'
@@ -42,9 +42,16 @@ module Sus
 			@count = 0
 		end
 		
+		# The identity that is used to identify this set of assertions.
 		attr :identity
+		
+		# The specific target of the assertions, e.g. the test case or nested test assertions.
 		attr :target
+		
+		# The output buffer used to capture output from the assertions.
 		attr :output
+		
+		# The nesting level of this set of assertions.
 		attr :level
 		
 		# 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.
@@ -288,7 +295,7 @@ module Sus
 			@output.error(error, @identity)
 		end
 		
-		def nested(target, identity: nil, isolated: false, distinct: false, inverted: false, **options)
+		def nested(target, identity: @identity, isolated: false, distinct: false, inverted: false, **options)
 			result = nil
 			
 			# Isolated assertions need to have buffered output so they can be replayed if they fail:
@@ -387,6 +394,8 @@ module Sus
 				# self.print(@output, verbose: false)
 				# @output.puts
 			end
+			
+			@skipped.concat(assertions.skipped)
 		end
 		
 		# Concatenate the child assertions into this instance.

data/lib/sus/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative 'context'
 
@@ -45,6 +45,7 @@ module Sus
 		base.extend(Context)
 		base.identity = Identity.new(root) if root
 		base.description = description
+		base.set_temporary_name("#{self}[#{description}]")
 		
 		return base
 	end

data/lib/sus/be_truthy.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2023, by Samuel Williams.
 
 module Sus
 	module BeTruthy

data/lib/sus/clock.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2023, by Samuel Williams.
 
 module Sus
 	class Clock

data/lib/sus/config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2023, by Samuel Williams.
 
 require_relative 'clock'
 require_relative 'registry'
@@ -78,12 +78,12 @@ module Sus
 			return Dir.glob(DEFAULT_TEST_PATTERN, base: @root)
 		end
 		
-		def registry
-			@registry ||= self.load_registry
+		def make_registry
+			Sus::Registry.new(root: @root)
 		end
 		
 		def load_registry(paths = @paths)
-			registry = Sus::Registry.new(root: @root)
+			registry = make_registry
 			
 			if paths&.any?
 				registry = Sus::Filter.new(registry)
@@ -99,6 +99,10 @@ module Sus
 			return registry
 		end
 		
+		def registry
+			@registry ||= self.load_registry
+		end
+		
 		def before_tests(assertions, output: self.output)
 			@clock.reset!
 			@clock.start!

data/lib/sus/context.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative 'assertions'
 require_relative 'identity'
@@ -16,15 +16,21 @@ module Sus
 			base.children = Hash.new
 		end
 		
-		def to_s
-			self.description || self.name
-		end
-		
-		def inspect
-			if description = self.description
-				"\#<#{self.name || "Context"} #{self.description}>"
-			else
-				self.name
+		unless respond_to?(:set_temporary_name)
+			def set_temporary_name(name)
+				# No-op.
+			end
+			
+			def to_s
+				(self.description || self.name).to_s
+			end
+			
+			def inspect
+				if description = self.description
+					"\#<#{self.name || "Context"} #{self.description}>"
+				else
+					self.name
+				end
 			end
 		end
 		
@@ -41,7 +47,13 @@ module Sus
 		end
 		
 		def print(output)
-			output.write("context ", :context, self.description)
+			output.write("context", :context, self.description)
+		end
+		
+		def full_name
+			output = Output::Buffered.new
+			print(output)
+			return output.string
 		end
 		
 		def call(assertions)

data/lib/sus/describe.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative 'context'
 
@@ -18,6 +18,8 @@ module Sus
 			base.subject = subject
 			base.description = subject.to_s
 			base.identity = Identity.nested(parent.identity, base.description, unique: unique)
+			base.set_temporary_name("#{self}[#{base.description}]")
+			
 			base.define_method(:subject, ->{subject})
 			
 			if block_given?

data/lib/sus/expect.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 module Sus
 	class Expect

data/lib/sus/file.rb

@@ -24,6 +24,10 @@ module Sus
 	module File
 		extend Context
 		
+		def self.[] path
+			self.build(Sus.base, path)
+		end
+		
 		def self.extended(base)
 			base.children = Hash.new
 		end
@@ -34,6 +38,7 @@ module Sus
 			base.extend(File)
 			base.description = path
 			base.identity = Identity.file(parent.identity, path)
+			base.set_temporary_name("#{self}[#{path}]")
 			
 			begin
 				TOPLEVEL_CLASS_EVAL.call(base, path)

data/lib/sus/filter.rb

@@ -1,9 +1,16 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 module Sus
+	# Provides a way to filter the registry according to the suffix on loaded paths.
+	#
+	# A test has an identity, e.g. the file and line number on which it's defined.
+	#
+	# A filter takes an identity, decomposes it into a file and suffix, loads the file, and registers the filter suffix.
+	#
+	# When the filter is used to enumerate the registry, it will only return the tests that match the suffix.
 	class Filter
 		class Index
 			def initialize

data/lib/sus/identity.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 module Sus
 	class Identity

data/lib/sus/include_context.rb

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

data/lib/sus/integrations.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+module Sus
+	module Integrations
+	end
+end

data/lib/sus/it.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative 'context'
 
@@ -12,6 +12,7 @@ module Sus
 			base.extend(It)
 			base.description = description
 			base.identity = Identity.nested(parent.identity, base.description, unique: unique)
+			base.set_temporary_name("#{self}[#{description}]")
 			
 			if block_given?
 				base.define_method(:call, &block)
@@ -27,11 +28,11 @@ module Sus
 		def print(output)
 			self.superclass.print(output)
 			
-			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
+			output.write(" it ", :it, self.description, :reset, " ", :identity, self.identity.to_s, :reset)
+		end
+		
+		def to_s
+			"it #{description}"
 		end
 		
 		def call(assertions)
@@ -64,5 +65,29 @@ module Sus
 			@__assertions__.skip(reason)
 			throw :skip, reason
 		end
+		
+		def skip_unless_method_defined(method, target)
+			unless target.method_defined?(method)
+				skip "Method #{method} is not defined in #{target}!"
+			end
+		end
+		
+		def skip_unless_constant_defined(constant, target = Object)
+			unless target.const_defined?(constant)
+				skip "Constant #{constant} is not defined in #{target}!"
+			end
+		end
+		
+		def skip_unless_minimum_ruby_version(version)
+			unless RUBY_VERSION >= version
+				skip "Ruby #{version} is required, but running #{RUBY_VERSION}!"
+			end
+		end
+		
+		def skip_if_maximum_ruby_version(version)
+			if RUBY_VERSION >= version
+				skip "Ruby #{version} is not supported, but running #{RUBY_VERSION}!"
+			end
+		end
 	end
 end

data/lib/sus/it_behaves_like.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative 'context'
 
@@ -17,6 +17,7 @@ module Sus
 			base.children = Hash.new
 			base.description = shared.name
 			base.identity = Identity.nested(parent.identity, base.description, unique: unique)
+			base.set_temporary_name("#{self}[#{base.description}]")
 
 			# User provided block is evaluated first, so that it can provide default behaviour for the shared context:
 			if block_given?

data/lib/sus/output/buffered.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require 'io/console'
 require 'stringio'

data/lib/sus/output/null.rb

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

data/lib/sus/output/text.rb

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

data/lib/sus/raise_exception.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 module Sus
 	class RaiseException

data/lib/sus/registry.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 # Copyright, 2022, by Brad Schrag.
 
 require_relative 'base'
@@ -27,7 +27,7 @@ module Sus
 			@base = Sus.base(self, **options)
 			@loaded = {}
 		end
-
+		
 		attr :base
 		
 		def print(output)
@@ -35,7 +35,7 @@ module Sus
 		end
 		
 		def to_s
-			@base.identity.to_s
+			@base&.identity&.to_s || self.class.name
 		end
 		
 		def load(path)

data/lib/sus/tree.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
 module Sus
 	class Tree
 		def initialize(context)

data/lib/sus/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 module Sus
-	VERSION = "0.21.1"
+	VERSION = "0.22.0"
 end

data/lib/sus/with.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative 'context'
 
@@ -19,6 +19,8 @@ module Sus
 			base.subject = subject
 			base.description = subject
 			base.identity = Identity.nested(parent.identity, base.description, unique: unique)
+			base.set_temporary_name("#{self}[#{base.description}]")
+			
 			base.variables = variables
 			
 			base.define_method(:description, ->{subject})
@@ -36,6 +38,7 @@ module Sus
 		
 		def print(output)
 			self.superclass.print(output)
+			
 			output.write(
 				" with ", :with, self.description, :reset,
 				# " ", :variables, self.variables.inspect

data/lib/sus.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative 'sus/version'
 require_relative 'sus/config'

data/readme.md

@@ -1,4 +1,4 @@
-# Sus(picious) \[working name\]
+# Sus(picious)
 
 An opinionated test framework designed with several goals:
 
@@ -38,8 +38,18 @@ Check `test` directory for examples.
 
 ## Contributing
 
+We welcome contributions to this project.
+
 1.  Fork it.
 2.  Create your feature branch (`git checkout -b my-new-feature`).
 3.  Commit your changes (`git commit -am 'Add some feature'`).
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,50 +38,8 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-06-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bake-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: bake-test-external
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
+date: 2023-07-22 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 executables:
@@ -116,6 +74,7 @@ files:
 - lib/sus/have_duration.rb
 - lib/sus/identity.rb
 - lib/sus/include_context.rb
+- lib/sus/integrations.rb
 - lib/sus/it.rb
 - lib/sus/it_behaves_like.rb
 - lib/sus/let.rb
@@ -155,14 +114,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A fast and scalable test runner.