flor 0.17.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bf01d8760a78e903218fef2a040fa42551d7273e
-  data.tar.gz: 402f89f60de25ebe27a11c16e3e34fdbd3e8b854
+SHA256:
+  metadata.gz: 553a980e772a1ce1d8990fc8d0744163b6615c5e9a4fe391d48ab73ac2219b2a
+  data.tar.gz: 7b922c56e568ac51cbb9cc3dbcb02c930984f94785ddd3b8ea76804ccff848de
 SHA512:
-  metadata.gz: 1132dd0609803767926d6546549d5285a0197837dd512ea2980ce03b8be23c76e43016b3a63c36b4d43fd7bd8a7c055bc1085c482b659ea69fa2da1fa94f894e
-  data.tar.gz: 59498ec443e22d08d01f8708a19dcf7b1b4b41a179e807fa0b6225d10f5642e2a3ab61bb04624c3ad80d9b0b2378d6c4b2b71651bb67bc0c25de5b22e0395120
+  metadata.gz: fc920c9d3f305e3e31f174ebbb5d8e7f935742a9b5bcd5a75b80646d5803746315e91e4937156a01f3fcc512c477b8770e6a665a86bd61a81120f0e305027652
+  data.tar.gz: 4dd48c11b6f59d2efc4aec15060d0c7db07541b1af4037dc8402b6ef701f43b88928aaaf3306e6ae0e1237a79f5fb360c992cf58648e26edb398f7adf843970e

data/CHANGELOG.md

@@ -2,6 +2,54 @@
 # CHANGELOG.md
 
 
+## flor 1.1.1  released 2021-03-03
+
+* Use YAML to have more compact msg_to_detail_s
+
+
+## flor 1.1.0  released 2021-01-06
+
+* Introduce Tasker #set_payload and #set_vars
+* Introduce the ModuleGanger
+* Allow for domain/dot.json taskers
+* Introduce Flor::StagedBasicTasker
+* Fix service/executor issue in Caller
+
+
+## flor 1.0.1  released 2020-11-23
+
+* Accept sto_uri strings pointing to constant like 'DB'
+
+
+## flor 1.0.0  released 2020-11-22
+
+* Lots of incremental improvements
+
+
+## flor 0.18.0  released 2019-05-05
+
+* Refine BasicTasker#reply (more arg patterns)
+* Fix "signal" vs exid: and payload:
+* Make payload optional when cancelling
+* Unlock `signal exid: other_execution_id "xxx"`
+* Allow for `trap 'signal0' payload: { a: 'A' }`
+* Allow for "on" in blocking mode (no block given)
+* Turn "sequence" single string att results to tags
+* gh-26, refine cancel / on_cancel and payload return
+* Allow for custom :schema_info migration table
+* Introduce a dedicated #refresh for all flor models
+* Let scheduler sleep only 0.001s if @idle_count less than 1
+* Implement Scheduler #dump and #load
+* Default target #cancel and #kill to node '0'
+* Expose taskname to tasker on detasking (@Subtletree)
+* Refine BasicTasker#reply (more arg patterns)
+* Allow for `trap 'signal0' payload: { a: 'A' }`
+* Allow for "on" in blocking mode (no block given)
+* Unlock `signal exid: other_execution_id "xxx"`
+* Make payload optional when cancelling (default to payload as it was
+  upon reaching the cancelled node)
+
+
 ## flor 0.17.0  released 2019-04-08
 
 - Switch to 0.17.x

data/CREDITS.md

@@ -3,6 +3,7 @@
 
 ## Contributors
 
+* Olle Jonsson - https://github.com/olleolleolle
 * Ryan Scott - https://github.com/Subtletree
 * Jeffrey Hicks - https://github.com/jrhicks
 * David Verrier - https://github.com/dverrier

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2015-2019, John Mettraux, jmettraux+flor@gmail.com
+Copyright (c) 2015-2021, John Mettraux, jmettraux+flor@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -32,7 +32,7 @@ build: gemspec_validate
 	mv $(NAME)-$(VERSION).gem pkg/
 
 push: build
-	gem push pkg/$(NAME)-$(VERSION).gem
+	gem push --otp "$(OTP)" pkg/$(NAME)-$(VERSION).gem
 
 
 ## flor tasks ##

