flor 0.18.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b74ff25bb24e46910557e440ddedc83d07730ec5
-  data.tar.gz: cc0d4de7df8c9a3e39879dfd8968ae70230310c7
+SHA256:
+  metadata.gz: 7a1f76874a9957b7c15c59baf997e0e60ff4872b9109a7cd741692735a94565c
+  data.tar.gz: 7fd1552910609023dd8bce0de0d5b5fc1ebc5ae1674fc27f0d0cb932c4bab2a7
 SHA512:
-  metadata.gz: b2085152306c18636cbd64e9e5d3bc140e6d3b19f2d8afc4111d5283e9da56328a7fc09ab5c2db5fa14f429f3f5f858b87c67c3c6defcb790cb34042608871cb
-  data.tar.gz: 52c344d0deb517f025eb7491201175d44356257c7fae1cad36e8f0a7006a60ec10a3829e0bbc1e7cae2781a0a2ad434e6e84f7499ef9cac94cb0ca095df91643
+  metadata.gz: cbca621e72efc0bdf1df26a4554590032f7a42d76ca19b361305f519071f1f026678c55c2980e74661ebcd5ac018d9e3e892376ee69a07c91ebb1d2d809cbb75
+  data.tar.gz: b2c7cbe0a13c12f0e9b935c3d675f583d93a4f78f921982e75eb9050c84d97914c63cf9280667b5be977280cda9de27a57972f3f0d72b097710a6b3b1e45d67b

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 # CHANGELOG.md
 
 
+## flor 0.19.0  not yet released
+
+
 ## flor 0.18.0  released 2019-05-05
 
 * Refine BasicTasker#reply (more arg patterns)

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-2020, 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

@@ -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
@@ -123,8 +134,11 @@ There are various other Ruby and Ruby on Rails projects about workflows and busi
 
 * [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/workflow_core](https://github.com/rails-engine/workflow_core) - "A Rails engine which providing essential infrastructure of workflow. It's based on Workflow Nets"
+* [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/).
 

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'
 

data/lib/flor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'pp'
 require 'json'
@@ -14,8 +15,7 @@ require 'dense'
 
 module Flor
 
-  VERSION = '0.18.0'
-  #VERSION = '1.0.0'
+  VERSION = '1.0.0'
 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)
 
@@ -447,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
 
@@ -830,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

data/lib/flor/core/texecutor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Flor
 
@@ -235,7 +236,7 @@ module Flor
 
         c = ! (ENV['FLOR_DEBUG'] || '').match(/conf/)
         e = self.new('conf' => c)
