petri_flow 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94179569c7519230838683fb177f10d5ba283b8443540929a9a73bd8883f342a
-  data.tar.gz: b8fefcc3f627b62f78c54ccfa8f9336593d3aba6604fabdb5054e391c2021796
+  metadata.gz: 0b63de997ab1759fc0d4ebf282bfd6994fcc5724f5536acccf5d75f0f7de4526
+  data.tar.gz: 46c06f8c268cd939872634a583a384a9a0deae3a0c39de010f714a57b92fcbb1
 SHA512:
-  metadata.gz: 9dcd057186dffe1eca9374c6186194af78418ca4252a32ef614e8c4e65924f144fdc60210e59f548af30193351b5df587cac376d4750486333eb0a7fe133e7af
-  data.tar.gz: 7126f1b8186a29fc709d5886199523a8a748625f0b3e154fd3a3904a1c4dd380c2439eb69400e97856980a3a75613b96a35a3750f47ed133153404649332dfee
+  metadata.gz: 6c22fec00a31eeb2026cc3f1c488da4bac9353c0cb275819b360a31b51c2b459ab4ee326e09194ee4d9eb6edbfcab08d50695ead0b1424c296a0300b403565ee
+  data.tar.gz: bb80c81ea18f8fcbae114af7b6fee30b0fca83112a9b32b87a882efb3116c056c428a6042c4cafbeeedf8d62b2428d881d19e9f9b67440f8a7dc0549c2f74840

data/README.md

@@ -1,26 +1,131 @@
-# Wf
-Short description and motivation.
+# Petri Flow
 
