wisper-rspec 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21502770eb4a955472b6c79fc17e2ef4714ccfc4
-  data.tar.gz: 542574ad03f2c399bb665f4dcaf9a7a6488106d3
+  metadata.gz: 643aca16e7e08f43376f456256d0cfc5a4cb2621
+  data.tar.gz: aee3c2ee2e11a253f1dae2796340e0e8ed5474de
 SHA512:
-  metadata.gz: f3cf54a835f388971225a8ab3cd0dba450d47a5b242a6f4ae5942f41e3a00ac289fe6e9c35c47539a8d4edb9922308a17252a2be447e8cb14ebec0a4c87cee0d
-  data.tar.gz: 207eec7fc007cef723ed80cda2b521b6b57b5600f6dafa68735d6d970a3e77aedefc72e5e11e293767331704e4c44317d44b9aa3f298b65afa26ab148f51f2a9
+  metadata.gz: 3f0b3ed5f0bbccbd7ab38de8d59985d5f60ade1dad5990fd57886c0e5401ee45ab2b2bcb55d08516b47c8dfe3ed19f039c4e736e56e5f2639d33a3ca87443cd8
+  data.tar.gz: 9d06774d7b55f981b1e908fdb61618fab9af01a006c10864fc9f72afcde01f4c353d1526264ce8bfd25af79da9637f4acf0c2b9436b9b8cadf334319b334f2e1

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/.travis.yml

@@ -1,4 +1,7 @@
+sudo: false
 language: ruby
