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:

$ bundle add sus

Create a test file in your project test/my_project/my_class.rb:

describe MyProject::MyClass do
	let(:instance) {subject.new}
	
	it "instantiates an object" do
		expect(instance).to be_a(Object)
	end
end

Run your tests with the sus command:

$ 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:

$ sus-parallel

Check out all the repositories in this organisation, including these notable examples: