saga_orchestrator 0.15 → 0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f2d80f2049b75b37a4a7bba59a62f4044e520c8e8ef6e883d37c6f25b83370b
-  data.tar.gz: 70ca29bd90e75a3528b30e3a7cfbc74960aabc2fff1ec27514e8dd81f5a51019
+  metadata.gz: 3cd99f62af35797ca43befbb1b88703e54d6e0d115c11f8bab5df7f8ed6a7fdd
+  data.tar.gz: 243c00eede8dc09ccbe45b72301db3237a9ed09c1d03a135291ebe4e01ff7439
 SHA512:
-  metadata.gz: e80266e57ca6d8800e2b75c9035259f8f7c246e389646cab07ae925f3e509b97b3c035ec34201bbda37052caa7d5dbc89b5ecb0a692d6064fb04d032fcbcd42a
-  data.tar.gz: 81b6e4d48f690b5eb8d21e9070dc02c9afafe71f757e926f2c25ab3cc0bebb2fe1992cd56517bea03c893eef99442ace1a967c9acbe46397b8d6fc31f75ada9c
+  metadata.gz: 83b097c7b8ffdfed0e33d32749273756fde8c8cc0340eb58b3b15e63ef0595ce60c5d1f59ecbebcefd2c9209ccb8cd7999b90fe260978f797bf6bcbd5f9af66c
+  data.tar.gz: f228f9ccc927995f41b61ad483621703a3ba4e4d87d32578b0d8df97728d231b0f0e393d431c78ff7cfd5f62fa97620e832a07fce5cdb1b33b4b882ee69aed48

data/Readme.md

@@ -4,6 +4,8 @@ Saga Orchestration gem is inspired by Microservice Patterns by Chris Richardson.
 
 It provides a framework to employ the Saga Orchestration patterns described in detail in his books and articles. Secondly, it makes it easier for firms to visualize the entire flow as a set of steps.
 
+This is available on github at: [Saga Orchestration Gem](https://github.com/jravz/saga_orchestrator)
+
 ## Description
 
 The key goals this gem seeks to address are -
@@ -44,10 +46,9 @@ To build workflows, the first step is to design the workflow. Let us take an exa
 ![workflow](images/flow_chart.png)
 
 1. Create a child class inheriting from Saga::StateEngine
-2. Add a function register_states within the child class to setup all the states as below.
+2. Add a function state_registration within the child class as below to setup all the states as below. Use register_states features to register various states.
 
-'''
-def state_registration
+    def state_registration
 
       register_states do |add_state|
 
@@ -102,7 +103,6 @@ def state_registration
       end
 
     end
-'''
 
 ### How to define a state
 

data/examples/main.rb

@@ -1,6 +1,6 @@
-require 'saga_orchestrator'
+require '../lib/saga_orchestrator'
 require_relative 'workflow_models/definitions/test'
 
-obj = Saga::Orchestrator::new(Workflows::Test, 30)
+obj = Saga::Orchestrator::new(Workflows::Test, 3000)
 puts obj.run()
 puts obj.execution_sequence

data/examples/workflow_models/definitions/test.rb

@@ -1,4 +1,4 @@
-require 'saga_orchestrator'
+require_relative '../../../lib/saga_orchestrator'
 require_relative '../processors/test'
 require_relative '../functions/test'
 require_relative '../rollback/test'
@@ -42,6 +42,14 @@ module Workflows
           state.process_output Processors::Test.method(:processor)
         end
 
+        add_state.standard :sample4 do |state|
+          state.call Functions::Test.method(:test_func4)
+          state.params do |p|
+            p.set_type :input_params
+          end
+
+        end
+
         add_state.standard :cond01 do |state|
           state.call Functions::Test.method(:conditional_test)
           state.params do |p|
@@ -55,14 +63,19 @@ module Workflows
 
     def sequence_states
       describe_flows do |seqs|
+
+        seqs.sub :seq_b do |seq|
+          seq.init state_name :sample4
+          seq.end
+        end
+
         seqs.start :seq_a do |seq|
           seq.init state_name :sample
           seq.then state_name :sample2
           seq.then_conditional state_name :cond01 do |t|
-            t.on_true state_name :sample
-            t.on_false state_name :sample2
+            t.on_true sequence_name :seq_b
+            t.on_false state_name :sample3
           end
-          seq.then state_name :sample3
           seq.end
         end
       end

data/examples/workflow_models/functions/test.rb

@@ -18,6 +18,13 @@ module Functions
       raise StandardError, "An error occurred"
     end
 
+    def self.test_func4 input
+      puts "in test_func: input - #{input}"
+      res = input * 10000
+      puts "result = #{res}"
+      res
+    end
+
     def self.conditional_test input
       res = input > 0
       puts "result = #{res}"

data/lib/state_management/sequences.rb

@@ -21,6 +21,12 @@ module Saga
       @run_state = nil
     end
 
+    def set_run_status bool
+      if bool.is_a?(TrueClass) || bool.is_a?(FalseClass)
+        @run_state = bool
+      end
+    end
+
     def run params = nil, last_state_result=nil
 
       if self.type == :stop
@@ -44,7 +50,7 @@ module Saga
     def next
 
       if @run_state.nil?
-        raise NodeNotRunError.new("Node has not been run yet.", { reason: "Next can only be decided after node has been run.", code: 1001 })
+        raise NodeNotRunError.new("Node has not been run yet.: #{self.name}", { reason: "Next can only be decided after node has been run.", code: 1001 })
       end
 
       if @run_state == true
@@ -61,14 +67,18 @@ module Saga
     def set_do task
 
       if task.nil?
-        raise NullStateError.new("State not defined.", { reason: "State has not been defined or registered.", code: 1001 })
+        raise NullStateError.new("Attempt to run an undefined state.", { reason: "State has not been defined or registered.", code: 1001 })
       end
 
       if task.is_a?(Sequence)
         @action_type = :sequence
+        @name = task.name
+        puts "within sequence - #{@name}"
+      else
+        @name = task.state_name
+        puts "within task - #{@name}"
       end
       @do = task
-      @name = task.state_name
     end
 
     def name
@@ -152,6 +162,10 @@ module Saga
       @initial_node = nil
     end
 
+    def name
+      @name
+    end
+
     def first
       @initial_node
     end

data/lib/state_management/state_engine.rb

@@ -86,8 +86,9 @@ module Saga
       current_node = active_node
 
       begin
-        if current_node.is_a?(Sequence)
+        if current_node.sequence?
           conduct_sequence current_node.activity.first
+          current_node.set_run_status true
         else
           @executing_node = current_node
           res = current_node.run @params, @last_result

data/lib/state_management/states.rb

@@ -30,7 +30,9 @@ module Saga
     end
 
     def get_state_by_name name
-      @states[name]
+      res = @states[name]
+      raise NullStateError.new("Attempt to run an undefined state = #{name}.", { reason: "State has not been defined or registered.", code: 1001 }) if res.nil?
+      res
     end
 
     def keys

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saga_orchestrator
 version: !ruby/object:Gem::Version
-  version: '0.15'
+  version: '0.17'
 platform: ruby
 authors:
 - Jayanth Ravindran
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-01 00:00:00.000000000 Z
+date: 2024-05-02 00:00:00.000000000 Z
 dependencies: []
 description: Framework to help employ the Saga Orchestration patterns in ruby or rails
   applications. Secondly, it makes it easier for firms to visualize the entire flow