petri_flow 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b75f2ac3288f2b169d4364a8aaa11586497d710477ecabe92adb6af2ffbf7376
-  data.tar.gz: 3a12e23472cc059ba4437ee1535d216b4df290f64d1de05c54a8395a648c5246
+  metadata.gz: 6b2bb56ad2f157e6a7fe5d3cbee2bfab0e3fcef64f9137bd709ac37ea27949b9
+  data.tar.gz: c2721a5074ba1fac6462ad95bef1012c7f00bfb74ff61a1eb6ae284f97c6b013
 SHA512:
-  metadata.gz: 6aad07e5b69eb1ed0046afaa59f9679a3f77b259fa7410533eb2939883b43da7adf7518fe4b4d17e1d3f3f3b40feca8d12c954d9c837ca9c052bf1af84385942
-  data.tar.gz: e278b0c46d95a0b7744ef457ebac2d8f8f56d5ac943ff009264086490b762378cfb37ea3e7c5b64362d7fe09d674374f48bb0eb4008f90d7aa732343cd1cd4f0
+  metadata.gz: 3f0f933aa496d45610048de363e7fd189586dab4af85bfb012e2b93a55703104163f0183655f61a4a8c60d7f3a20c1f9c69c64d451eb601c3da73e68e0f7b4d1
+  data.tar.gz: 78f35f561c65b366a7c21e20420d9235813b1368f1d06e0e87a35e888a0f8755317272854dd96224acae9ca42626635d44a1551d9b2e9853411348f45a87f2e1

data/README.md

@@ -8,6 +8,7 @@ Workflow engine for Rails.
 * Simple web admin for workflow definition and case management.
 * Build-in simple dynamic form.
 * Replaceable dynamic form.
+* Support sub workflow.
 * Graph screen for workflow definition.
 * Graph screen for case and token migration.
 * Powerful guard expression.

data/app/controllers/wf/transitions_controller.rb

@@ -64,7 +64,8 @@ module Wf
           :assignment_callback,
           :unassignment_callback,
           :notification_callback,
-          :deadline_callback
+          :deadline_callback,
+          :sub_workflow_id
         )
       end
   end

data/app/controllers/wf/workitems_controller.rb

@@ -58,9 +58,13 @@ module Wf
 
     def finish_and_redirect
       if @workitem.case.finished?
-        redirect_to workflow_case_path(@workitem.workflow, @workitem.case), notice: "workitem is done, and the case is finished."
+        if started_by = @workitem.case.started_by_workitem
+          redirect_to workflow_case_path(started_by.workflow, started_by.case), notice: "workitem is done, and goto parent case."
+        else
+          redirect_to workflow_case_path(@workitem.workflow, @workitem.case), notice: "workitem is done, and the case is finished."
+        end
       else
-        redirect_to workitem_path(Wf::Workitem.last.case.workitems.enabled.first), notice: "workitem is done, and goto next fireable workitem."
+        redirect_to workitem_path(@workitem.case.workitems.enabled.first), notice: "workitem is done, and goto next fireable workitem."
       end
     end
 

data/app/models/wf/case.rb

@@ -4,19 +4,21 @@
 #
 # Table name: wf_cases
 #
-#  id              :integer          not null, primary key
-#  workflow_id     :integer
-#  targetable_type :string
-#  targetable_id   :string
-#  state           :integer          default("0")
-#  created_at      :datetime         not null
-#  updated_at      :datetime         not null
+#  id                     :integer          not null, primary key
+#  workflow_id            :integer
+#  targetable_type        :string
+#  targetable_id          :string
+#  state                  :integer          default("0")
+#  created_at             :datetime         not null
+#  updated_at             :datetime         not null
+#  started_by_workitem_id :integer
 #
 
 module Wf
   class Case < ApplicationRecord
     belongs_to :workflow
     belongs_to :targetable, optional: true, polymorphic: true
+    belongs_to :started_by_workitem, optional: true, class_name: "Wf::Workitem"
     has_many :workitems
     has_many :tokens
     has_many :case_assignments

data/app/models/wf/case_command/enable_transitions.rb

@@ -26,6 +26,10 @@ module Wf::CaseCommand
           Wf::FireTimedWorkitemJob.set(wait: transition.trigger_limit.minutes).perform_later(workitem.id) if trigger_time
           SetWorkitemAssignments.call(workitem)
           workitem.transition.unassignment_callback.constantize.new(workitem.id).perform_now if workitem.workitem_assignments.count == 0
+          if sub_workflow = transition.sub_workflow
+            sub_case = Wf::CaseCommand::New.call(sub_workflow, nil, workitem).result
+            Wf::CaseCommand::StartCase.call(sub_case)
+          end
         end
       end
     end

data/app/models/wf/case_command/finished_p.rb

