sus 0.33.1 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f23ab2c7fb7e993b1d0e957104ec363d45512e7de084b3d8c539dd68f0944f0
-  data.tar.gz: 81786b021f4c5b2a27abcd589fc9844123f35c6c8b42495f56cbf1fba0f22778
+  metadata.gz: 5e9cdd2318c294d0d9cea4ae26b1b82635bdee10530302fc17c9fbbf66271e25
+  data.tar.gz: ae9c5b7311646e83acd88ad665126be152a8dc149db1e8a5156e0269f8a64b80
 SHA512:
-  metadata.gz: 9cac16658c6feadbdd5ea53d39f395527d4af3f620c1e06576e71f0f4bb8b59947f2aaec4da117eda384932e958e7c1cfe018d7573bc630d408142ce68abf916
-  data.tar.gz: 3d4964ca4aab54d6764072d8a1c015dc28c0ed2a4d84ec96877d62affc415eabf80094f74fbfc24cf88ca25c102f2f669560f0605b6f0474721c6ad0886cfab5
+  metadata.gz: da0963499c5f6b2aa2be21a5623a4ed1feb2f1889c6efcfb5fae927dbcf6bf33049a49ce849f622d4c87602ae353aa1476b89649bdc3de18a192dac495a97343
+  data.tar.gz: ddeb909536fdd63b90a1992fe7ba986320156fbd42d3c18bc2fdc82bdfd14879d61a3df0b4a7ffddb84bea8b0a5fb705b6730a4bbf05ff4083abaf2671042167

data/context/getting-started.md

