wisper-rspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e6d23dd1020653426db699b54fc2a1b42303bc8
+  data.tar.gz: 456ec8f7f24ec51cb10848addfbb11ebf1ee1737
+SHA512:
+  metadata.gz: 40882bd92bd01b9c8be1efd98ba72409c5dab9d0f7b4d1bac38d095db7bb659986c63909b697a8954412d33242a2cb90f48f8eb93b8c522034529a1e17ebbc45
+  data.tar.gz: 9ed7cd318f57629d129e8175008dd248478033547695cfb7405c60dcb188a38592c77382708bafc58ea560ba3cd59a2752aeff0eb2964bbb32097f65dee60a51

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+script: rspec spec
+rvm:
+  - '1.9.3'
+  - '2.1.2'

data/Gemfile

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

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,104 @@
+# Wisper::Rspec
+
+WIP - This is being extracted from Wisper.
+
+Rspec matcher and stubbing for 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)
+```
+
+### Using message expections
+
+If you need to assert on the arguments broadcast you can subscribe a double 
+with a [message expection](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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/wisper/rspec.rb

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

data/lib/wisper/rspec/matchers.rb

@@ -0,0 +1,57 @@
+require 'rspec/expectations'
+
+module Wisper
+  module RSpec
+    class EventRecorder
+      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
+      end
+
+      def broadcast?(event_name)
+        @broadcast_events.include?(event_name.to_s)
+      end
+    end
+
+    module BroadcastMatcher
+      class Matcher
+        def initialize(event)
+          @event = event
+        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)
+        end
+
+        def failure_message
+          "expected publisher to broadcast #{@event} event"
+        end
+
+        def failure_message_when_negated
+          "expected publisher not to broadcast #{@event} event"
+        end
+      end
+
+      def broadcast(event)
+        Matcher.new(event)
+      end
+    end
+  end
+end

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 = "0.0.1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/wisper/rspec/matchers_spec.rb

@@ -0,0 +1,18 @@
+require 'wisper/rspec/matchers'
+
+RSpec::configure do |config|
+  config.include(Wisper::RSpec::BroadcastMatcher)
+end
+
+describe 'broadcast matcher' do
+  let(:publisher_class) { Class.new { include Wisper::Publisher } }
+  let(:publisher) { publisher_class.new }
+
+  it 'passes when publisher broadcasts inside block' do
+    expect { publisher.send(:broadcast, :foobar) }.to broadcast(:foobar)
+  end
+
+  it 'passes with not_to when publisher does not broadcast inside block' do
+    expect { publisher }.not_to broadcast(:foobar)
+  end
+end

data/spec/wisper/rspec/stub_wisper_publisher_spec.rb

@@ -0,0 +1,27 @@
+require 'wisper'
+require 'wisper/rspec/stub_wisper_publisher'
+
+describe '#stub_wisper_publisher' do
+  describe "given a piece of code invoking a publisher" do
+    class CodeThatReactsToEvents
+      def do_something
+        publisher = MyPublisher.new
+        publisher.on(:some_event) do |variable1, variable2|
+          return "Hello with #{variable1} #{variable2}!"
+        end
+        publisher.execute
+      end
+    end
+
+    context "when stubbing the publisher to emit an event" do
+      before do
+        stub_wisper_publisher("MyPublisher", :execute, :some_event, "foo1", "foo2")
+      end
+
+      it "emits the event" do
+        response = CodeThatReactsToEvents.new.do_something
+        expect(response).to eq "Hello with foo1 foo2!"
+      end
+    end
+  end
+end

data/wisper-rspec.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/rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wisper-rspec"
+  spec.version       = Wisper::Rspec::VERSION
+  spec.authors       = ["Kris Leech"]
+  spec.email         = ["kris.leech@gmail.com"]
+  spec.summary       = "Rspec matchers and stubbing for Wisper"
+  spec.description   =  "Rspec matchers and stubbing for Wisper"
+  spec.homepage      = "https://github.com/krisleech/wisper-rspec"
+  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 'rspec'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: wisper-rspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kris Leech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-27 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: rspec
+  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'
+description: Rspec matchers and stubbing for Wisper
+email:
+- kris.leech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wisper/rspec.rb
+- lib/wisper/rspec/matchers.rb
+- lib/wisper/rspec/stub_wisper_publisher.rb
+- lib/wisper/rspec/version.rb
+- spec/spec_helper.rb
+- spec/wisper/rspec/matchers_spec.rb
+- spec/wisper/rspec/stub_wisper_publisher_spec.rb
+- wisper-rspec.gemspec
+homepage: https://github.com/krisleech/wisper-rspec
+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.2.2
+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/stub_wisper_publisher_spec.rb