wisper-minitest 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96b41c064896a906422c64e0078fcfbfd944c87a
+  data.tar.gz: a3b5288fffdf58d4e8a92e2d8f4c6839f05b6337
+SHA512:
+  metadata.gz: 4d16b0e5bdce500bad21e9c22f59c3e56945036cb28c5e2f2bc951688c15e23194f36b5ec6042362aa7dde23935a6adaa4afd407e554e5f9157400266a324a2a
+  data.tar.gz: 413789ece547ffef5c877f7c5e5ba35e3ccd6a1e955df945a62a0a232b630d0efd3733510917bfaa003c2709557bfe5d57b1a0794742cd9c0cfa0fd63ebb7042

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - '1.9.3'
+  - '2.1.5'
+  - '2.2.0'

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+0.0.1 (05/Jun/2015)
+
+* `assert_broadcast` assertion ported from [wisper-rspec](https://github.com/krisleech/wisper-rspec)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,28 @@
+The MIT License (MIT)
+
+Some work is Copyright (c) 2014 Kris Leech under the same license :
+	* The Wisper::Minitest::EventRecorder class, with some modifications from
+	  Digital Cuisine	  
+	* Tests have been ported from wisper-rspec — when possible the original code 
+	  has been kept.
+
+All the rest is Copyright (c) 2015 Digital Cuisine
+
+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,56 @@
+# Wisper::MiniTest
+
+MiniTest assertions/expectations and stubbing for [Wisper](https://github.com/krisleech/wisper).
+Based on @krisleech work and his own [wisper-rspec](https://github.com/krisleech/wisper-rspec) gem.
+
+[![Gem Version](https://img.shields.io/gem/v/wisper-minitest.svg)](https://rubygems.org/gems/wisper-minitest)
+[![Build Status](https://img.shields.io/travis/digitalcuisine/wisper-minitest.svg)](https://travis-ci.org/digitalcuisine/wisper-minitest)
+
+## Installation
+
+```ruby
+gem 'wisper-minitest', require: false
+```
+
+## Usage
+
+### Broadcast assertion
+
+In `test_helper`
+
+```ruby
+require 'wisper/minitest/assertions'
+```
+
+In your tests:
+```ruby
+assert_broadcast(:an_event) { publisher.execute }
+```
+This will match both `broadcast(:an_event)` and `broadcast(:an_event, :arg_1)`.
+
+
+```ruby
+# with optional arguments
+assert_broadcast(:another_event, :arg1, :arg2) { publisher.execute }
+```
+
+With event arguments, it matches only if the event is broadcast with those 
+arguments. This assertion matches `broadcast(:another_event, :arg1, :arg2)` but 
+not `broadcast(:another_event)`.
+
+
+
+## Todo
+
+The [wisper-rspec](https://github.com/krisleech/wisper-rspec) gem is not fully
+ported yet. Here's what's missing: 
+
+- [x] Convert `broadcast` expectation to `assert_broadcast` assertion
+- [x] Add a `refute_broadcast` assertion
+- [x] Make those available as Minitest expectations too
+- [ ] Document or implement a way to assert that a listener is receiving events 
+- [ ] Port publisher stub feature 
+
+## Contributing
+
+Any contribution is welcome! Open an issue or send a pull request to get started.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end
+
+task default: :test

data/lib/wisper/minitest.rb

@@ -0,0 +1 @@
+require 'wisper/minitest/version'

data/lib/wisper/minitest/assertions.rb

@@ -0,0 +1,72 @@
+require 'minitest/unit'
+require 'wisper/minitest/event_recorder'
+
+module Minitest::Assertions
+
+  module Messages
+
+    def self.assertion_failure(event_recorder)
+      msg = "expected publisher to broadcast #{event_recorder.event_name} event"
+      if event_recorder.args.size == 0
+        if event_recorder.broadcast_events.any?
+          msg += " (not included in #{event_recorder.broadcast_events.map(&:first).join(', ')})"
+        else
+          msg += ' (no events broadcast)'
+        end
+      end
+      msg += " with args: #{event_recorder.args.inspect}" if event_recorder.args.size > 0
+      msg
+    end
+
+    def self.refutation_failure(event_recorder)
+      msg = "expected publisher not to broadcast #{event_recorder.event_name} event"
+      if event_recorder.args.size == 0
+        if event_recorder.broadcast_events.count > 1
+          msg += " (included in #{event_recorder.broadcast_events.map(&:first).join(', ')})"
+        end
+      end
+      msg += " with args: #{event_recorder.args.inspect}" if event_recorder.args.size > 0
+      msg
+    end
+  end
+
+  def assert_broadcast(*args)
+    event = args.shift
+    blk = args.first.respond_to?(:call) ? args.shift : nil
+    event_recorder = Wisper::Minitest::EventRecorder.new
+
+    # Call the given block within a temporary global subscriber
+    Wisper.subscribe(event_recorder) do
+      if block_given?
+        yield
+      elsif blk.respond_to?(:call)
+        blk.call
+      end
+    end
+
+    test = event_recorder.broadcast?(event, *args)
+
+    # Check that given event has been broadcast 
+    assert test, Messages.assertion_failure(event_recorder)
+  end
+
+  def refute_broadcast(*args)
+    event = args.shift
+    blk = args.first.respond_to?(:call) ? args.shift : nil
+    event_recorder = Wisper::Minitest::EventRecorder.new
+
+    # Call the given block within a temporary global subscriber
+    Wisper.subscribe(event_recorder) do
+      if block_given?
+        yield
+      elsif blk.respond_to?(:call)
+        blk.call
+      end
+    end
+
+    test = event_recorder.broadcast?(event, *args)
+
+    # Check that given event has not been broadcast
+    refute test, Messages.refutation_failure(event_recorder)
+  end
+end

data/lib/wisper/minitest/event_recorder.rb

@@ -0,0 +1,32 @@
+module Wisper
+  module Minitest
+    class EventRecorder
+      attr_reader :broadcast_events
+      attr_reader :event_name
+      attr_reader :args
+
+      def initialize
+        @broadcast_events = []
+      end
+
+      def respond_to?(method_name)
+        true
+      end
+
+      def method_missing(method_name, *args, &block)
+        @broadcast_events << [method_name.to_s, *args]
+      end
+
+      def broadcast?(event_name, *args)
+        @event_name = event_name
+        @args = args
+        
+        if args.size > 0
+          @broadcast_events.include?([event_name.to_s, *args])
+        else
+          @broadcast_events.map(&:first).include?(event_name.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/wisper/minitest/expectations.rb

@@ -0,0 +1,8 @@
+require 'minitest/unit'
+require 'minitest/spec'
+require 'wisper/minitest/assertions'
+
+module Minitest::Expectations
+  infect_an_assertion :assert_broadcast, :must_broadcast
+  infect_an_assertion :refute_broadcast, :wont_broadcast
+end

data/lib/wisper/minitest/version.rb

@@ -0,0 +1,5 @@
+module Wisper
+  module Minitest
+    VERSION = '0.0.3'
+  end
+end

data/test/assert_broadcast_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+require 'wisper/minitest/assertions'
+
+class TestAssertBroadcast < Minitest::Test
+
+  extend Minitest::Spec::DSL
+  
+  let(:event_name) { 'it_happened' }
+  
+  let(:broadcaster) do
+    Class.new do
+      include Wisper::Publisher
+      public :broadcast
+    end.new
+  end
+  
+  let(:event1) { 'trololo' }
+  let(:event2) { 'u mad?' }
+  
+  let(:non_matching_broadcast) do
+    Proc.new do
+      broadcaster.broadcast(event1)
+      broadcaster.broadcast(event2)
+    end
+  end
+  
+  
+  def test_passes_with_matching_event
+    assert_broadcast(event_name) { broadcaster.broadcast(event_name) }
+  end
+
+  def test_fails_with_non_matching_event
+    assert_raises Minitest::Assertion do
+      assert_broadcast(event_name, &non_matching_broadcast)
+    end
+  end
+
+  def test_fails_with_descriptive_failure_message_on_non_matching_event
+    exp = assert_raises MiniTest::Assertion do
+      assert_broadcast(event_name, &non_matching_broadcast)
+    end
+
+    assert_equal exp.message, "expected publisher to broadcast #{event_name} event (not included in #{event1}, #{event2})"
+  end
+  
+  def test_fails_with_no_broadcast
+    assert_raises Minitest::Assertion do
+      assert_broadcast(event_name) { }
+    end
+  end
+  
+  def test_fails_with_descriptive_failure_message_on_no_event
+    exp = assert_raises Minitest::Assertion do
+      assert_broadcast(event_name) { }
+    end
+    
+    assert_equal exp.message, "expected publisher to broadcast #{event_name} event (no events broadcast)"
+  end
+  
+  def test_passes_with_matching_event_and_arguments
+    assert_broadcast(event_name, :arg1, :arg2) { broadcaster.broadcast(event_name, :arg1, :arg2) }
+  end
+  
+  def test_fails_with_non_matching_arguments
+    assert_raises Minitest::Assertion do
+      assert_broadcast(event_name, :arg1, :arg2, &non_matching_broadcast)
+    end
+  end
+
+  def test_fails_with_descriptive_failure_message_on_non_matching_arguments
+    exp = assert_raises Minitest::Assertion do
+      assert_broadcast(event_name, :arg1, :arg2, &non_matching_broadcast)
+    end
+
+    assert_equal exp.message, "expected publisher to broadcast #{event_name} event with args: [:arg1, :arg2]"
+  end
+  
+end

data/test/expectations_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+require 'wisper/minitest/expectations'
+
+class TestExpectations < Minitest::Test
+  extend Minitest::Spec::DSL
+
+  let(:event_name) { 'it_happened' }
+
+  let(:broadcaster) do
+    Class.new do
+      include Wisper::Publisher
+      public :broadcast
+    end.new
+  end
+
+  def test_must_broadcast_no_args
+    proc{ broadcaster.broadcast(event_name) }.must_broadcast(event_name)
+  end
+
+  def test_must_broadcast_with_args
+    proc{ broadcaster.broadcast(event_name, :arg1) }.must_broadcast(event_name, :arg1)
+    proc{ broadcaster.broadcast(event_name, :arg1) }.must_broadcast(event_name)
+  end
+
+  def test_wont_broadcast_no_args
+    proc{ }.wont_broadcast(event_name)
+    proc{ }.wont_broadcast(event_name, :arg1)
+  end
+
+  def test_wont_broadcast_with_args
+    proc{ broadcaster.broadcast(event_name) }.wont_broadcast(event_name, :arg1)
+  end
+end

data/test/refute_broadcast_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+require 'wisper/minitest/assertions'
+
+class TestRefuteBroadcast < Minitest::Test
+  extend Minitest::Spec::DSL
+
+  let(:event_name) { 'it_happened' }
+
+  let(:broadcaster) do
+    Class.new do
+      include Wisper::Publisher
+      public :broadcast
+    end.new
+  end
+
+  let(:event1) { 'trololo' }
+  let(:event2) { 'u mad?' }
+
+  let(:non_matching_broadcast) do
+    Proc.new do
+      broadcaster.broadcast(event1)
+      broadcaster.broadcast(event2)
+    end
+  end
+
+  def test_passes_with_non_matching_event
+    refute_broadcast(event_name, &non_matching_broadcast)
+  end
+
+  def test_passes_with_no_broadcast
+    refute_broadcast(event_name) { }
+  end
+
+  def test_passes_with_non_matching_arguments
+    refute_broadcast(event_name, :arg1, :arg2, &non_matching_broadcast)
+  end
+
+  def test_fails_on_matching_event
+    assert_raises Minitest::Assertion do
+      refute_broadcast(event_name) { broadcaster.broadcast(event_name) }
+    end
+  end
+
+  def test_fails_with_descriptive_failure_message_on_matching_event
+    exp = assert_raises Minitest::Assertion do
+      refute_broadcast(event_name) { broadcaster.broadcast(event_name) }
+    end
+
+    assert_equal exp.message, "expected publisher not to broadcast #{event_name} event"
+  end
+
+  def test_fails_with_matching_event_and_arguments
+    assert_raises Minitest::Assertion do
+      refute_broadcast(event_name, :arg1, :arg2) { broadcaster.broadcast(event_name, :arg1, :arg2) }
+    end
+  end
+
+  def test_fails_with_descriptive_failure_message_on_matching_event_and_arguments
+    exp = assert_raises Minitest::Assertion do
+      refute_broadcast(event_name, :arg1, :arg2) { broadcaster.broadcast(event_name, :arg1, :arg2) }
+    end
+
+    assert_equal exp.message, "expected publisher not to broadcast #{event_name} event with args: [:arg1, :arg2]"
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+gem 'minitest'
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'wisper'

data/wisper-minitest.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper/minitest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wisper-minitest'
+  spec.version       = Wisper::Minitest::VERSION
+  spec.authors       = ['Olivier Lance @ Digital Cuisine']
+  spec.email         = ["olivier@digitalcuisine.fr"]
+  spec.summary       = 'MiniTest assertions/expectations and stubbing for Wisper'
+  spec.description   = 'MiniTest assertions/expectations and stubbing for Wisper'
+  spec.homepage      = 'https://github.com/digitalcuisine/wisper-minitest'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'wisper'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: wisper-minitest
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Olivier Lance @ Digital Cuisine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MiniTest assertions/expectations and stubbing for Wisper
+email:
+- olivier@digitalcuisine.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/wisper/minitest.rb
+- lib/wisper/minitest/assertions.rb
+- lib/wisper/minitest/event_recorder.rb
+- lib/wisper/minitest/expectations.rb
+- lib/wisper/minitest/version.rb
+- test/assert_broadcast_test.rb
+- test/expectations_test.rb
+- test/refute_broadcast_test.rb
+- test/test_helper.rb
+- wisper-minitest.gemspec
+homepage: https://github.com/digitalcuisine/wisper-minitest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: MiniTest assertions/expectations and stubbing for Wisper
+test_files:
+- test/assert_broadcast_test.rb
+- test/expectations_test.rb
+- test/refute_broadcast_test.rb
+- test/test_helper.rb