wisper-rspec-compat 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f54802ba45a1ad17a8e580ffe568d573a34506954a71b44d259c8f455f708618
+  data.tar.gz: 9c23e3ea6404655a2160557331d769df189481fa8bce5fb5a8376cde62af5f32
+SHA512:
+  metadata.gz: c2bd72d0ec67353db404b319ccf3d4f7aa659fa24e12fd78e5eead60e82f17a31c80ef1de98cf4b441ec5fab5b230a70384eca3718e02dc1d868787847e200a1
+  data.tar.gz: 5a27d430bf60a51f510ac9cb91bb3a19af8cfa383c5cb2f985eea0ab82709680d918c76877b09bc6555b88ca9ef24ec749894819eb261b11c1f3372fe3529319

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+Unreleased
+
+* Fixed the error of the missing matcher description (https://github.com/krisleech/wisper-rspec/pull/32)
+* Add not_publish matcher (https://github.com/krisleech/wisper-rspec/pull/35)
+
+1.1.0 (15/May/2018)
+
+Authors: Nikolai (nikolai-b), David Kennedy (TheTeaNerd)
+
+* Add not_broadcast matcher (https://github.com/krisleech/wisper-rspec/pull/30)
+* Doc fixes
+
+1.0.1 (24/Feb/2018)
+
+Authors: Kris Leech, Konstantin Rudy (k-ruby)
+
+* fixes: undefined method `id` when using LoggerBroadcaster [#22]
+
+1.0.0 (16/Sept/2017)
+
+Authors: Adis Osmonov (adisos)
+
+* Matchers shows diff when expectation fails #18
+
+0.0.3 (7/Mar/2017)
+
+0.0.2 (8/Jan/2015)
+
+* Added support for argument matching [#1] by Gavin Todes (GAV1N)
+
+0.0.1 (27/Oct/2014)
+
+* Abstracted rspec from [Wisper](https://github.com/krisleech/wisper) gem.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kris Leech
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# Wisper::Rspec
+
+Rspec matcher and stubbing for [Wisper](https://github.com/krisleech/wisper).
+
+[![Gem Version](https://badge.fury.io/rb/wisper-rspec.png)](http://badge.fury.io/rb/wisper-rspec)
+[![Build Status](https://travis-ci.org/krisleech/wisper-rspec.png?branch=master)](https://travis-ci.org/krisleech/wisper-rspec)
+
+## Installation
+
+```ruby
+gem 'wisper-rspec', require: false
+```
+
+## Usage
+
+### Broadcast Matcher
+
+In `spec_helper`
+
+```ruby
+require 'wisper/rspec/matchers'
+
+RSpec::configure do |config|
+  config.include(Wisper::RSpec::BroadcastMatcher)
+end
+```
+
+In your specs:
+```ruby
+expect { publisher.execute }.to broadcast(:an_event)
+```
+This will match both `broadcast(:an_event)` and `broadcast(:an_event, :arg_1)`.
+
+
+```ruby
+# with optional arguments
+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)
+```
+
+Note that the `broadcast` method is aliased as `publish`, similar to the *Wisper* library itself.
+
+### Not broadcast matcher
+
+If you want to assert a broadcast was not made you can use `not_broadcast` which is especially useful when chaining expectations.
+
+```ruby
+expect {
+  publisher.execute(123)
+}.to not_broadcast(:event, 99).and broadcast(:event, 123)
+```
+
+### Using message expectations
+
+If you need to assert on the listener receiving broadcast arguments you can subscribe a double
+with a [message expectation](https://github.com/rspec/rspec-mocks#message-expectations)
+and then use any of the [argument matchers](https://github.com/rspec/rspec-mocks#argument-matchers).
+
+```ruby
+listener = double('Listener')
+
+expect(listener).to receive(:an_event).with(some_args)
+
+publisher.subscribe(listener)
+
+publisher.execute
+```
+
+### Stubbing publishers
+
+You can stub publishers and their events in unit (isolated) tests that only care about reacting to events.
+
+Given this piece of code:
+
+```ruby
+class MyController
+  def create
+    publisher = MyPublisher.new
+
+    publisher.on(:some_event) do |variable|
+      return "Hello with #{variable}!"
+    end
+
+    publisher.execute
+  end
+end
+```
+
+You can test it like this:
+
+```ruby
+require 'wisper/rspec/stub_wisper_publisher'
+
+describe MyController do
+  context "on some_event" do
+    before do
+      stub_wisper_publisher("MyPublisher", :execute, :some_event, "foo")
+    end
+
+    it "renders" do
+      response = MyController.new.create
+      expect(response).to eq "Hello with foo!"
+    end
+  end
+end
+```
+
+This is useful when testing Rails controllers in isolation from the business logic.
+
+You can use any number of args to pass to the event:
+
+```ruby
+stub_wisper_publisher("MyPublisher", :execute, :some_event, "foo1", "foo2", ...)
+```
+
+See `spec/lib/rspec_extensions_spec.rb` for a runnable example.
+
+
+## Contributing
+
+Yes, please.

data/bin/console

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wisper/rspec"
+require 'wisper/rspec/matchers'

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wisper/rspec/matchers.rb

@@ -0,0 +1,140 @@
+require 'wisper'
+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
+
+      def respond_to?(method_name)
+        true
+      end
+
+      def respond_to_missing?(*)
+        true
+      end
+
+      def method_missing(method_name, *args, **kwargs, &block)
+        @broadcast_events << [method_name.to_s, *args, **kwargs]
+      end
+
+      def broadcast?(event_name, *args, **kwargs)
+
+        expected_args = args.size > 0 ? args : [any_args]
+        expected_kwargs = kwargs.empty? ? {} : kwargs
+        @broadcast_events.any? do |event_params|
+          name, *args, kwargs = event_params
+          matcher = ::RSpec::Mocks::ArgumentListMatcher.new(event_name.to_s, *expected_args, **expected_kwargs)
+          matcher.args_match?(name, *args, **kwargs)
+        end
+      end
+    end
+
+    module BroadcastMatcher
+      class Matcher
+        include ::RSpec::Matchers::Composable
+
+        def initialize(event, *args, **kwargs)
+          @event = event
+          @args = args
+          @kwargs = kwargs
+        end
+
+        def supports_block_expectations?
+          true
+        end
+
+        def matches?(block)
+          @event_recorder = EventRecorder.new
+
+          Wisper.subscribe(@event_recorder, {}) do
+            block.call
+          end
+
+          @event_recorder.broadcast?(@event, *@args, **@kwargs)
+        end
+
+        def description
+          msg = "broadcast #{@event} event"
+          msg += " with args: #{@args.inspect}" if @args.size > 0
+          msg += " with kwargs: #{@kwargs.inspect}" unless @kwargs.empty?
+          msg
+        end
+
+        def failure_message
+          msg = "expected publisher to broadcast #{@event} event"
+          msg += " with args: #{@args.inspect}" if @args.size > 0
+          msg += " with args: #{@kwargs.inspect}" unless @kwargs.empty?
+          msg << broadcast_events_list
+          msg
+        end
+
+        def expected
+          [] << @args
+          [] << @kwargs
+        end
+
+        def actual
+          broadcast_events_args
+        end
+
+        def diffable?
+          true
+        end
+
+        def failure_message_when_negated
+          msg = "expected publisher not to broadcast #{@event} event"
+          msg += " with args: #{@args.inspect}" if @args.size > 0
+          msg += " with args: #{@kwargs.inspect}" unless @kwargs.empty?
+          msg
+        end
+
+        def broadcast_events_args
+          @event_recorder.broadcast_events.map {|event| event.size == 1 ? [] : event[1..-1] }
+        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, **kwargs)
+        Matcher.new(event, *args, **kwargs)
+      end
+
+      alias_method :publish, :broadcast
+    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
+
+::RSpec::Matchers.define_negated_matcher :not_broadcast, :broadcast
+::RSpec::Matchers.define_negated_matcher :not_publish, :publish

data/lib/wisper/rspec/stub_wisper_publisher.rb

@@ -0,0 +1,12 @@
+class TestWisperPublisher
+  include Wisper::Publisher
+  def initialize(*args); end
+end
+
+def stub_wisper_publisher(clazz, called_method, event_to_publish, *published_event_args)
+  stub_const(clazz, Class.new(TestWisperPublisher) do
+    define_method(called_method) do |*args|
+      publish(event_to_publish, *published_event_args)
+    end
+  end)
+end

data/lib/wisper/rspec/version.rb

@@ -0,0 +1,5 @@
+module Wisper
+  module Rspec
+    VERSION = "2.0.0"
+  end
+end

data/lib/wisper/rspec.rb

@@ -0,0 +1 @@
+require "wisper/rspec/version"

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: wisper-rspec-compat
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Kris Leech
+- Jamie Schembri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies: []
+description: Rspec matchers and stubbing for Wisper-Compat
+email:
+- kris.leech@gmail.com
+- jamie.schembri@nedap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/wisper/rspec.rb
+- lib/wisper/rspec/matchers.rb
+- lib/wisper/rspec/stub_wisper_publisher.rb
+- lib/wisper/rspec/version.rb
+homepage: https://github.com/nedap/wisper-rspec-compat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: Rspec matchers and stubbing for Wisper-Compat
+test_files: []