sus 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ef71ae68fa2f1c55825c77c389370bd8903b6888bc1a4034126d945c0d0e0c
-  data.tar.gz: 4abbb662af110be31822445fbb76049a26df539630d68466231dd117bb4ef50b
+  metadata.gz: 30853f93c0da945d2bb067d53fceba5fdc873ddc87c69369c364f2e61a5cce96
+  data.tar.gz: b3564630a2abe168125dedb7d16d9d70ef1116a99f6f9596fa39e0e215a4a437
 SHA512:
-  metadata.gz: c7ccf1055d49fdb0dcb45b4c3cad14c91f325bc0e897018680354cc1a6ae83c5476f7a240370a98569eabb523603d7b2006e3bd028571e82ef8e0138c337cd13
-  data.tar.gz: 49c602c11a456c8eaefcf105e4c135efd18c8c62a3106fc475de03245ce99ace9281d2a246528b0bff96ff153983430748967e4ee7b530e6a91008bbf9044394
+  metadata.gz: 812cc85caf14056ae5536b0847d1ccbe90b3ef74608c15168176aef9360b339e704c64c7c0c6b99f42951c3587c2d193bce82f09e98ccf0815504097b46e9507
+  data.tar.gz: f932395d4a5e082d5e5ee9a2ddb9e0bba304cca73cb3f66c9856838f91ae34e96d096da22490af6b27cad405fbcd11b02a6e6be75a25eef9efb44bb4ce167b7f

data/bin/sus

@@ -1,13 +1,10 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# require 'stackprof'
-# StackProf.start(mode: :wall, interval: 10)
-
-require_relative '../lib/sus/config'
+require_relative "../lib/sus/config"
 config = Sus::Config.load
 
-require_relative '../lib/sus'
+require_relative "../lib/sus"
 registry = config.registry
 
 if config.verbose?
@@ -24,11 +21,6 @@ config.before_tests(assertions)
 registry.call(assertions)
 config.after_tests(assertions)
 
-# StackProf.stop
-# StackProf.results('sus.stackprof')
-#
-# $ stackprof sus.stackprof --text --limit 10
-
 unless assertions.passed?
 	exit(1)
 end

data/bin/sus-host

@@ -1,22 +1,22 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
-require_relative '../lib/sus/config'
+require_relative "../lib/sus/config"
 config = Sus::Config.load
 
-require_relative '../lib/sus'
+require_relative "../lib/sus"
 
 verbose = false
 guard = Thread::Mutex.new
 
-require 'etc'
+require "etc"
 count = Etc.nprocessors
 
 $stdout.sync = true
 
-require_relative '../lib/sus/output/structured'
+require_relative "../lib/sus/output/structured"
 
 input = $stdin.dup
 $stdin.reopen(File::NULL)
@@ -36,7 +36,7 @@ end
 while line = input.gets
 	message = JSON.parse(line)
 	
-	if tests = message['run']
+	if tests = message["run"]
 		jobs = Thread::Queue.new
 		results = Thread::Queue.new
 		

data/bin/sus-parallel

@@ -1,19 +1,19 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/sus/config'
+require_relative "../lib/sus/config"
 config = Sus::Config.load
 
 Result = Struct.new(:job, :assertions)
 
-require_relative '../lib/sus'
-require_relative '../lib/sus/output'
+require_relative "../lib/sus"
+require_relative "../lib/sus/output"
 jobs = Thread::Queue.new
 results = Thread::Queue.new
 guard = Thread::Mutex.new
 progress = Sus::Output::Progress.new(config.output)
 
-require 'etc'
+require "etc"
 count = Etc.nprocessors
 
 loader = Thread.new do

data/bin/sus-tree

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
-require_relative '../lib/sus/config'
+require_relative "../lib/sus/config"
 config = Sus::Config.load
 
-require_relative '../lib/sus'
+require_relative "../lib/sus"
 
 verbose = false
 registry = config.registry

data/lib/sus/assertions.rb

@@ -3,10 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'output'
-require_relative 'clock'
+require_relative "output"
+require_relative "clock"
 
-require_relative 'output/backtrace'
+require_relative "output/backtrace"
 
 module Sus
 	class Assertions

data/lib/sus/base.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'context'
+require_relative "context"
 
 module Sus
 	# The base test case class. We need to be careful about what local state is stored.

data/lib/sus/config.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'clock'
-require_relative 'registry'
+require_relative "clock"
+require_relative "registry"
 
 module Sus
 	class Config
@@ -28,7 +28,7 @@ module Sus
 			end
 			
 			options = {
-				verbose: !!arguments.delete('--verbose')
+				verbose: !!arguments.delete("--verbose")
 			}
 			
 			return derived.new(root, arguments, **options)
@@ -53,8 +53,8 @@ module Sus
 		end
 		
 		def add_default_load_paths
