README.md in async-rspec-1.12.0 vs README.md in async-rspec-1.12.1
- old
+ new
@@ -21,16 +21,22 @@
$ bundle
Or install it yourself as:
$ gem install async-rspec
+
+Finally, add this require statement to the top of `spec/spec_helper.rb`
+```ruby
+require 'async/rspec'
+```
+
## Usage
### Leaks
-Leaking sockets and other kinds of IOs is a problem for long running services. `Async::RSpec::Leaks` tracks all open sockets both before and after the spec. If any are left open, the spec fails.
+Leaking sockets and other kinds of IOs are a problem for long running services. `Async::RSpec::Leaks` tracks all open sockets both before and after the spec. If any are left open, a `RuntimeError` is raised and the spec fails.
```ruby
RSpec.describe "leaky ios" do
include_context Async::RSpec::Leaks
@@ -39,11 +45,11 @@
@input, @output = IO.pipe
end
end
```
-In some cases, the Ruby garbage collector will close IOs. In the above case, it's possible to just writing `IO.pipe` will not leak, as Ruby will garbage collect the resulting IOs immediately. It's still incorrect to not correctly close IOs, so don't depend on this behaviour.
+In some cases, the Ruby garbage collector will close IOs. In the above case, it's possible that just writing `IO.pipe` will not leak as Ruby will garbage collect the resulting IOs immediately. It's still incorrect to not close IOs, so don't depend on this behaviour.
### Allocations
Allocating large amounts of objects can lead to memery problems. `Async::RSpec::Memory` adds a `limit_allocations` matcher, which tracks the number of allocations and memory size for each object type and allows you to specify expected limits.
@@ -58,45 +64,50 @@
end
it "limits allocation counts (hash)" do
expect do
6.times{String.new}
- end.to limit_allocations(String => { count: 10 }) # 10 strings can be allocated
+ end.to limit_allocations(String => {count: 10}) # 10 strings can be allocated
end
it "limits allocation size" do
expect do
6.times{String.new("foo")}
- end.to limit_allocations(String => { size: 1024 }) # 1 KB of strings can be allocated
+ end.to limit_allocations(String => {size: 1024}) # 1 KB of strings can be allocated
end
end
```
### Reactor
-Many specs need to run within a reactor. A shared context is provided which includes all the relevant bits, including the above leaks checks.
+Many specs need to run within a reactor. A shared context is provided which includes all the relevant bits, including the above leaks checks. If your spec fails to run in less than 10 seconds, an `Async::TimeoutError` raises to prevent your test suite from hanging.
```ruby
-RSpec.describe IO do
+require 'async/io'
+
+RSpec.describe Async::IO do
include_context Async::RSpec::Reactor
let(:pipe) {IO.pipe}
- let(:input) {pipe.last}
- let(:output) {pipe.first}
+ let(:input) {Async::IO::Generic.new(pipe.first)}
+ let(:output) {Async::IO::Generic.new(pipe.last)}
it "should send and receive data within the same reactor" do
message = nil
- output_task = reactor.with(output) do |wrapper|
- message = wrapper.read(1024)
+ output_task = reactor.async do
+ message = input.read(1024)
end
- reactor.with(input) do |wrapper|
- wrapper.write("Hello World")
+ reactor.async do
+ output.write("Hello World")
end
output_task.wait
expect(message).to be == "Hello World"
+
+ input.close
+ output.close
end
end
```
## Contributing