riverbed 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c5d4978c088d800b517175a266ff9f025c1566b17f4820d64d9a60cc563e968
-  data.tar.gz: 803fce7525da68cf7f039e21d4e872de9cf7b421cf58f895da5fca208f52be8b
+  metadata.gz: b70bef824c3c371e0b0511299f23855b02f64330bb767694b1594111a64c43da
+  data.tar.gz: cd22f4267059c7c959eba2e32fedd708f5b904b8170302aea84be28edb0bdf67
 SHA512:
-  metadata.gz: ea44732a062ed725d831d6abdd4c15c69ff9df667b26b30ed9014c8e86af51bd385168c3b0c669521ae1ca9efd0bf08e94a5551329a694430058f80c491e9e76
-  data.tar.gz: 4fd7136f509059fab6d0525f7125f9aaa6be070868e824e7dfa27e83422a537377a33ca47ea035f5c271defcbd183da2db50277ba011423ce17fda43fa390fd8
+  metadata.gz: 8f2f00bd0d73d7ea9eb42532dfc2a5bbba96bac58802e7661ce3514caa1eeca71c89617c9c8e69239d6197ff0ff2efcd8d9a93895ca5f9f32c6e256aaae96e04
+  data.tar.gz: e033f70f409f9454c0b2d478cb5330ca337f47dc643e46d0fc123ff40201fb99cc0db2fbaebdbea9b4bebadb03db3a5dc834d169af6c4bc7232ece762f02b1b4

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## [Unreleased]
 
+## [0.2.0] - 2021-09-24
+- Add log_id option to flow
+```ruby
+Flow.run(nil, { log_id: "abc_my_session_id" })
+```
+
+- Change the way in which flow accepts parameters. Now flow options are second parameter.
+Old way, no longer accepted:
+```ruby
+Flow.run(options: { logger: nil })
+Flow.run({}, options: { logger: nil })
+# Flow.run({}) ## This would raise error
+```
+
+New way:
+```ruby
+Flow.run(nil, { logger: nil })
+Flow.run({}, { logger: nil })
+# Flow.run(options: { logger: nil }) ## This would land in input instead of options
+# Flow.run({}, options: { logger: nil }) ## This would cause code to ignore options
+```
+
 ## [0.1.0] - 2021-06-26
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    riverbed (0.1.0)
+    riverbed (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Min example:
+### Min working example:
 ```ruby
 require "riverbed"
 
@@ -44,9 +44,12 @@ Flow1.run
 ```ruby
 require "riverbed"
 
+# uses flow input to print "Hello world"
+# stores data in flow_data - object available in all steps for storing and retreiving data
+# returns 10, which can be accessed in next step through `last_result` method called on flow_data
 class Step2 < Riverbed::Step
   def execute
-    puts flow_data.input + " world" # flow ipnut
+    puts flow_data.input + " world"
 
     flow_data.add(:abc, 123) # sets key :abc in flow data container
 
@@ -54,6 +57,8 @@ class Step2 < Riverbed::Step
   end
 end
 
+
+
 # gets result of previous step (or input if no previous steps exist)
 # and adds to value of key abc
 # `flow_data.get(:a)` will return nil if key not present, `flow_data.get!(:a)` will raise error if key not preset
@@ -73,10 +78,33 @@ class Flow2 < Riverbed::Flow
 end
 
 input = "Hello"
-result = Flow2.run(input, options: {}) # can set `options: { logger: nil }` to skip step execution time logging
+result = Flow2.run(input)
+# Flow2.run(input, { logger: nil }) - second parameter is for options
+# available options:
+# `logger: nil` to skip step execution time logging
+# `log_id: "abc"` sets log_id displayed when logging flow progress
+# `data_object: Riverbed::Data.new(my: :data)` if you want to use existing data object, eg. from previous flow
 
 puts "Final result: #{result}"
 ```
+### Options
+To run example flow with options:
+`Flow2.run(input, { logger: nil })` - second parameter is for options
+Available options:
+- `logger: nil` to skip logging
+- `log_id: "abc"` sets log_id displayed when logging flow progress
+- `data_object: Riverbed::Data.new(my: :data)` if you want to use existing data object, eg. from previous flow.
+
+### Available Flow Data methods
+#### Add to data container:
+`flow_data.add(:abc, 123)`
+#### Get value from data container:
+`flow_data.get(:abc)`
+`flow_data.get!(:abc)` # raises error if value is not set
+#### Get flow input value from data container:
+`flow_data.input`
+#### Get result of last step from data container:
+`flow_data.last_result`
 
 Check tests for more examples
 

data/lib/riverbed/flow.rb

@@ -4,11 +4,12 @@ module Riverbed
   class Flow
     def initialize(input, options)
       @logger = options.fetch(:logger, Logger.new($stdout))
+      @log_id = options.fetch(:log_id, generate_log_id)
 
       @data = options.fetch(:data_object, Riverbed::Data.new(input))
     end
 
-    def self.run(input = nil, options: {})
+    def self.run(input = nil, options = {})
       new(input, options).run
     end
 
@@ -21,6 +22,8 @@ module Riverbed
     end
 
     def run
+      log_flow_start
+
       begin
         run_steps(steps)
       rescue StandardError => e
@@ -29,13 +32,14 @@ module Riverbed
       end
 
       run_steps(always)
+      log_flow_end
 
       data.last_result
     end
 
     private
 
-    attr_accessor :logger, :data
+    attr_accessor :logger, :data, :log_id
 
     def run_steps(steps)
       steps.each do |step_class|
@@ -57,8 +61,16 @@ module Riverbed
       logger&.info("#{log_id} Step #{step_name} executed in #{((end_time - start_time) * 1000).round(2)} ms")
     end
 
-    def log_id
-      @log_id ||= SecureRandom.urlsafe_base64(8)
+    def generate_log_id
+      SecureRandom.urlsafe_base64(8)
+    end
+
+    def log_flow_start
+      logger&.info("#{log_id} Starting flow #{self.class}")
+    end
+
+    def log_flow_end
+      logger&.info("#{log_id} Ending flow #{self.class}")
     end
 
     def on_error(error)

data/lib/riverbed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Riverbed
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riverbed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - BMaczka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-26 00:00:00.000000000 Z
+date: 2021-09-24 00:00:00.000000000 Z
 dependencies: []
 description: Ruby business logic gem
 email: