waterfall 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 926586c0692a21fc3e8110a28818a907c8b10d2d
-  data.tar.gz: 438651277ce425c2a9667e003a9f4deb56bfd61a
+  metadata.gz: 2918f5c657d78ab72747847b48ca6024995b8cdc
+  data.tar.gz: 473b2b1b9cf9512fb13520523cbf4ae358a005b2
 SHA512:
-  metadata.gz: c4c1bb9dc927cd752e7b184274373d624ad625d5d316e0930238c96a75c3fa0b5ee9129f4ef3865271d490f5e1d86d0eadd60e553f6a06e3c9636a15cbba5fa6
-  data.tar.gz: f10b48892968cb75add57c80b13374413820902a12324c97f3b531a6c1f96c4d832762732c3b61d6e3116fa0e247f3830b3e93edf10f762330182a78a7de58eb
+  metadata.gz: 5ddce902522214cdb5e5cdf939d18a8a1dca0026dd79de3c29ac30c17f3bd7bc6c2abd06c21f8dc67398d3dbf617c3032a67136dd792ffe37b786138a2e1e57f
+  data.tar.gz: 1d17dee11a63dc85b223e3e70e94bd1b35e09df45ff926d2f3a2da8d6ea2eca07d7c56e4124124aa6b97af651e7ab7fdba0d043baa898ed4fcea365cee1ac0e1

data/.gitignore

@@ -32,3 +32,7 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+.ruby-gemset
+
+.ruby-version

data/Gemfile.lock

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

data/README.md

