waterfall 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e52a3c6940723b7e9c59482c7e171194d3cea775
-  data.tar.gz: 6ea7ab247654ef7ded20428d387c160d8a9d4e95
+  metadata.gz: 27aca92eae9decca2d3a32be3293985de0b219e1
+  data.tar.gz: d9e95c5a4a7aa9438f06bd67337bd5a87e7c8dd8
 SHA512:
-  metadata.gz: 89b68643618d10d2401c99780981e4e5dc684b90deed6c889c2bf7c237000ca8e530427d7b69229716dee7425559282d40946e0490e62bb3aa09f5e637dae788
-  data.tar.gz: 184a675a17e17452f99b163fb3761ad9b7abbbd4b83cc2164f46d6402de5556e2dc0786dccb4ecf2357b1df357c8b124a55f086a19724429f42c5e18daf6c823
+  metadata.gz: e178dab7e10f42a2215c17cd991d3af286a07908bd2e4c3d4f8f3b8769ee576a8c9e455af3a57c037a866bd3693aecf940894ef601f4684f3b4bbfeb15873f73
+  data.tar.gz: eac428e1c45e83e652451bf37fa972bbe03db7ad90c61c47a8597d7b512852d33c48d5010531fc78b52b006a9dc8bee71dd5d5b80f8931c7e9138f18addbd2de

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waterfall (1.0.5)
+    waterfall (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -53,4 +53,4 @@ DEPENDENCIES
   waterfall!
 
 BUNDLED WITH
-   1.13.6
+   1.14.4

data/README.md

@@ -1,4 +1,3 @@
-![Waterfall Logo](http://apneadiving.github.io/images/waterfall_logo.png)
 [![Code Climate](https://codeclimate.com/github/apneadiving/waterfall/badges/gpa.svg)](https://codeclimate.com/github/apneadiving/waterfall)
 [![Test Coverage](https://codeclimate.com/github/apneadiving/waterfall/badges/coverage.svg)](https://codeclimate.com/github/apneadiving/waterfall/coverage)
 [![Build Status](https://travis-ci.org/apneadiving/waterfall.svg?branch=master)](https://travis-ci.org/apneadiving/waterfall)
@@ -9,7 +8,14 @@ Chain ruby commands, and treat them like a flow, which provides a new approach t
 
 When logic is complicated, waterfalls show their true power and let you write intention revealing code. Above all they excel at chaining services.
 
-General presentation blog post there: [Chain services objects like a boss](https://medium.com/p/chain-service-objects-like-a-boss-35d0b83606ab) and upcoming book: [the Unhappy path](https://leanpub.com/the-unhappy-path)
+#### Material
+<a href="https://leanpub.com/the-unhappy-path"> <img align="left" width="80" height="116" src="https://apneadiving.github.io/images/unhappy-path.png"> </a>
+Upcoming book about failure management patterns, leveraging the gem: [The Unhappy path](https://leanpub.com/the-unhappy-path)
+
+General presentation blog post there: [Chain services objects like a boss](https://medium.com/p/chain-service-objects-like-a-boss-35d0b83606ab).
+
+Reach me [@apneadiving](https://twitter.com/apneadiving)
+
 
 #### Overview
 
@@ -19,7 +25,7 @@ Here is a basic representation:
 - green, the flow goes on, `chain` by `chain`
 - red its bypassed and only `on_dam` blocks are executed.
 
-![Waterfall Logo](http://apneadiving.github.io/images/waterfall_principle.png)
+![Waterfall Principle](https://apneadiving.github.io/images/waterfall_principle.png)
 
 #### Example
 
@@ -176,6 +182,18 @@ else
   self.chain { Service3.new }
 end
 ```
+### Halting chain
+Sometimes you have a flow and you need a return value. You can use `halt_chain`, which is executed whether or not the flow is dammed. It returns what the block returns. As a consequence, it cannot be chained anymore, so it must be the last command:
+
+```ruby
+self.halt_chain do |outflow, error_pool|
+  if error_pool
+    # what you want to return on error
+  else
+    # what you want to return from the outflow
+  end
+end
+```
 
 ### Rails and transactions
 I'm used to wrap every single object involving database interactions within transactions, so it can be rolled back on error.
@@ -224,6 +242,10 @@ end
 ```
 The huge benefit is that if you call services from services, everything will be rolled back.
 
+### FYI
+
+`Flow` is just an alias for the `Wf` class, so just use the one you prefer :)
+
 Examples / Presentations
 ========================
 - Check the [wiki for other examples](https://github.com/apneadiving/waterfall/wiki/Refactoring-examples).

data/changelog.md

@@ -1,3 +1,7 @@
+===1.1.0
+- Removed `chain_wf`.
+- Introduced `halt_chain`
+
 ===1.0.6
 Alias Wf with Flow
 

data/lib/waterfall.rb

@@ -33,11 +33,6 @@ module Waterfall
     end
   end
 
-  def chain_wf(mapping_hash = nil, &block)
-    warn "[DEPRECATION] `chain_wf` is deprecated.  Please use `chain` instead."
-    chain(mapping_hash, &block)
-  end
-
   def on_dam(&block)
     ::Waterfall::OnDam
       .new(self)
@@ -55,6 +50,10 @@ module Waterfall
     self
   end
 
+  def halt_chain(&block)
+    yield(outflow, error_pool)
+  end
+
   def dammed?
     !error_pool.nil?
   end

data/lib/waterfall/version.rb

@@ -1,3 +1,3 @@
 module Waterfall
-  VERSION = "1.0.6"
+  VERSION = "1.1.0"
 end

data/spec/wf_object_spec.rb

@@ -27,6 +27,11 @@ describe Flow do
     expect(wf.outflow.foo).to eq 1
   end
 
+  it 'returns itself to enable chaining' do
+    expect(wf.chain{ }).to eq wf
+    expect(wf.on_dam{ }).to eq wf
+  end
+
   it 'chain yields outflow and waterfall itself' do
     wf.chain do |outflow, waterfall|
       expect(outflow).to eq wf.outflow
@@ -98,8 +103,24 @@ describe Flow do
     expect { wf.chain(:foo) { Flow.new } }.to raise_error(Waterfall::IncorrectChainingArgumentError, Waterfall::Chain::MAPPING_ERROR_MESSAGE)
   end
 
-  it 'warns against chain_wf' do
-    expect(wf).to receive :warn
-    wf.chain_wf { Flow.new }
+  describe 'halt_chain' do
+    it "yields expected values" do
+      wf.chain(:foo) { 1 }.halt_chain do |outflow, error_pool|
+        expect(outflow).to    eq wf.outflow
+        expect(error_pool).to eq wf.error_pool
+      end
+    end
+
+    it "yields expected values even if dammed" do
+      wf.chain(:foo) { 1 }.dam("errr").halt_chain do |outflow, error_pool|
+        expect(outflow).to    eq wf.outflow
+        expect(error_pool).to eq wf.error_pool
+      end
+    end
+
+    it "returns what the block returns" do
+      expect(wf.halt_chain { "return value" }).to eq "return value"
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfall
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
 platform: ruby
 authors:
 - Benjamin Roth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler