flow_core 0.0.1

data/app/models/flow_core/transition_callback.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FlowCore
+  class TransitionCallback < FlowCore::ApplicationRecord
+    self.table_name = "flow_core_transition_callbacks"
+
+    belongs_to :workflow, class_name: "FlowCore::Workflow"
+    belongs_to :transition, class_name: "FlowCore::Transition"
+
+    before_validation do
+      self.workflow ||= transition&.workflow
+    end
+
+    def configurable?
+      false
+    end
+
+    def type_key
+      self.class.to_s.split("::").last.underscore
+    end
+
+    include FlowCore::TransitionCallbackable
+  end
+end

data/app/models/flow_core/transition_trigger.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FlowCore
+  class TransitionTrigger < FlowCore::ApplicationRecord
+    self.table_name = "flow_core_transition_triggers"
+
+    belongs_to :workflow, class_name: "FlowCore::Workflow"
+    belongs_to :transition, class_name: "FlowCore::Transition"
+
+    before_validation do
+      self.workflow ||= transition&.workflow
+    end
+
+    def configurable?
+      false
+    end
+
+    def type_key
+      self.class.to_s.split("::").last.underscore
+    end
+
+    include FlowCore::TransitionTriggerable
+  end
+end

data/app/models/flow_core/workflow.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module FlowCore
+  class Workflow < FlowCore::ApplicationRecord
+    self.table_name = "flow_core_workflows"
+
+    FORBIDDEN_ATTRIBUTES = %i[verified verified_at created_at updated_at].freeze
+
+    has_many :instances, class_name: "FlowCore::Instance", dependent: :destroy
+
+    has_many :arcs, class_name: "FlowCore::Arc", dependent: :delete_all
+    has_many :places, class_name: "FlowCore::Place", dependent: :delete_all
+    has_many :transitions, class_name: "FlowCore::Transition", dependent: :delete_all
+
+    has_one :start_place, class_name: "FlowCore::StartPlace", dependent: :delete
+    has_one :end_place, class_name: "FlowCore::EndPlace", dependent: :delete
+
+    def create_instance!(attributes = {})
+      unless verified?
+        raise FlowCore::UnverifiedWorkflow, "Workflow##{id} didn't do soundness check yet."
+      end
+
+      instances.create! attributes.with_indifferent_access.except(FlowCore::Instance::FORBIDDEN_ATTRIBUTES)
+    end
+
+    def invalid?
+      !verified?
+    end
+
+    def verify?
+      violations.clear
+
+      unless start_place
+        violations.add(:start_place, :presence)
+      end
+      unless end_place
+        violations.add(:end_place, :presence)
+      end
+
+      return false unless start_place && end_place
+
+      # TODO: Naive implementation for now, Help wanted!
+
+      rgl = to_rgl
+
+      start_place_code = "P_#{start_place.id}"
+      end_place_code = "P_#{end_place.id}"
+
+      unless rgl.path?(start_place_code, end_place_code)
+        violations.add :end_place, :unreachable
+      end
+
+      places.find_each do |p|
+        next if p == start_place
+        next if p == end_place
+
+        place_code = "P_#{p.id}"
+
+        unless rgl.path?(start_place_code, place_code)
+          violations.add p, :unreachable
+        end
+
+        unless rgl.path?(place_code, end_place_code)
+          violations.add p, :impassable
+        end
+      end
+      transitions.includes(:trigger).find_each do |t|
+        transition_code = "T_#{t.id}"
+
+        unless rgl.path?(start_place_code, transition_code)
+          violations.add t, :unreachable
+        end
+
+        unless rgl.path?(transition_code, end_place_code)
+          violations.add t, :impassable
+        end
+
+        t.verify violations: violations
+      end
+
+      violations.empty?
+    end
+
+    def violations
+      @violations ||= FlowCore::Violations.new
+    end
+
+    def verify_status
+      if verified_at.blank?
+        :unverified
+      elsif verified?
+        :verified
+      else
+        :invalid
+      end
+    end
+
+    def verify!
+      update! verified: verify?, verified_at: Time.zone.now
+      violations.empty?
+    end
+
+    def reset_workflow_verification!
+      update! verified: false, verified_at: nil
+    end
+
+    private
+
+      def to_rgl
+        graph = RGL::DirectedAdjacencyGraph.new
+
+        places.find_each do |p|
+          graph.add_vertex "P_#{p.id}"
+        end
+
+        transitions.find_each do |t|
+          graph.add_vertex "T_#{t.id}"
+        end
+
+        arcs.find_each do |arc|
+          if arc.in?
+            graph.add_edge "P_#{arc.place_id}", "T_#{arc.transition_id}"
+          else
+            graph.add_edge "T_#{arc.transition_id}", "P_#{arc.place_id}"
+          end
+        end
+
+        graph
+      end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+end

