wisper 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 62cd6c2948137446de8f7f515bcbebd11c14092d
-  data.tar.gz: dfbc3b2d28c9023edc9f8308a6c406887c20efed
+SHA256:
+  metadata.gz: 2890739bfde16edeb614504b6a6ac9f1babe148c3ed3255af7b11d2b68275dc8
+  data.tar.gz: f64460470b4778927d19bbab51f5cd190ec2d16df4909340ee09aaa89b8e9636
 SHA512:
-  metadata.gz: d82be662081f118b83ce5f01f87a0760be1bbc9d711163fc76ac303db689ba307ec453afb9edfb374fa1b23e92ab6a684a2c3857580d3f6a29195c75c8d6f754
-  data.tar.gz: 9395fbd3e0d2b925d31dc06682aa573ad66b0f4ee980533b1671e497ce7f2b8b82019840c7f8eb15c7f52b7bdae73934592ae0e5634729b4ad99f2c068bcae3e
+  metadata.gz: 82292503201b5402aebb60c3ad433c4f1bfb22858fbd1221ba86225dbb9e597f2ffb97c8b075847a12c5a801fb92d7e84a9485fb8919c39548f80e54c2fdf318
+  data.tar.gz: b40625e6e3cf17df8a457f6547ecf5f0d921ff7dc771910462d0a5219d2aba9ab0afcc91787cdb5ccd49d18f48845eda3b95f20ef9bdd4914d1afca5c2f45f4c

data/.travis.yml

@@ -6,11 +6,10 @@ bundler_args: --without=extras
 script: rspec spec
 sudo: false
 rvm:
-  - '2.1.10'
-  - '2.2.6'
-  - '2.3.3'
-  - '2.4.0'
-  - jruby-9.1.6.0
+  - 2.6.3
+  - 2.5.5
+  - 2.4.6
+  - jruby-9.2
   # - rbx-2
   ### ALLOWED FAILURES ###
   # see how compatible we are with dev versions, but do not fail the build

data/CHANGELOG.md

@@ -1,10 +1,33 @@
 ## HEAD (unreleased)
 
-## 2.0.0 (7th Mar 2017)
+## 2.0.1 (29th Aug 2019)
+
+Authors: David Wilkie, hosseintoussi, Maxim Polunin, Tristan
+Harmer, Bartosz Żurkowski, Kris Leech
 
-Authors: Sergey Mostovoy
+* fix: support nested temporary global listeners
+* docs: add threadsafe notes to README for global and temporary listeners
+* docs: fix spelling mistakes in README
+* fix: safely get signing key in gemspec when HOME is not set
+* adds: add console to aid experiments and REPL driven development
+* adds: Latest Ruby to CI
+
+## 2.0.0 (7th Mar 2017)
 
-* fix: logger raises exception if hash is passed as an argument to a listener
+Authors: Sergey Mostovoy, Andrew Kozin, Kyle Tolle, Martin, Rob Miller, Mike
+Dalto, orthographic-pedant, Drew Ulmer, Mikey Hogarth, Attila Domokos, Josh
+Miltz, Pascal Betz, Vasily Kolesnikov, Julien Letessier, Kris Leech
+
+* Fix: logger raises exception if hash is passed as an argument to a listener #133, #136
+* Fix: deprecation warnings #120
+* Doc improvements: #106, #111, #116, #122, #128, #130, #147, #149, #150, #151
+* Adds: Allow configuration of default prefix when using `prefix: true`. #105
+* Adds: Allow unsubscribing of global listeners #118
+* Adds: Helpful error message when passing a block to `#subscribe` of `#on` #125
+* Adds: raise an error message when `#on` is not passed a block #146
+* Adds: Support for JRuby 9.x #148
+* Adds: Support for MRI 2.4.0 #155
+* Refactor specs #126, #131
 
 ## 2.0.0.rc1 (17 Dec 2014)
 

data/CONTRIBUTING.md