data/README.md

@@ -1,7 +1,7 @@
 
 # flor
 
-[![Build Status](https://secure.travis-ci.org/floraison/flor.svg)](http://travis-ci.org/floraison/flor)
+[![tests](https://github.com/floraison/flor/workflows/test/badge.svg)](https://github.com/floraison/flor/actions)
 [![Gem Version](https://badge.fury.io/rb/flor.svg)](http://badge.fury.io/rb/flor)
 
 Flor is a "Ruby workflow engine", if that makes any sense.
@@ -11,6 +11,17 @@ Flor is a "Ruby workflow engine", if that makes any sense.
 * [twitter.com/@flor_workflow](https://twitter.com/flor_workflow)
 
 
+## use
+
+As a workflow engine, flor takes as input process definitions and executes them. Those executions may in turn call pieces of Ruby code or external scripts that perform the actual work. Those pieces of code and scripts are called "taskers".
+
+The classical way to use a language interpreter is to instantiate it as needed and let it die as the host execution ends. A workflow engine is more like a server, it may host multiple executions. And if the workflow engine stops, it may be restarted and pick the work back, when it was when it stopped.
+
+Flor process definitions are written in the flor language, a programming language mostly inspired by Scheme and Ruby. As always with programming languages, readability is hoped for, for a workflow engine this is especially necessary since those business processes are the bread and butter of business users.
+
+Using flor in your Ruby project requires you to clearly separate business process definitions from taskers. Since a flor instance may host multiple process executions based on one or more process definitions, many of the taskers may be reused from one definition to the other. For instance, if a "send-invoice-to-customer" tasker is created it might get used in the "process-retail-order" and the "process-big-distribution-order" processes.
+
+
 ## design
 
 * Strives to propose a scheming interpreter for long running executions
@@ -108,13 +119,34 @@ See [doc/](doc/).
 
 ## blog posts and presentations
 
-* [the flor language](http://jmettraux.skepti.ch/20180927.html?t=the_flor_language) - on the flor workflow definition language itself
+* [flor workflow engine](http://jmettraux.skepti.ch/20190407.html?t=flor_workflow_engine&f=readme) - on flor itself
+* [the flor language](http://jmettraux.skepti.ch/20180927.html?t=the_flor_language&f=readme) - on the flor workflow definition language itself
+* [reddit answer on workflow engines](http://jmettraux.skepti.ch/20190416.html?t=reddit_answer_on_workflow_engines&f=readme) - an answer to a Reddit question on workflow engines, archived as a post
 * [Flor, hubristic interpreter](http://rubykaigi.org/2017/presentations/jmettraux.html) - RubyKaigi 2017, Hiroshima - presentation
 * [flor design 0](http://jmettraux.skepti.ch/20171021.html?t=flor_design_0&f=readme) - running a simple execution, what happens - blog post
 * [flor, branch to branch](https://speakerdeck.com/jmettraux/flor-branch-to-branch) - q1 2017 - very dry deck
 * [flor 2017](https://speakerdeck.com/jmettraux/flor-2017) - q1 2017 - very dry deck
 
 
+## other Ruby projects about workflows
+
+There are various other Ruby and Ruby on Rails projects about workflows and business processes, each with its own take on them.
+
+* [Dynflow](http://dynflow.github.io/) - "Dynflow (DYNamic workFLOW) is a workflow engine written in Ruby"
+* [rails_workflow](https://github.com/madzhuga/rails_workflow) - "Rails Workflow Engine allows you to organize your application business logic by joining user- and auto- operations in processes"
+* [rails_engine/flow_core](https://github.com/rails-engine/flow_core) - "A multi purpose, extendable, Workflow-net-based workflow engine for Rails applications"
+* [Trailblazer](http://trailblazer.to/) - "The Advanced Business Logic Framework"
+* [Petri Flow](https://github.com/hooopo/petri_flow) - "Petri Net Workflow Engine for Ruby" (Rails)
+* [Pallets](https://github.com/linkyndy/pallets) - "Simple and reliable workflow engine, written in Ruby"
+* [Gush](https://github.com/chaps-io/gush) - "Fast and distributed workflow runner using ActiveJob and Redis"
+
+There is a [workflow engine](https://ruby.libhunt.com/categories/5786-workflow-engine) category on [Awesome Ruby](https://ruby.libhunt.com/).
+
+If you want your engine/library to be added in this list, don't hesitate to ask me on [Gitter](https://gitter.im/floraison/flor) or via a pull request.
+
+It's not limited to Ruby, but there is a wider list at [meirwah/awesome-workflow-engines](https://github.com/meirwah/awesome-workflow-engines).
+
+
 ## license
 
 MIT, see [LICENSE.txt](LICENSE.txt)

data/flor.gemspec

@@ -10,8 +10,7 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.authors = [ 'John Mettraux' ]
   s.email = [ 'jmettraux+flor@gmail.com' ]
-  s.homepage = 'http://github.com/floraison'
-  #s.rubyforge_project = 'flor'
+  s.homepage = 'https://github.com/floraison'
   s.license = 'MIT'
   s.summary = 'A Ruby workflow engine'
 
@@ -38,16 +37,16 @@ A Ruby workflow engine (ruote next generation)
     "#{s.name}.gemspec",
   ]
 
-  s.add_runtime_dependency 'munemo', '~> 1.0', '>= 1.0.1'
-  s.add_runtime_dependency 'raabro', '~> 1.1', '>= 1.1.5'
   #s.add_runtime_dependency 'rufus-lru', '~> 1.1'
-  s.add_runtime_dependency 'fugit', '~> 1.1', '>= 1.1.8'
-  s.add_runtime_dependency 'dense', '~> 1.1', '>= 1.1.6'
+  s.add_runtime_dependency 'munemo', '~> 1.0' # >= 1.0 and < 2
+  s.add_runtime_dependency 'raabro', '~> 1.1' # >= 1.1 and < 2
+  s.add_runtime_dependency 'fugit', '~> 1.2' # >= 1.2 and < 2
+  s.add_runtime_dependency 'dense', '~> 1.1' # >= 1.1 and < 2
 
-  s.add_runtime_dependency 'sequel', '~> 5'
+  s.add_runtime_dependency 'sequel', '~> 5.0' # >= 5.0 and < 6
 
-  s.add_development_dependency 'rspec', '~> 3.7'
-  s.add_development_dependency 'terminal-table'
+  s.add_development_dependency 'rspec', '~> 3.8' # >= 3.8 and < 4
+  s.add_development_dependency 'terminal-table', '~> 1.8' # >= 1.8 and < 2
 
   s.require_path = 'lib'
 end

data/lib/flor.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
 
 require 'pp'
 require 'json'
+require 'yaml'
 require 'logger'
 require 'thread'
 require 'digest'
@@ -14,8 +16,7 @@ require 'dense'
 
 module Flor
 
-  VERSION = '0.17.0'
-  #VERSION = '1.0.0'
+  VERSION = '1.1.1'
 end
 
 require 'flor/colours'

data/lib/flor/colours.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 
 module Flor
 
   COLS = Hash[*%w[
 
     reset 0;0
-    bright 1 dim 2 underlined 4 blink 5 reverse 7 hidden 8 default 39
+    bright 1 dim 2 underlined 4 blink 5 reverse 7 hidden 8 strike 9 default 39
     black 30 red 31 green 32 yellow 33 blue 34 magenta 35 cyan 36
     light_gray 37 dark_gray 90 light_red 91 light_green 92
     light_yellow 93 light_blue 94 light_magenta 95 light_cyan 96 white 97
@@ -17,7 +18,8 @@ module Flor
     brown yellow purple magenta dark_grey dark_gray light_grey light_gray
 
     rd red bl blue bu blue ba black bk black gn green gr green dg dark_gray
-    gy light_gray lg light_gray yl yellow y yellow ma magenta rs reset
+    gy light_gray lg light_gray yl yellow y yellow ma magenta wt white
+    rs reset
     br bright bri bright un underlined rv reverse bn blink blg bg_light_gray
     und underlined rev reverse
   ]]
@@ -28,7 +30,7 @@ module Flor
       if v.match(/\A\d/)
         class_eval(%{
           def #{k}(s=nil)
-           s ? "[#{v}m" + s + "" : "[#{v}m"
+           s ? "[#{v}m" + s + "" : "[#{v}m"
            end })
       else
         class_eval(

data/lib/flor/conf.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Flor
 

data/lib/flor/core.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Flor
 
@@ -28,7 +29,7 @@ module Flor
 
     t =
       tree.is_a?(String) ?
-      Flor.parse(tree, opts[:fname], opts) :
+      Flor.parse(tree, opts[:fname] || opts[:path], opts) :
       tree
 
     unless t
@@ -51,13 +52,13 @@ module Flor
       "given launch variables should come in a Hash, but it's a #{vs.class}"
     ) unless vs.is_a?(Hash)
 
-    msg =
-      { 'point' => 'execute',
-        'exid' => exid,
-        'nid' => '0',
-        'tree' => t,
-        'payload' => pl,
-        'vars' => vs }
+    msg = {
+      'point' => 'execute',
+      'exid' => exid,
+      'nid' => '0',
+      'tree' => t,
+      'payload' => pl,
+      'vars' => vs }
 
     msg['vdomain'] = opts[:vdomain] \
       if opts.has_key?(:vdomain)

data/lib/flor/core/executor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Flor
 
@@ -211,7 +212,8 @@ module Flor
         #
         # tag: et al
 
-        node['tree'] = message['tree'] = t = [ '_sqs', tree[0], tree[2] ]
+        node['tree'] = message['tree'] = t =
+          [ '_sqs', tree[0], tree[2] ]
 
         node['heat0'] = t[0]
         node['heat'] = h = n.deref(t[0])
@@ -221,14 +223,16 @@ module Flor
         #
         # rewrite `alpha` into `task alpha`
 
-        l = message['tree'][2]
+        mt = message['tree']
+        l = mt[2]
 
-        message['otree'] = Flor.dup(message['tree'])
+        message['otree'] = mt
 
-        message['tree'][0] =
-          'task'
-        message['tree'][1].unshift(
-          [ '_att', [ [ '_sqs', heat[1]['tasker'], l ] ], l ])
+        node['tree'] = message['tree'] =
+          [ 'task', [
+            [ '_att', [ [ '_sqs', heat[1]['tasker'], l ] ], l ],
+            *mt[1]
+          ], l ]
       end
     end
 
@@ -287,9 +291,8 @@ end
 
     def receive(message)
 
-      messages = leave_node(message)
-
       nid = message['nid']
+      messages = leave_node(message)
 
       return messages + toc_messages(message) unless nid
         # 'terminated' or 'ceased'
@@ -319,7 +322,9 @@ end
       cls = node['closures']
 
       pro = Flor::Procedure.make(self, node, message)
+
       pro.end
+        # do end the node
 
       cancels = pro.send(:wrap_cancel_children, 'cancel_trailing' => true)
 
@@ -380,12 +385,7 @@ end
 
     def error_reply(node, message, err)
 
-      m = message
-        .select { |k, v| %w[ sm exid nid from payload tree ].include?(k) }
-
-      m['point'] = 'failed'
-      m['fpoint'] = message['point']
-      m['error'] = Flor.to_error(err)
+      m = Flor.to_error_message(message, err)
 
       @unit.logger.log_err(self, m, flag: true)
 
@@ -419,15 +419,14 @@ end
 
       last = (message['cause'] ||= [])[0]
 
-      c = {
-        'cause' => cause,
-        'm' => message['m'],
-        'nid' => message['nid'],
-        'type' => message['type'],
-        'at' => last && last['at'] }
+      c = { 'cause' => cause, 'at' => last && last['at'] }
+      %w[ m sm nid type ].each { |k| c[k] = message[k] }
 
       return if c == last
 
+      # argh, the causes in the messages go most recent first
+      # while the statuses in the nodes go most recent last
+
       message['cause'] =
         [ c.tap { |h| h['at'] = Flor.tstamp } ] +
         message['cause']
@@ -448,7 +447,11 @@ end
         stack_cause(message) \
           if %w[ trigger cancel ].include?(message['point'])
 
-        determine_heat(message)
+        begin
+          determine_heat(message)
+        rescue => e
+          raise e unless message['point'] == 'failed'
+        end
 
         ms = []
         ms += @unit.notify(self, message) # pre

data/lib/flor/core/node.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Node
 
@@ -156,19 +157,6 @@ class Flor::Node
     nil
   end
 
-  #def lookup_tree(nid)
-  #  climb_down_for_tree(nid) ||
-  #  climb_up_for_tree(nid) ||
-  #end
-  #def climb_up_for_tree(nid)
-  #  # ...
-  #end
-  #def climb_down_for_tree(nid)
-  #  # ...
-  #end
-    #
-    # that might be the way...
-
   def lookup_value(path)
 
     original_path = path

data/lib/flor/core/procedure.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Procedure < Flor::Node
 
@@ -386,18 +387,30 @@ class Flor::Procedure < Flor::Node
     end
   end
 
+  # From the incoming message, return the most recent cause for this node
+  #
   def message_cause
 
     (@message['cause'] || [])
       .find { |c| c['nid'] == nid }
   end
 
+  # Given the current node status and the incoming message, returns the
+  # upstream cause that lead to the status.
+  # Returns nil if the incoming message is not related to the current status.
+  #
+  def status_cause
+
+    m = node_status['m']
+
+    (@message['cause'] || []).find { |c| c['m'] == m }
+  end
+
   def pop_on_receive_last
 
     orl = @node['on_receive_last']
 
-    return nil unless orl
-    return nil if orl.empty?
+    return nil if orl.nil? || orl.empty?
 
     c = message_cause
 
@@ -411,15 +424,16 @@ class Flor::Procedure < Flor::Node
 
     @node['mtime'] = Flor.tstamp
 
-    orl.each do |m|
-
-      m['from'] = @node['parent'] if m['from'] == 'parent'
+    orl
+      .each do |m|
 
-      #m['payload'] ||= Flor.dup(@node['payload'])
-        # No, let re_applier supply payload
-    end
+        m['from'] = @node['parent'] \
+          if m['from'] == 'parent'
 
-    orl
+        m['payload'] =
+          m.delete('force_payload') ||
+          message['payload']
+      end
   end
 
   def receive_from_child_when_closed
@@ -447,8 +461,21 @@ class Flor::Procedure < Flor::Node
 
     @fcid &&
     Flor.same_branch?(nid, from) &&
-    (c = children[@fcid]) &&
-    c[0] == '_att'
+    (c = children[@fcid]) && c[0] == '_att'
+  end
+
+  def from_keyed_att?
+
+    @fcid &&
+    Flor.same_branch?(nid, from) &&
+    (c = children[@fcid]) && c[0] == '_att' && c[1].size == 2
+  end
+
+  def from_unkeyed_att?
+
+    @fcid &&
+    Flor.same_branch?(nid, from) &&
+    (c = children[@fcid]) && c[0] == '_att' && c[1].size == 1
   end
 
   def from_sub_nid
@@ -804,8 +831,16 @@ class Flor::Procedure < Flor::Node
   def wrap_cancel_nodes(nids, h)
 
     (nids || [])
-      .collect { |i| wrap_cancel(h.merge('nid' => i, 'from' => nid)) }
+      .collect { |i|
+        n = @execution['nodes'][i]
+        s = n && n['status'].last
+        if n == nil || (s['status'] == 'closed' && s['point'] == 'cancel')
+          nil
+        else
+          wrap_cancel(h.merge('nid' => i, 'from' => nid))
+        end }
       .flatten(1)
+      .compact
   end
 
   def wrap_cancelled
@@ -828,6 +863,16 @@ class Flor::Procedure < Flor::Node
   #
   def do_cancel
 
+    @message['payload'] ||= Flor.dup(@node['payload'])
+      #
+      # Ensure the 'cancel' message has a payload.
+      # If not, let's use the payload as it was upon reaching this node.
+
+    return wrap if node_closed? && status_cause
+      #
+      # if the node is cancelled and that is caused by a message upstream
+      # that caused the incoming message, simply reply immediately...
+
     if orl = @message['on_receive_last']
       #
       # the message on_receive_last is used by the re_apply feature