petri_flow 0.1.0

data/app/models/wf/field_value.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_field_values
+#
+#  id            :integer          not null, primary key
+#  workflow_id   :integer
+#  transition_id :integer
+#  form_id       :integer
+#  field_id      :integer
+#  value         :text
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#  entry_id      :integer
+#
+
+module Wf
+  class FieldValue < ApplicationRecord
+    belongs_to :workflow, optional: true
+    belongs_to :transition, optional: true
+    belongs_to :form
+    belongs_to :field
+    belongs_to :entry
+
+    def value_after_cast
+      field.type_for_cast.cast(value)
+    end
+  end
+end

data/app/models/wf/form.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_forms
+#
+#  id          :integer          not null, primary key
+#  name        :string
+#  description :text
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#
+
+module Wf
+  class Form < ApplicationRecord
+    has_many :fields, dependent: :destroy
+  end
+end

data/app/models/wf/group.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_groups
+#
+#  id         :integer          not null, primary key
+#  name       :string
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+
+module Wf
+  class Group < ApplicationRecord
+    has_many :users
+    has_one :party, as: :partable
+    after_create do
+      create_party(party_name: name)
+    end
+  end
+end

data/app/models/wf/guard.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# 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
+#
+
+module Wf
+  class Guard < ApplicationRecord
+    belongs_to :workflow
+    belongs_to :arc, touch: true, counter_cache: true
+    belongs_to :fieldable, polymorphic: true, optional: true
+
+    before_validation do
+      self.workflow = arc.workflow
+    end
+
+    OP = %w[
+      =
+      >
+      <
+      >=
+      <=
+      is_empty
+    ].freeze
+
+    def value_after_cast
+      field = fieldable
+      if fieldable
+        fieldable.type_for_cast.cast(value)
+      else
+        # TODO
+      end
+    end
+
+    def pass?(entry)
+      fv = entry.field_values.where(field_id: fieldable_id).first
+      return unless fv
+
+      if op == "="
+        fv.value_after_cast == value_after_cast
+      elsif op == ">"
+        fv.value_after_cast > value_after_cast
+      elsif op == "<"
+        fv.value_after_cast < value_after_cast
+      elsif op == ">="
+        fv.value_after_cast >= value_after_cast
+      elsif op == "<="
+        fv.value_after_cast <= value_after_cast
+      elsif op == "is_empty"
+        fv.value_after_cast.blank?
+      else
+        false
+      end
+    end
+
+    def inspect
+      %(#{fieldable&.form&.name}.#{fieldable&.name} #{op} #{value})
+    end
+  end
+end

data/app/models/wf/party.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_parties
+#
+#  id            :integer          not null, primary key
+#  partable_type :string
+#  partable_id   :string
+#  party_name    :string
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#
+
+module Wf
+  class Party < ApplicationRecord
+    # TODO: use acts_as_partable for sync group or role or user to party
+    belongs_to :partable, polymorphic: true
+    has_many :transition_static_assignments
+    has_many :workitem_assignments
+  end
+end

data/app/models/wf/place.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_places
+#
+#  id          :integer          not null, primary key
+#  workflow_id :integer
+#  name        :string
+#  description :text
+#  sort_order  :integer          default("0")
+#  place_type  :integer          default("0")
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#
+
+module Wf
+  class Place < ApplicationRecord
+    belongs_to :workflow, touch: true
+    has_many :arcs
+    has_many :tokens
+    enum place_type: {
+      start: 0,
+      normal: 1,
+      end: 2
+    }
+  end
+end

data/app/models/wf/token.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_tokens
+#
+#  id                 :integer          not null, primary key
+#  workflow_id        :integer
+#  case_id            :integer
+#  targetable_type    :string
+#  targetable_id      :string
+#  place_id           :integer
+#  state              :integer          default("0")
+#  locked_workitem_id :integer
+#  produced_at        :datetime
+#  locked_at          :datetime
+#  canceled_at        :datetime
+#  consumed_at        :datetime
+#  created_at         :datetime         not null
+#  updated_at         :datetime         not null
+#
+
+module Wf
+  class Token < ApplicationRecord
+    belongs_to :workflow
+    belongs_to :case
+    belongs_to :place
+    belongs_to :locked_workitem, class_name: "Wf::Workitem", optional: true
+
+    enum state: {
+      free: 0,
+      locked: 1,
+      canceled: 2,
+      consumed: 3
+    }
+  end
+end

data/app/models/wf/transition.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_transitions
+#
+#  id                    :integer          not null, primary key
+#  name                  :string
+#  description           :text
+#  workflow_id           :integer
+#  sort_order            :integer          default("0")
+#  trigger_limit         :integer
+#  trigger_type          :integer          default("0")
+#  created_at            :datetime         not null
+#  updated_at            :datetime         not null
+#  form_id               :integer
+#  enable_callback       :string           default("Wf::Callbacks::EnableDefault")
+#  fire_callback         :string           default("Wf::Callbacks::FireDefault")
+#  notification_callback :string           default("Wf::Callbacks::NotificationDefault")
+#  time_callback         :string           default("Wf::Callbacks::TimeDefault")
+#  deadline_callback     :string           default("Wf::Callbacks::DeadlineDefault")
+#  hold_timeout_callback :string           default("Wf::Callbacks::HoldTimeoutDefault")
+#  assignment_callback   :string           default("Wf::Callbacks::AssignmentDefault")
+#  unassignment_callback :string           default("Wf::Callbacks::UnassignmentDefault")
+#
+
+module Wf
+  class Transition < ApplicationRecord
+    belongs_to :workflow, touch: true
+    has_many :arcs
+    has_many :transition_static_assignments
+    has_many :static_parties, through: :transition_static_assignments, source: "party"
+    has_many :workitems
+    belongs_to :form, optional: true
+
+    enum trigger_type: {
+      user: 0,
+      automatic: 1,
+      message: 2,
+      time: 3
+    }
+
+    def explicit_or_split?
+      arcs.out.sum(:guards_count) >= 1
+    end
+
+    validates :name, presence: true
+  end
+end

data/app/models/wf/transition_static_assignment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_transition_static_assignments
+#
+#  id            :integer          not null, primary key
+#  party_id      :integer
+#  transition_id :integer
+#  workflow_id   :integer
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#
+
+module Wf
+  class TransitionStaticAssignment < ApplicationRecord
+    belongs_to :workflow
+    belongs_to :transition
+    belongs_to :party
+  end
+end

data/app/models/wf/user.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_users
+#
+#  id         :integer          not null, primary key
+#  name       :string
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#  group_id   :integer
+#
+
+module Wf
+  class User < ApplicationRecord
+    belongs_to :group, optional: true
+    has_one :party, as: :partable
+
+    # NOTICE: group or user or role all has_many users
+    has_many :users, foreign_key: :id
+
+    after_create do
+      create_party(party_name: name)
+    end
+  end
+end

data/app/models/wf/workflow.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_workflows
+#
+#  id          :integer          not null, primary key
+#  name        :string
+#  description :text
+#  is_valid    :boolean          default("false")
+#  creator_id  :string
+#  error_msg   :text
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#
+
+module Wf
+  class Workflow < ApplicationRecord
+    has_many :places, dependent: :destroy
+    has_many :transitions, dependent: :destroy
+    has_many :arcs, dependent: :destroy
+    has_many :transition_static_assignments
+    has_many :cases
+    has_many :workitems
+    has_many :tokens
+
+    validates :name, presence: true
+
+    # TODO: move to config
+    def self.enable_callbacks
+      [Wf::Callbacks::EnableDefault]
+    end
+
+    def self.fire_callbacks
+      [Wf::Callbacks::FireDefault]
+    end
+
+    def self.assignment_callbacks
+      [Wf::Callbacks::AssignmentDefault]
+    end
+
+    def self.unassignment_callbacks
+      [Wf::Callbacks::UnassignmentDefault]
+    end
+
+    def self.notification_callbacks
+      [Wf::Callbacks::NotificationDefault]
+    end
+
+    def self.deadline_callbacks
+      [Wf::Callbacks::DeadlineDefault]
+    end
+
+    def self.time_callbacks
+      [Wf::Callbacks::TimeDefault]
+    end
+
+    def self.hold_timeout_callbacks
+      [Wf::Callbacks::HoldTimeoutDefault]
+    end
+
+    def self.user_class
+      ::Wf::User
+    end
+
+    def self.org_classes
+      {
+        group: ::Wf::Group
+      }
+    end
+
+    after_save do
+      do_validate!
+    end
+
+    after_touch do
+      do_validate!
+    end
+
+    # TODO: can from start place to end place
+    def do_validate!
+      msgs = []
+      msgs << "must have start place" if places.start.blank?
+      msgs << "must have only one start place" if places.start.count > 1
+      msgs << "must have end place" if places.end.blank?
+      msgs << "must have only one end place" if places.end.count > 1
+      if msgs.present?
+        update_columns(is_valid: false, error_msg: msgs.join("\n"))
+      else
+        update_columns(is_valid: true, error_msg: "")
+      end
+    end
+
+    def to_graph(wf_case = nil)
+      graph = 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
+        []
+      end
+      pg_mapping = {}
+      places.order("place_type ASC").each do |p|
+        if p.start?
+          fillcolor = :yellow
+          shape     = :doublecircle
+        elsif p.end?
+          fillcolor = :green
+          shape     = :doublecircle
+        else
+          fillcolor = :lightpink
+          shape     = :circle
+        end
+
+        token_count = free_token_places.count(p.id)
+        if token_count >= 1
+          label  = "&bull;"
+          xlabel = nil
+          fontsize = 25
+        else
+          label = p.name
+          xlabel = nil
+        end
+
+        pg = graph.add_nodes(p.name,
+                             label: label,
+                             xlabel: xlabel,
+                             shape: shape,
+                             fixedsize: true,
+                             style: :filled,
+                             fontsize: fontsize,
+                             fillcolor: fillcolor,
+                             href: Wf::Engine.routes.url_helpers.edit_workflow_place_path(self, p))
+        pg_mapping[p] = pg
+      end
+
+      tg_mapping = {}
+      transitions.each do |t|
+        tg = graph.add_nodes(t.name, label: t.name, shape: :box, style: :filled, fillcolor: :lightblue, href: Wf::Engine.routes.url_helpers.edit_workflow_transition_path(self, t))
+        tg_mapping[t] = tg
+      end
+
+      arcs.order("direction desc").each do |arc|
+        label = if arc.guards_count > 0
+          arc.guards.map(&:inspect).join(" & ")
+        else
+          ""
+        end
+        if arc.in?
+          graph.add_edges(
+            pg_mapping[arc.place],
+            tg_mapping[arc.transition],
+            label: label,
+            weight: 1,
+            labelfloat: false,
+            labelfontcolor: :red,
+            arrowhead: :vee,
+            href: Wf::Engine.routes.url_helpers.edit_workflow_arc_path(self, arc)
+          )
+        else
+          graph.add_edges(
+            tg_mapping[arc.transition],
+            pg_mapping[arc.place],
+            label: label,
+            weight: 1,
+            labelfloat: false,
+            labelfontcolor: :red,
+            arrowhead: :vee,
+            href: Wf::Engine.routes.url_helpers.edit_workflow_arc_path(self, arc)
+          )
+        end
+      end
+      graph
+    end
+
+    def render_graph(wf_case = nil)
+      graph = to_graph(wf_case)
+      path = Rails.root.join("tmp", "#{id}.svg")
+      graph.output(svg: path)
+      File.read(path)
+    end
+  end
+end

data/app/models/wf/workitem.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_workitems
+#
+#  id              :integer          not null, primary key
+#  case_id         :integer
+#  workflow_id     :integer
+#  transition_id   :integer
+#  targetable_type :string
+#  targetable_id   :string
+#  state           :integer          default("0")
+#  enabled_at      :datetime
+#  started_at      :datetime
+#  canceled_at     :datetime
+#  finished_at     :datetime
+#  overridden_at   :datetime
+#  deadline        :datetime
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#  trigger_time    :datetime
+#  holding_user_id :string
+#
+
+module Wf
+  class Workitem < ApplicationRecord
+    belongs_to :workflow
+    belongs_to :transition
+    belongs_to :case
+    belongs_to :targetable, optional: true
+    belongs_to :holding_user, foreign_key: :holding_user_id, class_name: Workflow.user_class.to_s, optional: true
+    has_many :workitem_assignments
+    has_many :parties, through: :workitem_assignments, source: "party"
+    has_many :comments
+    has_many :entries
+
+    enum state: {
+      enabled: 0,
+      started: 1,
+      canceled: 2,
+      finished: 3,
+      overridden: 4
+    }
+
+    def name
+      "Workitem -> #{id}"
+    end
+
+    # TODO: guards exp && target guards
+    def pass_guard?(arc, has_passed = false)
+      if arc.guards_count == 0
+        !has_passed
+      else
+        entry = entries.where(user: holding_user).first
+        arc.guards.all? { |guard| guard.pass?(entry) }
+      end
+    end
+
+    def started_by?(user)
+      enabled? && owned_by?(user)
+    end
+
+    def finished_by?(user)
+      started? && owned_by?(user) && holding_user == user
+    end
+
+    def owned_by?(user)
+      Wf::Party.joins(workitem_assignments: { workitem: %i[transition case] })
+               .where(Wf::Transition.table_name => { trigger_type: Wf::Transition.trigger_types[:user] })
+               .where(Wf::Case.table_name => { state: Wf::Case.states[:active] })
+               .where(Wf::Workitem.table_name => { state: Wf::Workitem.states.values_at(:started, :enabled) })
+               .where(Wf::Workitem.table_name => { id: id }).map do |party|
+        party.partable.users.to_a
+      end.flatten.include?(user)
+    end
+  end
+end

data/app/models/wf/workitem_assignment.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: wf_workitem_assignments
+#
+#  id          :integer          not null, primary key
+#  party_id    :integer
+#  workitem_id :integer
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#
+
+module Wf
+  class WorkitemAssignment < ApplicationRecord
+    belongs_to :party
+    belongs_to :workitem
+  end
+end

data/app/views/layouts/wf/_alert.html.erb

@@ -0,0 +1,4 @@
+<% return if alert.blank? %>
+<div id="alert" class="alert alert-warning">
+  <p><%= alert %></p>
+</div>

data/app/views/layouts/wf/_footer.html.erb

@@ -0,0 +1,13 @@
+<footer class="footer">
+  <div class="container">
+    <div class="has-text-centered">
+      <p>
+        <strong>
+          <a href="https://github.com/hooopo/petri_flow" target="_blank" rel="nofollow">Petri Flow</a>
+        </strong>
+        crafted by <a href="https://github.com/hooopo" target="_blank" rel="nofollow">Hooopo</a>.
+        The source code is licensed under <a href="http://opensource.org/licenses/mit-license.php">MIT license</a>.
+      </p>
+    </div>
+  </div>
+</footer>

data/app/views/layouts/wf/_nav.html.erb

@@ -0,0 +1,13 @@
+<nav class="navbar has-shadow" role="navigation" aria-label="main navigation">
+  <div class="container">
+    <div class="navbar-brand">
+      <%= link_to "Petri Flow", root_path, class: "navbar-item" %>
+    </div>
+
+    <div class="navbar-end">
+      <%= link_to current_user&.name, workitems_path %>
+      <%= link_to 'Forms', forms_path, class: "navbar-item #{"is-active" if controller_name == "forms"}" %>
+      <%= link_to 'Workflows', workflows_path, class: "navbar-item #{"is-active" if controller_name.start_with?("workflows")}" %>
+    </div>
+  </div>
+</nav>

data/app/views/layouts/wf/_notice.html.erb

@@ -0,0 +1,4 @@
+<% return if notice.blank? %>
+<div id="notice" class="alert alert-success">
+  <p><%= notice %></p>
+</div>

data/app/views/layouts/wf/application.html.erb

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <title>Petri Flow</title>
+
+  <%= csrf_meta_tags %>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.0"/>
+
+  <%= stylesheet_link_tag    "wf/application", media: "all", "data-turbolinks-track": "reload" %>
+  <%= javascript_include_tag "wf/application", "data-turbolinks-track": "reload" %>
+</head>
+<body>
+<%= render "layouts/wf/notice" %>
+<%= render "layouts/wf/alert" %>
+<%= render "layouts/wf/nav" %>
+
+<main class="container">
+  <nav aria-label="breadcrumb">
+  <ol class='breadcrumb'>
+    <% breadcrumb_trail do |crumb| %>
+      <li class="breadcrumb-item <%= crumb.current? ? 'active' : '' %>">
+        <%= link_to crumb.name, crumb.url, (crumb.current? ? {'aria-current' => 'page'} : {}) %>
+      </li>
+    <% end %>
+  </ol>
+</nav>
+  <%= content_for?(:content) ? yield(:content) : yield %>
+</main>
+
+<%= render "layouts/wf/footer" %>
+</body>
+</html>