@@ -20,7 +20,12 @@ module Wf::CaseCommand
         raise("The workflow net is misconstructed: Some parallel executions have not finished.") if free_and_locked_token_num > 1
 
         ConsumeToken.call(wf_case, end_place)
-        wf_case.finished!
+        unless wf_case.finished?
+          wf_case.finished!
+          if started_by_workitem = wf_case.started_by_workitem
+            Wf::CaseCommand::FinishWorkitem.call(started_by_workitem)
+          end
+        end
         true
       end
     end

data/app/models/wf/case_command/new.rb

@@ -3,14 +3,15 @@
 module Wf::CaseCommand
   class New
     prepend SimpleCommand
-    attr_reader :workflow, :target
-    def initialize(workflow, target = nil)
+    attr_reader :workflow, :target, :started_by
+    def initialize(workflow, target = nil, started_by = nil)
       @workflow = workflow
       @target = target
+      @started_by = started_by
     end
 
     def call
-      wf_case = workflow.cases.create!(targetable: target, state: :created)
+      wf_case = workflow.cases.create!(targetable: target, started_by_workitem: started_by, state: :created)
       wf_case
     end
   end

data/app/models/wf/guard.rb

@@ -4,17 +4,16 @@
 #
 # Table name: wf_guards
 #
-#  id               :integer          not null, primary key
-#  arc_id           :integer
-#  workflow_id      :integer
-#  fieldable_type   :string
-#  fieldable_id     :string
-#  op               :string
-#  value            :string
-#  exp              :string
-#  created_at       :datetime         not null
-#  updated_at       :datetime         not null
-#  target_attr_name :string
+#  id             :integer          not null, primary key
+#  arc_id         :integer
+#  workflow_id    :integer
+#  fieldable_type :string
+#  fieldable_id   :string
+#  op             :string
+#  value          :string
+#  exp            :string
+#  created_at     :datetime         not null
+#  updated_at     :datetime         not null
 #
 
 module Wf

data/app/models/wf/place.rb

@@ -24,5 +24,9 @@ module Wf
       normal: 1,
       end: 2
     }
+
+    def graph_id
+      "#{name}/#{id}"
+    end
   end
 end

data/app/models/wf/transition.rb

@@ -23,6 +23,7 @@
 #  assignment_callback   :string           default("Wf::Callbacks::AssignmentDefault")
 #  unassignment_callback :string           default("Wf::Callbacks::UnassignmentDefault")
 #  form_type             :string           default("Wf::Form")
+#  sub_workflow_id       :integer
 #
 
 module Wf
@@ -33,6 +34,7 @@ module Wf
     has_many :static_parties, through: :transition_static_assignments, source: "party"
     has_many :workitems
     belongs_to :form, optional: true, polymorphic: true
+    belongs_to :sub_workflow, optional: true, class_name: "Wf::Workflow"
 
     enum trigger_type: {
       user: 0,
@@ -41,10 +43,24 @@ module Wf
       time: 3
     }
 
+    validate :validate_trigger_type_and_sub
+
+    def is_sub_workflow?
+      !!sub_workflow_id
+    end
+
     def explicit_or_split?
       arcs.out.sum(:guards_count) >= 1
     end
 
     validates :name, presence: true
+
+    def validate_trigger_type_and_sub
+      errors.add(:trigger_type, "sub workflow must have trigger type: automatic, message and time.") if user? && is_sub_workflow?
+    end
+
+    def graph_id
+      "#{name}/#{id}"
+    end
   end
 end

data/app/models/wf/workflow.rb

@@ -25,6 +25,8 @@ module Wf
 
     validates :name, presence: true
 
+    scope :valid, -> { where(is_valid: true) }
+
     after_save do
       do_validate!
     end
@@ -64,10 +66,11 @@ module Wf
       end
     end
 
-    def to_graph(wf_case = nil)
+    def to_graph(wf_case = nil, base = nil)
       fontfamily = "system, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Noto Color Emoji, Segoe UI Symbol"
       fontfamily_monospace = "SFMono-Regular, Consolas, Liberation Mono, Menlo, Courier, monospace"
-      graph = GraphViz.new(name, type: :digraph, rankdir: "LR", splines: true, ratio: :auto)
+      graph = base || GraphViz.new(name, type: :digraph, rankdir: "LR", splines: true, ratio: :auto)
+
       free_token_places = if wf_case
         wf_case.tokens.free.map(&:place_id)
       else
@@ -99,7 +102,7 @@ module Wf
           xlabel = nil
         end
 