-			add_load_path('lib')
-			add_load_path('fixtures')
+			add_load_path("lib")
+			add_load_path("fixtures")
 		end
 		
 		attr :root
@@ -103,9 +103,15 @@ module Sus
 			@registry ||= self.load_registry
 		end
 		
+		def prepare_warnings!
+			Warning[:deprecated] = true
+		end
+		
 		def before_tests(assertions, output: self.output)
 			@clock.reset!
 			@clock.start!
+			
+			prepare_warnings!
 		end
 		
 		def after_tests(assertions, output: self.output)

data/lib/sus/context.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'assertions'
-require_relative 'identity'
+require_relative "assertions"
+require_relative "identity"
 
 module Sus
 	module Context

data/lib/sus/describe.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'context'
+require_relative "context"
 
 module Sus
 	module Describe

data/lib/sus/file.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 # Copyright, 2022, by Brad Schrag.
 
-require_relative 'context'
+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__)}

data/lib/sus/filter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 module Sus
 	# Provides a way to filter the registry according to the suffix on loaded paths.
@@ -48,7 +48,7 @@ module Sus
 		end
 		
 		def load(target)
-			path, filter = target.split(':', 2)
+			path, filter = target.split(":", 2)
 			
 			@registry.load(path)
 			

data/lib/sus/have.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'have/all'
-require_relative 'have/any'
+require_relative "have/all"
+require_relative "have/any"
 
 module Sus
 	module Have

data/lib/sus/identity.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 module Sus
 	class Identity
@@ -82,7 +82,7 @@ module Sus
 				# For a specific leaf node, the last part is not unique, i.e. it must be identified explicitly.
 				append_unique_key(key, @unique == true ? false : @unique)
 				
-				@key = key.join(':')
+				@key = key.join(":")
 			end
 			
 			return @key

data/lib/sus/include_context.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'context'
+require_relative "context"
 
 module Sus
 	module Context

data/lib/sus/it.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'context'
+require_relative "context"
 
 module Sus
 	module It

data/lib/sus/it_behaves_like.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'context'
+require_relative "context"
 
 module Sus
 	module ItBehavesLike

data/lib/sus/let.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'context'
+require_relative "context"
 
 module Sus
 	module Context

data/lib/sus/mock.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'expect'
+require_relative "expect"
 
 module Sus
 	class Mock

data/lib/sus/output/buffered.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require 'io/console'
-require 'stringio'
+require "io/console"
+require "stringio"
 
 module Sus
 	# Styled output output.

data/lib/sus/output/lines.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require 'io/console'
+require "io/console"
 
 module Sus
 	module Output

data/lib/sus/output/null.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'messages'
+require_relative "messages"
 
 module Sus
 	# Styled output output.

data/lib/sus/output/progress.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'bar'
-require_relative 'status'
-require_relative 'lines'
+require_relative "bar"
+require_relative "status"
+require_relative "lines"
 
 module Sus
 	module Output

data/lib/sus/output/status.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 module Sus
 	module Output
@@ -17,8 +17,8 @@ module Sus
 			end
 			
 			INDICATORS = {
-				busy: ['◑', '◒', '◐', '◓'],
-				free: ['◌']
+				busy: ["◑", "◒", "◐", "◓"],
+				free: ["◌"]
 			}
 			
 			def update(state, context = nil)

data/lib/sus/output/structured.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
-require_relative 'null'
+require_relative "null"
 
 module Sus
 	# Styled output output.

data/lib/sus/output/text.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'messages'
-require_relative 'buffered'
+require_relative "messages"
+require_relative "buffered"
 
 module Sus
 	module Output

data/lib/sus/output/xterm.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require 'io/console'
+require "io/console"
 
-require_relative 'text'
+require_relative "text"
 
 module Sus
 	# Styled output output.

data/lib/sus/output.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'output/bar'
-require_relative 'output/text'
-require_relative 'output/xterm'
+require_relative "output/bar"
+require_relative "output/text"
+require_relative "output/xterm"
 
-require_relative 'output/null'
-require_relative 'output/progress'
+require_relative "output/null"
+require_relative "output/progress"
 
 module Sus
 	module Output

data/lib/sus/receive.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'respond_to'
+require_relative "respond_to"
 
 module Sus
 	class Receive

data/lib/sus/registry.rb

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 # Copyright, 2022, by Brad Schrag.
 
-require_relative 'base'
+require_relative "base"
 
-require_relative 'file'
-require_relative 'describe'
-require_relative 'with'
+require_relative "file"
+require_relative "describe"
+require_relative "with"
 
-require_relative 'it'
+require_relative "it"
 
-require_relative 'shared'
-require_relative 'it_behaves_like'
-require_relative 'include_context'
+require_relative "shared"
+require_relative "it_behaves_like"
+require_relative "include_context"
 