+before_install:
+  - gem install bundler
 script: rspec spec
 rvm:
   - '1.9.3'

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+0.0.3 (7/Mar/2017)
+
 0.0.2 (8/Jan/2015)
 
 * Added support for argument matching [#1] by Gavin Todes (GAV1N)

data/README.md

@@ -39,9 +39,26 @@ expect { publisher.execute }.to broadcast(:another_event, :arg_1, :arg_2)
 
 With event arguments, it matches only if the event is broadcast with those arguments. This assertion matches `broadcast(:another_event, :arg_1, :arg_2)` but not `broadcast(:another_event)`.
 
+```ruby
+# with arguments matcher
+expect { publisher.execute }.to broadcast(:event, hash_including(a: 2))
+```
 
+Rspec values matcher can be used to match arguments. This assertion matches `broadcast(:another_event, a: 2, b: 1)` but not `broadcast(:another_event, a: 3)`
+ 
+Matchers can be composed using [compound rspec matchers](http://www.rubydoc.info/gems/rspec-expectations/RSpec/Matchers/Composable):
 
-
+```ruby
+expect {
+  publisher.execute(123)
+  publisher.execute(234)
+}.to broadcast(:event, 123).and broadcast(:event, 234)
+
+expect {
+  publisher.execute(123)
+  publisher.execute(234)
+}.to broadcast(:event, 123).or broadcast(:event, 234)
+```
 
 ### Using message expections
 

data/lib/wisper/rspec/matchers.rb

@@ -1,8 +1,12 @@
 require 'rspec/expectations'
+require 'rspec/mocks/argument_list_matcher'
 
 module Wisper
   module RSpec
     class EventRecorder
+      include ::RSpec::Mocks::ArgumentMatchers
+      attr_reader :broadcast_events
+
       def initialize
         @broadcast_events = []
       end
@@ -16,16 +20,18 @@ module Wisper
       end
 
       def broadcast?(event_name, *args)
-        if args.size > 0
-          @broadcast_events.include?([event_name.to_s, *args])
-        else
-          @broadcast_events.map(&:first).include?(event_name.to_s)
+        expected_args = args.size > 0 ? args : [any_args]
+        @broadcast_events.any? do |event_params|
+          matcher = ::RSpec::Mocks::ArgumentListMatcher.new(event_name.to_s, *expected_args)
+          matcher.args_match?(*event_params)
         end
       end
     end
 
     module BroadcastMatcher
       class Matcher
+        include ::RSpec::Matchers::Composable
+
         def initialize(event, *args)
           @event = event
           @args = args
@@ -36,18 +42,19 @@ module Wisper
         end
 
         def matches?(block)
-          event_recorder = EventRecorder.new
+          @event_recorder = EventRecorder.new
 
-          Wisper.subscribe(event_recorder) do
+          Wisper.subscribe(@event_recorder) do
             block.call
           end
 
-          event_recorder.broadcast?(@event, *@args)
+          @event_recorder.broadcast?(@event, *@args)
         end
 
         def failure_message
           msg = "expected publisher to broadcast #{@event} event"
           msg += " with args: #{@args.inspect}" if @args.size > 0
+          msg << broadcast_events_list
           msg
         end
 
@@ -56,6 +63,22 @@ module Wisper
           msg += " with args: #{@args.inspect}" if @args.size > 0
           msg
         end
+
+        def broadcast_events_list
+          if @event_recorder.broadcast_events.any?
+            " (actual events broadcast: #{event_names.join(', ')})"
+          else
+            " (no events broadcast)"
+          end
+        end
+        private :broadcast_events_list
+
+        def event_names
+          @event_recorder.broadcast_events.map do |event|
+            event.size == 1 ? event[0] : "#{event[0]}(#{event[1..-1].join(", ")})"
+          end
+        end
+        private :event_names
       end
 
       def broadcast(event, *args)
@@ -63,4 +86,15 @@ module Wisper
       end
     end
   end
+
+  # Prior to being extracted from Wisper the matcher was namespaced as Rspec,
+  # it is now RSpec. This will raise a helpful message for those upgrading to
+  # Wisper 2.0
+  module Rspec
+    module BroadcastMatcher
+      def self.included(base)
+        raise 'Please include Wisper::RSpec::BroadcastMatcher instead of Wisper::Rspec::BroadcastMatcher (notice the capitalization of RSpec)'
+      end
+    end
+  end
 end

data/lib/wisper/rspec/version.rb

@@ -1,5 +1,5 @@
 module Wisper
   module Rspec
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/wisper/rspec/matchers_spec.rb

@@ -1,4 +1,4 @@
-require 'wisper/rspec/matchers'
+require_relative '../../../lib/wisper/rspec/matchers'
 
 RSpec::configure do |config|
   config.include(Wisper::RSpec::BroadcastMatcher)
@@ -6,13 +6,13 @@ end
 
 describe 'broadcast matcher' do
   let(:publisher_class) { Class.new { include Wisper::Publisher } }
-  let(:publisher) { publisher_class.new }
+  let(:publisher)       { publisher_class.new }
 
   it 'passes when publisher broadcasts inside block' do
     expect { publisher.send(:broadcast, :foobar) }.to broadcast(:foobar)
   end
 
-  context "with arguments" do
+  context 'with arguments' do
     it 'passes when publisher broadcasts inside block' do
       expect { publisher.send(:broadcast, :fizzbuzz, 12345) }.to broadcast(:fizzbuzz, 12345)
     end
@@ -21,11 +21,34 @@ describe 'broadcast matcher' do
       expect { publisher.send(:broadcast, :fizzbuzz, 12345) }.to broadcast(:fizzbuzz)
     end
 
+    it 'passes with rspect arguments matchers' do
+      expect { publisher.send(:broadcast, :fizzbuzz, 12345) }.to broadcast(:fizzbuzz, kind_of(Numeric))
+    end
+
+    it 'fails with rspec arguments matchers' do
+      expect { publisher.send(:broadcast, :fizzbuzz, 12345) }.to_not broadcast(:fizzbuzz, kind_of(Hash))
+    end
+
     it 'fails with incorrect arguments when publisher broadcasts inside block' do
       expect { publisher.send(:broadcast, :fizzbuzz, 12345) }.not_to broadcast(:fizzbuzz, 98765)
     end
   end
 
+  context 'with compound assertions' do
+    it 'passes when both values are expected' do
+      expect {
+        publisher.send(:broadcast, :fizzbuzz, 12345)
+        publisher.send(:broadcast, :fizzbuzz, 54321)
+      }.to broadcast(:fizzbuzz, 12345).and broadcast(:fizzbuzz, 54321)
+    end
+
+    it 'passes when either value is expected' do
+      expect {
+        publisher.send(:broadcast, :fizzbuzz, 54321)
+      }.to broadcast(:fizzbuzz, 12345).or broadcast(:fizzbuzz, 54321)
+    end
+  end
+
   it 'passes with not_to when publisher does not broadcast inside block' do
     expect { publisher }.not_to broadcast(:foobar)
   end

data/spec/wisper/rspec/old_matcher_spec.rb

@@ -0,0 +1,9 @@
+require_relative '../../../lib/wisper/rspec/matchers'
+
+describe 'including mis-capitalized matcher' do
+  it 'raises an exception' do
+    expect do
+      Class.new.send(:include, Wisper::Rspec::BroadcastMatcher)
+    end.to raise_error(/include Wisper::RSpec::BroadcastMatcher instead of/)
+  end
+end

data/spec/wisper/rspec/unit/broadcast_matcher_spec.rb

@@ -0,0 +1,72 @@
+require 'wisper'
+require_relative '../../../../lib/wisper/rspec/matchers'
+
+describe Wisper::RSpec::BroadcastMatcher::Matcher do
+  let(:event_name) { 'it_happened' }
+  let(:matcher)    { described_class.new(event_name) }
+
+  let(:broadcaster) do
+    Class.new do
+      include Wisper.publisher
+
+      public :broadcast
+    end.new
+  end
+
+  context 'matching event broadcast' do
+    let(:block) do
+      Proc.new do
+        broadcaster.broadcast(event_name)
+      end
+    end
+
+    describe '#matches?' do
+      it 'returns true' do
+        expect(matcher.matches?(block)).to be_truthy
+      end
+    end
+  end
+
+  context 'no events broadcast' do
+    let(:block) { Proc.new {} }
+
+    describe '#matches?' do
+      it 'returns false' do
+        expect(matcher.matches?(block)).to be_falsey
+      end
+    end
+
+    describe '#failure_message' do
+      before { matcher.matches?(block) }
+
+      it 'has descriptive failure message' do
+        expect(matcher.failure_message).to eq "expected publisher to broadcast #{event_name} event (no events broadcast)"
+      end
+    end
+  end
+
+  context 'non-matching event broadcast' do
+    let(:block) do
+      Proc.new do
+        broadcaster.broadcast('event1')
+        broadcaster.send(:broadcast, 'event2', 12345, :foo)
+      end
+    end
+
+    describe '#matches?' do
+      it 'returns false' do
+        expect(matcher.matches?(block)).to be_falsey
+      end
+    end
+
+    describe '#failure_message' do
+      before { matcher.matches?(block) }
+
+      it 'has descriptive failure message' do
+        message = "expected publisher to broadcast it_happened event "\
+          "(actual events broadcast: event1, event2(12345, foo))"
+        expect(matcher.failure_message).to eq(message)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wisper-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kris Leech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wisper
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -87,7 +88,9 @@ files:
 - lib/wisper/rspec/version.rb
 - spec/spec_helper.rb
 - spec/wisper/rspec/matchers_spec.rb
+- spec/wisper/rspec/old_matcher_spec.rb
 - spec/wisper/rspec/stub_wisper_publisher_spec.rb
+- spec/wisper/rspec/unit/broadcast_matcher_spec.rb
 - wisper-rspec.gemspec
 homepage: https://github.com/krisleech/wisper-rspec
 licenses:
@@ -109,11 +112,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rspec matchers and stubbing for Wisper
 test_files:
 - spec/spec_helper.rb
 - spec/wisper/rspec/matchers_spec.rb
+- spec/wisper/rspec/old_matcher_spec.rb
 - spec/wisper/rspec/stub_wisper_publisher_spec.rb
+- spec/wisper/rspec/unit/broadcast_matcher_spec.rb