@@ -2,15 +2,14 @@
 [![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)
+[![Gem Version](https://badge.fury.io/rb/waterfall.svg)](https://badge.fury.io/rb/waterfall)
 #### Goal
 
-Be able to chain ruby commands, and treat them like a flow.
-
-It provides a new approach to flow control.
+Chain ruby commands, and treat them like a flow, which provides a new approach to application control flow.
 
 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 slides can [be found here](https://slides.com/apneadiving/code-ruby-like-you-build-lego).
+General presentation blog post there: [Chain services objects like a boss](https://medium.com/p/chain-service-objects-like-a-boss-35d0b83606ab).
 
 #### Overview
 

data/lib/waterfall.rb

@@ -10,6 +10,9 @@ module Waterfall
 
   attr_reader :error_pool, :outflow, :flowing, :_wf_rolled_back
 
+  class IncorrectDamArgumentError      < StandardError; end
+  class IncorrectChainingArgumentError < StandardError; end
+
   def when_falsy(&block)
     handler = ::Waterfall::WhenFalsy.new(self)
     _wf_run { handler.call(&block) }
@@ -31,6 +34,7 @@ module Waterfall
   end
 
   def chain_wf(mapping_hash = nil, &block)
+    warn "[DEPRECATION] `chain_wf` is deprecated.  Please use `chain` instead."
     chain(mapping_hash, &block)
   end
 
@@ -42,12 +46,13 @@ module Waterfall
   end
 
   def dam(obj)
+    raise IncorrectDamArgumentError.new("You cant dam with a falsy object") unless obj
     @error_pool = obj
     self
   end
 
   def undam
-    dam nil
+    @error_pool = nil
     self
   end
 

data/lib/waterfall/predicates/chain.rb

@@ -18,6 +18,8 @@ module Waterfall
     def map_waterfalls(child_waterfall, mapping)
       child_waterfall.call unless child_waterfall.flowing?
 
+      raise IncorrectChainingArgumentError.new(mapping_error_message) unless mapping.is_a?(Hash)
+
       mapping.each do |k, v|
         @root.update_outflow(k, child_waterfall.outflow[v])
       end
@@ -28,5 +30,9 @@ module Waterfall
 
       self
     end
+
+    def mapping_error_message
+      "When chaining waterfalls, you must pass a mapping hash to pass data from one to the other"
+    end
   end
 end

data/lib/waterfall/version.rb

@@ -1,3 +1,3 @@
 module Waterfall
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/spec/integration_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 describe 'Wf' do
   let(:wf) { Wf.new }
+  let(:error_string) { 'error' }
 
   describe "chain" do
 
@@ -23,10 +24,10 @@ describe 'Wf' do
     context "wf internals" do
       it "dam from within" do
         wf
-          .chain  {|outflow, waterfall| waterfall.dam('errrrr') }
+          .chain  {|outflow, waterfall| waterfall.dam(error_string) }
 
         expect(wf.dammed?).to be true
-        expect(wf.error_pool).to eq 'errrrr'
+        expect(wf.error_pool).to eq error_string
       end
 
       it "expose child waterfall outflow even if dammed (or at least what was computed)" do
@@ -55,15 +56,19 @@ describe 'Wf' do
     describe "chaining waterfalls" do
 
       shared_examples "a waterfall chain" do
-        describe 'chain_wf' do
+        describe 'chain waterfall' do
           it "takes expected vars only and rename them" do
             wf
-              .chain_wf(baz: :foo) { waterfall }
+              .chain(baz: :foo) { waterfall }
 
             expect(wf.outflow.foo).to be nil
             expect(wf.outflow.bar).to be nil
             expect(wf.outflow.baz).to eq waterfall.outflow.foo
           end
+
+          it 'raises if chain waterfall without hash mapping' do
+            expect { wf.chain(:foo) { waterfall } }.to raise_error(Waterfall::IncorrectChainingArgumentError)
+          end
         end
       end
 
@@ -116,7 +121,7 @@ describe 'Wf' do
       wf
         .chain { wf.dam('dammed') if dam? }
         .when_falsy { my_proc.call(bool) }
-          .dam  { 'err' }
+          .dam  { error_string }
         .chain  { @foo = 1 }
     end
 
@@ -125,13 +130,13 @@ describe 'Wf' do
 
       it "when actually falsy" do
         action false
-        expect(wf.error_pool).to eq 'err'
+        expect(wf.error_pool).to eq error_string
         expect(@foo).to_not eq 1
       end
 
       it "when actually truthy" do
         action true
-        expect(wf.error_pool).to_not eq 'err'
+        expect(wf.error_pool).to_not eq error_string
         expect(@foo).to eq 1
       end
     end
@@ -154,7 +159,7 @@ describe 'Wf' do
       wf
         .chain { wf.dam('dammed') if dam? }
         .when_truthy { my_proc.call(bool) }
-          .dam  { 'err' }
+          .dam  { error_string }
         .chain  { @foo = 1 }
     end
 
@@ -163,13 +168,13 @@ describe 'Wf' do
 
       it "when actually falsy" do
         action false
-        expect(wf.error_pool).to_not eq 'err'
+        expect(wf.error_pool).to_not eq error_string
         expect(@foo).to eq 1
       end
 
       it "when actually truthy" do
         action true
-        expect(wf.error_pool).to eq 'err'
+        expect(wf.error_pool).to eq error_string
         expect(@foo).to_not eq 1
       end
     end
@@ -195,24 +200,36 @@ describe 'Wf' do
       end
 
       def self.error
-        'err'
+        'error'
       end
     end
 
     it "error propagates" do
       wf
         .chain { FailingChain.new }
-        .chain    { @foo = 1 }
+        .chain { @foo = 1 }
 
       expect(@foo).to_not eq 1
       expect(wf.error_pool).to eq FailingChain.error
     end
   end
 
+  describe "dam" do
+    it "raises if falsy argument sent" do
+      expect { wf.dam(nil) }.to raise_error(Waterfall::IncorrectDamArgumentError)
+    end
+
+    it "dams with truthy argument" do
+      wf.dam(error_string)
+      expect(wf.error_pool).to eq error_string
+      expect(wf.dammed?).to be true
+    end
+  end
+
   describe "undam" do
     it "flow goes back to green path" do
       wf
-        .chain  { wf.dam('err') }
+        .chain  { wf.dam(error_string) }
         .on_dam { wf.undam }
         .chain  { @foo = 1 }
         .on_dam { raise('shouldnt happen') }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfall
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Benjamin Roth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A slice of functional programming to chain ruby services and blocks. Make