rx-rspec 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c09e839a091c586847715b943b738538766dbd9
-  data.tar.gz: 24371ceefd48af50620a622f1677d99145453f2d
+  metadata.gz: 5ec713b68381116f5cd0dd29928c999f8e831176
+  data.tar.gz: 41a63b49be631831293838c800c634fa5526a5d0
 SHA512:
-  metadata.gz: a1d837c502f93a25eb91a31a0464a894b3ef404a1b9ea006f668a15394e351278b3404631fcf1d58a6283bc6ab85531f5b3813e79dc24614ba23e4dae88a989f
-  data.tar.gz: 7b22bc0e6606ac700b44ac10e22f325e550d98cbe9c1ae53012a7473abdc896bff221f035aaa20e049cb3de7b2325863710481c7090d3b46701e1d2fe5c91fd3
+  metadata.gz: 9ae42de39081fd07ec0cefeca36057110f8e61110e46e679337283e0167ff7e6a8a2e75dffc5df029506bf60939cb28bc1bcd476f6a682d4ed4af856d8e0874c
+  data.tar.gz: fab1f1821c010e82aa29f8a1b8f63729f75a6dae62c66e5f4ebcc4eda7e61f36246c68e2ee2131fb14b1fc4738f7a103d913ce861ef6a4bdbc5099e53cb6e1b7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rx-rspec (0.3.1)
+    rx-rspec (0.4.1)
       rx
 
 GEM

data/README.md

