Skip to content

Commit 4668091

Browse files
committed
📝 More complete usage documentation
1 parent ca7084d commit 4668091

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,21 @@ Add to your `spec/spec_helper.rb`:
4040

4141
```ruby
4242
require "kettle/test/rspec"
43+
44+
# ... any other config you need to do.
45+
46+
# NOTE: Gemfiles for older rubies (< 2.7) won't have kettle-soup-cover.
47+
# The rescue LoadError handles that scenario.
48+
begin
49+
require "kettle-soup-cover"
50+
require "simplecov" if Kettle::Soup::Cover::DO_COV # `.simplecov` is run here!
51+
rescue LoadError => error
52+
# check the error message, and re-raise if not what is expected
53+
raise error unless error.message.include?("kettle")
54+
end
55+
56+
# This gem (or app)
57+
require "gem-under-test"
4358
```
4459

4560
Now you have many powerful testing tools at your disposal, all fully [documented](#-configuration) and tested.
@@ -169,6 +184,21 @@ Add to your `spec/spec_helper.rb`:
169184

170185
```ruby
171186
require "kettle/test/rspec"
187+
188+
# ... any other config you need to do.
189+
190+
# NOTE: Gemfiles for older rubies (< 2.7) won't have kettle-soup-cover.
191+
# The rescue LoadError handles that scenario.
192+
begin
193+
require "kettle-soup-cover"
194+
require "simplecov" if Kettle::Soup::Cover::DO_COV # `.simplecov` is run here!
195+
rescue LoadError => error
196+
# check the error message, and re-raise if not what is expected
197+
raise error unless error.message.include?("kettle")
198+
end
199+
200+
# This gem (or app)
201+
require "gem-under-test"
172202
```
173203

174204
That's it! Additional customizations can be done by setting environment variables.

0 commit comments

Comments
 (0)