async-rspec 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97dcfa776e85aa05a958dccc0211b29022faf1fbe054a9c294070efd23785e97
-  data.tar.gz: 267e2a08e809376bba96b59f80face4062d8782bf67406678a10c458cda9320c
+  metadata.gz: f46e5f7273a9f4b02334cb93c5af94692a1be38475e786650ba0bbe18b758bb4
+  data.tar.gz: 03dae4d878f4745f25185afa43712384b7045358492b7c7b403953d407e44210
 SHA512:
-  metadata.gz: 5c68ec95f28cef903eeb5c806d76e8c22260a7ba662179c96c96b9eaa8af268c6fc5f8b519d9fbde914ad7933b7495ed4a1e6a1424f479e46b5ff295d5862938
-  data.tar.gz: aa6aee44bb59f53f89a7a90f287728c946cd41508729b8274b92770c5fdafeab75d0fe5b72e90c359767eaa5f9a04ee05e7ea27ab5bd039791c308f7bf74b66a
+  metadata.gz: c97bc9bac72f0106c943f02562d5c94a2f4c01044611328a779cd7ee80f8dbac87d8cbfb1c820c7164cd538c4ec5a94a600439817457d30b4b640b65c3fd0986
+  data.tar.gz: 8d2b079fa24d81c270bd44dfad3ad4aed1456b100e03c5298661db9ae7a3a3f12bfc9eee7810416f2c6e5a103e4f38239f80d4ac24595f36b79ff36557ecfe46

data/.travis.yml

@@ -3,7 +3,6 @@ cache: bundler
 
 matrix:
   include:
-    - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in async-rspec.gemspec
 gemspec
 
+# gem "async", path: "../async"
+
 group :test do
-	gem "ruby-prof", platform: :mri
-end
+	gem "ruby-prof", git: "https://github.com/ruby-prof/ruby-prof"
+end

data/README.md

@@ -32,52 +32,7 @@ require 'async/rspec'
 
 ## Usage
 
-### Leaks
-
-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
-	
-	# The following fails:
-	it "leaks io" do
-		@input, @output = IO.pipe
-	end
-end
-```
-
-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.
-
-```ruby
-RSpec.describe "memory allocations" do
-	include_context Async::RSpec::Memory
-	
-	it "limits allocation counts" do
-		expect do
-			6.times{String.new}
-		end.to limit_allocations(String => 10) # 10 strings can be allocated
-	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
-	
-	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
-end
-```
-
-### Reactor
+### Async 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. If your spec fails to run in less than 10 seconds, an `Async::TimeoutError` raises to prevent your test suite from hanging.
 
@@ -111,6 +66,37 @@ RSpec.describe Async::IO do
 end
 ```
 
+### Changing Timeout
+
+You can change the timeout by specifying it as an option:
+
+```ruby
+RSpec.describe MySlowThing, timeout: 60 do
+	# ...
+end
+```
+
+### File Descriptor Leaks
+
+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
+	
+	# The following fails:
+	it "leaks io" do
+		@input, @output = IO.pipe
+	end
+end
+```
+
+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
+
+This functionality was moved to [`rspec-memory`](https://github.com/socketry/rspec-memory).
+
 ## Contributing
 
 1. Fork it

data/async-rspec.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 	spec.add_dependency "rspec-files", "~> 1.0"
 	
 	# Since we test the shared contexts, we need some bits of async:
-	spec.add_development_dependency "async", "~> 1.8"
+	spec.add_development_dependency "async", "~> 1.24"
 	
 	spec.add_development_dependency "covered"
 	spec.add_development_dependency "bundler"

data/lib/async/rspec/reactor.rb

@@ -20,49 +20,58 @@
 
 require_relative 'leaks'
 
+require 'kernel/async'
+
 require 'async/reactor'
 require 'async/debug/selector'
 
 module Async
 	module RSpec
 		module Reactor
-			def run_example(reactor, example, duration)
+			def notify_failure(exception = $!)
+				::RSpec::Support.notify_failure(exception)
+			end
+			
+			def run_in_reactor(reactor, duration = nil)
 				result = nil
 				
+				timer_task = nil
+				
+				if duration
+					timer_task = reactor.async do |task|
+						# Wait for the timeout, at any point this task might be cancelled if the user code completes:
+						task.annotate("timer task duration=#{duration}")
+						task.sleep(duration)
+						
+						# The timeout expired, so generate an error:
+						buffer = StringIO.new
+						reactor.print_hierarchy(buffer)
+						
+						# Raise an error so it is logged:
+						raise TimeoutError, "run time exceeded duration #{duration}s:\r\n#{buffer.string}"
+					end
+				end
+				
 				reactor.run do |task|
 					task.annotate(self.class)
 					
-					reactor = task.reactor
-					timer = nil
-					
-					if duration
-						timer = reactor.async do |task|
-							task.annotate("timer task duration=#{duration}")
-							task.sleep(duration)
-							
-							buffer = StringIO.new
-							reactor.print_hierarchy(buffer)
-							
-							reactor.stop
-							
-							raise TimeoutError, "run time exceeded duration #{duration}s:\r\n#{buffer.string}"
-						end
-					end
-					
-					task.async do |spec_task|
-						spec_task.annotate("example runner")
+					spec_task = task.async do |spec_task|
+						spec_task.annotate("running example")
+						
+						result = yield
 						
-						result = example.run
+						timer_task&.stop
 						
-						if result.is_a? Exception
-							reactor.stop
-						else
-							spec_task.children&.each(&:wait)
-						end
-					end.wait
+						raise Async::Stop
+					end
 					
-					timer.stop if timer
-				end
+					begin
+						timer_task&.wait
+						spec_task.wait
+					ensure
+						spec_task.stop
+					end
+				end.wait
 				
 				return result
 			end
@@ -79,7 +88,9 @@ module Async
 				duration = example.metadata.fetch(:timeout, 10)
 				
 				begin
-					run_example(reactor, example, duration)
+					run_in_reactor(reactor, duration) do
+						example.run
+					end
 				ensure
 					reactor.close
 				end

data/lib/async/rspec/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module RSpec
-		VERSION = "1.13.0"
+		VERSION = "1.14.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-rspec
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-10 00:00:00.000000000 Z
+date: 2019-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.24'
 - !ruby/object:Gem::Dependency
   name: covered
   requirement: !ruby/object:Gem::Requirement
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Helpers for writing specs against the async gem.