File tree Expand file tree Collapse file tree 5 files changed +68
-2
lines changed
Expand file tree Collapse file tree 5 files changed +68
-2
lines changed Original file line number Diff line number Diff line change 1+ # Getting Started
2+
3+ This guide explains how to use the ` sus ` gem to write tests for your Ruby projects.
4+
5+ ## Installation
6+
7+ Add the gem to your project:
8+
9+ ~~~ bash
10+ $ bundle add sus
11+ ~~~
12+
13+ ## Write Some Tests
14+
15+ Create a test file in your project ` test/my_project/my_class.rb ` :
16+
17+ ~~~ ruby
18+ describe MyProject ::MyClass do
19+ let(:instance ) {subject.new }
20+
21+ it " instantiates an object" do
22+ expect(instance).to be_a(Object )
23+ end
24+ end
25+ ~~~
26+
27+ ## Run Your Tests
28+
29+ Run your tests with the ` sus ` command:
30+
31+ ~~~ bash
32+ $ sus
33+ 1 passed out of 1 total (1 assertions)
34+ 🏁 Finished in 47.0µs; 21272.535 assertions per second.
35+ 🐇 No slow tests found! Well done!
36+ ~~~
37+
38+ You can also run your tests in parallel:
39+
40+ ~~~ bash
41+ $ sus-parallel
42+ ~~~
43+
44+ ## More Examples
45+
46+ Check out all the repositories in this organisation, including these notable examples:
47+
48+ - [ sus/test] ( https://github.com/socketry/sus/tree/main/test/sus )
49+ - [ async/test] ( https://github.com/socketry/async/tree/main/test )
Original file line number Diff line number Diff line change 1+ # Automatically generated context index for Utopia::Project guides.
2+ # Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
3+ ---
4+ description : A fast and scalable test runner.
5+ metadata :
6+ documentation_uri : https://socketry.github.io/sus/
7+ funding_uri : https://github.com/sponsors/ioquatix/
8+ source_code_uri : https://github.com/socketry/sus.git
9+ files :
10+ - path : getting-started.md
11+ title : Getting Started
12+ description : This guide explains how to use the `sus` gem to write tests for your
13+ Ruby projects.
Original file line number Diff line number Diff line change 44# Copyright, 2021-2025, by Samuel Williams.
55
66module Sus
7- VERSION = "0.33.1 "
7+ VERSION = "0.34.0 "
88end
Original file line number Diff line number Diff line change @@ -29,6 +29,10 @@ Please see the [project documentation](https://socketry.github.io/sus/) for more
2929
3030Please see the [ project releases] ( https://socketry.github.io/sus/releases/index ) for all releases.
3131
32+ ### v0.34.0
33+
34+ - Allow ` expect(...).to receive(...) ` to accept one or more calls (at least once).
35+
3236### v0.33.0
3337
3438 - Add support for ` agent-context ` gem.
Original file line number Diff line number Diff line change 11# Releases
22
3- ## Unreleased
3+ ## v0.34.0
44
55 - Allow ` expect(...).to receive(...) ` to accept one or more calls (at least once).
66
You can’t perform that action at this time.
0 commit comments