@@ -32,12 +32,19 @@ describe 'awesome' do
   it { should emit_exactly(1, 2, 3) }
 end
 ```
+You can also set a timeout in seconds so your specs don't block forever in case an observable never emits/completes/errors.
+```
+it 'should be fast' do
+  expect(observable).to emit_exactly(42).within(0.1)
+end
+```
 
 ## Matchers
 
 rx-spec include the following matchers:
 
-- **emit_nothing()** matches an observable that completes without emitting events or erroring.
-- **emit_exactly()** matches against all items produced by the observable and requires the observable to be completed.
-- **emit_first()** matches against the first elements of the observable, but does not require it to complete
-- **emit_include()** consumes elements until the expected elements have occurred
+- **emit_error(class, message)** matches an observable that errors without emitting any values.
+- **emit_exactly(\*events)** matches an observable that emits exactly the given values and requires the observable to be completed.
+- **emit_first(\*events)** matches against the first values emitted by the observable, but does not require it to complete.
+- **emit_include(\*events)** consumes values until the expected values have been seen.
+- **emit_nothing()** matches an observable that completes without emitting values or erroring.

data/lib/rx-rspec.rb

@@ -1,3 +1,5 @@
+require 'rx-rspec/error'
 require 'rx-rspec/exactly'
 require 'rx-rspec/first'
 require 'rx-rspec/include'
+require 'rx-rspec/nothing'

data/lib/rx-rspec/async_runner.rb

@@ -0,0 +1,47 @@
+require 'rspec'
+
+module RxRspec
+  class TimeoutError < RuntimeError ; end
+
+  class AsyncRunner
+    def initialize(timeout)
+      @timeout = timeout
+    end
+
+    def await_done(&block)
+      condition = ConditionVariable.new
+      deadline = Time.now + @timeout
+      done_args = nil
+      error = nil
+      Thread.new do
+        done = Proc.new do |*args|
+          done_args = args unless done_args
+          condition.signal
+        end
+        begin
+          block.call(done)
+        rescue => e
+          error = e
+          done.call
+        end
+      end.join(@timeout)
+
+      gate = Mutex.new
+      while Time.now < deadline && done_args.nil?
+        gate.synchronize { condition.wait(gate, deadline - Time.now) }
+      end
+
+      if error
+        raise error
+      elsif done_args.nil?
+        RSpec::Expectations.fail_with("Timeout after #{@timeout} seconds")
+      end
+
+      if done_args.nil? || done_args.size == 0
+        nil
+      else
+        done_args
+      end
+    end
+  end
+end

data/lib/rx-rspec/error.rb

@@ -0,0 +1,38 @@
+require 'rspec'
+require 'rx-rspec/shared'
+
+RSpec::Matchers.define :emit_error do
+  include RxRspec::Shared
+
+  match do |actual|
+    error_class, message = expected
+    begin
+      @actual = await_done do |done|
+        actual.subscribe(
+          lambda { |event| done.call(:events, event) },
+          lambda { |err| done.call(:error, err) },
+          lambda { done.call(:complete, nil) }
+        )
+      end
+    rescue Exception => err
+      @actual = [:error, err]
+      raise err
+    end
+    type, emitted = @actual
+    return type == :error &&
+      values_match?(error_class, emitted) &&
+      values_match?(message, emitted.message)
+  end
+
+  failure_message do
+    type, emitted = @actual
+    if type == :events
+      "unexpected #{emitted} emitted"
+    elsif type == :complete
+      "completed without error"
+    else
+      error_class, message = expected
+      present_error("#{error_class} with #{message}", emitted)
+    end
+  end
+end

data/lib/rx-rspec/exactly.rb

@@ -1,47 +1,39 @@
 require 'rspec'
 require 'rx-rspec/shared'
 
-# TODO:
-# - should have specific timeout message 'x seconds waiting for y'
-
 RSpec::Matchers.define :emit_exactly do |*expected|
   include RxRspec::Shared
 
-  events = []
-  errors = []
   match do |actual|
-    Thread.new do
-      spinlock = expected.size
-      actual.subscribe(
-        lambda do |event|
-          events << event
-          spinlock -= 1
-        end,
-        lambda do |err|
-          errors << err
-          spinlock = 0
-        end,
-        lambda { spinlock = 0 }
-      )
-      for n in 1..10
-        break if spinlock == 0
-        sleep(0.05)
+    events = []
+    begin
+      error = await_done do |done|
+        actual.subscribe(
+          lambda do |event|
+            events << event
+            done.call if events.size > expected.size
+          end,
+          lambda { |err| done.call(:error, err) },
+          lambda { done.call }
+        )
       end
-      raise 'timeout' if spinlock > 0
-    end.join
+    rescue Exception => err
+      @actual = [:error, err]
+      raise err
+    end
 
-    return false unless errors.empty?
-    @actual = events
-    values_match? expected, events
+    @actual = error || [:events, events]
+    error.nil? && values_match?(expected, events)
   end
 
   diffable
 
   failure_message do
-    if errors.empty?
-      "expected #{events} to match #{expected}"
+    type, emitted = @actual
+    if type == :events
+      "expected #{emitted} to match #{expected}"
     else
-      present_error(expected, errors[0])
+      present_error(expected, emitted)
     end
   end
 end

data/lib/rx-rspec/first.rb

@@ -1,46 +1,39 @@
 require 'rspec'
 require 'rx-rspec/shared'
 
-# TODO:
-# - should have specific timeout message 'x seconds waiting for y'
-
 RSpec::Matchers.define :emit_first do |*expected|
   include RxRspec::Shared
 
-  events = []
-  errors = []
-  completed = []
-
   match do |actual|
     raise 'Please supply at least one expectation' if expected.size == 0
     expect_clone = expected.dup
-    Thread.new do
-      deadline = Time.now + 0.5
-      actual.take_while do |event|
-        events << event
-        values_match?(expect_clone.shift, event) && expect_clone.size > 0
-      end.subscribe(
-        lambda { |event| },
-        lambda { |err| errors << err },
-        lambda { completed << :complete }
-      )
-
-      until Time.now > deadline
-        break if expect_clone.empty?
-        break unless completed.empty? && errors.empty?
-        sleep(0.05)
+    events = []
+    begin
+      error = await_done do |done|
+        actual.take_while do |event|
+          events << event
+          values_match?(expect_clone.shift, event) && expect_clone.size > 0
+        end.subscribe(
+          lambda { |event| },
+          lambda { |err| done.call(:error, err) },
+          lambda { done.call }
+        )
       end
-      raise 'timeout' if Time.now > deadline
-    end.join
+    rescue Exception => err
+      @actual = [:error, err]
+      raise err
+    end
 
-    values_match? expected, events
+    @actual = error || [:events, events]
+    error.nil? && values_match?(expected, events)
   end
 
   failure_message do
-    if errors.empty?
-      "expected #{events} to emit at least #{expected}"
+    type, emitted = @actual
+    if type == :events
+      "expected #{emitted} to emit at least #{expected}"
     else
-      present_error(expected, errors[0])
+      present_error(expected, emitted)
     end
   end
 end

data/lib/rx-rspec/include.rb

@@ -1,47 +1,40 @@
 require 'rspec'
 require 'rx-rspec/shared'
 
-# TODO:
-# - should have specific timeout message 'x seconds waiting for y'
-
 RSpec::Matchers.define :emit_include do |*expected|
   include RxRspec::Shared
 
-  events = []
-  errors = []
-  completed = []
-
   match do |actual|
     expected = expected.dup
-    Thread.new do
-      deadline = Time.now + 0.5
-      actual.take_while do |event|
-        events << event
-        idx = expected.index { |exp| values_match?(exp, event) }
-        expected.delete_at(idx) unless idx.nil?
-        expected.size > 0
-      end.subscribe(
-        lambda { |event| },
-        lambda { |err| errors << err },
-        lambda { completed << :complete }
-      )
-
-      until Time.now > deadline
-        break if expected.empty?
-        break unless completed.empty? && errors.empty?
-        sleep(0.05)
+    events = []
+    begin
+      error = await_done do |done|
+        actual.take_while do |event|
+          events << event
+          idx = expected.index { |exp| values_match?(exp, event) }
+          expected.delete_at(idx) unless idx.nil?
+          expected.size > 0
+        end.subscribe(
+          lambda { |event| },
+          lambda { |err| done.call(:error, err) },
+          lambda { done.call }
+        )
       end
-      raise 'timeout' if Time.now > deadline
-    end.join
+    rescue Exception => err
+      @actual = [:error, err]
+      raise err
+    end
 
-    expected.empty?
+    @actual = error || [:events, events]
+    expected.empty? && error.nil?
   end
 
   failure_message do
-    if errors.empty?
-      "expected #{events} to include #{expected}"
+    type, emitted = @actual
+    if type == :events
+      "expected #{emitted} to include #{expected}"
     else
-      present_error(expected, errors[0])
+      present_error(expected, emitted)
     end
   end
 end

data/lib/rx-rspec/nothing.rb

@@ -1,39 +1,31 @@
 require 'rspec'
 require 'rx-rspec/shared'
 
-# TODO:
-# - should have specific timeout message 'x seconds waiting for y'
-
-RSpec::Matchers.define :emit_nothing do |*expected|
+RSpec::Matchers.define :emit_nothing do
   include RxRspec::Shared
 
-  events = []
-  errors = []
-  completed = []
   match do |actual|
-    Thread.new do
-      actual.subscribe(
-        lambda { |event| events << event },
-        lambda { |err| errors << err },
-        lambda { completed << :complete }
-      )
-      for n in 1..10
-        break unless completed.empty?
-        break unless errors.empty? && events.empty?
-        sleep(0.05)
+    begin
+      @actual = await_done do |done|
+        actual.subscribe(
+          lambda { |event| done.call(:events, event) },
+          lambda { |err| done.call(:error, err) },
+          lambda { done.call }
+        )
       end
-      raise 'timeout' if errors.empty? && events.empty? && completed.empty?
-    end.join
-
-    return false unless errors.empty?
-    return events.empty?
+    rescue Exception => err
+      @actual = [:error, err]
+      raise err
+    end
+    return @actual.nil?
   end
 
   failure_message do
-    if errors.empty?
-      "unexpected #{events[0]} emitted"
+    type, emitted = @actual
+    if type == :events
+      "unexpected #{emitted} emitted"
     else
-      present_error(expected, errors[0])
+      present_error(expected, emitted)
     end
   end
 end

data/lib/rx-rspec/shared.rb

@@ -1,7 +1,35 @@
+require 'rspec'
+require 'rx-rspec/async_runner'
+
 module RxRspec
   module Shared
+    DEFAULT_TIMEOUT = 0.5
+
+    def self.included(mod)
+      mod.chain :within do |seconds|
+        @timeout = seconds
+      end
+
+      mod.description do
+        if @timeout
+          super() + " within #{@timeout} seconds"
+        else
+          super()
+        end
+      end
+    end
+
+    def timeout
+      @timeout || DEFAULT_TIMEOUT
+    end
+
+    def await_done(&block)
+      AsyncRunner.new(timeout).await_done(&block)
+    end
+
     def present_error(expected, error)
       backtrace = error.backtrace || []
+      return error.message if /^Timeout/.match(error.message)
       present_error = "#{error.inspect}:#{$/}#{backtrace.join($/)}"
       "expected #{expected} but received error #{present_error}"
     end

data/rx-rspec.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name        = 'rx-rspec'
-  spec.version     = '0.3.1'
+  spec.version     = '0.4.1'
   spec.summary     = 'rspec testing support for RxRuby'
   spec.description = 'Writing specs for reactive streams is tricky both because of their asynchronous nature and because their next/error/completed semantics. The goal of rx-rspec is to provide powerful matchers that lets you express your expectations in a traditional rspec-like synchronous manner.'
   spec.authors     = ['Anders Qvist']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rx-rspec
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Anders Qvist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rx
@@ -110,6 +110,8 @@ files:
 - LICENSE.md
 - README.md
 - lib/rx-rspec.rb
+- lib/rx-rspec/async_runner.rb
+- lib/rx-rspec/error.rb
 - lib/rx-rspec/exactly.rb
 - lib/rx-rspec/first.rb
 - lib/rx-rspec/include.rb