workflow_core 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e37fe908ba22a89b01f43680721ad466544bb1eef47cc8bc95ea26d7a77c00d
-  data.tar.gz: 1a052885996e219ec88a60d1e890e7b7b49b855b30bef3b073d1b3a98cc19167
+  metadata.gz: 811e973c52672a22910d4cbd3cea630788de539f951d0ed5b83185e7bf7b8dc6
+  data.tar.gz: 8cac78ded90082dbf6a66c77fb4d2969b3a30846192f27c20d15ae0bae86670a
 SHA512:
-  metadata.gz: ad2e77a5043dcbd124a489ef4e0cb047fe3ef15de5db8d23eab6aea2c0f331299cefedb19f9100378db82555cc094ec535ad7d86383b4d50dcb21e5f7b6baada
-  data.tar.gz: af92427c841e043165b8ad2c7179f83bb1edd4906ebef9adcd54eddaedbde9669b695f8ecfbe486399b846b03b2da5898360ff6be6b82c290e8a0caa23a86ce7
+  metadata.gz: 316fef5691389a031987ec16a194d242d5b961511ec20dac720841e07eff364958d210072dd61b6abbec87daa7337e27359450ccbb27e4a2cb09e219dd39ba17
+  data.tar.gz: 0adeeeba9b7c7a80aa2b11ac73cc1b28c559ad88f5f47f6a987acfa800eac77bd3842e4753a10eb4be3789db5f449edd0e858db72396b6b264298232dec41a11

data/README.md

@@ -9,13 +9,40 @@ Workflow Core
 
 A Rails engine which providing essential infrastructure of workflow.
 
-It's based on [Workflow Net](http://mlwiki.org/index.php/Workflow_Nets) technique.
+WorkflowCore is originally designed for Business Process Management (BPM), in this scenario:
 
-The gem provides:
+- Workflows are usually defined by users dynamically
+- Task may tight with application features
+- May meet some special or weird requirements
 
