nala 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1de5be775b1e14835cc70a4e7a8b0068f13caa9d
-  data.tar.gz: 555a05e4158913607cc7b5ff1a8c54b734c89cf4
+  metadata.gz: cdba579249251211672cfe2194920064d8c347a5
+  data.tar.gz: def872611eadb7bfc924939c4a51792562b50eed
 SHA512:
-  metadata.gz: 061bf9c1b1ca1b18f16dc5d08753261929365028bca2d84210a4d711f0297e5e659e4396daf352123777a96dcba81c4e15232f0348dc8a14db9b5b5dbd376a9d
-  data.tar.gz: c9ec24f01a7055c227afde5bdbf325b6e590f64e1a659363f08781e6ea985fc91f5a54c212f14d7e5668585303be15d8ca4b2612f8706b6175a96145986c0e82
+  metadata.gz: 25eca85f93b3b66134ee9ec135eb0842424c349cc6e67bd961564bc16237fc8aad3c08d709d959a933c5ede12f872eb38d1af2046a2715c2220e976a36264484
+  data.tar.gz: 0052b8685f00185a3ca665aa945c060e9e2aafb9cf3d4a9f68a5f182f3b6ad059205de47b285372611005147ff57de99b880613948d8ef4d78bee2c1d454baf5

data/lib/nala/rspec.rb

@@ -21,6 +21,10 @@ module Nala
     def called?
       @called
     end
+
+    def spy
+      proc { |*args| called_with!(args) }
+    end
   end
 end
 

data/lib/nala/version.rb

@@ -1,3 +1,3 @@
 module Nala
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/readme.md

@@ -18,11 +18,13 @@ gem "nala"
 
 ## Usage
 
-Nala is intended to be used with use case style classes where the class performs a
-single action. These classes typically have verb names such as `PlaceOrder` etc.
+Nala is intended to be used with use case style classes where the class performs
+a single action. These classes typically have verb names such as `PlaceOrder`
+etc.
 
 To use, add the `Nala::Publisher` module to your class and expose a `call`
-instance method. If your class requires data, it can be passed to it via the constructor.
+instance method. If your class requires data, it can be passed to it via the
+constructor.
 
 For example:
 
@@ -46,9 +48,9 @@ class PlaceOrder
 end
 ```
 
-Usage of these use case style classes gives a home to your business logic, removes
-conditionals from your Rails controllers and helps prevent your models getting too
-big.
+Usage of these use case style classes gives a home to your business logic,
+removes conditionals from your Rails controllers and helps prevent your models
+getting too big.
 
 ```ruby
 class OrderController < ApplicationController
@@ -83,13 +85,15 @@ end
 
 ## Testing with RSpec
 
-If you are using RSpec then you can use the supplied matcher by adding the following line to your `spec_helper.rb` file:
+If you are using RSpec then you can use the supplied matcher by adding the
+following line to your `spec_helper.rb` file:
 
 ```ruby
 require "nala/rspec"
 ```
 
-Then within your specs, you can confirm that a handler is called with the following:
+Then within your specs, you can confirm that a handler is called with the
+following:
 
 ```ruby
 let(:block) { Nala::BlockSpy.new }
@@ -101,36 +105,56 @@ it "invokes a handler for a published event" do
 end
 ```
 
-If you want to check the arguments that are passed to the block you can use the following:
+If you want to check the arguments that are passed to the block you can use the
+following:
 
 ```ruby
 let(:block) { Nala::BlockSpy.new }
 
 it "passes multiple arguments to handlers" do
   PublishArgsClass.call
-    .on(:multiple) { |*x| block.called_with!(x) }
+    .on(:multiple) { |*args| block.called_with!(args) }
 
   expect(block).to be_called_with(:a, :b, :c)
 end
 ```
 
-If you need check the arguments attributes in more detail you can do the following:
+If you need check the arguments attributes in more detail you can do the
+following:
 
 ```ruby
 let(:block) { Nala::BlockSpy.new }
 
 it "passes a user with the correct name" do
   RegisterUser.call
-    .on(:success) { |*x| block.called_with!(x) }
+    .on(:success) { |*args| block.called_with!(args) }
 
   user = block.args.first
   expect(user.name).to eq("Andy")
 end
 ```
 
-## Building a publishing gem updates
+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:
 
-Bump the version number in `lib/nala/version.rb` and use the same number in the command below:
+```ruby
+let(:block) { Nala::BlockSpy.new }
+
+it "passes multiple arguments to handlers" do
+  PublishArgsClass.call
+    .on(:multiple, &block.spy)
+
+  expect(block).to be_called_with(:a, :b, :c)
+end
+```
+
+## Notes for maintainers
+
+**Building a publishing gem updates**
+
+Bump the version number in `lib/nala/version.rb` and use the same number in the
+command below:
 
 ```
 gem build nala.gemspec

metadata

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