@@ -0,0 +1,49 @@
+# Getting Started
+
+This guide explains how to use the `sus` gem to write tests for your Ruby projects.
+
+## Installation
+
+Add the gem to your project:
+
+~~~ bash
+$ bundle add sus
+~~~
+
+## Write Some Tests
+
+Create a test file in your project `test/my_project/my_class.rb`:
+
+~~~ ruby
+describe MyProject::MyClass do
+	let(:instance) {subject.new}
+	
+	it "instantiates an object" do
+		expect(instance).to be_a(Object)
+	end
+end
+~~~
+
+## Run Your Tests
+
+Run your tests with the `sus` command:
+
+~~~ bash
+$ sus
+1 passed out of 1 total (1 assertions)
+🏁 Finished in 47.0µs; 21272.535 assertions per second.
+🐇 No slow tests found! Well done!
+~~~
+
+You can also run your tests in parallel:
+
+~~~ bash
+$ sus-parallel
+~~~
+
+## More Examples
+
+Check out all the repositories in this organisation, including these notable examples:
+
+- [sus/test](https://github.com/socketry/sus/tree/main/test/sus)
+- [async/test](https://github.com/socketry/async/tree/main/test)

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: A fast and scalable test runner.
+metadata:
+  documentation_uri: https://socketry.github.io/sus/
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/sus.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to use the `sus` gem to write tests for your
+    Ruby projects.

data/lib/sus/assertions.rb

@@ -368,7 +368,7 @@ module Sus
 				@errored << assertions
 			elsif assertions.passed?
 				@passed << assertions
-
+				
 				# if @verbose
 				# 	@output.write(:indent, :passed, pass_prefix, :reset)
 				# 	self.print(@output, verbose: false)
@@ -376,7 +376,7 @@ module Sus
 				# end
 			else
 				@failed << assertions
-
+				
 				# @output.write(:indent, :failed, fail_prefix, :reset)
 				# self.print(@output, verbose: false)
 				# @output.puts

data/lib/sus/config.rb

@@ -195,7 +195,7 @@ module Sus
 				output.puts "🐇 No slow tests found! Well done!"
 			else
 				output.puts "🐢 Slow tests:"
-			
+				
 				slowest_tests.each do |test|
 					output.puts "\t", :variable, test.clock, :reset, ": ", test.target
 				end

data/lib/sus/mock.rb

@@ -28,7 +28,7 @@ module Sus
 		
 		def replace(method, &hook)
 			execution_context = Thread.current
-
+			
 			@interceptor.define_method(method) do |*arguments, **options, &block|
 				if execution_context == Thread.current
 					hook.call(*arguments, **options, &block)
@@ -42,24 +42,24 @@ module Sus
 		
 		def before(method, &hook)
 			execution_context = Thread.current
-
+			
 			@interceptor.define_method(method) do |*arguments, **options, &block|
 				hook.call(*arguments, **options, &block) if execution_context == Thread.current
 				super(*arguments, **options, &block)
 			end
-
+			
 			return self
 		end
-
+		
 		def after(method, &hook)
 			execution_context = Thread.current
-
+			
 			@interceptor.define_method(method) do |*arguments, **options, &block|
 				result = super(*arguments, **options, &block)
 				hook.call(result, *arguments, **options, &block) if execution_context == Thread.current
 				return result
 			end
-
+			
 			return self
 		end
 		
@@ -80,7 +80,7 @@ module Sus
 			end
 		end
 	end
-
+	
 	module Mocks
 		def after(error = nil)
 			super
@@ -90,36 +90,36 @@ module Sus
 		
 		def mock(target)
 			validate_mock!(target)
-
+			
 			mock = self.mocks[target]
-
+			
 			if block_given?
 				yield mock
 			end
-
+			
 			return mock
 		end
 		
 		private
 		
 		MockTargetError = Class.new(StandardError)
-
+		
 		def validate_mock!(target)
 			if target.frozen?
 				raise MockTargetError, "Cannot mock frozen object #{target.inspect}!"
 			end
 		end
-
+		
 		def mocks
 			@mocks ||= Hash.new{|h,k| h[k] = Mock.new(k)}.compare_by_identity
 		end
 	end
-
+	
 	class Base
 		def mock(target, &block)
 			# Pull in the extra functionality:
 			self.singleton_class.prepend(Mocks)
-
+			
 			# Redirect the method to the new functionality:
 			self.mock(target, &block)
 		end

data/lib/sus/output/messages.rb

@@ -56,13 +56,13 @@ module Sus
 			
 			def error(error, identity, prefix = error_prefix)
 				lines = error.message.split(/\r?\n/)
-			
+				
 				self.puts(:indent, *prefix, error.class, ": ", lines.shift)
 				
 				lines.each do |line|
 					self.puts(:indent, line)
 				end
-					
+				
 				self.write(Output::Backtrace.for(error, identity))
 				
 				if cause = error.cause

data/lib/sus/output/null.rb

@@ -22,13 +22,13 @@ module Sus
 			
 			def append(buffer)
 			end
-
+			
 			def indent
 			end
 			
 			def outdent
 			end
-
+			
 			def indented
 				yield
 			end

data/lib/sus/receive.rb

@@ -177,12 +177,12 @@ module Sus
 		end
 		
 		class Times
-			ONCE = Be.new(:==, 1)
+			AT_LEAST_ONCE = Be.new(:>=, 1)
 			
-			def initialize(condition = ONCE)
+			def initialize(condition = AT_LEAST_ONCE)
 				@condition = condition
 			end
-				
+			
 			def print(output)
 				output.write("with call count ", @condition)
 			end

data/lib/sus/respond_to.rb

@@ -36,7 +36,7 @@ module Sus
 			def initialize(options)
 				@options = options
 			end
-						
+			
 			def print(output)
 				output.write("with options ", :variable, @options.inspect)
 			end

data/lib/sus/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2021-2025, by Samuel Williams.
 
 module Sus
-	VERSION = "0.33.1"
+	VERSION = "0.34.0"
 end

data/readme.md

@@ -29,6 +29,10 @@ Please see the [project documentation](https://socketry.github.io/sus/) for more
 
 Please see the [project releases](https://socketry.github.io/sus/releases/index) for all releases.
 
+### v0.34.0
+
+  - Allow `expect(...).to receive(...)` to accept one or more calls (at least once).
+
 ### v0.33.0
 
   - Add support for `agent-context` gem.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.34.0
+
+  - Allow `expect(...).to receive(...)` to accept one or more calls (at least once).
+
 ## v0.33.0
 
   - Add support for `agent-context` gem.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.33.1
+  version: 0.34.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -51,6 +51,8 @@ files:
 - bin/sus-host
 - bin/sus-parallel
 - bin/sus-tree
+- context/getting-started.md
+- context/index.yaml
 - context/mocking.md
 - context/shared.md
 - context/usage.md
@@ -123,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A fast and scalable test runner.
 test_files: []