waterfall 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4fa811a59c1b353ab25f5c56d47c494aab50972
-  data.tar.gz: 07657eeaebc676339be72d29373afecff23527f1
+  metadata.gz: 078be4fc0c809c19b4dc69414117ed5ab2962cec
+  data.tar.gz: a1dbebd4c474ea3cca0f3d2ac62ca2883d2cbc73
 SHA512:
-  metadata.gz: 512a8896bbd591e770c78be0d3c8fd3628f824c664020b2d1b430b0a2c718e34dc8cca6661f1387d283368eef54b4e439698bad1d0ca950e3c991aa2c9a25257
-  data.tar.gz: ce7e7632e200548d05a87419aa03b8f318c3284f40052b2b792fa1c8afba5246860b67151a1dda8db66e8006c5e26510edad3925833e0ab17499f927140e1447
+  metadata.gz: 4cb114ad14c238c888ee842cc29020a56ce9d554848ba83a60b90bf2faa17a4888d6ff32ad6c2d066379d4107909d252cafa0f55b0741feb3b29b0e233707885
+  data.tar.gz: e21b53012acfcf0555c874c26f8fd3bd490f33e9ff74be1afccb9043625038ed08c6b00bc1daa7502f1a0ddd514f51e461952fa68eeabe3c1d9d10f6b36418c8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waterfall (1.2.1)
+    waterfall (1.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -53,7 +53,7 @@ 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
+    .on_dam {|error, context| puts(error, context) }         # report error
 ```
 
 Which works like:

data/changelog.md

@@ -1,3 +1,8 @@
+===1.3.0
+- Introduced `error_pool_context`, providing with the stacktrace leading to the dam
+- changed `on_dam` signature to pass context to the block
+- add `Waterfall.caller_locations_length` to limit the number of lines of the stacktrace (default is nil: unlimited)
+
 ===1.2.1
 - Introduced `Waterfall.with_reversible_flow`, makes `reverse_flow` optionnal, may save memory
 - outflow is now lazy loaded

data/lib/waterfall.rb

@@ -6,17 +6,21 @@ require 'waterfall/predicates/when_falsy'
 require 'waterfall/predicates/when_truthy'
 require 'waterfall/predicates/chain'
 
+WATERFALL_PATH = "lib/waterfall"
+
 module Waterfall
 
-  attr_reader :error_pool
+  attr_reader :error_pool, :error_pool_context
 
   class IncorrectDamArgumentError      < StandardError; end
   class IncorrectChainingArgumentError < StandardError; end
 
   class << self
     attr_accessor :with_reversible_flow
+    attr_accessor :caller_locations_length
   end
   @with_reversible_flow = true
+  @caller_locations_length = nil
 
   def outflow
     @outflow ||= OpenStruct.new({})
@@ -49,16 +53,17 @@ module Waterfall
     self
   end
 
-  def dam(obj)
+  def dam(obj, context = nil)
     raise IncorrectDamArgumentError.new("You cant dam with a falsy object") unless obj
     _wf_run do
       @error_pool = obj
+      @error_pool_context = context || _error_pool_context
       _reverse_flows(true)
     end
   end
 
   def halt_chain(&block)
-    yield(outflow, error_pool)
+    yield(outflow, error_pool, error_pool_context)
   end
 
   def dammed?
@@ -104,6 +109,12 @@ module Waterfall
     yield unless dammed?
     self
   end
+
+  def _error_pool_context
+    caller_locations(1, Waterfall.caller_locations_length).reject do |line|
+      line.to_s.include?(WATERFALL_PATH)
+    end
+  end
 end
 
 class Wf

data/lib/waterfall/predicates/chain.rb

@@ -27,7 +27,7 @@ module Waterfall
       @root.send :_add_executed_flow, child_waterfall
 
       if child_waterfall.dammed?
-        @root.dam child_waterfall.error_pool
+        @root.dam child_waterfall.error_pool, child_waterfall.error_pool_context
       end
 
       self

data/lib/waterfall/predicates/on_dam.rb

@@ -7,7 +7,7 @@ module Waterfall
 
     def call
       return unless @root.dammed?
-      yield @root.error_pool, @root.outflow, @root
+      yield @root.error_pool, @root.error_pool_context, @root.outflow, @root
     end
   end
 end

data/lib/waterfall/version.rb

@@ -1,3 +1,3 @@
 module Waterfall
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/spec/wf_object_spec.rb

@@ -42,12 +42,14 @@ describe Flow do
   it 'isnt dammed by default' do
     expect(wf.dammed?).to be false
     expect(wf.error_pool).to eq nil
+    expect(wf.error_pool_context).to be nil
   end
 
   it 'is dammed if you dam it!' do
     wf.dam('error')
     expect(wf.dammed?).to be true
     expect(wf.error_pool).to eq 'error'
+    expect(wf.error_pool_context).to be_an Array
   end
 
   it 'dam raises if falsy argument sent' do
@@ -66,6 +68,15 @@ describe Flow do
     expect(wf.error_pool).to eq 'error'
   end
 
+  it 'error pool and context values propagate to root flow' do
+    sub_flow = Flow.new
+    sub_flow.chain { sub_flow.dam('errr')  }
+    wf.chain { sub_flow }
+
+    expect(wf).to be_dammed
+    expect(wf.error_pool_context).to eq sub_flow.error_pool_context
+  end
+
   it 'doesnt execute chain blocks once dammed' do
     expect do
       wf.when_falsy { false }.dam { 'error' }.chain { raise 'I should not be executed because of damming before me' }
@@ -85,9 +96,10 @@ describe Flow do
     expect(listener).to have_received :failure
   end
 
-  it 'on_dam blocks yield error pool, outflow and waterfall' do
-    wf.dam('errr').on_dam do |error_pool, outflow, waterfall|
+  it 'on_dam blocks yield error pool, error context, outflow and waterfall' do
+    wf.dam('errr').on_dam do |error_pool, error_pool_context, outflow, waterfall|
       expect(error_pool).to eq wf.error_pool
+      expect(error_pool_context).to eq wf.error_pool_context
       expect(outflow).to eq wf.outflow
       expect(waterfall).to eq wf
     end
@@ -106,9 +118,10 @@ describe Flow do
     end
 
     it "yields expected values even if dammed" do
-      wf.chain(:foo) { 1 }.dam("errr").halt_chain do |outflow, error_pool|
+      wf.chain(:foo) { 1 }.dam("errr").halt_chain do |outflow, error_pool, error_pool_context|
         expect(outflow).to    eq wf.outflow
         expect(error_pool).to eq wf.error_pool
+        expect(error_pool_context).to eq wf.error_pool_context
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waterfall
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Benjamin Roth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler