nala 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e24b33814fd472cb82c0a1df0245dd50bca407cc
-  data.tar.gz: 7acae49d029d2c69fb61777de30f37384f0b3bb5
+  metadata.gz: 10e423acb67e8578fc4b9c652b138b9b1979dce6
+  data.tar.gz: 85e858c8451d9ef09346981ccee760dbc804e140
 SHA512:
-  metadata.gz: 1c9e49b94f37ac4f107781016db0b19851c3e02e7aaad1dc71b99fba3f490a8e45e28eb7de98641d63f3a380c12369a908e63d3cf68e1d1c38e77168c831aa0b
-  data.tar.gz: ea4cf4ed1e5a030634c77847b93fbd214c66a072f6d26ebf7c25acad960e828972ceea4018414620eb5f4f1c157726dbca8633c486f345c446f5678f6b502897
+  metadata.gz: 35dcef02bab31d9ca81df1a6ef999731ec10f58cf388f1b27d10fbd7a5cfc912e2788f17656ee54cbd8cc158dcc3e4c871dc66913bf9a9c1d2e0c7eb00df8690
+  data.tar.gz: ba908b8cd78c9d0d3f14d04a8bc698c9b8dff44128250c8fde68a4387cf6c20f86bfc60c7f0d40d7c6440f38e38a846e8a904aae338691db3f80e09d04c54647

data/lib/nala/rspec.rb

@@ -26,6 +26,22 @@ module Nala
       proc { |*args| called_with!(args) }
     end
   end
+
+  module RSpecHelpers
+    def emit(event, *args)
+      Nala::EventEmitter.new.tap do |emitter|
+        emitter.store_result(event, args)
+      end
+    end
+
+    def block_spy
+      Nala::BlockSpy.new
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Nala::RSpecHelpers
 end
 
 RSpec::Matchers.define :be_called_with do |*expected_args|

data/lib/nala/version.rb

@@ -1,3 +1,3 @@
 module Nala
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/readme.md

@@ -106,7 +106,7 @@ Then within your specs, you can confirm that a handler is called with the
 following:
 
 ```ruby
-let(:block) { Nala::BlockSpy.new }
+let(:block) { block_spy }
 
 it "invokes a handler for a published event" do
   SuccessClass.call.on(:success) { block.called! }
@@ -119,7 +119,7 @@ If you want to check the arguments that are passed to the block you can use the
 following:
 
 ```ruby
-let(:block) { Nala::BlockSpy.new }
+let(:block) { block_spy }
 
 it "passes multiple arguments to handlers" do
   PublishArgsClass.call
@@ -133,7 +133,7 @@ If you need check the arguments attributes in more detail you can do the
 following:
 
 ```ruby
-let(:block) { Nala::BlockSpy.new }
+let(:block) { block_spy }
 
 it "passes a user with the correct name" do
   RegisterUser.call
@@ -145,11 +145,10 @@ end
 ```
 
 You can make the tracking of block arguments less verbose by using the `spy`
-method of `Nala::BlockSpy` and passing it as an explicit block to the `on`
-method:
+method of `Nala::BlockSpy` (which `block_spy` returns) and passing it as an explicit block to the `on` method:
 
 ```ruby
-let(:block) { Nala::BlockSpy.new }
+let(:block) { block_spy }
 
 it "passes multiple arguments to handlers" do
   PublishArgsClass.call.on(:multiple, &block.spy)
@@ -163,8 +162,8 @@ recommend naming your block after the event it will be called by (rather than
 just `block`):
 
 ```ruby
-let(:success)  { Nala::BlockSpy.new }
-let(:notified) { Nala::BlockSpy.new }
+let(:success)  { block_spy }
+let(:notified) { block_spy }
 
 it "calls multiple handlers" do
   PlaceOrder.call
@@ -176,6 +175,18 @@ it "calls multiple handlers" do
 end
 ```
 
+If you would like to stub calls to the `.call` method of your use case class but want to make sure handlers are called, you can use the supplied `emit` helper method like so:
+
+```
+allow(SuccessClass).to receive(:call) { emit(:success) }
+```
+
+or you can supply arguments to the block:
+
+```
+allow(SuccessClass).to receive(:call) { emit(:success, "My Argument") }
+```
+
 ## Notes for maintainers
 
 **Building a publishing gem updates**

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nala
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Andy Pike