FlowCore is ready for open reviewing, but it haven't tested in production yet, any help are most welcome, breaking change is acceptable.
FlowCore is a Rails engine to help you build your automation or business process application.
FlowCore modeling workflow with WorkflowNet (a special case of PetriNet) theory which is a generalisation of automata theory such that the concept of concurrently occurring events can be expressed.
You should try FlowCore if you need:
All persistent data are present as ActiveRecord model and not use any DB-specific feature.
FlowCore basically followed best practice of Rails engine, you can extend as Rails Guides suggests.
Your app-specific workflow triggers, and guards can be extended via Single Table Inheritance
FlowCore also provides callbacks for triggers (which control behavior of a transition) covered whole task lifecycle.
Petri-net is a technique for description and analysis of concurrent systems.
FlowCore choose its special type called Workflow-net to expressing workflow.
Compared to more popular activity-based workflow definitions (e.g BPMN), Petri-net has only few rules but could express very complex case.
Check workflow patterns to learn how to use Petri-net expressing workflows.
A workflow should be verified first before running it.
FlowCore provides the mechanism to help to prevent unexpected error on instance running
This is the hard work and help wanted Workflow-net has soundness checking but I don't know how to implement it
FlowCore separate app-world and engine-world using interfaces and abstract classes, basically you no need to know Workflow-net internal works.
FlowCore provides necessary columns and event callbacks for runtime error and suspend.
FlowCore provides a powerful DSL for creating workflow.
You need to install Graphviz first
Clone the repository.
$ git clone https://github.com/rails-engine/flow_core.git
$ cd flow_core
$ bundle install
$ bin/rails db:migrate
Import sample workflow
$ bin/rails db:seed
Build Script Core
$ bin/rails app:script_core:engine:build $ bin/rails app:script_core:engine:compile_lib
Start the Rails server
$ bin/rails s
Open your browser, and visit
Basic design based on An activity based Workflow Engine for PHP By Tony Marston.
TaskExecutablethrough Rails polymorphic-reference. It finish means the transition is done and can moving on.
createdTask created by a Petri-net Token
enabledTransit to this stage when next transition requirement fulfilled
terminatedTask killed by instance (e.g Instance cancelled) or other race condition task
Because it's not aim to "out-of-box", some gem like Devise giving developer an out-of-box experience, that's awesome, but on the other hand, it also introducing a very complex abstraction that may hard to understanding how it works, especially when you attempting to customize it.
I believe that the gem is tightly coupled with features that face to end users directly, so having a good customizability and easy to understanding are of the most concern, so I just wanna give you a domain framework that you can build your own that just fitting your need, and you shall have fully control and without any unnecessary abstraction.
Add this line to your application's Gemfile:
Or you may want to include the gem directly from GitHub:
gem 'flow_core', github: 'rails-engine/flow_core'
And then execute:
And then execute:
$ rails flow_core_engine:install:migrations
And then execute:
$ rails db:migrate
Bug report or pull request are welcome.
git checkout -b my-new-feature)
git commit -am 'Add some feature')
git push origin my-new-feature)
Please write unit test with your code if necessary.
The gem is available as open source under the terms of the MIT License.