-        r = e.launch(source, payload: fs, vars: vs)
+        r = e.launch(source, payload: fs, vars: vs, path: path)
 
         unless r['point'] == 'terminated'
           ae = ArgumentError.new(
@@ -250,7 +251,7 @@ module Flor
           o['_path'] = path
           o['root'] ||= Flor.relativize_path(vs['root'])
         elsif o.is_a?(Array)
-          o.each { |ee| ee['_path'] = path }
+          o.each { |ee| ee['_path'] = path if ee.is_a?(Hash) }
         end
 
         o
@@ -258,6 +259,12 @@ module Flor
 
       def interpret_path(path, context=nil)
 
+        path = File.join(path, 'etc/conf.json') if File.directory?(path)
+
+        fail ArgumentError.new(
+          "flor configuration file not found #{path.inspect}"
+        ) unless File.exist?(path)
+
         interpret(path, load(path), context || {})
       end
 

data/lib/flor/djan.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'io/console'
 

data/lib/flor/errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::FlorError < StandardError
 

data/lib/flor/flor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Flor
 
@@ -77,6 +78,23 @@ module Flor
       deep_merge(o0, o1, true)
     end
 
+    def dup_message(m)
+
+      tc = m.delete('tconf')
+      m1 = Flor.dup(m)
+      m1['tconf'] = tc
+        .inject({}) { |h, (k, v)|
+          h[k] =
+            case k
+            when 'class' then v
+            else Flor.dup(v)
+            end
+          h
+        } if tc
+
+      m1
+    end
+
     def false?(o)
 
       o == nil || o == false
@@ -87,6 +105,20 @@ module Flor
       o != nil && o != false
     end
 
+    def yes?(o)
+
+      oo = o.respond_to?(:downcase) ? o.downcase : o
+
+      [ 'y', 'yes', 'true', true ].include?(o)
+    end
+
+    def no?(o)
+
+      oo = o.respond_to?(:downcase) ? o.downcase : o
+
+      [ 'n', 'no', 'false', false ].include?(o)
+    end
+
     def to_error(o)
 
       h = {}
@@ -109,19 +141,24 @@ module Flor
       h['cwd'] = Dir.pwd
       h['rlp'] = $: if o.is_a?(::LoadError)
 
+      h['details'] = o.details if o.respond_to?(:details)
+      h['details'] = o.flor_details if o.respond_to?(:flor_details)
+
       h
     end
 
-    def to_error_message(message, err)
+    TO_ERROR_MESSAGE_KEYS = %w[ sm exid nid from payload tree er tasker ]
 
-      m = message
-        .select { |k, v|
-          %w[ sm exid nid from payload tree er tasker ].include?(k) }
+    def to_error_message(message, error)
+
+#puts "---"
+#puts caller
+      m = message.select { |k, v| TO_ERROR_MESSAGE_KEYS.include?(k) }
 
       m['point'] = 'failed'
       m['fpoint'] = message['point']
       m['fm'] = message['m']
-      m['error'] = to_error(err)
+      m['error'] = to_error(error)
 
       m
     end
@@ -337,6 +374,7 @@ module Flor
       sub == dom ||
       sub[0, dom.length + 1] == dom + '.'
     end
+    alias subdomain? sub_domain?
 
     def split_domain_unit(s)
 
@@ -385,6 +423,31 @@ module Flor
       (s ? (t[1] == s) : t[1].is_a?(String))
     end
 
+    def is_leaf_tree?(t)
+
+      t.is_a?(Array) &&
+      t[2].is_a?(Integer) &&
+      Flor::Pro::Atom.names.include?(t[0])
+    end
+    #alias is_atom_tree? is_leaf_tree?
+
+#  # Array, object or atom tree
+#  #
+#  def is_value_tree?(o)
+#
+#    o.is_a?(Array) &&
+#    %w[ _num _boo _sqs _dqs _rxs _nul _arr _obj ].include?(o[0]) &&
+#    o[2].is_a?(Integer)
+#  end
+
+    def is_collection_tree?(t)
+
+      t.is_a?(Array) &&
+      (t[0] == '_arr' || t[0] == '_obj') &&
+      t[1].is_a?(Array)
+    end
+    alias is_coll_tree? is_collection_tree?
+
     def is_att_tree?(t)
 
       t.is_a?(Array) &&
@@ -418,15 +481,6 @@ module Flor
       t.is_a?(Array) && t[0].is_a?(String) && t[0] != '_' && t[1] == []
     end
 
-#  # Array, object or atom tree
-#  #
-#  def is_value_tree?(o)
-#
-#    o.is_a?(Array) &&
-#    %w[ _num _boo _sqs _dqs _rxs _nul _arr _obj ].include?(o[0]) &&
-#    o[2].is_a?(Integer)
-#  end
-
     def is_proc_tree?(o)
 
       o.is_a?(Array) &&
@@ -483,7 +537,7 @@ module Flor
     def is_ref_tree?(o)
 
       o.is_a?(Array) &&
-      (o[0] == '_ref' || o[0] == '_reff') &&
+      Flor::Pro::Ref.names.include?(o[0]) &&
       o[2].is_a?(Integer) &&
       o[1].is_a?(Array) &&
       o[1].all? { |e| is_sqs_tree?(e) || is_num_tree?(e) }
@@ -520,6 +574,81 @@ module Flor
     end
 
 
+    #
+    # tree to flor code
+
+    # Given a tree returns the equivalent flor piece of code
+    #
+    def tree_to_flor(t, opts={})
+
+      o = opts[:o] ||= StringIO.new
+      opts[:ind] ||= ''
+
+      t_to_flor(t, opts)
+
+      o.string
+    end
+
+    protected
+
+    def t_to_flor(t, opts)
+
+      o = opts[:o]
+      i = opts[:ind]
+
+      t1 = t[1]
+
+      return o << '_' if t[0, 2] == [ '_', [] ]
+      return c_to_flor(t, opts) if is_coll_tree?(t)
+      return o << JSON.dump(t1) if is_leaf_tree?(t)
+      return o << t1.collect { |a| a[1].to_s }.join('.') if is_ref_tree?(t)
+
+      o << i << t[0]
+
+      if t1.is_a?(Array)
+
+        atts, ctrees = t1.partition { |ct| is_att_tree?(ct) }
+
+        atts.each do |at|
+          ats = at[1]
+          o << ' '
+          if ats.length == 1
+            tree_to_flor(ats[0], opts)
+          else
+            o << ats[0].first << ': '
+            tree_to_flor(ats[1], opts)
+          end
+        end
+
+        ctrees.each do |ct|
+          o << "\n"
+          tree_to_flor(ct, opts.merge(ind: '  ' + i))
+        end unless opts[:chop]
+      end
+    end
+
+    def c_to_flor(t, opts)
+
+      o = opts[:o]
+
+      bs = (t[0] == '_arr') ? %w[ [ ] ] : %w[ { } ]
+
+      o << bs[0] # opening
+
+      atts, ctrees = t[1].partition { |ct| is_att_tree?(ct) }
+
+      ctrees.each_with_index do |ct, i|
+        o << ' '
+        t_to_flor(ct, opts)
+        o << ':' if bs[0] == '{' && i.even?
+      end
+
+      o << (ctrees.any? ? ' ' : '') << bs[1] # closing
+    end
+
+    public
+
+
     #
     # misc