aasm-vis 0.1.1 → 0.1.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +43 -0
- data/aasm-vis.gemspec +4 -4
- data/lib/aasm/vis/version.rb +1 -1
- data/lib/aasm/vis.rb +0 -5
- metadata +44 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: abab34e1ec6ea9364f7963c0ed11f5e81527206bfea2c296cba867c5c19a2d2b
|
4
|
+
data.tar.gz: c03d37d981466d01cad1c651ac1eeb8859f73d2d04180bfdd853fcab911255bf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c2790e89a20c09851e858f0a375140c1a0966686bdeae2bfbb26ba1ff794e210e1a2f5f12916e4abd7445aaf72847d42124b6f035b3d8ad0abfbea5e91ee8d7f
|
7
|
+
data.tar.gz: ac07cd5d3f3359f48d6ea3c84acfa3613dc36ec28cbb66f62e2229362bda5ea7ae46f16b4b12fc5adf030b6f961399eec38a28a2e6e4c81578a40203a8541412
|
data/README.md
CHANGED
@@ -12,6 +12,49 @@ Add `gem 'aasm-vis', group: :development` to your `Gemfile` and run `bundle`.
|
|
12
12
|
|
13
13
|
To visualise the results you can use the [github cli](https://cli.github.com/): `gh gist create tmp/assm-vis.md` or any other tool that can render markdown files supporting mermaid.
|
14
14
|
|
15
|
+
## Example
|
16
|
+
|
17
|
+
The following ruby code defines a simple state machine for a `Job` model:
|
18
|
+
```ruby
|
19
|
+
class Job < ApplicationRecord
|
20
|
+
include AASM
|
21
|
+
|
22
|
+
aasm :state do
|
23
|
+
state :created, initial: true
|
24
|
+
state :running
|
25
|
+
state :finished_successfully
|
26
|
+
state :finished_with_error
|
27
|
+
|
28
|
+
event :run, after: :notify_somebody do
|
29
|
+
transitions from: :created, to: :running
|
30
|
+
transitions from: :running, to: :finished_with_error
|
31
|
+
transitions from: :running, to: :finished_successfully
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
```
|
36
|
+
|
37
|
+
It will generate the following mermaid diagram:
|
38
|
+
|
39
|
+
```mermaid
|
40
|
+
---
|
41
|
+
title: Job#state
|
42
|
+
---
|
43
|
+
stateDiagram-v2
|
44
|
+
|
45
|
+
created : Created
|
46
|
+
running : Running
|
47
|
+
finished_successfully : Finished successfully
|
48
|
+
finished_with_error : Finished with error
|
49
|
+
|
50
|
+
[*] --> created
|
51
|
+
created --> running
|
52
|
+
running --> finished_with_error
|
53
|
+
running --> finished_successfully
|
54
|
+
|
55
|
+
finished_with_error --> [*]
|
56
|
+
finished_successfully --> [*]
|
57
|
+
```
|
15
58
|
|
16
59
|
## Development
|
17
60
|
|
data/aasm-vis.gemspec
CHANGED
@@ -32,9 +32,9 @@ Gem::Specification.new do |spec|
|
|
32
32
|
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
|
33
33
|
spec.require_paths = ["lib"]
|
34
34
|
|
35
|
-
|
36
|
-
# spec.add_dependency "example-gem", "~> 1.0"
|
35
|
+
spec.add_dependency "aasm", "~> 5"
|
37
36
|
|
38
|
-
#
|
39
|
-
|
37
|
+
# TODO make it work without Rails
|
38
|
+
spec.add_dependency "rake"
|
39
|
+
spec.add_dependency "railties"
|
40
40
|
end
|
data/lib/aasm/vis/version.rb
CHANGED
data/lib/aasm/vis.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aasm-vis
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Kamil Gwóźdź
|
@@ -9,7 +9,49 @@ autorequire:
|
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
11
|
date: 2024-07-18 00:00:00.000000000 Z
|
12
|
-
dependencies:
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: aasm
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '5'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '5'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: railties
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
13
55
|
description: Gem for visualising https://github.com/aasm/aasm state machines using
|
14
56
|
markdown and https://github.com/mermaid-js/mermaid.
|
15
57
|
email:
|