sus 0.33.0 → 0.33.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db29c44268893d062be3e45b5719a6dbc19e262f35176dd0c42d94cb2353d799
-  data.tar.gz: 9ec4e241579b44e02c319c96d58556629e58f3d293802abbc162ea0d503788d8
+  metadata.gz: 8f23ab2c7fb7e993b1d0e957104ec363d45512e7de084b3d8c539dd68f0944f0
+  data.tar.gz: 81786b021f4c5b2a27abcd589fc9844123f35c6c8b42495f56cbf1fba0f22778
 SHA512:
-  metadata.gz: a21e37fc13db88ab62f707aced7c459f6db1e12b51b70c872e82274f6fe2f70392dcd3248286dfd5714c02662205e72f4e554a70f23df42a3016d5ca03a585de
-  data.tar.gz: 8076f874b40ee4aab71dbf34c2efc0270a2d0e802a0455503d842935beeca28fa35333939304eee3f54ea06183e3c0bee6667776d66357076ffc6f32ddb59b21
+  metadata.gz: 9cac16658c6feadbdd5ea53d39f395527d4af3f620c1e06576e71f0f4bb8b59947f2aaec4da117eda384932e958e7c1cfe018d7573bc630d408142ce68abf916
+  data.tar.gz: 3d4964ca4aab54d6764072d8a1c015dc28c0ed2a4d84ec96877d62affc415eabf80094f74fbfc24cf88ca25c102f2f669560f0605b6f0474721c6ad0886cfab5

data/context/mocking.md

@@ -0,0 +1,95 @@
+# Mocking
+
+There are two types of mocking in sus: `receive` and `mock`. The `receive` matcher is a subset of full mocking and is used to set expectations on method calls, while `mock` can be used to replace method implementations or set up more complex behavior.
+
+Mocking non-local objects permanently changes the object's ancestors, so it should be used with care. For local objects, you can use `let` to define the object and then mock it.
+
+Sus does not support the concept of test doubles, but you can use `receive` and `mock` to achieve similar functionality.
+
+## Method Call Expectations
+
+The `receive(:method)` expectation is used to set up an expectation that a method will be called on an object. You can also specify arguments and return values. However, `receive` is not sequenced, meaning it does not enforce the order of method calls. If you need to enforce the order, use `mock` instead.
+
+```ruby
+describe MyThing do
+	let(:my_thing) {subject.new}
+	
+	it "calls the expected method" do
+		expect(my_thing).to receive(:my_method)
+		
+		expect(my_thing.my_method).to be == 42
+	end
+end
+```
+
+### With Arguments
+
+```ruby
+it "calls the method with arguments" do
+	expect(object).to receive(:method_name).with(arg1, arg2)
+	# or .with_arguments(be == [arg1, arg2])
+	# or .with_options(be == {option1: value1, option2: value2})
+	# or .with_block
+	
+	object.method_name(arg1, arg2)
+end
+```
+
+### Returning Values
+
+```ruby
+it "returns a value" do
+	expect(object).to receive(:method_name).and_return("expected value")
+	result = object.method_name
+	expect(result).to be == "expected value"
+end
+```
+
+### Raising Exceptions
+
+```ruby
+it "raises an exception" do
+	expect(object).to receive(:method_name).and_raise(StandardError, "error message")
+	
+	expect{object.method_name}.to raise_exception(StandardError, message: "error message")
+end
+```
+
+### Multiple Calls
+
+```ruby
+it "calls the method multiple times" do
+	expect(object).to receive(:method_name).twice.and_return("result")
+	# or .with_call_count(be == 2)
+	expect(object.method_name).to be == "result"
+	expect(object.method_name).to be == "result"
+end
+```
+
+## Mock Objects
+
+Mock objects are used to replace method implementations or set up complex behavior. They can be used to intercept method calls, modify arguments, and control the flow of execution. They are thread-local, meaning they only affect the current thread, therefore are not suitable for use in tests that have multiple threads.
+
+```ruby
+describe ApiClient do
+	let(:http_client) {Object.new}
+	let(:client) {ApiClient.new(http_client)}
+	let(:users) {["Alice", "Bob"]}
+	
+	it "makes GET requests" do
+		mock(http_client) do |mock|
+			mock.replace(:get) do |url, headers: {}|
+				expect(url).to be == "/api/users"
+				expect(headers).to be == {"accept" => "application/json"}
+				users.to_json
+			end
+			
+			# or mock.before {|...| ...}
+			# or mock.after {|...| ...}
+			# or mock.wrap(:new) {|original, ...| original.call(...)}
+		end
+		
+		expect(client.fetch_users).to be == users
+	end
+end
+```

