waterfall 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 152fb9437b8752b16fd77478ec2e12c0d9b6401f
-  data.tar.gz: 5e6f25d4bd7c0e23c4a8cd16b921227ed5397a3a
+  metadata.gz: e52a3c6940723b7e9c59482c7e171194d3cea775
+  data.tar.gz: 6ea7ab247654ef7ded20428d387c160d8a9d4e95
 SHA512:
-  metadata.gz: 597154dc366df15c6fe84f707c1206e82c624c77b57b818323e67347fd1d3e3f9f990b926d5c389060e2b75c1de71aa807ab7601b9735584cb8c138d40b26c6b
-  data.tar.gz: 8004a1da08994b9e668113e348d5312503394d071be2f366fda20dda1650d7648aa19ecb1555a46beab22d6866bd23f1a9bdb10b29184b39bcafc79aad537aa7
+  metadata.gz: 89b68643618d10d2401c99780981e4e5dc684b90deed6c889c2bf7c237000ca8e530427d7b69229716dee7425559282d40946e0490e62bb3aa09f5e637dae788
+  data.tar.gz: 184a675a17e17452f99b163fb3761ad9b7abbbd4b83cc2164f46d6402de5556e2dc0786dccb4ecf2357b1df357c8b124a55f086a19724429f42c5e18daf6c823

data/README.md

@@ -9,7 +9,7 @@ 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).
+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)
 
 #### Overview
 
@@ -43,11 +43,11 @@ end
 and call / chain:
 
 ```ruby
-Wf.new
-  .chain(user1: :user) { FetchUser.new(1) }
-  .chain(user2: :user) { FetchUser.new(2) }
-  .chain  {|outflow| puts(outflow.user1, outflow.user2)  } # report success
-  .on_dam {|error|   puts(error)      }                    # report error
+Flow.new
+    .chain(user1: :user) { FetchUser.new(1) }
+    .chain(user2: :user) { FetchUser.new(2) }
+    .chain  {|outflow| puts(outflow.user1, outflow.user2)  } # report success
+    .on_dam {|error|   puts(error)      }                    # report error
 ```
 
 Which works like:
@@ -77,28 +77,30 @@ Wiki contains many details, please check appropriate pages:
 - [Wf Object](https://github.com/apneadiving/waterfall/wiki/Wf-object)
 - [Testing](https://github.com/apneadiving/waterfall/wiki/Testing)
 
+### Koans (!)
+You can try and exercise your understanding of Waterfall using the [Koans here](https://github.com/apneadiving/waterfall_koans)
 
 ## Illustration of chaining
 Doing
 ```ruby
- Wf.new
-   .chain(foo: :bar) { Wf.new.chain(:bar){ 1 } }
+Flow.new
+    .chain(foo: :bar) { Flow.new.chain(:bar){ 1 } }
 ```
 
 is the same as doing:
 
 ```ruby
- Wf.new
-   .chain do |outflow, parent_waterfall|
-     unless parent_waterfall.dammed?
-       child = Wf.new.chain(:bar){ 1 }
-       if child.dammed?
-         parent_waterfall.dam(child.error_pool)
-       else
-         parent_waterfall.ouflow.foo = child.outflow.bar
-       end
-     end
-   end
+Flow.new
+    .chain do |outflow, parent_waterfall|
+      unless parent_waterfall.dammed?
+        child = Wf.new.chain(:bar){ 1 }
+        if child.dammed?
+          parent_waterfall.dam(child.error_pool)
+        else
+          parent_waterfall.ouflow.foo = child.outflow.bar
+        end
+      end
+    end
 ```
 
 Hopefully you better get the chaining power this way.
@@ -117,13 +119,13 @@ end
 You may have noticed that I usually write:
 
 ```ruby
-Wf.new
-  .chain { MyWaterfall.new }
+Flow.new
+    .chain { MyWaterfall.new }
 ```
 instead of
 ```ruby
-Wf.new
-  .chain { MyWaterfall.new.call }
+Flow.new
+    .chain { MyWaterfall.new.call }
 ```
 Both are the same: if a block returns a waterfall which was not executed, it will execute it (hence the `call` convention)
 
@@ -207,7 +209,7 @@ class AuthenticateUser
   attr_reader :user
 
   def initialize(email, password)
-    @email, @password = email, @password
+    @email, @password = email, password
   end
 
   def call

data/changelog.md

@@ -1,6 +1,18 @@
-===1.0.3
+===1.0.6
+Alias Wf with Flow
+
+=== 1.0.5
+- naming: changed flowing to has_flown to clarify its not related to damming
+- spec change
+
+=== 1.0.4
+- add clearer error messages
+- deprecate chain_wf
+- prevent from damming falsy values
+
+=== 1.0.3
 - Small refactors
 - if waterfall 1 calls waterfall 2 and waterfall2 is dammed, now waterfall1 is able to get values from waterfall2's outflow
 
-===1.0.2
-Initial release
+=== 1.0.2
+Initial release

data/lib/waterfall.rb

@@ -86,3 +86,5 @@ class Wf
     _wf_run {}
   end
 end
+
+Flow = Wf

data/lib/waterfall/version.rb

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

data/spec/chaining_services_spec.rb

@@ -24,7 +24,7 @@ describe 'Chaining services' do
     end
   end
 
-  let(:wf) { Wf.new }
+  let(:wf) { Flow.new }
   let(:listener) { spy 'listener', is_waterfall?: false }
 
   it 'you dont need to call child waterfalls, just pass the instance' do

data/spec/wf_object_spec.rb

@@ -1,7 +1,11 @@
 require 'spec_helper'
 
-describe Wf do
-  let(:wf) { Wf.new }
+describe Flow do
+  let(:wf) { Flow.new }
+
+  it 'is aliased' do
+    expect(Flow).to eq Wf
+  end
 
   it 'is a waterfall' do
     expect(wf.is_waterfall?).to be true
@@ -91,11 +95,11 @@ describe Wf do
   end
 
   it 'raises if chain waterfall without hash mapping' do
-    expect { wf.chain(:foo) { Wf.new } }.to raise_error(Waterfall::IncorrectChainingArgumentError, Waterfall::Chain::MAPPING_ERROR_MESSAGE)
+    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 { Wf.new }
+    wf.chain_wf { Flow.new }
   end
 end

metadata

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