@@ -28,10 +28,6 @@ appropriate as an extension to Wisper.
 
 We also have a [Gitter channel](https://gitter.im/krisleech/wisper) if you wish to discuss your ideas.
 
-## Backlog /  Roadmap
-
-The backlog for Wisper and related gems is on [Waffle](https://waffle.io/krisleech/wisper).
-
 ## Questions
 
 Try the [Wiki](https://github.com/krisleech/wisper/wiki) first, the examples
@@ -43,7 +39,7 @@ Feel free to ping me the URL on [Twitter](https://twitter.com/krisleech).
 
 ## Pull requests
 
-* Fork the project, create a new branch from `v1` or `master`.
+* Fork the project, create a new branch `master`.
 * Squash commits which are related.
 * Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
 * Documentation only changes should have `[skip ci]` in the commit message
@@ -58,4 +54,4 @@ not backwards compatible.
 The `v1` branch is a long lived branch and you should
 branch from this if you wish to fix an issue in version `~> 1.0`.
 
-The `master` branch will target the next version of Wisper.
+Otherwise branch from `master` branch.

data/Gemfile

@@ -2,8 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake',  '~> 10.3.0'
-gem 'rspec', '~> 3.4.0'
+gem 'rake'
+gem 'rspec'
 gem 'coveralls', require: false
 
 group :extras do

data/README.md

@@ -10,10 +10,12 @@
 * Decouple core business logic from external concerns in Hexagonal style architectures
 * Use as an alternative to ActiveRecord callbacks and Observers in Rails apps
 * Connect objects based on context without permanence
-* React to events synchronously or asynchronously
+* Publish events synchronously or asynchronously
 
 Note: Wisper was originally extracted from a Rails codebase but is not dependant on Rails.
 
+Please also see the [Wiki](https://github.com/krisleech/wisper/wiki) for more additional information and articles.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -74,7 +76,7 @@ class OrderNotifier
   def cancel_order_successful(order_id)
     order = Order.find_by_id(order_id)
 
-    # notify someone ...    
+    # notify someone ...
   end
 end
 ```
@@ -118,8 +120,9 @@ cancel_order.subscribe(OrderNotifier.new, async: true)
 Wisper has various adapters for asynchronous event handling, please refer to
 [wisper-celluloid](https://github.com/krisleech/wisper-celluloid),
 [wisper-sidekiq](https://github.com/krisleech/wisper-sidekiq),
-[wisper-activejob](https://github.com/krisleech/wisper-activejob), or
-[wisper-que](https://github.com/joevandyk/wisper-que).
+[wisper-activejob](https://github.com/krisleech/wisper-activejob),
+[wisper-que](https://github.com/joevandyk/wisper-que) or
+[wisper-resque](https://github.com/bzurkowski/wisper-resque).
 
 Depending on the adapter used the listener may need to be a class instead of an object. In this situation, every method corresponding to events should be declared as a class method, too. For example:
 
@@ -131,7 +134,7 @@ class OrderNotifier
   def self.cancel_order_successful(order_id)
     order = Order.find_by_id(order_id)
 
-    # notify someone ...    
+    # notify someone ...
   end
 end
 ```
@@ -191,9 +194,10 @@ This is useful for cross cutting concerns such as recording statistics, indexing
 Wisper.subscribe(MyListener.new)
 ```
 
-In a Rails app you might want to add your global listeners in an initalizer.
+In a Rails app you might want to add your global listeners in an initializer.
+
+Global listeners are threadsafe. Subscribers will receive events published on all threads.
 
-Global listeners are threadsafe.
 
 ### Scoping by publisher class
 
@@ -231,7 +235,7 @@ listeners.
 
 This is useful for capturing events published by objects to which you do not have access in a given context.
 
-Temporary Global Listeners are threadsafe.
+Temporary Global Listeners are threadsafe. Subscribers will receive events published on the same thread.
 
 ## Subscribing to selected events
 
@@ -291,7 +295,7 @@ You could also alias the method within your listener, as such
 
 ## Testing
 
-Testing matchers and stubs are in seperate gems.
+Testing matchers and stubs are in separate gems.
 
 * [wisper-rspec](https://github.com/krisleech/wisper-rspec)
 * [wisper-minitest](https://github.com/digitalcuisine/wisper-minitest)
@@ -339,6 +343,7 @@ Please read the [Contributing Guidelines](https://github.com/krisleech/wisper/bl
 
 * gem releases are [signed](http://guides.rubygems.org/security/) ([public key](https://github.com/krisleech/wisper/blob/master/gem-public_cert.pem))
 * commits are GPG signed ([public key](https://pgp.mit.edu/pks/lookup?op=get&search=0x3ABC74851F7CCC88))
+* My [Keybase.io profile](https://keybase.io/krisleech)
 
 ## License
 

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wisper"
+
+require "pry"
+Pry.start
+

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/gem-public_cert.pem

@@ -1,21 +1,20 @@
 -----BEGIN CERTIFICATE-----
-MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRMwEQYDVQQDDAprcmlz
-LmxlZWNoMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNj
-b20wHhcNMTQxMTA1MTEwMzQ4WhcNMTUxMTA1MTEwMzQ4WjBBMRMwEQYDVQQDDApr
-cmlzLmxlZWNoMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
-FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCtW0/UtrFK/tSm
-uq5HnCUkZAQjnSaZ/h1Tby9s30CDJjDUdizPRdLQCplLDAMHFsAfTyD0Mc+Ez8o9
-CdTh8EZ4TSf+nokL+SUprpdR6qm6OWU03Ntd+bDCP0+rdqCX82g3N3mnvjR9aD3a
-+hd9Fhp0WuEyqTNjQ7IlopeUPDW7eYfSwI4bjfRHxsDR1GuZ3j0npxCAgAIN41WH
-MSTTZhdo0vKEiKZEtMMnT6w6fG/c3XIhVVPGnqy5+IZqBL0SYC+WJL3vC6yUBgqB
-nrpA/q+b3M69W+q+TkGv0qOnrxln0O7J2pykjoGIxUhhRkiGEldEhy9dxQWubffr
-hVJ4F0wLAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-BBSzq+x8mwj0ldvNkvjOl44OJG354jAfBgNVHREEGDAWgRRrcmlzLmxlZWNoQGdt
-YWlsLmNvbTAfBgNVHRIEGDAWgRRrcmlzLmxlZWNoQGdtYWlsLmNvbTANBgkqhkiG
-9w0BAQUFAAOCAQEAF5M2Md3DcNCrQrDRDLaIzHaMM+RTgfbpgmZ6tU0iEowES18g
-QWQgrAbFuvQRPETJ2gbL5AC35fEqN80nU+3GhgW/bDYhII5D3PGLMorxhFw1JYLI
-0Fd7MCE0sImc2rPybYUdpZ6TxvqgPKp+8CzM8vBUrdYd+dSHXit1piViWBcZcJb+
-EL5Ze4IodjkCPAeHvu2MQieieViLyfB4eG1syvfkxvAXCjFHeQoIFP16vVtcljdF
-k5cHH/4SGeMuGrSLRsqVvltxVV3AbQAfH8WUos2brjYHsoH5tVPrJ7UcFhzP95oU
-pEfFMW42smiNTOXpzG6JoIpA11szEHFT5ZS+UQ==
+MIIDQDCCAiigAwIBAgIBATANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBprcmlz
+LmxlZWNoL0RDPWdtYWlsL0RDPWNvbTAeFw0xOTEwMTYxNDEzNDVaFw0yMDEwMTUx
+NDEzNDVaMCUxIzAhBgNVBAMMGmtyaXMubGVlY2gvREM9Z21haWwvREM9Y29tMIIB
+IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8gg/iZE6RFkl6GjisJJf9wQl
+5Tog+mrGqtylNpe9QKeyQS1fKLNR3Cqmv6sT3f3GlU8hhG+802MXmlJo7VyENs+s
+HdMy85fBnYwhS/szhTzBqduXw43RAAGqB0VaHAoHdufTZBkmFSXET5c0/jUqQrPL
+Zxsm2i0NV8cVpvrZlQcsW4Kf97DG1ZFNncS0IfCDqnluh21qMSgVAuiKHGoVKCYG
+Igey486VuuJ8j6axwW3ii8HoBOxjF8Ka/rJ/t4sB9Ql/p6RHR4RhxP5xIS9geCpI
+dsPGnCSleTW1EnXGHLdOdJpVmJXueYJEQJ1Rh/rR+9PeqAT3RA0D/dxSGIVtrQID
+AQABo3sweTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUyupX2gb3
++isBRwf4/fhgLnh02sYwHwYDVR0RBBgwFoEUa3Jpcy5sZWVjaEBnbWFpbC5jb20w
+HwYDVR0SBBgwFoEUa3Jpcy5sZWVjaEBnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
+ggEBAExirH+Py0Wm8+ZzNnx/oyFXSF7V9FClYhPUXwQ5FmvQG+gXRlonO9IR/HL+
+wGJNFh4B19fpughgQeJKjKJsG2zk2XnSK2yQyyNGdr/9dHXp/TS5sGvX9jFYVeAr
+0XCWXRBK+IfEqNnbFvPkwZEK62WLnrL50gMs3u2ILmLP5gkO3EoLyezJvIj33CLO
+HX0Plp0VwiSp8+gEELX5wtdrnJ/UjmrY1lg7szukE+jgOJ++1e7Rzr+woBewIWvF
+xn3z1ObkNQCnLZMRmzEcSa40T10/AuuuEv32emAgb50u9vz+s4y2lnE9i4mWW7+X
+5vdRgX7VnzYPA+Lc39kD+AcGIrQ=
 -----END CERTIFICATE-----

data/lib/wisper/temporary_listeners.rb

@@ -4,7 +4,6 @@
 
 module Wisper
   class TemporaryListeners
-
     def self.subscribe(*listeners, &block)
       new.subscribe(*listeners, &block)
     end
@@ -13,13 +12,14 @@ module Wisper
       new.registrations
     end
 
-    def subscribe(*listeners, &block)
-      options = listeners.last.is_a?(Hash) ? listeners.pop : {}
+    def subscribe(*listeners, &_block)
+      new_registrations = build_registrations(listeners)
+
       begin
-        listeners.each { |listener| registrations << ObjectRegistration.new(listener, options) }
+        registrations.merge new_registrations
         yield
       ensure
-        clear
+        registrations.subtract new_registrations
       end
       self
     end
@@ -30,8 +30,9 @@ module Wisper
 
     private
 
-    def clear
-      registrations.clear
+    def build_registrations(listeners)
+      options = listeners.last.is_a?(Hash) ? listeners.pop : {}
+      listeners.map { |listener| ObjectRegistration.new(listener, options) }
     end
 
     def key

data/lib/wisper/version.rb

@@ -1,3 +1,3 @@
 module Wisper
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/lib/temporary_global_listeners_spec.rb

@@ -32,6 +32,42 @@ describe Wisper::TemporaryListeners do
       publisher.instance_eval { broadcast(:failure) }
     end
 
+    it 'globally subscribes listeners for duration of nested block' do
+
+      expect(listener_1).to receive(:success)
+      expect(listener_1).to receive(:failure)
+
+      expect(listener_2).to receive(:success)
+      expect(listener_2).to_not receive(:failure)
+
+      Wisper::TemporaryListeners.subscribe(listener_1) do
+        Wisper::TemporaryListeners.subscribe(listener_2) do
+          publisher.instance_eval { broadcast(:success) }
+        end
+        publisher.instance_eval { broadcast(:failure) }
+      end
+    end
+
+    it 'clears registrations for the block which exits' do
+
+      # listener_1 is subscribed twice hence it's supposed to get the message twice
+      expect(listener_1).to receive(:success).twice
+      expect(listener_1).to receive(:failure)
+      expect(listener_1).to_not receive(:ignored)
+
+      expect(listener_2).to receive(:success)
+      expect(listener_2).to_not receive(:failure)
+      expect(listener_2).to_not receive(:ignored)
+
+      Wisper::TemporaryListeners.subscribe(listener_1) do
+        Wisper::TemporaryListeners.subscribe(listener_1, listener_2) do
+          publisher.instance_eval { broadcast(:success) }
+        end
+        publisher.instance_eval { broadcast(:failure) }
+      end
+      publisher.instance_eval { broadcast(:ignored) }
+    end
+
     it 'is thread safe' do
       num_threads = 20
       (1..num_threads).to_a.map do

data/wisper.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/krisleech/wisper"
   gem.license       = "MIT"
 
-  signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
+  signing_key = File.expand_path(ENV['HOME'].to_s + '/.ssh/gem-private_key.pem')
 
   if File.exist?(signing_key)
     gem.signing_key = signing_key

metadata

@@ -1,14 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: wisper
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Kris Leech
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQDCCAiigAwIBAgIBATANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBprcmlz
+  LmxlZWNoL0RDPWdtYWlsL0RDPWNvbTAeFw0xOTEwMTYxNDEzNDVaFw0yMDEwMTUx
+  NDEzNDVaMCUxIzAhBgNVBAMMGmtyaXMubGVlY2gvREM9Z21haWwvREM9Y29tMIIB
+  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8gg/iZE6RFkl6GjisJJf9wQl
+  5Tog+mrGqtylNpe9QKeyQS1fKLNR3Cqmv6sT3f3GlU8hhG+802MXmlJo7VyENs+s
+  HdMy85fBnYwhS/szhTzBqduXw43RAAGqB0VaHAoHdufTZBkmFSXET5c0/jUqQrPL
+  Zxsm2i0NV8cVpvrZlQcsW4Kf97DG1ZFNncS0IfCDqnluh21qMSgVAuiKHGoVKCYG
+  Igey486VuuJ8j6axwW3ii8HoBOxjF8Ka/rJ/t4sB9Ql/p6RHR4RhxP5xIS9geCpI
+  dsPGnCSleTW1EnXGHLdOdJpVmJXueYJEQJ1Rh/rR+9PeqAT3RA0D/dxSGIVtrQID
+  AQABo3sweTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUyupX2gb3
+  +isBRwf4/fhgLnh02sYwHwYDVR0RBBgwFoEUa3Jpcy5sZWVjaEBnbWFpbC5jb20w
+  HwYDVR0SBBgwFoEUa3Jpcy5sZWVjaEBnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
+  ggEBAExirH+Py0Wm8+ZzNnx/oyFXSF7V9FClYhPUXwQ5FmvQG+gXRlonO9IR/HL+
+  wGJNFh4B19fpughgQeJKjKJsG2zk2XnSK2yQyyNGdr/9dHXp/TS5sGvX9jFYVeAr
+  0XCWXRBK+IfEqNnbFvPkwZEK62WLnrL50gMs3u2ILmLP5gkO3EoLyezJvIj33CLO
+  HX0Plp0VwiSp8+gEELX5wtdrnJ/UjmrY1lg7szukE+jgOJ++1e7Rzr+woBewIWvF
+  xn3z1ObkNQCnLZMRmzEcSa40T10/AuuuEv32emAgb50u9vz+s4y2lnE9i4mWW7+X
+  5vdRgX7VnzYPA+Lc39kD+AcGIrQ=
+  -----END CERTIFICATE-----
+date: 2019-10-16 00:00:00.000000000 Z
 dependencies: []
 description: |2
       A micro library providing objects with Publish-Subscribe capabilities.
@@ -16,7 +37,9 @@ description: |2
       Check out the Wiki for articles, guides and examples: https://github.com/krisleech/wisper/wiki
 email:
 - kris.leech@gmail.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -28,6 +51,8 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - gem-public_cert.pem
 - lib/wisper.rb
 - lib/wisper/broadcasters/logger_broadcaster.rb
@@ -76,8 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A micro library providing objects with Publish-Subscribe capabilities