minitest-sus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 519ea936c0c0a204223290984b2d6c7c852a92ee3ffc2b930d183b66e77ea9d1
+  data.tar.gz: ac3ca0c1346b34c931a0c7982509845c48456af0d1f4857a66829d4cd53991cd
+SHA512:
+  metadata.gz: de792de78716e35bbffefece449cf0c83f898a42005089ba3d1dd6b87f7e1eb87fb6395d4e355489118ae0c652143f3051a0e6eb3a7d4ba80cf79f90d656bd23
+  data.tar.gz: d73fa1de9931a39f622e386c54a39ab3be3eb25a64e34acb7bb13f6182ad4d69c54116325dfdc401810b92dd511b3bdc7bba06bd629314c6676b209487e47d07

data/context/getting-started.md

@@ -0,0 +1,90 @@
+# Getting Started
+
+This guide explains how to use the `minitest-sus` gem to use [sus](https://github.com/socketry/sus) fixtures within [Minitest](https://github.com/minitest/minitest) tests.
+
+## Installation
+
+Add the gem to your project:
+
+``` bash
+$ bundle add minitest-sus
+```
+
+## Usage
+
+A sus fixture is a plain module that exposes `before`, `after` and `around` hooks along with helper methods. `Minitest::Sus::Context` provides the small amount of glue Minitest is missing (an `around` chain and a `mock` method) so those fixtures work unchanged.
+
+Include `Minitest::Sus::Context` into your test class **before** the fixtures. The fixtures must sit above the bridge in the ancestor chain, so ordering matters:
+
+``` ruby
+require "minitest/autorun"
+require "minitest/sus"
+
+require "sus/fixtures/async/reactor_context"
+
+class MyTest < Minitest::Test
+	include Minitest::Sus::Context
+	include Sus::Fixtures::Async::ReactorContext
+	
+	def test_runs_inside_the_reactor
+		# The fixture's `around` hook wraps the whole test in a reactor:
+		refute_nil Async::Task.current
+	end
+end
+```
+
+The entire Minitest lifecycle (`setup`, the test method and `teardown`) runs inside the fixture's `around` block, so any reactor, server or client set up by the fixture is available throughout.
+
+### HTTP Server Fixture
+
+`sus-fixtures-async-http` provides a server and client. It uses sus's `mock` API internally, which the bridge supplies, so it works without any changes:
+
+``` ruby
+require "minitest/autorun"
+require "minitest/sus"
+
+require "sus/fixtures/async/http/server_context"
+
+class ServerTest < Minitest::Test
+	include Minitest::Sus::Context
+	include Sus::Fixtures::Async::HTTP::ServerContext
+	
+	def test_can_perform_a_request
+		response = client.get("/")
+		
+		assert_equal 200, response.status
+		assert_equal "Hello World!", response.read
+	end
+end
+```
+
+You can override the fixture's helper methods (e.g. `app`, `url`, `protocol`) just like you would in sus, by defining them in your test class:
+
+``` ruby
+class ApplicationTest < Minitest::Test
+	include Minitest::Sus::Context
+	include Sus::Fixtures::Async::HTTP::ServerContext
+	
+	def app
+		Protocol::HTTP::Middleware.for do |request|
+			Protocol::HTTP::Response[200, {}, ["Hello from my app!"]]
+		end
+	end
+	
+	def test_serves_the_application
+		response = client.get("/")
+		
+		assert_equal "Hello from my app!", response.read
+	end
+end
+```
+
+## Isolation
+
+The bridge is opt-in per test class. Nothing about `Minitest::Test` is patched globally, so any test that does not include `Minitest::Sus::Context` is completely unaffected — no reactor is started and no hooks are installed.
+
+## Limitations
+
+The bridge supports the fixture contract used by gems like `sus-fixtures-async` and `sus-fixtures-async-http`: module-level `include`, the `before`/`after`/`around` hooks, helper methods and `mock`.
+
+It does not implement sus's class-level context DSL (`include_context`, shared contexts, `let`, `it`, nested `describe`/`context`), as those overlap with Minitest's own test model. Write your test methods and assertions using Minitest as usual.

data/context/index.yaml

@@ -0,0 +1,13 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: Use sus fixtures within Minitest tests.
+metadata:
+  documentation_uri: https://socketry.github.io/minitest-sus/
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/minitest-sus.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to use the `minitest-sus` gem to use [sus](https://github.com/socketry/sus)
+    fixtures within [Minitest](https://github.com/minitest/minitest) tests.

data/lib/minitest/sus/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+module Minitest
+	module Sus
+		VERSION = "0.1.0"
+	end
+end

data/lib/minitest/sus.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+require "minitest"
+
+# We reuse sus's own mock implementation so that fixtures which rely on `mock`
+# (e.g. sus-fixtures-async-http) work unchanged. It loads standalone.
+require "sus/mock"
+
+require_relative "sus/version"
+
+module Minitest
+	# A bridge that lets sus fixtures (plain modules exposing `before`, `after`,
+	# `around`, helper methods and `mock`) be used inside Minitest tests.
+	module Sus
+		# Include this into a `Minitest::Test` subclass to host sus fixtures,
+		# *before* the fixtures themselves so they sit above it in the ancestor
+		# chain.
+		#
+		# It is opt-in per test class — nothing about Minitest::Test is patched
+		# globally, so tests that don't use it are completely unaffected.
+		#
+		# It is the terminal of the fixture hook chain: it mirrors `Sus::Base`'s
+		# `before`/`after`/`around` contract, bridges `mock`, and wraps the whole
+		# Minitest run (setup + test + teardown) in the `around` chain so fixtures
+		# such as the async reactor are active throughout.
+		#
+		# @example Use an async reactor fixture within a Minitest test:
+		# 	class MyTest < Minitest::Test
+		# 		include Minitest::Sus::Context
+		# 		include Sus::Fixtures::Async::ReactorContext
+		# 		
+		# 		def test_example
+		# 			Async::Task.current # We are running inside the reactor.
+		# 		end
+		# 	end
+		module Context
+			# A hook which is called before the test is executed. Fixtures override
+			# this and call `super`.
+			def before
+			end
+			
+			# A hook which is called after the test is executed. Fixtures override
+			# this and call `super`.
+			# @parameter error [Exception | Nil] The error raised by the test, if any.
+			def after(error = nil)
+			end
+			
+			# Wrap logic around the test being executed. This is the terminal
+			# implementation: it runs `before`, yields, then `after`. Fixtures
+			# override this and call `super(&block)` to compose.
+			def around(&block)
+				self.before
+				
+				return block.call
+			rescue => error
+				raise
+			ensure
+				self.after(error)
+			end
+			
+			# Bridge sus's `mock` API onto the Minitest instance. The first call
+			# upgrades the instance with `Sus::Mocks`, which also installs the
+			# `after` cleanup that clears the mocks.
+			# @parameter target [Object] The object to mock.
+			def mock(target, &block)
+				self.singleton_class.prepend(::Sus::Mocks)
+				
+				# Redirect to the freshly prepended implementation:
+				self.mock(target, &block)
+			end
+			
+			# Run the test, wrapping the entire Minitest lifecycle in the `around`
+			# chain so fixture state (reactor, server, client, ...) is available to
+			# setup, the test body and teardown alike.
+			def run
+				result = nil
+				
+				around do
+					result = super
+				end
+				
+				return result
+			end
+		end
+	end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2026, by Samuel Williams.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,53 @@
+# Minitest::Sus
+
+Provides a bridge for using [sus](https://github.com/socketry/sus) fixtures within [Minitest](https://github.com/minitest/minitest) tests, e.g. `sus-fixtures-async` and `sus-fixtures-async-http`.
+
+[![Development Status](https://github.com/socketry/minitest-sus/workflows/Test/badge.svg)](https://github.com/socketry/minitest-sus/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/minitest-sus/) for more details.
+
+  - [Getting Started](https://socketry.github.io/minitest-sus/guides/getting-started/index) - This guide explains how to use the `minitest-sus` gem to use [sus](https://github.com/socketry/sus) fixtures within [Minitest](https://github.com/minitest/minitest) tests.
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/minitest-sus/releases/index) for all releases.
+
+### v0.1.0
+
+  - Initial implementation of the Minitest ↔ sus fixtures bridge.
+
+## 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.
+
+### Running Tests
+
+To run the test suite:
+
+``` shell
+bundle exec sus
+```
+
+### Making Releases
+
+To make a new release:
+
+``` shell
+bundle exec bake gem:release:patch # or minor or major
+```
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v0.1.0
+
+  - Initial implementation of the Minitest ↔ sus fixtures bridge.

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: minitest-sus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- context/getting-started.md
+- context/index.yaml
+- lib/minitest/sus.rb
+- lib/minitest/sus/version.rb
+- license.md
+- readme.md
+- releases.md
+homepage: https://github.com/socketry/minitest-sus
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://socketry.github.io/minitest-sus/
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/minitest-sus.git
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Use sus fixtures within Minitest tests.
+test_files: []