state_machines-yard 0.0.1 → 0.3.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 +5 -5
- data/.github/workflows/ci.yml +32 -0
- data/.github/workflows/release.yml +18 -0
- data/.release-please-manifest.json +3 -0
- data/.rubocop.yml +38 -0
- data/CHANGELOG.md +44 -0
- data/Gemfile +13 -0
- data/LICENSE.txt +1 -1
- data/README.md +50 -1
- data/Rakefile +29 -0
- data/lib/state_machines/yard/description.rb +74 -0
- data/lib/state_machines/yard/handlers/base.rb +122 -21
- data/lib/state_machines/yard/handlers/callback.rb +96 -0
- data/lib/state_machines/yard/handlers/event.rb +20 -11
- data/lib/state_machines/yard/handlers/machine.rb +263 -241
- data/lib/state_machines/yard/handlers/requirements.rb +92 -0
- data/lib/state_machines/yard/handlers/state.rb +20 -11
- data/lib/state_machines/yard/handlers/transition.rb +26 -31
- data/lib/state_machines/yard/handlers.rb +4 -6
- 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 +15 -4
- data/release-please-config.json +11 -0
- data/state_machines-yard.gemspec +19 -11
- data/test/description_test.rb +99 -0
- data/test/handlers/base_test.rb +83 -0
- data/test/handlers/callback_test.rb +137 -0
- data/test/handlers/event_test.rb +97 -0
- data/test/handlers/guards_test.rb +180 -0
- data/test/handlers/machine_test.rb +156 -0
- data/test/handlers/review_test.rb +192 -0
- data/test/handlers/state_test.rb +73 -0
- data/test/handlers/transition_test.rb +142 -0
- data/test/integration_test.rb +163 -0
- data/test/templates_test.rb +95 -0
- data/test/test_helper.rb +51 -0
- metadata +146 -16
data/test/test_helper.rb
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'minitest/autorun'
|
|
4
|
+
require 'yard'
|
|
5
|
+
require 'state_machines'
|
|
6
|
+
require 'state_machines/yard'
|
|
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
|
|
13
|
+
require 'nokogiri'
|
|
14
|
+
require 'fileutils'
|
|
15
|
+
require 'tmpdir'
|
|
16
|
+
|
|
17
|
+
# Helper module for tests
|
|
18
|
+
module TestHelpers
|
|
19
|
+
# Create a temporary directory for YARD outputs
|
|
20
|
+
def setup_yard
|
|
21
|
+
@yard_dir = Dir.mktmpdir('state_machines-yard')
|
|
22
|
+
YARD::Registry.clear
|
|
23
|
+
# Register our handlers
|
|
24
|
+
YARD::Tags::Library.define_tag('State Machines', :state_machines)
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Parse the given code with YARD
|
|
28
|
+
def parse_code(code)
|
|
29
|
+
YARD.parse_string(code)
|
|
30
|
+
YARD::Registry.load
|
|
31
|
+
end
|
|
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
|
+
|
|
41
|
+
# Clean up after test
|
|
42
|
+
def cleanup_yard
|
|
43
|
+
FileUtils.rm_rf(@yard_dir)
|
|
44
|
+
YARD::Registry.clear
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# Helper method to check if registry object has attribute
|
|
48
|
+
def attribute?(obj, name)
|
|
49
|
+
obj.respond_to?(:[]) && !obj[name].nil?
|
|
50
|
+
end
|
|
51
|
+
end
|
metadata
CHANGED
|
@@ -1,18 +1,17 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: state_machines-yard
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0
|
|
4
|
+
version: 0.3.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Abdelkader Boudih
|
|
8
8
|
- Aaron Pfeifer
|
|
9
|
-
autorequire:
|
|
10
9
|
bindir: bin
|
|
11
10
|
cert_chain: []
|
|
12
|
-
date:
|
|
11
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
13
12
|
dependencies:
|
|
14
13
|
- !ruby/object:Gem::Dependency
|
|
15
|
-
name:
|
|
14
|
+
name: rdoc
|
|
16
15
|
requirement: !ruby/object:Gem::Requirement
|
|
17
16
|
requirements:
|
|
18
17
|
- - ">="
|
|
@@ -26,7 +25,35 @@ dependencies:
|
|
|
26
25
|
- !ruby/object:Gem::Version
|
|
27
26
|
version: '0'
|
|
28
27
|
- !ruby/object:Gem::Dependency
|
|
29
|
-
name: state_machines
|
|
28
|
+
name: state_machines
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - ">="
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: 0.303.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.303.0
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: state_machines-diagram
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - ">="
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: 0.3.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.3.0
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: yard
|
|
30
57
|
requirement: !ruby/object:Gem::Requirement
|
|
31
58
|
requirements:
|
|
32
59
|
- - ">="
|
|
@@ -45,16 +72,30 @@ dependencies:
|
|
|
45
72
|
requirements:
|
|
46
73
|
- - ">="
|
|
47
74
|
- !ruby/object:Gem::Version
|
|
48
|
-
version: '0'
|
|
75
|
+
version: '4.0'
|
|
49
76
|
type: :development
|
|
50
77
|
prerelease: false
|
|
51
78
|
version_requirements: !ruby/object:Gem::Requirement
|
|
52
79
|
requirements:
|
|
53
80
|
- - ">="
|
|
54
81
|
- !ruby/object:Gem::Version
|
|
55
|
-
version: '0'
|
|
82
|
+
version: '4.0'
|
|
56
83
|
- !ruby/object:Gem::Dependency
|
|
57
|
-
name:
|
|
84
|
+
name: minitest
|
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - "~>"
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: '6.0'
|
|
90
|
+
type: :development
|
|
91
|
+
prerelease: false
|
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
93
|
+
requirements:
|
|
94
|
+
- - "~>"
|
|
95
|
+
- !ruby/object:Gem::Version
|
|
96
|
+
version: '6.0'
|
|
97
|
+
- !ruby/object:Gem::Dependency
|
|
98
|
+
name: nokogiri
|
|
58
99
|
requirement: !ruby/object:Gem::Requirement
|
|
59
100
|
requirements:
|
|
60
101
|
- - ">="
|
|
@@ -67,6 +108,76 @@ dependencies:
|
|
|
67
108
|
- - ">="
|
|
68
109
|
- !ruby/object:Gem::Version
|
|
69
110
|
version: '0'
|
|
111
|
+
- !ruby/object:Gem::Dependency
|
|
112
|
+
name: rake
|
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
|
114
|
+
requirements:
|
|
115
|
+
- - "~>"
|
|
116
|
+
- !ruby/object:Gem::Version
|
|
117
|
+
version: '13.0'
|
|
118
|
+
type: :development
|
|
119
|
+
prerelease: false
|
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
121
|
+
requirements:
|
|
122
|
+
- - "~>"
|
|
123
|
+
- !ruby/object:Gem::Version
|
|
124
|
+
version: '13.0'
|
|
125
|
+
- !ruby/object:Gem::Dependency
|
|
126
|
+
name: rubocop
|
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
|
128
|
+
requirements:
|
|
129
|
+
- - "~>"
|
|
130
|
+
- !ruby/object:Gem::Version
|
|
131
|
+
version: '1.59'
|
|
132
|
+
type: :development
|
|
133
|
+
prerelease: false
|
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
135
|
+
requirements:
|
|
136
|
+
- - "~>"
|
|
137
|
+
- !ruby/object:Gem::Version
|
|
138
|
+
version: '1.59'
|
|
139
|
+
- !ruby/object:Gem::Dependency
|
|
140
|
+
name: rubocop-minitest
|
|
141
|
+
requirement: !ruby/object:Gem::Requirement
|
|
142
|
+
requirements:
|
|
143
|
+
- - "~>"
|
|
144
|
+
- !ruby/object:Gem::Version
|
|
145
|
+
version: '0.34'
|
|
146
|
+
type: :development
|
|
147
|
+
prerelease: false
|
|
148
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
149
|
+
requirements:
|
|
150
|
+
- - "~>"
|
|
151
|
+
- !ruby/object:Gem::Version
|
|
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'
|
|
70
181
|
description: State machines YARD plugin for automated documentation
|
|
71
182
|
email:
|
|
72
183
|
- terminale@gmail.com
|
|
@@ -74,28 +185,50 @@ executables: []
|
|
|
74
185
|
extensions: []
|
|
75
186
|
extra_rdoc_files: []
|
|
76
187
|
files:
|
|
188
|
+
- ".github/workflows/ci.yml"
|
|
189
|
+
- ".github/workflows/release.yml"
|
|
77
190
|
- ".gitignore"
|
|
191
|
+
- ".release-please-manifest.json"
|
|
192
|
+
- ".rubocop.yml"
|
|
193
|
+
- CHANGELOG.md
|
|
78
194
|
- Gemfile
|
|
79
195
|
- LICENSE.txt
|
|
80
196
|
- README.md
|
|
81
197
|
- Rakefile
|
|
82
198
|
- lib/state_machines/yard.rb
|
|
199
|
+
- lib/state_machines/yard/description.rb
|
|
83
200
|
- lib/state_machines/yard/handlers.rb
|
|
84
201
|
- lib/state_machines/yard/handlers/base.rb
|
|
202
|
+
- lib/state_machines/yard/handlers/callback.rb
|
|
85
203
|
- lib/state_machines/yard/handlers/event.rb
|
|
86
204
|
- lib/state_machines/yard/handlers/machine.rb
|
|
205
|
+
- lib/state_machines/yard/handlers/requirements.rb
|
|
87
206
|
- lib/state_machines/yard/handlers/state.rb
|
|
88
207
|
- lib/state_machines/yard/handlers/transition.rb
|
|
208
|
+
- lib/state_machines/yard/renderer.rb
|
|
89
209
|
- lib/state_machines/yard/templates.rb
|
|
90
210
|
- lib/state_machines/yard/templates/default/class/html/setup.rb
|
|
91
211
|
- lib/state_machines/yard/templates/default/class/html/state_machines.erb
|
|
92
212
|
- lib/state_machines/yard/version.rb
|
|
213
|
+
- release-please-config.json
|
|
93
214
|
- state_machines-yard.gemspec
|
|
94
|
-
|
|
215
|
+
- test/description_test.rb
|
|
216
|
+
- test/handlers/base_test.rb
|
|
217
|
+
- test/handlers/callback_test.rb
|
|
218
|
+
- test/handlers/event_test.rb
|
|
219
|
+
- test/handlers/guards_test.rb
|
|
220
|
+
- test/handlers/machine_test.rb
|
|
221
|
+
- test/handlers/review_test.rb
|
|
222
|
+
- test/handlers/state_test.rb
|
|
223
|
+
- test/handlers/transition_test.rb
|
|
224
|
+
- test/integration_test.rb
|
|
225
|
+
- test/templates_test.rb
|
|
226
|
+
- test/test_helper.rb
|
|
227
|
+
homepage: https://github.com/state-machines/state_machines-yard
|
|
95
228
|
licenses:
|
|
96
229
|
- MIT
|
|
97
|
-
metadata:
|
|
98
|
-
|
|
230
|
+
metadata:
|
|
231
|
+
rubygems_mfa_required: 'true'
|
|
99
232
|
rdoc_options: []
|
|
100
233
|
require_paths:
|
|
101
234
|
- lib
|
|
@@ -103,17 +236,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
103
236
|
requirements:
|
|
104
237
|
- - ">="
|
|
105
238
|
- !ruby/object:Gem::Version
|
|
106
|
-
version:
|
|
239
|
+
version: '4.0'
|
|
107
240
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
108
241
|
requirements:
|
|
109
242
|
- - ">="
|
|
110
243
|
- !ruby/object:Gem::Version
|
|
111
244
|
version: '0'
|
|
112
245
|
requirements: []
|
|
113
|
-
|
|
114
|
-
rubygems_version: 2.2.2
|
|
115
|
-
signing_key:
|
|
246
|
+
rubygems_version: 4.0.20
|
|
116
247
|
specification_version: 4
|
|
117
248
|
summary: State machines YARD plugin
|
|
118
249
|
test_files: []
|
|
119
|
-
has_rdoc:
|