data/db/migrate/20200130200532_create_flow_core_tables.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+class CreateFlowCoreTables < ActiveRecord::Migration[6.0]
+  def change
+    create_table :flow_core_workflows do |t|
+      t.string :name, null: false
+      t.string :tag
+
+      t.integer :verified, null: false, default: false
+      t.datetime :verified_at
+
+      t.string :type
+
+      t.timestamps
+    end
+
+    create_table :flow_core_places do |t|
+      t.references :workflow, null: false, foreign_key: { to_table: :flow_core_workflows }
+
+      t.string :name
+      t.string :tag
+
+      t.string :type
+
+      t.timestamps
+    end
+
+    create_table :flow_core_transitions do |t|
+      t.references :workflow, null: false, foreign_key: { to_table: :flow_core_workflows }
+
+      t.string :name
+      t.string :tag
+
+      t.timestamps
+    end
+
+    create_table :flow_core_transition_callbacks do |t|
+      t.references :workflow, null: false, foreign_key: { to_table: :flow_core_workflows }
+      t.references :transition, null: false, foreign_key: { to_table: :flow_core_transitions }
+
+      t.string :configuration
+      t.string :type
+
+      t.timestamps
+    end
+
+    create_table :flow_core_transition_triggers do |t|
+      t.references :workflow, null: false, foreign_key: { to_table: :flow_core_workflows }
+      t.references :transition, null: false, foreign_key: { to_table: :flow_core_transitions }
+
+      t.text :configuration
+      t.string :type
+
+      t.timestamps
+    end
+
+    create_table :flow_core_arcs do |t|
+      t.references :workflow, null: false, foreign_key: { to_table: :flow_core_workflows }
+      t.references :transition, null: false, foreign_key: { to_table: :flow_core_transitions }
+      t.references :place, null: false, foreign_key: { to_table: :flow_core_places }
+
+      t.integer :direction, null: false, default: 0, comment: "0-in, 1-out"
+
+      t.timestamps
+    end
+
+    create_table :flow_core_arc_guards do |t|
+      t.references :workflow, null: false, foreign_key: { to_table: :flow_core_workflows }
+      t.references :arc, null: false, foreign_key: { to_table: :flow_core_arcs }
+
+      t.text :configuration
+      t.string :type
+
+      t.timestamps
+    end
+
+    create_table :flow_core_instances do |t|
+      t.references :workflow, null: false, foreign_key: { to_table: :flow_core_workflows }
+
+      t.string :tag, index: { unique: true }
+
+      t.integer :stage, default: 0, comment: "0-created, 1-activated, 2-canceled, 3-finished, 4-terminated"
+      t.datetime :activated_at
+      t.datetime :finished_at
+      t.datetime :canceled_at
+      t.datetime :terminated_at
+
+      t.string :terminated_reason
+
+      t.datetime :errored_at
+      t.datetime :rescued_at
+
+      t.datetime :suspended_at
+      t.datetime :resumed_at
+
+      t.text :payload
+
+      t.timestamps
+    end
+
+    create_table :flow_core_tokens do |t|
+      t.references :workflow, null: false, foreign_key: { to_table: :flow_core_workflows }
+      t.references :instance, null: false, foreign_key: { to_table: :flow_core_instances }
+      t.references :place, null: false, foreign_key: { to_table: :flow_core_places }
+
+      t.integer :stage, default: 0, comment: "0-free, 1-locked, 11-consumed, 12-terminated"
+      t.datetime :locked_at
+      t.datetime :consumed_at
+      t.datetime :terminated_at
+
+      t.references :created_by_task, foreign_key: { to_table: :flow_core_tasks }
+      t.references :consumed_by_task, foreign_key: { to_table: :flow_core_tasks }
+
+      t.boolean :task_created, null: false, default: false
+
+      t.timestamps
+    end
+
+    create_table :flow_core_tasks do |t|
+      t.references :workflow, null: false, foreign_key: { to_table: :flow_core_workflows }
+      t.references :instance, null: false, foreign_key: { to_table: :flow_core_instances }
+      t.references :transition, null: false, foreign_key: { to_table: :flow_core_transitions }
+
+      t.string :tag, index: { unique: true }
+
+      t.references :created_by_token, foreign_key: { to_table: :flow_core_tokens }
+
+      t.integer :stage, default: 0, comment: "0-created, 1-enabled, 11-finished, 12-terminated"
+      t.datetime :enabled_at
+      t.datetime :finished_at
+      t.datetime :terminated_at
+
+      t.string :terminate_reason
+
+      t.datetime :errored_at
+      t.datetime :rescued_at
+      t.string :error_reason
+
+      t.datetime :suspended_at
+      t.datetime :resumed_at
+
+      t.boolean :output_token_created, null: false, default: false
+
+      t.references :executable, polymorphic: true
+
+      t.text :payload
+
+      t.timestamps
+    end
+  end
+end