data/context/shared.md

@@ -0,0 +1,185 @@
+# Shared Test Behaviors and Fixtures
+
+## Overview
+
+Sus provides shared test contexts which can be used to define common behaviours or tests that can be reused across one or more test files.
+
+When you have common test behaviors that you want to apply to multiple test files, add them to the `fixtures/` directory. When you have common test behaviors that you want to apply to multiple implementations of the same interface, within a single test file, you can define them as shared contexts within that file.
+
+## Shared Fixtures
+
+### Directory Structure
+
+```
+my-gem/
+├── lib/
+│   ├── my_gem.rb
+│   └── my_gem/
+│       └── my_thing.rb
+├── fixtures/
+│   └── my_gem/
+│       └── a_thing.rb               # Provides MyGem::AThing shared context
+└── test/
+    ├── my_gem.rb
+    └── my_gem/
+        └── my_thing.rb
+```
+
+### Creating Shared Fixtures
+
+Create shared behaviors in the `fixtures/` directory using `Sus::Shared`:
+
+```ruby
+# fixtures/my_gem/a_user.rb
+
+require "sus/shared"
+
+module MyGem
+	AUser = Sus::Shared("a user") do |role|
+		let(:user) do
+			{
+				name: "Test User",
+				email: "test@example.com",
+				role: role
+			}
+		end
+		
+		it "has a name" do
+			expect(user[:name]).not.to be_nil
+		end
+		
+		it "has a valid email" do
+			expect(user[:email]).to be(:include?, "@")
+		end
+		
+		it "has a role" do
+			expect(user[:role]).to be_a(String)
+		end
+	end
+end
+```
+
+### Using Shared Fixtures
+
+Require and use shared fixtures in your test files:
+
+```ruby
+# test/my_gem/user_manager.rb
+require 'my_gem/a_user'
+
+describe MyGem::UserManager do
+	it_behaves_like MyGem::AUser, "manager"
+	# or include_context MyGem::AUser, "manager"
+end
+```
+
+### Multiple Shared Fixtures
+
+You can create multiple shared fixtures for different scenarios:
+
+```ruby
+# fixtures/my_gem/users.rb
+module MyGem
+	module Users
+		AStandardUser = Sus::Shared("a standard user") do
+			let(:user) do
+				{ name: "John Doe", role: "user", active: true }
+			end
+			
+			it "is active" do
+				expect(user[:active]).to be_truthy
+			end
+		end
+		
+		AnAdminUser = Sus::Shared("an admin user") do
+			let(:user) do
+				{ name: "Admin User", role: "admin", active: true }
+			end
+			
+			it "has admin role" do
+				expect(user[:role]).to be == "admin"
+			end
+		end
+	end
+end
+```
+
+Use specific shared fixtures:
+
+```ruby
+# test/my_gem/authorization.rb
+require 'my_gem/users'
+
+describe MyGem::Authorization do
+	with "standard user" do
+		# If there are no arguments, you can use `include` directly:
+		include MyGem::Users::AStandardUser
+		
+		it "denies admin access" do
+			auth = subject.new
+			expect(auth.can_admin?(user)).to be_falsey
+		end
+	end
+	
+	with "admin user" do
+		include MyGem::Users::AnAdminUser
+		
+		it "allows admin access" do
+			auth = subject.new
+			expect(auth.can_admin?(user)).to be_truthy
+		end
+	end
+end
+```
+
+### Modules
+
+You can also define shared behaviors in modules and include them in your test files:
+
+```ruby
+# fixtures/my_gem/shared_behaviors.rb
+module MyGem
+	module SharedBehaviors
+		def self.included(base)
+			base.it "uses shared data" do
+				expect(shared_data).to be == "some shared data"
+			end
+		end
+		
+		def shared_data
+			"some shared data"
+		end
+	end
+end
+```
+
+### Enumerating Tests
+
+Some tests will be run multiple times with different arguments (for example, multiple database adapters). You can use `Sus::Shared` to define these tests and then enumerate them:
+
+```ruby
+# test/my_gem/database_adapter.rb
+
+require "sus/shared"
+
+ADatabaseAdapter = Sus::Shared("a database adapter") do |adapter|
+	let(:database) {adapter.new}
+	
+	it "connects to the database" do
+		expect(database.connect).to be_truthy
+	end
+	
+	it "can execute queries" do
+		expect(database.execute("SELECT 1")).to be == [[1]]
+	end
+end
+
+# Enumerate the tests with different adapters
+MyGem::DatabaseAdapters.each do |adapter|
+	describe "with #{adapter}", unique: adapter.name do
+		it_behaves_like ADatabaseAdapter, adapter
+	end
+end
+```
+
+Note the use of `unique: adapter.name` to ensure each test is uniquely identified, which is useful for reporting and debugging - otherwise the same test line number would be used for all iterations, which can make it hard to identify which specific test failed.

