state_machines-yard 0.1.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +12 -4
- data/.github/workflows/release.yml +8 -6
- data/.release-please-manifest.json +3 -0
- data/.rubocop.yml +38 -0
- data/CHANGELOG.md +54 -0
- data/Gemfile +12 -1
- data/README.md +45 -0
- data/Rakefile +21 -3
- data/lib/state_machines/yard/description.rb +77 -0
- data/lib/state_machines/yard/handlers/actions.rb +113 -0
- data/lib/state_machines/yard/handlers/base.rb +145 -20
- data/lib/state_machines/yard/handlers/callback.rb +56 -0
- data/lib/state_machines/yard/handlers/event.rb +16 -12
- data/lib/state_machines/yard/handlers/machine.rb +258 -253
- data/lib/state_machines/yard/handlers/requirements.rb +92 -0
- data/lib/state_machines/yard/handlers/state.rb +16 -12
- data/lib/state_machines/yard/handlers/transition.rb +59 -30
- data/lib/state_machines/yard/handlers.rb +3 -1
- data/lib/state_machines/yard/renderer.rb +62 -0
- data/lib/state_machines/yard/templates/default/class/html/setup.rb +14 -7
- data/lib/state_machines/yard/templates/default/class/html/state_machines.erb +33 -0
- data/lib/state_machines/yard/templates.rb +2 -0
- data/lib/state_machines/yard/version.rb +3 -1
- data/lib/state_machines/yard.rb +7 -0
- data/release-please-config.json +11 -0
- data/state_machines-yard.gemspec +16 -8
- data/test/description_test.rb +138 -0
- data/test/handlers/base_test.rb +43 -18
- data/test/handlers/callback_test.rb +168 -0
- data/test/handlers/event_test.rb +32 -19
- data/test/handlers/guards_test.rb +180 -0
- data/test/handlers/machine_test.rb +100 -16
- data/test/handlers/review_test.rb +192 -0
- data/test/handlers/state_test.rb +20 -13
- data/test/handlers/transition_test.rb +154 -19
- data/test/integration_test.rb +47 -36
- data/test/templates_test.rb +39 -16
- data/test/test_helper.rb +24 -10
- metadata +103 -20
data/test/templates_test.rb
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
require 'test_helper'
|
|
2
4
|
require 'nokogiri'
|
|
3
5
|
|
|
@@ -23,15 +25,15 @@ class TemplatesTest < Minitest::Test
|
|
|
23
25
|
state :parked
|
|
24
26
|
state :idling
|
|
25
27
|
state :moving
|
|
26
|
-
|
|
28
|
+
#{' '}
|
|
27
29
|
event :ignite do
|
|
28
30
|
transition parked: :idling
|
|
29
31
|
end
|
|
30
|
-
|
|
32
|
+
#{' '}
|
|
31
33
|
event :drive do
|
|
32
34
|
transition idling: :moving
|
|
33
35
|
end
|
|
34
|
-
|
|
36
|
+
#{' '}
|
|
35
37
|
event :park do
|
|
36
38
|
transition moving: :parked
|
|
37
39
|
end
|
|
@@ -40,33 +42,54 @@ class TemplatesTest < Minitest::Test
|
|
|
40
42
|
RUBY
|
|
41
43
|
|
|
42
44
|
parse_code(code)
|
|
43
|
-
|
|
45
|
+
|
|
44
46
|
# Generate documentation
|
|
45
47
|
options = YARD::CLI::YardocOptions.new
|
|
46
48
|
options.files = []
|
|
47
49
|
options.output = @yard_dir
|
|
48
|
-
|
|
50
|
+
|
|
49
51
|
YARD::CLI::Yardoc.run('--no-save', '--no-progress', '--quiet', '-o', @yard_dir)
|
|
50
|
-
|
|
52
|
+
|
|
51
53
|
# Check if the HTML file was generated
|
|
52
54
|
html_file = File.join(@yard_dir, 'Vehicle.html')
|
|
53
|
-
|
|
54
|
-
|
|
55
|
+
|
|
56
|
+
assert_path_exists html_file, 'HTML file for Vehicle should exist'
|
|
57
|
+
|
|
55
58
|
# Parse the HTML and check for state machine content
|
|
56
59
|
html = File.read(html_file)
|
|
57
60
|
doc = Nokogiri::HTML(html)
|
|
58
|
-
|
|
61
|
+
|
|
59
62
|
# Check for state machine section
|
|
60
63
|
state_machines_section = doc.at_css('h2:contains("State Machines")')
|
|
61
|
-
|
|
62
|
-
|
|
64
|
+
|
|
65
|
+
refute_nil state_machines_section, 'State Machines section should exist in the HTML'
|
|
66
|
+
|
|
63
67
|
# Check for status machine
|
|
64
68
|
status_machine = doc.at_css('h3:contains("status")')
|
|
65
|
-
|
|
66
|
-
|
|
69
|
+
|
|
70
|
+
refute_nil status_machine, 'Status machine heading should exist in the HTML'
|
|
71
|
+
|
|
67
72
|
# Check for description
|
|
68
73
|
description = status_machine.next_element
|
|
69
|
-
|
|
70
|
-
|
|
74
|
+
|
|
75
|
+
refute_nil description, 'Machine description should exist'
|
|
76
|
+
assert_equal 'This is a state machine for vehicle status', description.text.strip
|
|
77
|
+
|
|
78
|
+
case ENV.fetch('STATE_MACHINES_RENDERER', nil)
|
|
79
|
+
when 'graphviz'
|
|
80
|
+
image = doc.at_css('img[alt^="State machine diagram for"]')
|
|
81
|
+
|
|
82
|
+
refute_nil image, 'Graphviz image should be rendered'
|
|
83
|
+
when 'mermaid'
|
|
84
|
+
mermaid_block = doc.at_css('pre.mermaid')
|
|
85
|
+
|
|
86
|
+
refute_nil mermaid_block, 'Mermaid block should be rendered'
|
|
87
|
+
else
|
|
88
|
+
image = doc.at_css('img[alt^="State machine diagram for"]')
|
|
89
|
+
mermaid_block = doc.at_css('pre.mermaid')
|
|
90
|
+
|
|
91
|
+
assert_nil image, 'No image should be rendered'
|
|
92
|
+
assert_nil mermaid_block, 'No mermaid block should be rendered'
|
|
93
|
+
end
|
|
71
94
|
end
|
|
72
|
-
end
|
|
95
|
+
end
|
data/test/test_helper.rb
CHANGED
|
@@ -1,21 +1,27 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
require 'minitest/autorun'
|
|
2
4
|
require 'yard'
|
|
3
5
|
require 'state_machines'
|
|
4
6
|
require 'state_machines/yard'
|
|
5
|
-
|
|
7
|
+
case ENV.fetch('STATE_MACHINES_RENDERER', nil)
|
|
8
|
+
when 'graphviz'
|
|
9
|
+
require 'state_machines/graphviz'
|
|
10
|
+
when 'mermaid'
|
|
11
|
+
require 'state_machines-mermaid'
|
|
12
|
+
end
|
|
6
13
|
require 'nokogiri'
|
|
7
14
|
require 'fileutils'
|
|
15
|
+
require 'tmpdir'
|
|
8
16
|
|
|
9
17
|
# Helper module for tests
|
|
10
18
|
module TestHelpers
|
|
11
19
|
# Create a temporary directory for YARD outputs
|
|
12
20
|
def setup_yard
|
|
13
|
-
@yard_dir =
|
|
14
|
-
FileUtils.rm_rf(@yard_dir) if Dir.exist?(@yard_dir)
|
|
15
|
-
FileUtils.mkdir_p(@yard_dir)
|
|
21
|
+
@yard_dir = Dir.mktmpdir('state_machines-yard')
|
|
16
22
|
YARD::Registry.clear
|
|
17
23
|
# Register our handlers
|
|
18
|
-
YARD::Tags::Library.define_tag(
|
|
24
|
+
YARD::Tags::Library.define_tag('State Machines', :state_machines)
|
|
19
25
|
end
|
|
20
26
|
|
|
21
27
|
# Parse the given code with YARD
|
|
@@ -24,14 +30,22 @@ module TestHelpers
|
|
|
24
30
|
YARD::Registry.load
|
|
25
31
|
end
|
|
26
32
|
|
|
33
|
+
# Parse the given code into fresh parser globals and return the machines
|
|
34
|
+
# the handlers built, keyed by the owner's namespace path, then name
|
|
35
|
+
def parse_machines(code)
|
|
36
|
+
globals = YARD::OpenStruct.new
|
|
37
|
+
YARD::Parser::SourceParser.new(:ruby, globals).parse(StringIO.new(code))
|
|
38
|
+
globals.state_machines
|
|
39
|
+
end
|
|
40
|
+
|
|
27
41
|
# Clean up after test
|
|
28
42
|
def cleanup_yard
|
|
29
|
-
FileUtils.rm_rf(@yard_dir)
|
|
43
|
+
FileUtils.rm_rf(@yard_dir)
|
|
30
44
|
YARD::Registry.clear
|
|
31
45
|
end
|
|
32
|
-
|
|
46
|
+
|
|
33
47
|
# Helper method to check if registry object has attribute
|
|
34
|
-
def
|
|
35
|
-
obj.respond_to?(:[]) && obj[name]
|
|
48
|
+
def attribute?(obj, name)
|
|
49
|
+
obj.respond_to?(:[]) && !obj[name].nil?
|
|
36
50
|
end
|
|
37
|
-
end
|
|
51
|
+
end
|
metadata
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: state_machines-yard
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Abdelkader Boudih
|
|
8
8
|
- Aaron Pfeifer
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
|
-
name:
|
|
14
|
+
name: rdoc
|
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
@@ -25,21 +25,35 @@ dependencies:
|
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
26
|
version: '0'
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
|
-
name: state_machines
|
|
28
|
+
name: state_machines
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
|
30
30
|
requirements:
|
|
31
31
|
- - ">="
|
|
32
32
|
- !ruby/object:Gem::Version
|
|
33
|
-
version:
|
|
33
|
+
version: 0.304.0
|
|
34
34
|
type: :runtime
|
|
35
35
|
prerelease: false
|
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
|
37
37
|
requirements:
|
|
38
38
|
- - ">="
|
|
39
39
|
- !ruby/object:Gem::Version
|
|
40
|
-
version:
|
|
40
|
+
version: 0.304.0
|
|
41
41
|
- !ruby/object:Gem::Dependency
|
|
42
|
-
name:
|
|
42
|
+
name: state_machines-diagram
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - ">="
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: 0.4.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.4.0
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: yard
|
|
43
57
|
requirement: !ruby/object:Gem::Requirement
|
|
44
58
|
requirements:
|
|
45
59
|
- - ">="
|
|
@@ -54,18 +68,46 @@ dependencies:
|
|
|
54
68
|
version: '0'
|
|
55
69
|
- !ruby/object:Gem::Dependency
|
|
56
70
|
name: bundler
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - ">="
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: '4.0'
|
|
76
|
+
type: :development
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - ">="
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: '4.0'
|
|
83
|
+
- !ruby/object:Gem::Dependency
|
|
84
|
+
name: minitest
|
|
57
85
|
requirement: !ruby/object:Gem::Requirement
|
|
58
86
|
requirements:
|
|
59
87
|
- - "~>"
|
|
60
88
|
- !ruby/object:Gem::Version
|
|
61
|
-
version: '
|
|
89
|
+
version: '6.0'
|
|
62
90
|
type: :development
|
|
63
91
|
prerelease: false
|
|
64
92
|
version_requirements: !ruby/object:Gem::Requirement
|
|
65
93
|
requirements:
|
|
66
94
|
- - "~>"
|
|
67
95
|
- !ruby/object:Gem::Version
|
|
68
|
-
version: '
|
|
96
|
+
version: '6.0'
|
|
97
|
+
- !ruby/object:Gem::Dependency
|
|
98
|
+
name: nokogiri
|
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
|
100
|
+
requirements:
|
|
101
|
+
- - ">="
|
|
102
|
+
- !ruby/object:Gem::Version
|
|
103
|
+
version: '0'
|
|
104
|
+
type: :development
|
|
105
|
+
prerelease: false
|
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
107
|
+
requirements:
|
|
108
|
+
- - ">="
|
|
109
|
+
- !ruby/object:Gem::Version
|
|
110
|
+
version: '0'
|
|
69
111
|
- !ruby/object:Gem::Dependency
|
|
70
112
|
name: rake
|
|
71
113
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -81,33 +123,61 @@ dependencies:
|
|
|
81
123
|
- !ruby/object:Gem::Version
|
|
82
124
|
version: '13.0'
|
|
83
125
|
- !ruby/object:Gem::Dependency
|
|
84
|
-
name:
|
|
126
|
+
name: rubocop
|
|
85
127
|
requirement: !ruby/object:Gem::Requirement
|
|
86
128
|
requirements:
|
|
87
129
|
- - "~>"
|
|
88
130
|
- !ruby/object:Gem::Version
|
|
89
|
-
version: '
|
|
131
|
+
version: '1.59'
|
|
90
132
|
type: :development
|
|
91
133
|
prerelease: false
|
|
92
134
|
version_requirements: !ruby/object:Gem::Requirement
|
|
93
135
|
requirements:
|
|
94
136
|
- - "~>"
|
|
95
137
|
- !ruby/object:Gem::Version
|
|
96
|
-
version: '
|
|
138
|
+
version: '1.59'
|
|
97
139
|
- !ruby/object:Gem::Dependency
|
|
98
|
-
name:
|
|
140
|
+
name: rubocop-minitest
|
|
99
141
|
requirement: !ruby/object:Gem::Requirement
|
|
100
142
|
requirements:
|
|
101
|
-
- - "
|
|
143
|
+
- - "~>"
|
|
102
144
|
- !ruby/object:Gem::Version
|
|
103
|
-
version: '0'
|
|
145
|
+
version: '0.34'
|
|
104
146
|
type: :development
|
|
105
147
|
prerelease: false
|
|
106
148
|
version_requirements: !ruby/object:Gem::Requirement
|
|
107
149
|
requirements:
|
|
108
|
-
- - "
|
|
150
|
+
- - "~>"
|
|
109
151
|
- !ruby/object:Gem::Version
|
|
110
|
-
version: '0'
|
|
152
|
+
version: '0.34'
|
|
153
|
+
- !ruby/object:Gem::Dependency
|
|
154
|
+
name: rubocop-performance
|
|
155
|
+
requirement: !ruby/object:Gem::Requirement
|
|
156
|
+
requirements:
|
|
157
|
+
- - "~>"
|
|
158
|
+
- !ruby/object:Gem::Version
|
|
159
|
+
version: '1.20'
|
|
160
|
+
type: :development
|
|
161
|
+
prerelease: false
|
|
162
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
163
|
+
requirements:
|
|
164
|
+
- - "~>"
|
|
165
|
+
- !ruby/object:Gem::Version
|
|
166
|
+
version: '1.20'
|
|
167
|
+
- !ruby/object:Gem::Dependency
|
|
168
|
+
name: rubocop-rake
|
|
169
|
+
requirement: !ruby/object:Gem::Requirement
|
|
170
|
+
requirements:
|
|
171
|
+
- - "~>"
|
|
172
|
+
- !ruby/object:Gem::Version
|
|
173
|
+
version: '0.6'
|
|
174
|
+
type: :development
|
|
175
|
+
prerelease: false
|
|
176
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
177
|
+
requirements:
|
|
178
|
+
- - "~>"
|
|
179
|
+
- !ruby/object:Gem::Version
|
|
180
|
+
version: '0.6'
|
|
111
181
|
description: State machines YARD plugin for automated documentation
|
|
112
182
|
email:
|
|
113
183
|
- terminale@gmail.com
|
|
@@ -118,26 +188,38 @@ files:
|
|
|
118
188
|
- ".github/workflows/ci.yml"
|
|
119
189
|
- ".github/workflows/release.yml"
|
|
120
190
|
- ".gitignore"
|
|
191
|
+
- ".release-please-manifest.json"
|
|
192
|
+
- ".rubocop.yml"
|
|
121
193
|
- CHANGELOG.md
|
|
122
194
|
- Gemfile
|
|
123
195
|
- LICENSE.txt
|
|
124
196
|
- README.md
|
|
125
197
|
- Rakefile
|
|
126
198
|
- lib/state_machines/yard.rb
|
|
199
|
+
- lib/state_machines/yard/description.rb
|
|
127
200
|
- lib/state_machines/yard/handlers.rb
|
|
201
|
+
- lib/state_machines/yard/handlers/actions.rb
|
|
128
202
|
- lib/state_machines/yard/handlers/base.rb
|
|
203
|
+
- lib/state_machines/yard/handlers/callback.rb
|
|
129
204
|
- lib/state_machines/yard/handlers/event.rb
|
|
130
205
|
- lib/state_machines/yard/handlers/machine.rb
|
|
206
|
+
- lib/state_machines/yard/handlers/requirements.rb
|
|
131
207
|
- lib/state_machines/yard/handlers/state.rb
|
|
132
208
|
- lib/state_machines/yard/handlers/transition.rb
|
|
209
|
+
- lib/state_machines/yard/renderer.rb
|
|
133
210
|
- lib/state_machines/yard/templates.rb
|
|
134
211
|
- lib/state_machines/yard/templates/default/class/html/setup.rb
|
|
135
212
|
- lib/state_machines/yard/templates/default/class/html/state_machines.erb
|
|
136
213
|
- lib/state_machines/yard/version.rb
|
|
214
|
+
- release-please-config.json
|
|
137
215
|
- state_machines-yard.gemspec
|
|
216
|
+
- test/description_test.rb
|
|
138
217
|
- test/handlers/base_test.rb
|
|
218
|
+
- test/handlers/callback_test.rb
|
|
139
219
|
- test/handlers/event_test.rb
|
|
220
|
+
- test/handlers/guards_test.rb
|
|
140
221
|
- test/handlers/machine_test.rb
|
|
222
|
+
- test/handlers/review_test.rb
|
|
141
223
|
- test/handlers/state_test.rb
|
|
142
224
|
- test/handlers/transition_test.rb
|
|
143
225
|
- test/integration_test.rb
|
|
@@ -146,7 +228,8 @@ files:
|
|
|
146
228
|
homepage: https://github.com/state-machines/state_machines-yard
|
|
147
229
|
licenses:
|
|
148
230
|
- MIT
|
|
149
|
-
metadata:
|
|
231
|
+
metadata:
|
|
232
|
+
rubygems_mfa_required: 'true'
|
|
150
233
|
rdoc_options: []
|
|
151
234
|
require_paths:
|
|
152
235
|
- lib
|
|
@@ -154,14 +237,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
154
237
|
requirements:
|
|
155
238
|
- - ">="
|
|
156
239
|
- !ruby/object:Gem::Version
|
|
157
|
-
version: '
|
|
240
|
+
version: '4.0'
|
|
158
241
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
159
242
|
requirements:
|
|
160
243
|
- - ">="
|
|
161
244
|
- !ruby/object:Gem::Version
|
|
162
245
|
version: '0'
|
|
163
246
|
requirements: []
|
|
164
|
-
rubygems_version:
|
|
247
|
+
rubygems_version: 4.0.20
|
|
165
248
|
specification_version: 4
|
|
166
249
|
summary: State machines YARD plugin
|
|
167
250
|
test_files: []
|