-        pg = graph.add_nodes(p.name,
+        pg = graph.add_nodes(p.graph_id,
                              label: label,
                              xlabel: xlabel,
                              shape: shape,
@@ -116,10 +119,20 @@ module Wf
 
       tg_mapping = {}
       transitions.each do |t|
-        tg = graph.add_nodes(t.name, label: t.name, shape: :box, style: :filled, fillcolor: "#d6ddfa", color: "#d6ddfa",
-                                     fontcolor: "#2c50ed", fontname: fontfamily,
-                                     href: Wf::Engine.routes.url_helpers.edit_workflow_transition_path(self, t))
+        tg = graph.add_nodes(t.graph_id, label: t.name, shape: :box, style: :filled, fillcolor: "#d6ddfa", color: "#d6ddfa",
+                                         fontcolor: "#2c50ed", fontname: fontfamily,
+                                         href: Wf::Engine.routes.url_helpers.edit_workflow_transition_path(self, t))
         tg_mapping[t] = tg
+        # NOTICE: if sub_workflow is transition's workflow, then graph will loop infinite, this is valid for workflow definition.
+        next unless t.is_sub_workflow? && t.sub_workflow != t.workflow
+
+        sub_graph = graph.add_graph("cluster#{t.sub_workflow_id}", rankdir: "LR", splines: true, ratio: :auto)
+        sub_graph[:label] = t.sub_workflow.name
+        sub_graph[:style] = :dashed
+        sub_graph[:color] = :lightgrey
+        # TODO: detect related case for sub workflow.
+        t.sub_workflow.to_graph(nil, sub_graph)
+        graph.add_edges(tg, t.sub_workflow.places.start.first.graph_id, style: :dashed, dir: :both)
       end
 
       arcs.order("direction desc").each do |arc|

data/app/models/wf/workitem.rb

@@ -31,6 +31,7 @@ module Wf
     has_many :parties, through: :workitem_assignments, source: "party"
     has_many :comments
     has_many :entries, class_name: Wf.entry_class.to_s
+    has_one :started_case, foreign_key: :started_by_workitem_id, class_name: "Wf::Case"
 
     enum state: {
       enabled: 0,

data/app/views/wf/transitions/_form.html.erb

@@ -41,6 +41,11 @@
     <%= f.select :trigger_type, Wf::Transition.trigger_types.keys, {}, class: "form-control custom-select", placeholder: "Trigger Type" %>
   </div>
 
+  <div class="form-group">
+    <%= f.label :sub_workflow, class: "label" %>
+    <%= f.select :sub_workflow_id, options_for_select(Wf::Workflow.valid.all.map{|x| [x.name, x.id]} || []), {include_blank: 'Start a sub workflow?'}, class: "form-control custom-select", placeholder: "Sub Workflow" %>
+  </div>
+
   <div class="form-group">
     <%= f.label :form, class: "label" %>
     <%= f.select :form, options_for_select(Wf.form_class.constantize.all.map{|x| [x.name, x.to_global_id]} || [], selected: f.object&.form&.to_global_id), {include_blank: 'user can input from custom form?'}, class: "form-control custom-select", placeholder: "Form" %>

data/app/views/wf/workflows/show.html.erb

@@ -118,6 +118,7 @@
         <th scope="col">Trigger Type</th>
         <th scope="col">Sort Order</th>
         <th scope="col">Custom Form</th>
+        <th scope="col">Sub Workflow</th>
         <th scope='col'> </th>
       </tr>
     </thead>
@@ -138,6 +139,13 @@
              No Form
             <% end %>
           </td>
+          <td>
+            <% if transition.sub_workflow %>
+              <%= link_to transition.sub_workflow.name, workflow_path(transition.sub_workflow_id) %>
+            <% else %>
+              No
+            <% end %>
+          </td> 
           <td><%= link_to 'Edit Transition', edit_workflow_transition_path(@workflow, transition), class: 'btn btn-sm btn-link mr-2' %>
             <%= link_to 'Delete Transition', [@workflow, transition], remote: true, method: :delete, data: {confirm: 'confirm?'}, class: 'btn btn-sm btn-link text-danger' %></td>
         </tr>

data/db/migrate/20200220070839_remove_unused_column.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class RemoveUnusedColumn < ActiveRecord::Migration[6.0]
+  def change
+    remove_column :wf_guards, :target_attr_name
+  end
+end

data/db/migrate/20200220072512_add_sub_workflow.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddSubWorkflow < ActiveRecord::Migration[6.0]
+  def change
+    add_column :wf_transitions, :sub_workflow_id, :bigint, index: true
+    add_column :wf_cases, :started_by_workitem_id, :bigint, index: true, comment: "As a sub workflow instance, it is started by one workitem."
+  end
+end

data/lib/wf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wf
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: petri_flow
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Hooopo Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap
@@ -351,6 +351,8 @@ files:
 - db/migrate/20200213085258_add_formable.rb
 - db/migrate/20200213125753_add_form_id_for_entry.rb
 - db/migrate/20200213130900_remove_workflow_id_from_form_related.rb
+- db/migrate/20200220070839_remove_unused_column.rb
+- db/migrate/20200220072512_add_sub_workflow.rb
 - lib/tasks/wf_tasks.rake
 - lib/wf.rb
 - lib/wf/engine.rb