-- Models to describe workflow nets
-- Models to describe workflow instances
-- Interfaces to define transitions
+WorkflowCore is based on [Workflow Net](http://mlwiki.org/index.php/Workflow_Nets) technique, and only providing essential features for a workflow engine.
+
+## Features
+
+### Models to describe workflow net
+
+Workflow Net is a special case of [Petri net](http://mlwiki.org/index.php/Petri_Nets)
+
+![](_assets/workflow_net.png)
+
+There are two kinds of nodes
+
+- Place (circles): represent the states of a system
+- Transition (squares): represent state changes
+
+WorkflowCore provides Place & Transition models that can represent a workflow net, and a Workflow model as root.
+
+### Models to describe workflow instances
+
+Workflow net use Token (dots in places) to tracking states of a process, every place can contain one or more tokens.
+ 
+WorkflowCore provides WorkflowInstance model represent processes, and it has many tokens.
+
+### Interfaces to define how to transit
+
+Transition has a transactional `fire` method which accept a token that would consume it and generate new token(s), developer could create many kinds of transitions and overrides `on_fire` to define how to transit
+
+In addition, `on_error` is used for error handling.
 
 ## Why “core”
 
@@ -27,11 +54,11 @@ BTW, the dummy app is a full-featured app with production level codebase that yo
 
 ## Todo
 
-- Make sure transit must be an atomic operation, and help developers to avoiding Rails' nested transaction pitfalls.
-- Consider consequences of changing the Net, well handle Net changes. e.g: what about running instances?
+- Find a good way to validate all nodes of the net, when? where? how?
+- Consider native workflows (those which defined in code and tight with the app) support
 - Stabilizing interfaces.
 - Evaluate that can supporting async, scheduled and event-based transition properly.
-- Efficiency (especially on database).
+- Efficiency (especially database queries).
 - Easy to use.
 - Transforming to graph representation for visualization and other usages (e.g proving [Soundness](http://mlwiki.org/index.php/Workflow_Soundness)).
 - Polish codebase.
@@ -86,41 +113,7 @@ The dummy app integrates with [Form Core](https://github.com/rails-engine/form_c
 
 ![](_assets/dummy_overview.png)
 
-### Features
-
-#### Importing workflow definitions from a BPMN2 xml,
-
-![](_assets/importing_bpmn.png)
-
-Because there isn't have a easy-to-use web-based flowchart designer, I implement a stupid BPMN2 importer, it have many restrictions:
-
-- Only supports `Sequence`, `Start event`, `End event`, `Parallel gateway` and `Exclusive gateway`
-- Using gateway to fork flows must have corresponding join (or merge) gateway
-- Only read `name` property, other such as `condition expression` must configure on the dummy app
-
-You can check `_samples` folder, or you can try a BPMN2 designer (e.g [Camunda modeler](https://github.com/camunda/camunda-modeler)).
-
-#### Defining form
-
-![](_assets/defining_form.png)
-
-You can defining a dynamic form for a workflow.
-
-In transition's options, you can configure field's accessibility
-
-#### Exclusive choice configuration supports Ruby expression
-
-![](_assets/editing_transition.png)
-
-Exclusive choice is a special transition that needs to configure conditions that determine how to transit to a branch.
-
-The condition is a Ruby expression, and running in a mRuby sandbox (powered by ScriptCore but it's also undone yet), and you can access form data through `@input[:payload]`, for example, there is a field named `approved`, we can check the field checked by `@input[:payload]["approved"]`
-
-#### Run a workflow
-
-That should make sense.
-
-### Usage
+**You need to install Graphviz first**
 
 Clone the repository.
 
@@ -140,6 +133,13 @@ Run bundler
 $ bundle install
 ```
 
+Build mruby engine & engine lib
+
+```sh
+$ bin/rails app:script_core:engine:build
+$ bin/rails app:script_core:engine:compile_lib 
+```
+
 Preparing database
 
 ```sh
@@ -154,6 +154,42 @@ $ bin/rails s
 
 Open your browser, and visit `http://localhost:3000`
 
+### Features
+
+#### Importing workflow definitions from a BPMN2 xml,
+
+![](_assets/importing_bpmn.png)
+
+Because there isn't have a easy-to-use web-based flowchart designer, I implement a stupid BPMN2 importer, it have many restrictions:
+
+- Only supports `Sequence`, `Start event`, `End event`, `Parallel gateway` and `Exclusive gateway`
+- Using gateway to fork flows must have corresponding join (or merge) gateway
+- Only read `name` property, other such as `condition expression` must configure on the dummy app
+
+You can check `_samples` folder, I've already provided some samples, or you can try a BPMN2 designer (e.g [Camunda modeler](https://github.com/camunda/camunda-modeler)).
+
+#### Defining form
+
+![](_assets/defining_form.png)
+
+You can defining a dynamic form for a workflow.
+
+In transition's options, you can configure field's accessibility
+
+#### Exclusive choice configuration supports Ruby expression
+
+![](_assets/editing_transition.png)
+
+Exclusive choice is a special transition that needs to configure conditions that determine how to transit to a branch.
+
+The condition is a Ruby expression, and running in a mRuby sandbox (powered by [ScriptCore](https://github.com/rails-engine/script_core)),
+and you can access form data through `Input`, for example, there is a field named `approved`,
+we can check the field checked by `Input["approved"]`
+
+#### Run a workflow
+
+See `Instance` tab, that should make sense.
+
 ## Contributing
 
 Bug report or pull request are welcome.

data/app/models/workflow_core/place.rb

@@ -2,14 +2,16 @@
 
 module WorkflowCore
   class Place < ApplicationRecord
+    include WorkflowCore::Concerns::Models::Place
+
     self.table_name = "workflow_places"
 
     belongs_to :workflow
 
     belongs_to :input_transition, optional: true, foreign_key: "input_transition_id",
-               class_name: "WorkflowCore::Transition"
+                                  class_name: "WorkflowCore::Transition"
     belongs_to :output_transition, optional: true, foreign_key: "output_transition_id",
-               class_name: "WorkflowCore::Transition"
+                                   class_name: "WorkflowCore::Transition"
 
     has_many :tokens
   end

data/app/models/workflow_core/token.rb

@@ -2,6 +2,8 @@
 
 module WorkflowCore
   class Token < ApplicationRecord
+    include WorkflowCore::Concerns::Models::Token
+
     self.table_name = "workflow_tokens"
 
     belongs_to :instance,
@@ -10,7 +12,7 @@ module WorkflowCore
 
     belongs_to :place
     belongs_to :previous, optional: true,
-               class_name: "WorkflowCore::Token"
+                          class_name: "WorkflowCore::Token"
 
     enum status: {
       processing: 0,

data/app/models/workflow_core/transition.rb

@@ -2,17 +2,15 @@
 
 module WorkflowCore
   class Transition < ApplicationRecord
+    include WorkflowCore::Concerns::Models::Transition
+
     self.table_name = "workflow_transitions"
 
     belongs_to :workflow
 
     has_many :input_places, dependent: :nullify,
-             foreign_key: "output_transition_id", class_name: "WorkflowCore::Place"
+                            foreign_key: "output_transition_id", class_name: "WorkflowCore::Place"
     has_many :output_places, dependent: :destroy,
-             foreign_key: "input_transition_id", class_name: "WorkflowCore::Place"
-
-    def fire(_token)
-      raise NotImplementedError
-    end
+                             foreign_key: "input_transition_id", class_name: "WorkflowCore::Place"
   end
 end

data/app/models/workflow_core/workflow.rb

@@ -2,6 +2,8 @@
 
 module WorkflowCore
   class Workflow < ApplicationRecord
+    include WorkflowCore::Concerns::Models::Workflow
+
     self.table_name = "workflows"
 
     has_one :start_place, class_name: "WorkflowCore::Place", dependent: :destroy

data/app/models/workflow_core/workflow_instance.rb

@@ -2,6 +2,8 @@
 
 module WorkflowCore
   class WorkflowInstance < ApplicationRecord
+    include WorkflowCore::Concerns::Models::WorkflowInstance
+
     self.table_name = "workflow_instances"
 
     belongs_to :workflow

data/db/migrate/20180910200203_create_workflow_places.rb

@@ -3,8 +3,8 @@
 class CreateWorkflowPlaces < ActiveRecord::Migration[5.2]
   def change
     create_table :workflow_places do |t|
-      t.references :input_transition, foreign_key: {to_table: "workflow_transitions"}
-      t.references :output_transition, foreign_key: {to_table: "workflow_transitions"}
+      t.references :input_transition, foreign_key: { to_table: "workflow_transitions" }
+      t.references :output_transition, foreign_key: { to_table: "workflow_transitions" }
 
       t.string :type, null: false
       t.references :workflow, foreign_key: true

data/db/migrate/20180912223722_create_workflow_tokens.rb

@@ -5,10 +5,10 @@ class CreateWorkflowTokens < ActiveRecord::Migration[5.2]
     create_table :workflow_tokens do |t|
       t.integer :status, null: false, default: 0
 
-      t.references :place, foreign_key: {to_table: "workflow_places"}
-      t.references :previous, foreign_key: {to_table: "workflow_tokens"}
+      t.references :place, foreign_key: { to_table: "workflow_places" }
+      t.references :previous, foreign_key: { to_table: "workflow_tokens" }
 
-      t.references :instance, foreign_key: {to_table: "workflow_instances"}
+      t.references :instance, foreign_key: { to_table: "workflow_instances" }
       t.references :workflow, foreign_key: true
       t.timestamps
     end

data/lib/workflow_core.rb

@@ -2,6 +2,11 @@
 
 require "workflow_core/engine"
 
+require "workflow_core/concerns/models/workflow"
+require "workflow_core/concerns/models/transition"
+require "workflow_core/concerns/models/place"
+require "workflow_core/concerns/models/workflow_instance"
+require "workflow_core/concerns/models/token"
+
 module WorkflowCore
-  # Your code goes here...
 end

data/lib/workflow_core/concerns/models/place.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WorkflowCore::Concerns
+  module Models
+    module Place
+      extend ActiveSupport::Concern
+    end
+  end
+end

data/lib/workflow_core/concerns/models/token.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WorkflowCore::Concerns
+  module Models
+    module Token
+      extend ActiveSupport::Concern
+    end
+  end
+end

data/lib/workflow_core/concerns/models/transition.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module WorkflowCore::Concerns
+  module Models
+    module Transition
+      extend ActiveSupport::Concern
+
+      def fire(token, transaction_options: { requires_new: true }, **options)
+        transaction(**transaction_options) do
+          on_fire(token, transaction_options, options)
+        end
+      rescue StandardError => e
+        rescue_fire_error e
+      end
+
+      protected
+
+        def on_fire(_token, _transaction_options, **_options)
+          raise NotImplementedError
+        end
+
+        def rescue_fire_error(ex)
+          raise ex
+        end
+    end
+  end
+end

data/lib/workflow_core/concerns/models/workflow.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WorkflowCore::Concerns
+  module Models
+    module Workflow
+      extend ActiveSupport::Concern
+    end
+  end
+end

data/lib/workflow_core/concerns/models/workflow_instance.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WorkflowCore::Concerns
+  module Models
+    module WorkflowInstance
+      extend ActiveSupport::Concern
+    end
+  end
+end

data/lib/workflow_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WorkflowCore
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: workflow_core
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - jasl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2019-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 6.0.0.rc1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 7.0.0
 description: A Rails engine which providing essential infrastructure of workflow.
   It's based on Workflow Nets.
 email:
@@ -49,6 +55,11 @@ files:
 - db/migrate/20180912223722_create_workflow_tokens.rb
 - lib/tasks/workflow_core_tasks.rake
 - lib/workflow_core.rb
+- lib/workflow_core/concerns/models/place.rb
+- lib/workflow_core/concerns/models/token.rb
+- lib/workflow_core/concerns/models/transition.rb
+- lib/workflow_core/concerns/models/workflow.rb
+- lib/workflow_core/concerns/models/workflow_instance.rb
 - lib/workflow_core/engine.rb
 - lib/workflow_core/version.rb
 homepage: https://github.com/rails-engine/workflow_core
@@ -70,8 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A Rails engine which providing essential infrastructure of workflow. It's