data/lib/flow_core.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rgl/adjacency"
+require "rgl/dijkstra"
+require "rgl/topsort"
+require "rgl/traversal"
+require "rgl/path"
+
+require "flow_core/engine"
+
+require "flow_core/errors"
+require "flow_core/arc_guardable"
+require "flow_core/transition_triggerable"
+require "flow_core/transition_callbackable"
+require "flow_core/task_executable"
+
+require "flow_core/definition"
+require "flow_core/violations"
+
+ActiveSupport.on_load(:i18n) do
+  I18n.load_path << File.expand_path("flow_core/locale/en.yml", __dir__)
+end
+
+module FlowCore
+end

data/lib/flow_core/arc_guardable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FlowCore
+  module ArcGuardable
+    extend ActiveSupport::Concern
+
+    def permit?(_task)
+      raise NotImplementedError
+    end
+
+    def description
+      raise NotImplementedError
+    end
+  end
+end

data/lib/flow_core/definition.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "flow_core/definition/place"
+require "flow_core/definition/transition"
+require "flow_core/definition/net"
+require "flow_core/definition/trigger"
+require "flow_core/definition/guard"
+require "flow_core/definition/callback"
+
+module FlowCore::Definition
+  class << self
+    def build(attributes = {}, &block)
+      FlowCore::Definition::Net.new(attributes, &block)
+    end
+    alias new build
+  end
+end

data/lib/flow_core/definition/callback.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module FlowCore::Definition
+  class Callback
+    def initialize(attributes)
+      constant_or_klass = attributes.is_a?(Hash) ? attributes.delete(:type) : attributes
+      @klass =
+        if constant_or_klass.is_a? String
+          constant_or_klass.safe_constantize
+        else
+          constant_or_klass
+        end
+      unless @klass && @klass < FlowCore::TransitionCallback
+        raise TypeError, "First argument expect `FlowCore::TransitionCallback` subclass or its constant name - #{constant_or_klass}"
+      end
+
+      @configuration = attributes.is_a?(Hash) ? attributes : nil
+    end
+
+    def compile
+      if @configuration&.any?
+        {
+          type: @klass.to_s,
+          configuration: @configuration
+        }
+      else
+        {
+          type: @klass.to_s
+        }
+      end
+    end
+  end
+end

data/lib/flow_core/definition/guard.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module FlowCore::Definition
+  class Guard
+    def initialize(attributes)
+      constant_or_klass = attributes.is_a?(Hash) ? attributes.delete(:type) : attributes
+      @klass =
+        if constant_or_klass.is_a? String
+          constant_or_klass.safe_constantize
+        else
+          constant_or_klass
+        end
+      unless @klass && @klass < FlowCore::ArcGuard
+        raise TypeError, "First argument expect `FlowCore::TransitionTrigger` subclass or its constant name - #{constant_or_klass}"
+      end
+
+      @configuration = attributes.is_a?(Hash) ? attributes : nil
+    end
+
+    def compile
+      if @configuration&.any?
+        {
+          type: @klass.to_s,
+          configuration: @configuration
+        }
+      else
+        {
+          type: @klass.to_s
+        }
+      end
+    end
+  end
+end