workflow_core 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e37fe908ba22a89b01f43680721ad466544bb1eef47cc8bc95ea26d7a77c00d
+  data.tar.gz: 1a052885996e219ec88a60d1e890e7b7b49b855b30bef3b073d1b3a98cc19167
+SHA512:
+  metadata.gz: ad2e77a5043dcbd124a489ef4e0cb047fe3ef15de5db8d23eab6aea2c0f331299cefedb19f9100378db82555cc094ec535ad7d86383b4d50dcb21e5f7b6baada
+  data.tar.gz: af92427c841e043165b8ad2c7179f83bb1edd4906ebef9adcd54eddaedbde9669b695f8ecfbe486399b846b03b2da5898360ff6be6b82c290e8a0caa23a86ce7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Jun Jiang
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,173 @@
+Workflow Core
+====
+
+> WorkflowCore is under development, the codebase is unoptimized and has many bad practices, I may do breaking changes even force pushing to master branch.
+> 
+> In short, it's not ready yet, but I realize that a workflow engine is complicated to design and it needs a long term to done well, so I decide to open source at early stage.
+> 
+> Any way, feedbacks and suggestions are highly welcome!
+
+A Rails engine which providing essential infrastructure of workflow.
+
+It's based on [Workflow Net](http://mlwiki.org/index.php/Workflow_Nets) technique.
+
+The gem provides:
+
+- Models to describe workflow nets
+- Models to describe workflow instances
+- Interfaces to define transitions
+
+## Why “core”
+
+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.
+
+BTW, the dummy app is a full-featured app with production level codebase that you can freely to reference it.
+
+## 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?
+- Stabilizing interfaces.
+- Evaluate that can supporting async, scheduled and event-based transition properly.
+- Efficiency (especially on database).
+- 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.
+- Continually improving dummy app.
+
+## Requirements
+
+- MRI 2.3+
+- Rails 5.0+
+
+## Usage
+
+See demo for now.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'workflow_core'
+```
+
+Or you may want to include the gem directly from GitHub:
+
+```ruby
+gem 'workflow_core', github: 'rails-engine/workflow_core'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Copy migrations
+
+```sh
+$ bin/rails workflow_core:install:migrations
+```
+
+Then do migrate
+
+```sh
+$ bin/rails db:migrate
+```
+
+## Demo
+
+**Demo is also under development.**
+
+The dummy app integrates with [Form Core](https://github.com/rails-engine/form_core) and [Script Core](https://github.com/rails-engine/script_core) shows an Approving Manage System.
+
+![](_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
+
+Clone the repository.
+
+```sh
+$ git clone https://github.com/rails-engine/workflow_core.git
+```
+
+Change directory
+
+```sh
+$ cd workflow_core
+```
+
+Run bundler
+
+```sh
+$ bundle install
+```
+
+Preparing database
+
+```sh
+$ bin/rails db:migrate
+```
+
+Start the Rails server
+
+```sh
+$ bin/rails s
+```
+
+Open your browser, and visit `http://localhost:3000`
+
+## Contributing
+
+Bug report or pull request are welcome.
+
+### Make a pull request
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Please write unit test with your code if necessary.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "WorkflowCore"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/jobs/workflow_core/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module WorkflowCore
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/models/workflow_core/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WorkflowCore
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/workflow_core/place.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WorkflowCore
+  class Place < ApplicationRecord
+    self.table_name = "workflow_places"
+
+    belongs_to :workflow
+
+    belongs_to :input_transition, optional: true, foreign_key: "input_transition_id",
+               class_name: "WorkflowCore::Transition"
+    belongs_to :output_transition, optional: true, foreign_key: "output_transition_id",
+               class_name: "WorkflowCore::Transition"
+
+    has_many :tokens
+  end
+end

data/app/models/workflow_core/token.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module WorkflowCore
+  class Token < ApplicationRecord
+    self.table_name = "workflow_tokens"
+
+    belongs_to :instance,
+               class_name: "WorkflowCore::WorkflowInstance"
+    belongs_to :workflow
+
+    belongs_to :place
+    belongs_to :previous, optional: true,
+               class_name: "WorkflowCore::Token"
+
+    enum status: {
+      processing: 0,
+      completed: 1,
+      failed: 2,
+      unexpected: 3,
+      terminated: 4
+    }
+  end
+end

data/app/models/workflow_core/transition.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WorkflowCore
+  class Transition < ApplicationRecord
+    self.table_name = "workflow_transitions"
+
+    belongs_to :workflow
+
+    has_many :input_places, dependent: :nullify,
+             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
+  end
+end

data/app/models/workflow_core/workflow.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module WorkflowCore
+  class Workflow < ApplicationRecord
+    self.table_name = "workflows"
+
+    has_one :start_place, class_name: "WorkflowCore::Place", dependent: :destroy
+
+    has_many :transitions, class_name: "WorkflowCore::Transition", dependent: :destroy
+    has_many :places, class_name: "WorkflowCore::Place", dependent: :destroy
+
+    has_many :instances, class_name: "WorkflowCore::WorkflowInstance", dependent: :destroy
+    has_many :tokens, class_name: "WorkflowCore::Token", dependent: :destroy
+  end
+end

data/app/models/workflow_core/workflow_instance.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WorkflowCore
+  class WorkflowInstance < ApplicationRecord
+    self.table_name = "workflow_instances"
+
+    belongs_to :workflow
+    has_many :tokens, foreign_key: "instance_id", dependent: :destroy
+
+    enum status: {
+      processing: 0,
+      completed: 1,
+      failed: 2,
+      unexpected: 3,
+      terminated: 4
+    }
+
+    serialize :payload
+  end
+end

data/db/migrate/20180910195950_create_workflows.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class CreateWorkflows < ActiveRecord::Migration[5.2]
+  def change
+    create_table :workflows do |t|
+      t.string :type, null: false
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180910200203_create_workflow_places.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+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.string :type, null: false
+      t.references :workflow, foreign_key: true
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180910200454_create_workflow_transitions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateWorkflowTransitions < ActiveRecord::Migration[5.2]
+  def change
+    create_table :workflow_transitions do |t|
+      t.string :type, null: false
+      t.references :workflow, foreign_key: true
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180912223642_create_workflow_instances.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateWorkflowInstances < ActiveRecord::Migration[5.2]
+  def change
+    create_table :workflow_instances do |t|
+      t.text :payload
+      t.integer :status, null: false, default: 0
+
+      t.references :workflow, foreign_key: true
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180912223722_create_workflow_tokens.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateWorkflowTokens < ActiveRecord::Migration[5.2]
+  def change
+    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 :instance, foreign_key: {to_table: "workflow_instances"}
+      t.references :workflow, foreign_key: true
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/workflow_core_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :workflow_core do
+#   # Task goes here
+# end

data/lib/workflow_core/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WorkflowCore
+  class Engine < ::Rails::Engine
+    isolate_namespace WorkflowCore
+  end
+end

data/lib/workflow_core/version.rb

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

data/lib/workflow_core.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "workflow_core/engine"
+
+module WorkflowCore
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: workflow_core
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jasl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-26 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: A Rails engine which providing essential infrastructure of workflow.
+  It's based on Workflow Nets.
+email:
+- jasl9187@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/jobs/workflow_core/application_job.rb
+- app/models/workflow_core/application_record.rb
+- app/models/workflow_core/place.rb
+- app/models/workflow_core/token.rb
+- app/models/workflow_core/transition.rb
+- app/models/workflow_core/workflow.rb
+- app/models/workflow_core/workflow_instance.rb
+- db/migrate/20180910195950_create_workflows.rb
+- db/migrate/20180910200203_create_workflow_places.rb
+- db/migrate/20180910200454_create_workflow_transitions.rb
+- db/migrate/20180912223642_create_workflow_instances.rb
+- db/migrate/20180912223722_create_workflow_tokens.rb
+- lib/tasks/workflow_core_tasks.rake
+- lib/workflow_core.rb
+- lib/workflow_core/engine.rb
+- lib/workflow_core/version.rb
+homepage: https://github.com/rails-engine/workflow_core
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A Rails engine which providing essential infrastructure of workflow. It's
+  based on Workflow Nets.
+test_files: []