-require_relative 'let'
+require_relative "let"
 
 module Sus
 	class Registry

data/lib/sus/shared.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'context'
+require_relative "context"
 
 module Sus
 	module Shared

data/lib/sus/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2021-2024, by Samuel Williams.
 
 module Sus
-	VERSION = "0.31.0"
+	VERSION = "0.32.0"
 end

data/lib/sus/with.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'context'
+require_relative "context"
 
 module Sus
 	module With

data/lib/sus.rb

@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'sus/version'
-require_relative 'sus/config'
-require_relative 'sus/registry'
-require_relative 'sus/assertions'
-require_relative 'sus/tree'
+require_relative "sus/version"
+require_relative "sus/config"
+require_relative "sus/registry"
+require_relative "sus/assertions"
+require_relative "sus/tree"
 
-require_relative 'sus/expect'
-require_relative 'sus/be'
-require_relative 'sus/be_truthy'
-require_relative 'sus/be_within'
+require_relative "sus/expect"
+require_relative "sus/be"
+require_relative "sus/be_truthy"
+require_relative "sus/be_within"
 
-require_relative 'sus/mock'
-require_relative 'sus/receive'
+require_relative "sus/mock"
+require_relative "sus/receive"
 
-require_relative 'sus/raise_exception'
-require_relative 'sus/have_duration'
-require_relative 'sus/have'
+require_relative "sus/raise_exception"
+require_relative "sus/have_duration"
+require_relative "sus/have"
 
-require_relative 'sus/filter'
+require_relative "sus/filter"

data/readme.md

@@ -2,12 +2,12 @@
 
 Sus is a testing framework for Ruby.
 
-- It's similar to RSpec but with less baggage and more parallelism.
-- It uses `expect` style syntax with first-class predicates.
-- It has direct [support for code coverage](https://github.com/socketry/covered).
-- It supports the [VSCode Test Runner interface](https://github.com/socketry/sus-vscode).
-- It's based on my experience writing thousands of tests.
-- It's easy to extend (see the `sus-fixtures-` gems for examples).
+  - It's similar to RSpec but with less baggage and more parallelism.
+  - It uses `expect` style syntax with first-class predicates.
+  - It has direct [support for code coverage](https://github.com/socketry/covered).
+  - It supports the [VSCode Test Runner interface](https://github.com/socketry/sus-vscode).
+  - It's based on my experience writing thousands of tests.
+  - It's easy to extend (see the `sus-fixtures-` gems for examples).
 
 [![Development Status](https://github.com/socketry/sus/workflows/Test/badge.svg)](https://github.com/socketry/sus/actions?workflow=Test)
 
@@ -15,7 +15,7 @@ Sus is a testing framework for Ruby.
 
 <div align="center">
   <a href="https://www.youtube.com/watch?v=BDQHgb2rrwU">
-    <img src="https://img.youtube.com/vi/BDQHgb2rrwU/0.jpg" alt="Testing with Sus">
+    <img src="https://img.youtube.com/vi/BDQHgb2rrwU/0.jpg" alt="Testing with Sus"/>
   </a>
 </div>
 
@@ -25,9 +25,17 @@ Please see the [project documentation](https://socketry.github.io/sus/) for more
 
   - [Getting Started](https://socketry.github.io/sus/guides/getting-started/index) - This guide explains how to use the `sus` gem to write tests for your Ruby projects.
 
+## Releases
+
+Please see the [project releases](https://socketry.github.io/sus/releases/index) for all releases.
+
+### v0.32.0
+
+  - `Sus::Config` now has a `prepare_warnings!` hook which enables deprecated warnings by default. This is generally considered good behaviour for a test framework.
+
 ## See Also
 
-- [sus-vscode](https://github.com/socketry/sus-vscode) - Visual Studio Code extension for Sus.
+  - [sus-vscode](https://github.com/socketry/sus-vscode) - Visual Studio Code extension for Sus.
 
 ## Contributing
 

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v0.32.0
+
+  - `Sus::Config` now has a `prepare_warnings!` hook which enables deprecated warnings by default. This is generally considered good behaviour for a test framework.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -101,6 +101,7 @@ files:
 - lib/sus/with.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/sus
 licenses:
 - MIT
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A fast and scalable test runner.

metadata.gz.sig

@@ -1 +1,2 @@
-$#��g�=ȥbf����6���!}&Bݷ,���������}m�"
eL�xPN�n�#ˌ�H�M���T\'g\��߷Y<B�=[�-b]�NX=z6�C��Ø!��3HR6oM��o��܃�$v�/
+�2���pi��ٓc��p{^���
+��NU�M��.iQ �����&�1l)뀘�P�$@e���z����6�Hv�?��f��|���ڜ �7���w�h[<���z�m>�nee'�쬋d��!�ܙ