-## Usage
-How to use my plugin.
+Workflow engine for Rails.
+
+## Features
+* Full petri net features support (seq, parallel, iterative, timed, automitic etc.)
+* Both approval workflow and business workflow.
+* Simple web admin for workflow definition and case management.
+* Build-in simple dynamic form.
+* Replaceable dynamic form.
+* Graph screen for workflow definition.
+* Graph screen for case and token migration.
+* Powerful guard expression.
+* MySQL and Postgres Support.
+* Powerful assignment management.
+* Flexible integration of organizational structure system(role, group, position or department etc.)
+
+## Docs
+
+* [Petri-Nets and Workflows](https://app.gitbook.com/@hooopo/s/petri-flow/)
+* [Workflow Conceptual Guide](https://app.gitbook.com/@hooopo/s/petri-flow/workflow-conceptual-guide)
+* [Workflow Concepts Reference](https://app.gitbook.com/@hooopo/s/petri-flow/workflow-concepts-reference)
+* [Petri Flow ERD](https://app.gitbook.com/@hooopo/s/petri-flow/erd)
+* [Developer Doc](https://app.gitbook.com/@hooopo/s/petri-flow/developer-document)
+
+## Screenshots
+
+###  iterative routing
+
+![](https://github.com/hooopo/wf/blob/master/screenshots/iterative_routing.png)
+
+### parallel_routing
+
+![](https://github.com/hooopo/wf/blob/master/screenshots/parallel_routing.png)
+
+### guard
+
+![](https://github.com/hooopo/wf/blob/master/screenshots/workflow_with_guard.png)
 
+### case state graph
+
+![](https://github.com/hooopo/wf/blob/master/screenshots/case_state_graph.png)
+
+### 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'wf'
+gem 'petri_flow', require: 'wf'
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install wf
+Install graphviz
+
+```
+brew install graphviz
+```
+
+Migration:
+
+```
+bundle exec rake wf:install:migrations
+bundle exec rails db:create
+bundle exec rails db:migrate
+```
+## Usage
+
+Add wf_config:
+
+```ruby
+# config/initializers/wf_config.rb
+Wf::Workflow.class_eval do
+  def self.user_class
+    ::User
+  end
+  
+  # you can add more org class, for example, Role, Department, Position etc.
+  def self.org_classes
+    { group: ::Group }
+  end
+end
+```
+
+Set parties:
+
+```ruby
+class User < ApplicationRecord
+  belongs_to :group, optional: true
+  has_one :party, as: :partable, class_name: 'Wf::Party'
+
+  # 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
+```
+
+```ruby
+class Group < ApplicationRecord
+  has_many :users
+  has_one :party, as: :partable, class_name: 'Wf::Party'
+  after_create do
+    create_party(party_name: name)
+  end
+end
+```
+
+then
+
+```
+bundle exec rails 
 ```
 
+visit:
+
+```
+http://localhost:3000/wf
+```
+
+Demo App: https://github.com/hooopo/petri_flow_demo
+
 ## Contributing
 Contribution directions go here.
 

data/app/controllers/wf/application_controller.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Wf
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ApplicationController
     protect_from_forgery with: :exception
-    helper_method :current_user
+    helper_method :wf_current_user
 
     breadcrumb "Home", :root_path
 
-    def current_user
-      Wf::User.first
+    def wf_current_user
+      current_user
     end
   end
 end

data/app/controllers/wf/comments_controller.rb

@@ -16,7 +16,7 @@ module Wf
 
     def create
       @workitem = Wf::Workitem.find(params[:workitem_id])
-      Wf::CaseCommand::AddComment.call(@workitem, params[:comment][:body], current_user)
+      Wf::CaseCommand::AddComment.call(@workitem, params[:comment][:body], wf_current_user)
       redirect_to workitem_path(@workitem), notice: "Comment Added."
     end
 

data/app/controllers/wf/workitems_controller.rb

@@ -12,9 +12,9 @@ module Wf
 
     def index
       current_party_ids = [
-        current_user,
-        Wf::Workflow.org_classes.map { |org, _org_class| current_user.public_send(org) }
-      ].flatten.map { |x| x.party&.id }
+        wf_current_user,
+        Wf::Workflow.org_classes.map { |org, _org_class| wf_current_user.public_send(org) }
+      ].flatten.map { |x| x&.party&.id }.compact
       @workitems = Wf::Workitem.joins(:workitem_assignments).where(Wf::WorkitemAssignment.table_name => { party_id: current_party_ids })
       @workitems = @workitems.where(state: params[:state].intern) if params[:state]
       @workitems = @workitems.where(state: params[:state].intern) if params[:state].present?
@@ -27,7 +27,7 @@ module Wf
     end
 
     def start
-      Wf::CaseCommand::StartWorkitem.call(@workitem, current_user)
+      Wf::CaseCommand::StartWorkitem.call(@workitem, wf_current_user)
       breadcrumb @workitem.workflow.name, workflow_path(@workitem.workflow)
       breadcrumb @workitem.case.name, workflow_case_path(@workitem.workflow, @workitem.case)
       breadcrumb @workitem.name, workitem_path(@workitem)
@@ -42,7 +42,7 @@ module Wf
 
     def finish
       if @workitem.transition.form && params[:workitem][:entry]
-        entry = @workitem.entries.find_or_create_by!(user: current_user)
+        entry = @workitem.entries.find_or_create_by!(user: wf_current_user)
         params[:workitem][:entry].permit!.each do |field_id, field_value|
           if field = entry.field_values.where(form: @workitem.transition.form, workflow: @workitem.workflow, field_id: field_id).first
             field.update!(value: field_value)
@@ -65,13 +65,13 @@ module Wf
     end
 
     def check_start
-      unless @workitem.started_by?(current_user)
+      unless @workitem.started_by?(wf_current_user)
         redirect_to workitem_path(@workitem), notice: "You can not start this workitem, Please assign to youself first."
       end
     end
 
     def check_finish
-      unless @workitem.finished_by?(current_user)
+      unless @workitem.finished_by?(wf_current_user)
         redirect_to workitem_path(@workitem), notice: "You can not the holding use of this workitem, Please assign to youself && start it first."
       end
     end

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

@@ -5,7 +5,7 @@
     </div>
 
     <div class="navbar-end">
-      <%= link_to current_user&.name, workitems_path %>
+      <%= link_to wf_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>

data/app/views/wf/workitems/show.html.erb

@@ -125,15 +125,15 @@
       <tr>
          <td colspan="5">
           <% if @workitem.transition.user? && (@workitem.started? || @workitem.enabled?) %>
-             <% if @workitem.finished_by?(current_user) %>
+             <% if @workitem.finished_by?(wf_current_user) %>
                <%= link_to "Pre Finish Workitem", pre_finish_workitem_path(@workitem), class: 'btn btn-sm btn-dark' %>
-             <% elsif @workitem.started_by?(current_user)%>
+             <% elsif @workitem.started_by?(wf_current_user)%>
                <%= link_to "Start Workitem", start_workitem_path(@workitem), method: :put, class: 'btn btn-sm btn-dark' %>
              <% else %>
                You can not start workitem, Please assign to youself.
              <% end %>
              <%= link_to "Re Assign", new_workitem_workitem_assignment_path(@workitem), class: 'btn btn-success btn-sm' %>
-             <%= link_to "Assign Yourself", new_workitem_workitem_assignment_path(@workitem, party_id: current_user.party&.id), class: 'btn btn-success btn-sm' %>
+             <%= link_to "Assign Yourself", new_workitem_workitem_assignment_path(@workitem, party_id: wf_current_user.party&.id), class: 'btn btn-success btn-sm' %>
              <%= link_to "Add Comment", new_workitem_comment_path(@workitem), class: 'btn btn-success btn-sm' %>
             <% end %>
           </td>

data/lib/wf/engine.rb

@@ -6,5 +6,19 @@ module Wf
     config.autoload_paths += %W[
       #{config.root}/app/models/wf/concerns
     ]
+
+    config.to_prepare do
+      require_dependency(Rails.root + "config/initializers/wf_config.rb")
+    rescue LoadError
+      puts("config/initializers/wf_config.rb not found.")
+    end
   end
 end
+
+require "bootstrap"
+require "bootstrap4-kaminari-views"
+require "jquery-rails"
+require "kaminari"
+require "simple_command"
+require "loaf"
+require "graphviz"

data/lib/wf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wf
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: petri_flow
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Hooopo Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2020-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap