wisper-testing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4668832b4665bea0f8e3fee3daa2b29026b86689
+  data.tar.gz: 2f2c12b2acea21ac13676543ebd1c92b78799a22
+SHA512:
+  metadata.gz: b43632d980a24170b43bdf2c0865cfc2960f2c3237d3b619ea73485430b907a8d4272f0723df8512a011ce67ea045064f822a7ea5ea45ce91c9297546e735134
+  data.tar.gz: ecb631fdc01454792b6c242576c910be3ef83bd79450f4dc454dbcc5851b5bf1cffc5fec5e8e872be575c9e8258750cbba6721ca0a98e6e68043039f8ef81ed5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+sudo: false
+rvm:
+  - '2.4.0'
+before_install: gem install bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "bundler", "~> 1.10"
+gem "rake", "~> 10.0"
+gem "rspec"
+gem 'pry-byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kris Leech
+
+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,78 @@
+# Wisper::Testing
+
+[![Build Status](https://travis-ci.org/krisleech/wisper-testing.svg?branch=master)](https://travis-ci.org/krisleech/wisper-testing)
+
+Helpers for testing Wisper publisher/subscribers.
+
+## Installation
+
+```ruby
+gem 'wisper-testing'
+```
+
+## Usage
+
+Using `fake!` and `fake` prevents any events from being broadcast. 
+
+Instead each event is recorded and can be inspected.
+
+```ruby
+Wisper::Testing.fake!
+
+Wisper::Testing.fake do
+  # ...
+end
+
+Wisper::Testing.events # => [...]
+```
+
+### Inline
+
+Using `inline!` and `inline` ensures all events are broadcast using the default
+broadcaster, meaning any subscribers which are subscribed with `async: true`
+will not be called asynchronously, but synchronously.
+
+```ruby
+Wisper::Testing.inline!
+
+Wisper::Testing.inline do
+  # ...
+end
+```
+
+### Restore
+
+Using `restore!` will turn off `fake!` and `inline!` and restore the original
+configuration.
+
+It is not nessesary to call this if you are using the block variations 
+`fake` and `inline`.
+
+```ruby
+Wisper::Testing.restore!
+```
+
+### Enabled
+
+```ruby
+Wisper::Testing.enabled? # => true/false
+```
+
+## Development
+
+```
+ls **/*.rb | entr -c bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/krisleech/wisper-testing.
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org)
+code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wisper/testing"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

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/testing.rb

@@ -0,0 +1,117 @@
+require "wisper/testing/version"
+require "wisper/testing/fake_broadcaster"
+require "wisper/testing/inline_broadcaster"
+
+module Wisper
+  class Testing
+    # Sets all broadcasters to FakeBroadcaster which does not broadcast any
+    # events to the subscriber.
+    #
+    # @return self
+    #
+    def self.fake!
+      store_original_broadcasters
+      Wisper.configuration.broadcasters.keys.each do |key, broadcaster|
+        Wisper.configuration.broadcasters[key] = FakeBroadcaster.new
+      end
+      is_enabled
+      self
+    end
+
+    # Sets all broadcasters to FakeBroadcaster which does not broadcast any
+    # events to the subscriber, for the duration of the block
+    #
+    # @return self
+    #
+    def self.fake
+      fake!
+      yield
+      restore!
+      self
+    end
+
+    # Sets all broadcasters to InlineBroadcaster which broadcasts event
+    #  to the subscriber synchronously.
+    #
+    #  @return self
+    #
+    def self.inline!
+      store_original_broadcasters
+      Wisper.configuration.broadcasters.keys.each do |key, broadcaster|
+        Wisper.configuration.broadcasters[key] = InlineBroadcaster.new
+      end
+      is_enabled
+      self
+    end
+    
+    # Sets all broadcasters to InlineBroadcaster which broadcasts event
+    #  to the subscriber synchronously.
+    #
+    #  @return self
+    #
+    def self.inline
+      inline!
+      yield
+      restore!
+      self
+    end
+
+    # Restores the original broadcasters configuration
+    #
+    # @return self
+    #
+    def self.restore!
+      if enabled?
+        Wisper.configuration.broadcasters.clear
+        original_broadcasters.each do |key, broadcaster|
+          Wisper.configuration.broadcasters[key] = broadcaster
+        end
+        is_not_enabled
+      end
+      self
+    end
+
+    # Returns true when either fake! or inline! having been invoked and restore!
+    # has not subsequently been invoked.
+    #
+    # @return Boolean
+    #
+    def self.enabled?
+      !!@enabled
+    end
+
+    # Forget the original broadcaster configuration.
+    #
+    # This is only used in the specs of Wisper::Testing to get clean state.
+    #
+    # @api private
+    #
+    def self._forget
+      return unless original_broadcasters?
+      @enabled = false
+      @original_broadcasters = nil
+    end
+
+    private
+
+    def self.is_enabled
+      @enabled = true
+    end
+
+    def self.is_not_enabled
+      @enabled = false
+    end
+
+    def self.original_broadcasters
+      @original_broadcasters
+    end
+
+    def self.store_original_broadcasters
+      @original_broadcasters = Wisper.configuration.broadcasters.to_h.dup
+    end
+
+    def self.original_broadcasters?
+      !!original_broadcasters
+    end
+  end
+end

data/lib/wisper/testing/fake_broadcaster.rb

@@ -0,0 +1,9 @@
+module Wisper
+  class Testing
+    class FakeBroadcaster
+      def broadcast(listener, publisher, event, args)
+        # no-op
+      end
+    end
+  end
+end

data/lib/wisper/testing/inline_broadcaster.rb

@@ -0,0 +1,6 @@
+module Wisper
+  class Testing
+    class InlineBroadcaster < Wisper::Broadcasters::SendBroadcaster
+    end
+  end
+end

data/lib/wisper/testing/version.rb

@@ -0,0 +1,5 @@
+module Wisper
+  class Testing
+    VERSION = "0.1.0"
+  end
+end

data/wisper-testing.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper/testing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wisper-testing"
+  spec.version       = Wisper::Testing::VERSION
+  spec.authors       = ["Kris Leech"]
+  spec.email         = ["kris.leech@gmail.com"]
+
+  spec.summary       = "Helpers for testing Wisper publisher/subscribers."
+  spec.homepage      = "https://github.com/krisleech/wisper-testing"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'wisper', '~>2.0'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: wisper-testing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kris Leech
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- kris.leech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wisper/testing.rb
+- lib/wisper/testing/fake_broadcaster.rb
+- lib/wisper/testing/inline_broadcaster.rb
+- lib/wisper/testing/version.rb
+- wisper-testing.gemspec
+homepage: https://github.com/krisleech/wisper-testing
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Helpers for testing Wisper publisher/subscribers.
+test_files: []