chainit 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c74ac4b8fd343c0102004f3c6f36b9e96a5d4e0
-  data.tar.gz: 6b5b8dca91e216e026b414d4efadfc2689acb9f2
+  metadata.gz: 9fd7e2e3e12a8707ca3992b5d229395ce0a50e62
+  data.tar.gz: beaeefe42f9984cc4be7d564c34ef2553b01c8ce
 SHA512:
-  metadata.gz: 52ad71c4a97c6e1ce038b4d15eab7fe7a3c310cabb6bdc1c84d6b7a2b44751a316008a06b15b354ea4849f56b7533a5af73431ae05e321e2eb41ea1d38c5e8fd
-  data.tar.gz: 32fd4e691d7db94f937c2fa71f524f24070eb17917c1d43459434de47e1a52eb02bc1b8196d47ce6e40062ff855a2dd2dc001e14bfb5503354b6439d6f00584a
+  metadata.gz: 143eb82b10d0c3b877fac51cc6bf11db176c253c37d00e2effd7cdb2d95b35d3319bc7a8a8da081abf4cc8840e7c9711a486282f9ee7bfe157c4546fba0e5286
+  data.tar.gz: 744156b8e3b84a97d260bfe9225d329c76e5758d23745743363d2be12f255938e46ed975423bd1b1f69d3e0e30709f4274b0533d1e458a29b21a97d7c6019c37

data/README.md

@@ -1,16 +1,21 @@
 # ChainIt
-[![CircleCI](https://circleci.com/gh/spark-solutions/chain_it/tree/master.svg?style=svg&circle-token=3bb16aef0dbcbe7fd18500376a110bd6cedf668a)](https://circleci.com/gh/spark-solutions/ChainIt/tree/master)
+### Gain full control over what is going in your code!
+[![CircleCI](https://circleci.com/gh/tier-tools/chainit/tree/master.svg?style=svg)](https://circleci.com/gh/tier-tools/chainit/tree/master)
 
-## Description
-This provides the tool which is implementation of railway-oriented programming concept itself
-(Read more on this <a href="https://fsharpforfunandprofit.com/rop">here</a>).
+## What exactly is `ChainIt`?
+It's the  Ruby implementation of a railway-oriented programming concept. <a href="https://fsharpforfunandprofit.com/rop">read more</a> 
 
-Ideally suited for executing task sequences that should be immediately interrupted when any subsequen task fails.
+The gem makes it super easy to control complex operations flow - the next step will happen only if the previous one was successful.
 
-## Usage
-Everything comes down to chaining subsequent `#chain` method calls to a `ChainIt` object instance.
+Ideally suited for handling task sequences that should be  interrupted as soon as any subsequent task fails.
 
-The gem supports design-by-contract programming concept - assuming every block related to `#chain` have to return both `#value` and `#failure?` aware object.We reccomend using Struct for that purpouse.
+## How should I use `ChainIt`?
+As not hard to guess, alll is about chaining subsequent `#chain` method calls to a `ChainIt` instance.
+
+### Prerequisites
+The gem supports design-by-contract programming concept assuming `ChainIt` will be used together with both `#value` and `#failure?` aware object that have to be returned by every `#chain`related block. It is used to consider the operation successful or failed.
+
+We reccomend using `Struct`:
 
 ```ruby
 Result = Struct.new(:success, :value) do
@@ -20,42 +25,68 @@ Result = Struct.new(:success, :value) do
 end
 
 ```
-### Examples
+### Interface explanation
+`#initialize` - Initiates the operation. Auto exception handling mode is configurable here. (see examples section)</br>
+`#chain` - Performs the code in its related block and memorizes the internal result value. This is done only when the state of the operation allows it.</br>
+`#skip_next` - Skips the next `#chain` call when it's block evaluates to `true`.</br>
+`#result` - The result of the operation representing succes of failure. </br>
+
+### `ChainIt` modes
+`auto_exception_handling` - default `false` - Decide if any `StandardError` exception should be rescued from any `#chain` call. If so the rescued exception will be memorized as operation result object.
 
+### Examples </br>
+#### Success path
 ```ruby
-# Basic flow explanation
 success = ->(value) { Result.new(true, value) }
 
-ChainIt.new.
-        chain { success.call 2 }.               #=> The subsequent chain will be triggered
-        chain { |num| success.call(num * 2) }.  #=> We can pass the previous block evaluation as the block argument
-        chain { |num| success.call(num * 2) }.
-        result.
-        value                                   #=> 8
-
-# Working with #skip_next
 ChainIt.new.
         chain { success.call 2 }.               
-        skip_next { |num| num == 2 }.           #=> The next chain will be skipped conditionally since block returns true
-        chain { success.call 8 }.              
-        chain { |num| success.call(num * 2) }.  #=> The block argument is the last executed #chain value
-        result.
+        chain { |num| success.call(num * 2) }.  # The operation result is passed as block argument if used.
+        result.                                 #=> <struct Result success=true, value=4>
         value                                   #=> 4
 
-# Dealing with a failure
+```
+
+#### Failure path
+```ruby
 failure = ->(value) { Result.new(false, value) }
 
 ChainIt.new.
         chain { success.call 2 }.
-        chain { failure.call 0 }.               #=> All later #chain calls will be skipped
+        chain { failure.call 0 }.               # All later steps calls will be skipped. 
         chain { success.call 4 }.
-        result.
+        result.                                 #=> <struct Result success=false, value=0>
         value                                   #=> 0
 ```
-## Contributing
+#### Working with `#skip_next`
+```ruby
+ChainIt.new.
+        chain { success.call 2 }.               
+        skip_next { |num| num == 2 }.           # The next chain will be skipped as the block evaluates to true.
+        chain { success.call 8 }.              
+        result.                                 #=> <struct Result success=true, value=2>
+        value                                   #=> 2
+```
+
+#### With `auto_exception_handling` mode disabled
+```ruby
+ChainIt.new.
+        chain { raise StandardError.new }.      #=> StandardError: StandardError                             
+        result.                                 
+        value
+```
+
+#### With `auto_exception_handling` mode enabled
+```ruby
+ChainIt.new(auto_exception_handling: true).
+        chain { raise StandardError.new }.
+        result.                                  #=> <StandardError: StandardError>
+        value                                    #=> <StandardError: StandardError>
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/spark-solutions/chain_it.
+## Develop `ChainIt`
+All the contributions are really welcome on GitHub at https://github.com/tier-tools/chainit according to the open-source spirit.
 
-## License
+## `ChainIt` License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/chain_it.rb

@@ -1,6 +1,11 @@
 class ChainIt
+  DEFAULT_SETTINGS = { auto_exception_handling: false }.freeze
   INVALID_RESULT_MSG = "ChainIt#chain block must return both #value and #failure? aware object.\n Check documentation: https://github.com/spark-solutions/chain_it#usage"
 
+  def initialize(settings = {})
+    @settings = DEFAULT_SETTINGS.merge(settings)
+  end
+
   def chain
     if @skip_next
       @skip_next = false
@@ -13,6 +18,14 @@ class ChainIt
     @result = yield result_value
     @skip = true if result_failure?
     self
+  rescue StandardError => e
+    raise e unless @settings[:auto_exception_handling]
+
+    e.define_singleton_method(:value) { e }
+    @result = e
+
+    @skip = true
+    self
   end
 
   def skip_next

data/lib/chain_it/version.rb

@@ -1,3 +1,3 @@
 class ChainIt
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chainit
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - btolarz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2018-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: A tool for executing successive tasks in a railway-oriented manner