aboutsummaryrefslogtreecommitdiff
path: root/workflow.go
blob: f079e6c086d1b81828fa6c6f0a2a93f7e7df701c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
package workflow

import (
	"bytes"
	"errors"
	"fmt"
)

var (
	// ErrTransitionNotFound error if no transition with this name
	ErrTransitionNotFound = errors.New("transition not found")
)

// Workflow state machine
type Workflow struct {
	transitions  map[Place][]Place
	initialPlace Place
}

// NewWorkflow returns new Workflow instance
func NewWorkflow(initialPlace Place) *Workflow {
	return &Workflow{initialPlace: initialPlace, transitions: map[Place][]Place{}}
}

// Can returns nil if transition applicable to object and error if not
func (w *Workflow) Can(obj Placeer, to Place) error {
	currentPlace := obj.GetPlace()
	if currentPlace == "" {
		currentPlace = w.initialPlace
	}
	tr, ok := w.transitions[currentPlace]
	if !ok {
		return ErrTransitionNotFound
	}
	for _, f := range tr {
		if f == to {
			return nil
		}
	}
	return ErrTransitionNotFound
}

// GetEnabledTransitions return all applicable transitions for object
func (w *Workflow) GetEnabledTransitions(obj Placeer) []Place {
	currentPlace := obj.GetPlace()
	if currentPlace == "" {
		currentPlace = w.initialPlace
	}
	if _, ok := w.transitions[currentPlace]; !ok {
		return nil
	}
	return w.transitions[currentPlace]
}

// Apply next state from transition to object
func (w *Workflow) Apply(obj Placeer, to Place) error {
	currentPlace := obj.GetPlace()
	if currentPlace == "" {
		currentPlace = w.initialPlace
	}
	tr, ok := w.transitions[currentPlace]
	if !ok {
		return ErrTransitionNotFound
	}
	for _, f := range tr {
		if f == to {
			return obj.SetPlace(to)
		}
	}
	return ErrTransitionNotFound
}

// AddTransition to workflow
func (w *Workflow) AddTransition(from Place, to Place) {
	if _, ok := w.transitions[from]; !ok {
		w.transitions[from] = []Place{}
	}
	w.transitions[from] = append(w.transitions[from], to)
}

// DumpToDot dumps transitions to Graphviz Dot format
func (w *Workflow) DumpToDot() []byte {
	buf := bytes.NewBufferString(fmt.Sprintf("digraph {\n%s[color=\"blue\"]\n", w.initialPlace))
	for from, to := range w.transitions {
		for _, place := range to {
			_, _ = buf.WriteString(fmt.Sprintf("%s -> %s[label=\"%s\"];\n", from, place, fmt.Sprintf("%s → %s", from, place)))
		}
	}
	buf.WriteString("}")
	return buf.Bytes()
}

// Merge another workflow to current
func (w *Workflow) Merge(workflow *Workflow) {
	for from, tos := range workflow.transitions {
		for _, to := range tos {
			w.AddTransition(from, to)
		}
	}
}

// Place is one of state
type Place string