data/context/usage.md

@@ -0,0 +1,380 @@
+# Using Sus Testing Framework
+
+## Overview
+
+Sus is a modern Ruby testing framework that provides a clean, BDD-style syntax for writing tests. It's designed to be fast, simple, and expressive.
+
+## Basic Structure
+
+Here is an example structure for testing with Sus - the actual structure may vary based on your gem's organization, but aside from the `lib/` directory, sus expects the following structure:
+
+```
+my-gem/
+├── config/
+│   └── sus.rb                     # Sus configuration file
+├── lib/
+│   ├── my_gem.rb
+│   └── my_gem/
+│       └── my_thing.rb
+├── fixtures/
+│   └── my_gem/
+│       └── a_thing.rb               # Provides MyGem::AThing shared context
+└── test/
+    ├── my_gem.rb                    # Tests MyGem
+    └── my_gem/
+        └── my_thing.rb              # Tests MyGem::MyThing
+```
+
+### Configuration File
+
+Create `config/sus.rb`:
+
+```ruby
+# frozen_string_literal: true
+
+# Use the covered gem for test coverage reporting:
+require 'covered/sus'
+include Covered::Sus
+
+def before_tests(assertions, output: self.output)
+	# Starts the clock and sets up the test environment:
+	super
+end
+
+def after_tests(assertions, output: self.output)
+	# Stops the clock and prints the test results:
+	super
+end
+```
+
+### Fixtures Files
+
+`fixtures/` gets added to the `$LOAD_PATH` automatically, so you can require files from there without needing to specify the full path.
+
+### Test Files
+
+Sus runs all Ruby files in the `test/` directory by default. But you can also create tests in any file, and run them with the `sus my_tests.rb` command.
+
+## Basic Syntax
+
+```ruby
+# frozen_string_literal: true
+
+describe MyThing do
+	let(:my_thing) {subject.new}
+	
+	with "#my_method" do
+		it "does something" do
+			expect(my_thing.my_method).to be == 42
+		end
+	end
+end
+```
+
+### `describe` - Test Groups
+
+Use `describe` to group related tests:
+
+```ruby
+describe MyThing do
+	# The subject will be whatever is described:
+	let(:my_thing) {subject.new}
+end
+```
+
+### `it` - Individual Tests
+
+Use `it` to define individual test cases:
+
+```ruby
+it "returns the expected value" do
+	expect(result).to be == "expected"
+end
+```
+
+You can use `it` blocks at the top level or within `describe` or `with` blocks.
+
+### `with` - Context Blocks
+
+Use `with` to create context-specific test groups:
+
+```ruby
+with "valid input" do
+	let(:input) {"valid input"}
+	it "succeeds" do
+		expect{my_thing.process(input)}.not.to raise_exception
+	end
+end
+
+# Non-lazy state can be provided as keyword arguments:
+with "invalid input", input: nil do
+	it "raises an error" do
+		expect{my_thing.process(input)}.to raise_exception(ArgumentError)
+	end
+end
+```
+
+When testing methods, use `with` to specify the method being tested:
+
+```ruby
+with "#my_method" do
+	it "results a value" do
+		expect(my_thing.method).to be == 42
+	end
+end
+
+with ".my_class_method" do
+	it "returns a value" do
+		expect(MyThing.class_method).to be == "class value"
+	end
+end
+```
+
+### `let` - Lazy Variables
+
+Use `let` to define variables that are evaluated when first accessed:
+
+```ruby
+let(:helper) {subject.new}
+let(:test_data) {"test value"}
+
+it "uses the helper" do
+	expect(helper.process(test_data)).to be_truthy
+end
+```
+
+### `before` and `after` - Setup/Teardown
+
+Use `before` and `after` for setup and teardown logic:
+
+```ruby
+before do
+	# Setup logic.
+end
+
+after do
+	# Cleanup logic.
+end
+```
+
+Error handling in `after` allows you to perform cleanup even if the test fails with an exception (not a test failure).
+
+```ruby
+after do |error = nil|
+	if error
+		# The state of the test is unknown, so you may want to forcefully kill processes or clean up resources.
+		Process.kill(:KILL, @child_pid)
+	else
+		# Normal cleanup logic.
+		Process.kill(:TERM, @child_pid)
+	end
+	
+	Process.waitpid(@child_pid)
+end
+```
+
+### `around` - Setup/Teardown
+
+Use `around` for setup and teardown logic:
+
+```ruby
+around do |&block|
+	# Setup logic.
+	super() do
+		# Run the test.
+		block.call
+	end
+ensure
+	# Cleanup logic.
+end
+```
+
+Invoking `super()` calls any parent `around` block, allowing you to chain setup and teardown logic.
+
+## Assertions
+
+### Basic Assertions
+
+```ruby
+expect(value).to be == expected
+exepct(value).to be >= 10
+expect(value).to be <= 100
+expect(value).to be > 0
+expect(value).to be < 1000
+expect(value).to be_truthy
+expect(value).to be_falsey
+expect(value).to be_nil
+expect(value).to be_equal(another_value)
+expect(value).to be_a(Class)
+```
+
+### Strings
+
+```ruby
+expect(string).to be(:start_with?, "prefix")
+expect(string).to be(:end_with?, "suffix")
+expect(string).to be(:match?, /pattern/)
+expect(string).to be(:include?, "substring")
+```
+
+### Ranges and Tolerance
+
+```ruby
+expect(value).to be_within(0.1).of(5.0)
+expect(value).to be_within(5).percent_of(100)
+```
+
+### Method Calls
+
+To call methods on the expected object:
+
+```ruby
+expect(array).to be(:include?, "value")
+expect(string).to be(:start_with?, "prefix")
+expect(object).to be(:respond_to?, :method_name)
+```
+
+### Collection Assertions
+
+```ruby
+expect(array).to have_attributes(length: be == 1)
+expect(array).to have_value(be > 1)
+
+expect(hash).to have_keys(:key1, "key2")
+expect(hash).to have_keys(key1: be == 1, "key2" => be == 2)
+```
+
+### Attribute Testing
+
+```ruby
+expect(user).to have_attributes(
+  name: be == "John",
+  age: be >= 18,
+  email: be(:include?, "@")
+)
+```
+
+### Exception Assertions
+
+```ruby
+expect do
+	risky_operation
+end.to raise_exception(RuntimeError, message: be =~ /expected error message/)
+```
+
+## Combining Predicates
+
+Predicates can be nested.
+
+```ruby
+expect(user).to have_attributes(
+	name: have_attributes(
+		first: be == "John",
+		last: be == "Doe"
+	),
+	comments: have_value(be =~ /test comment/),
+	created_at: be_within(1.minute).of(Time.now)
+)
+```
+
+### Logical Combinations
+
+```ruby
+expect(value).to (be > 10).and(be < 20)
+expect(value).to be_a(String).or(be_a(Symbol), be_a(Integer))
+```
+
+### Custom Predicates
+
+You can create custom predicates for more complex assertions:
+
+```ruby
+def be_small_prime
+	(be == 2).or(be == 3, be == 5, be == 7)
+end
+```
+
+## Block Expectations
+
+### Testing Blocks
+
+```ruby
+expect{operation}.to raise_exception(Error)
+expect{operation}.to have_duration(be < 1.0)
+```
+
+### Performance Testing
+
+You should generally avoid testing performance in unit tests, as it will be highly unstable and dependent on the environment. However, if you need to test performance, you can use:
+
+```ruby
+expect{slow_operation}.to have_duration(be < 2.0)
+expect{fast_operation}.to have_duration(be < 0.1)
+```
+
+- For less unsable performance tests, you can use the `sus-fixtures-time` gem which tries to compensate for the environment by measuring execution time.
+
+- For benchmarking, you can use the `sus-fixtures-benchmark` gem which measures a block of code multiple times and reports the execution time.
+
+## File Operations
+
+### Temporary Directories
+
+Use `Dir.mktmpdir` for isolated test environments:
+
+```ruby
+around do |block|
+	Dir.mktmpdir do |root|
+		@root = root
+		block.call
+	end
+end
+
+let(:test_path) {File.join(@root, "test.txt")}
+
+it "can create a file" do
+	File.write(test_path, "content")
+	expect(File).to be(:exist?, test_path)
+end
+```
+
+## Test Output
+
+In general, tests should not produce output unless there is an error or failure.
+
+### Informational Output
+
+You can use `inform` to print informational messages during tests:
+
+```ruby
+it "logs an informational message" do
+	rate = copy_data(source, destination)
+	inform "Copied data at #{rate}MB/s"
+	expect(rate).to be > 0
+end
+```
+
+This can be useful for debugging or providing context during test runs.
+
+### Console Output
+
+The `sus-fixtures-console` gem provides a way to surpress and capture console output during tests. If you are using code which generates console output, you can use this gem to capture it and assert on it.
+
+## Running Tests
+
+```bash
+# Run all tests
+bundle exec sus
+
+# Run specific test file
+bundle exec sus test/specific_test.rb
+```
+
+## Best Practices
+
+1. **Use real objects** instead of mocks when possible.
+2. **Dependency injection** for testability.
+3. **Isolatae mutable state** using temporary directories.
+4. **Clear test descriptions** that explain the behavior.
+5. **Group tests** with `describe` (classes) and `with` for better organization.
+6. **Keep tests simple** and focused on one behavior.

data/lib/sus/receive.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2024, by Samuel Williams.
+# Copyright, 2022-2025, by Samuel Williams.
 
 require_relative "respond_to"
 

data/lib/sus/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2024, by Samuel Williams.
+# Copyright, 2021-2025, by Samuel Williams.
 
 module Sus
-	VERSION = "0.33.0"
+	VERSION = "0.33.1"
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2021-2024, by Samuel Williams.  
+Copyright, 2021-2025, by Samuel Williams.  
 Copyright, 2022, by Brad Schrag.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.33.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -51,6 +51,9 @@ files:
 - bin/sus-host
 - bin/sus-parallel
 - bin/sus-tree
+- context/mocking.md
+- context/shared.md
+- context/usage.md
 - lib/sus.rb
 - lib/sus/assertions.rb
 - lib/sus/base.rb
@@ -113,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="