waterfall 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd6e3cd5ae2df5e4e6121b46e1ad127a9613b39b
-  data.tar.gz: bd9634100ae693fd84e1a6ed7b2c362395be627b
+  metadata.gz: e4fa811a59c1b353ab25f5c56d47c494aab50972
+  data.tar.gz: 07657eeaebc676339be72d29373afecff23527f1
 SHA512:
-  metadata.gz: 89668b9efe963d440bb839827984a73e2b14ef3f3d1eeb4879a40c80ebf33465cde450685e392a0168b77686024413ff0257e1dcd10e0304ca3fe4c0dea5f90e
-  data.tar.gz: a425c2ced04535bca474ebff300070664172735bb120a22cea2d4e29b7f8d758042b9a702101d1bc232a373b558fbaa6f4da00b64e57b7b19490142b3b5f2f12
+  metadata.gz: 512a8896bbd591e770c78be0d3c8fd3628f824c664020b2d1b430b0a2c718e34dc8cca6661f1387d283368eef54b4e439698bad1d0ca950e3c991aa2c9a25257
+  data.tar.gz: ce7e7632e200548d05a87419aa03b8f318c3284f40052b2b792fa1c8afba5246860b67151a1dda8db66e8006c5e26510edad3925833e0ab17499f927140e1447

data/Gemfile.lock

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

data/README.md

@@ -242,6 +242,14 @@ end
 ```
 The huge benefit is that if you call services from services, everything will be rolled back.
 
+### Undo
+
+If you get to dam a flow, this would trigger the `reverse_flow` method in all Services previously executed.
+
+`reverse_flow` is not executed on the service which just failed, consider the `on_dam` hook in this case.
+
+Take this as a hook to undo whatever you need to undo if things go wrong. Yet, you probably do not need to bother about databases inserts: this is the purpose of `with_transaction`.
+
 ### FYI
 
 `Flow` is just an alias for the `Wf` class, so just use the one you prefer :)

data/changelog.md

@@ -1,3 +1,7 @@
+===1.2.1
+- Introduced `Waterfall.with_reversible_flow`, makes `reverse_flow` optionnal, may save memory
+- outflow is now lazy loaded
+
 ===1.2.0
 - Removed `undam`.
 - Introduced `reverse_flow`

data/lib/waterfall.rb

@@ -8,11 +8,20 @@ require 'waterfall/predicates/chain'
 
 module Waterfall
 
-  attr_reader :error_pool, :outflow
+  attr_reader :error_pool
 
   class IncorrectDamArgumentError      < StandardError; end
   class IncorrectChainingArgumentError < StandardError; end
 
+  class << self
+    attr_accessor :with_reversible_flow
+  end
+  @with_reversible_flow = true
+
+  def outflow
+    @outflow ||= OpenStruct.new({})
+  end
+
   def when_falsy(&block)
     ::Waterfall::WhenFalsy.new(self).tap do |handler|
       _wf_run { handler.call(&block) }
@@ -75,6 +84,7 @@ module Waterfall
   protected
 
   def _reverse_flows(skip_self)
+    return unless Waterfall.with_reversible_flow
     return if @flow_reversed
     @flow_reversed = true
     reverse_flow unless skip_self
@@ -84,13 +94,13 @@ module Waterfall
   end
 
   def _add_executed_flow(flow)
+    return unless Waterfall.with_reversible_flow
     @_executed_flows ||= []
     @_executed_flows.push(flow)
   end
 
   def _wf_run
     @has_flown = true
-    @outflow ||= OpenStruct.new({})
     yield unless dammed?
     self
   end

data/lib/waterfall/version.rb

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

data/spec/wf_object_spec.rb

@@ -169,5 +169,22 @@ describe Flow do
 
       action
     end
+
+    context "without reversible flow" do
+      around do |example|
+        Waterfall.with_reversible_flow = false
+        example.run
+        Waterfall.with_reversible_flow = true
+      end
+
+      it 'doesnt call reverse_flow, ever' do
+        expect(sub_sub_flow2).to_not receive(:reverse_flow)
+        expect(sub_sub_flow1).to_not receive(:reverse_flow)
+        expect(sub_sub_sub_flow1).to_not receive(:reverse_flow)
+        expect(sub_flow1).to_not receive(:reverse_flow)
+
+        action
+      end
+    end
   end
 end

metadata

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