asciidoctor-diagram 1.2.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (126) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.adoc +262 -7
  3. data/README.adoc +463 -40
  4. data/README_zh-CN.adoc +336 -0
  5. data/Rakefile +3 -7
  6. data/examples/features.adoc +2 -2
  7. data/images/asciidoctor-diagram-classes.png +0 -0
  8. data/images/asciidoctor-diagram-process.png +0 -0
  9. data/lib/asciidoctor-diagram/a2s/converter.rb +55 -0
  10. data/lib/asciidoctor-diagram/a2s/extension.rb +14 -0
  11. data/lib/asciidoctor-diagram/a2s.rb +7 -0
  12. data/lib/asciidoctor-diagram/blockdiag/converter.rb +37 -0
  13. data/lib/asciidoctor-diagram/blockdiag/extension.rb +11 -11
  14. data/lib/asciidoctor-diagram/blockdiag.rb +5 -4
  15. data/lib/asciidoctor-diagram/bpmn/converter.rb +62 -0
  16. data/lib/asciidoctor-diagram/bpmn/extension.rb +14 -0
  17. data/lib/asciidoctor-diagram/bpmn.rb +7 -0
  18. data/lib/asciidoctor-diagram/diagram_converter.rb +19 -0
  19. data/lib/asciidoctor-diagram/diagram_processor.rb +320 -0
  20. data/lib/asciidoctor-diagram/diagram_source.rb +275 -0
  21. data/lib/asciidoctor-diagram/ditaa/converter.rb +86 -0
  22. data/lib/asciidoctor-diagram/ditaa/extension.rb +6 -28
  23. data/lib/asciidoctor-diagram/ditaa.rb +3 -4
  24. data/lib/asciidoctor-diagram/erd/converter.rb +31 -0
  25. data/lib/asciidoctor-diagram/erd/extension.rb +14 -0
  26. data/lib/asciidoctor-diagram/erd.rb +7 -0
  27. data/lib/asciidoctor-diagram/gnuplot/converter.rb +63 -0
  28. data/lib/asciidoctor-diagram/gnuplot/extension.rb +14 -0
  29. data/lib/asciidoctor-diagram/gnuplot.rb +7 -0
  30. data/lib/asciidoctor-diagram/graphviz/converter.rb +32 -0
  31. data/lib/asciidoctor-diagram/graphviz/extension.rb +8 -10
  32. data/lib/asciidoctor-diagram/graphviz.rb +3 -4
  33. data/lib/asciidoctor-diagram/http/server.rb +127 -0
  34. data/lib/asciidoctor-diagram/lilypond/converter.rb +54 -0
  35. data/lib/asciidoctor-diagram/lilypond/extension.rb +14 -0
  36. data/lib/asciidoctor-diagram/lilypond.rb +7 -0
  37. data/lib/asciidoctor-diagram/meme/converter.rb +122 -0
  38. data/lib/asciidoctor-diagram/meme/extension.rb +28 -0
  39. data/lib/asciidoctor-diagram/meme.rb +6 -0
  40. data/lib/asciidoctor-diagram/mermaid/converter.rb +178 -0
  41. data/lib/asciidoctor-diagram/mermaid/extension.rb +14 -0
  42. data/lib/asciidoctor-diagram/mermaid.rb +7 -0
  43. data/lib/asciidoctor-diagram/msc/converter.rb +35 -0
  44. data/lib/asciidoctor-diagram/msc/extension.rb +14 -0
  45. data/lib/asciidoctor-diagram/msc.rb +7 -0
  46. data/lib/asciidoctor-diagram/nomnoml/converter.rb +25 -0
  47. data/lib/asciidoctor-diagram/nomnoml/extension.rb +14 -0
  48. data/lib/asciidoctor-diagram/nomnoml.rb +7 -0
  49. data/lib/asciidoctor-diagram/plantuml/converter.rb +115 -0
  50. data/lib/asciidoctor-diagram/plantuml/extension.rb +14 -20
  51. data/lib/asciidoctor-diagram/plantuml.rb +3 -5
  52. data/lib/asciidoctor-diagram/salt.rb +7 -0
  53. data/lib/asciidoctor-diagram/shaape/converter.rb +25 -0
  54. data/lib/asciidoctor-diagram/shaape/extension.rb +9 -11
  55. data/lib/asciidoctor-diagram/shaape.rb +3 -5
  56. data/lib/asciidoctor-diagram/smcat/converter.rb +44 -0
  57. data/lib/asciidoctor-diagram/smcat/extension.rb +14 -0
  58. data/lib/asciidoctor-diagram/smcat.rb +7 -0
  59. data/lib/asciidoctor-diagram/svgbob/converter.rb +25 -0
  60. data/lib/asciidoctor-diagram/svgbob/extension.rb +14 -0
  61. data/lib/asciidoctor-diagram/svgbob.rb +7 -0
  62. data/lib/asciidoctor-diagram/syntrax/converter.rb +55 -0
  63. data/lib/asciidoctor-diagram/syntrax/extension.rb +14 -0
  64. data/lib/asciidoctor-diagram/syntrax.rb +7 -0
  65. data/lib/asciidoctor-diagram/tikz/converter.rb +56 -0
  66. data/lib/asciidoctor-diagram/tikz/extension.rb +14 -0
  67. data/lib/asciidoctor-diagram/tikz.rb +7 -0
  68. data/lib/asciidoctor-diagram/umlet/converter.rb +24 -0
  69. data/lib/asciidoctor-diagram/umlet/extension.rb +14 -0
  70. data/lib/asciidoctor-diagram/umlet.rb +7 -0
  71. data/lib/asciidoctor-diagram/util/binaryio.rb +20 -0
  72. data/lib/asciidoctor-diagram/util/cli.rb +81 -0
  73. data/lib/asciidoctor-diagram/util/cli_generator.rb +73 -22
  74. data/lib/asciidoctor-diagram/util/gif.rb +21 -0
  75. data/lib/asciidoctor-diagram/util/java.rb +95 -1
  76. data/lib/asciidoctor-diagram/util/java_jruby.rb +14 -20
  77. data/lib/asciidoctor-diagram/util/java_socket.rb +175 -0
  78. data/lib/asciidoctor-diagram/util/pdf.rb +10 -0
  79. data/lib/asciidoctor-diagram/util/platform.rb +97 -0
  80. data/lib/asciidoctor-diagram/util/png.rb +1 -0
  81. data/lib/asciidoctor-diagram/util/svg.rb +4 -3
  82. data/lib/asciidoctor-diagram/util/which.rb +15 -9
  83. data/lib/asciidoctor-diagram/vega/converter.rb +47 -0
  84. data/lib/asciidoctor-diagram/vega/extension.rb +14 -0
  85. data/lib/asciidoctor-diagram/vega.rb +10 -0
  86. data/lib/asciidoctor-diagram/version.rb +1 -1
  87. data/lib/asciidoctor-diagram/wavedrom/converter.rb +50 -0
  88. data/lib/asciidoctor-diagram/wavedrom/extension.rb +14 -0
  89. data/lib/asciidoctor-diagram/wavedrom.rb +7 -0
  90. data/lib/asciidoctor-diagram.rb +22 -5
  91. data/lib/batik-all-1.10.jar +0 -0
  92. data/lib/ditaa-1.3.14.jar +0 -0
  93. data/lib/ditaamini-0.12.jar +0 -0
  94. data/lib/jlatexmath-minimal-1.0.5.jar +0 -0
  95. data/lib/plantuml-1.3.14.jar +0 -0
  96. data/lib/plantuml.jar +0 -0
  97. data/lib/server-1.3.14.jar +0 -0
  98. data/spec/a2s_spec.rb +167 -0
  99. data/spec/blockdiag_spec.rb +55 -24
  100. data/spec/bpmn-example.xml +44 -0
  101. data/spec/bpmn_spec.rb +96 -0
  102. data/spec/ditaa_spec.rb +150 -15
  103. data/spec/erd_spec.rb +289 -0
  104. data/spec/gnuplot_spec.rb +478 -0
  105. data/spec/graphviz_spec.rb +20 -20
  106. data/spec/lilypond_spec.rb +151 -0
  107. data/spec/man.jpg +0 -0
  108. data/spec/meme_spec.rb +67 -0
  109. data/spec/mermaid_spec.rb +336 -0
  110. data/spec/msc_spec.rb +230 -0
  111. data/spec/nomnoml_spec.rb +170 -0
  112. data/spec/plantuml_spec.rb +895 -54
  113. data/spec/shaape_spec.rb +25 -24
  114. data/spec/smcat_spec.rb +164 -0
  115. data/spec/svgbob_spec.rb +167 -0
  116. data/spec/syntrax_spec.rb +228 -0
  117. data/spec/test_helper.rb +88 -9
  118. data/spec/tikz_spec.rb +127 -0
  119. data/spec/umlet_spec.rb +85 -0
  120. data/spec/vega_spec.rb +241 -0
  121. data/spec/wavedrom_spec.rb +214 -0
  122. metadata +130 -35
  123. data/lib/asciidoctor-diagram/plantuml/generator.rb +0 -46
  124. data/lib/asciidoctor-diagram/util/diagram.rb +0 -220
  125. data/lib/asciidoctor-diagram/util/java_rjb.rb +0 -90
  126. data/lib/ditaamini0_9.jar +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 74838c060f09bcfe7603faef3aeee8c075cecaec
4
- data.tar.gz: cb315faf5b140f071a6f7a0fdb748e366d5eefae
2
+ SHA256:
3
+ metadata.gz: d37e7e92d9ff0bcae6607a862a17d8d642a54ad482f896a671c698993c22ad18
4
+ data.tar.gz: 9da43fb78ccd16a79e341c662f0e6dae0fdb2edf4bd9697005f4321c8e518fe0
5
5
  SHA512:
6
- metadata.gz: 131fb3f8a3cecb232601c72424240c284996bfeef9a66c64bc3d88c6e0a1aab48299c2baa5935d1d3ed54ceca85b912716ae10dea48c21950ce6d5ff3b76f960
7
- data.tar.gz: 4d096215c18e27b7fdfbb4bccd131c6e94699c9fb572c1f5f00e9df196a2c0d81390dd84c70dfbef3153a9cfe8d7c3598fd15f6f14d53979b93fe44130f82589
6
+ metadata.gz: 5366ef0c9961283fa4df0dd1b59774237dfc78923160e705d739d856f7b8dd64dc0edd4b93bc7cc139e413481dd597a384b952e52483a36a672e3f47eed30e2f
7
+ data.tar.gz: b2828d5e8987b2f27f2c1c55a0bd80eae39b7c2015c09c9899cf5ad1ce0e264cef2af7782a402225ceea81027f65ef12480a8882af90e0dd4571e98fb1571c5c
data/CHANGELOG.adoc CHANGED
@@ -1,5 +1,262 @@
1
1
  = Asciidoctor-diagram Changelog
2
2
 
3
+ == 2.0.0
4
+
5
+ Enhancements::
6
+ * Cleaned up internals of the extension
7
+ * Add support for BPMN (@gtudan)
8
+ * Update PlantUML to v1.2019.12
9
+ * #231 Improve PlantUML error reporting
10
+ * #247 Add support for document-level `diagram-svg-type` and block-level `svg-type` attributes to control SVG interactivity
11
+ * #250 Add support for Mermaid's `puppeteerConfig` option (@ldz-w)
12
+
13
+ == 1.5.19
14
+
15
+ Bug Fixes::
16
+ * Issue #233: Resolve character encoding issues with Ditaa on Windows with Java runtimes that do not use UTF-8 encoding by default
17
+ * Fix generation of SVG output for TikZ diagrams (@joelsmith)
18
+ * Improve TikZ image cropping (@joelsmith)
19
+
20
+ Enhancements::
21
+ * Issue #225: Add support for WaveDrom CLI 2.0.0
22
+ * Issue #234: Add support for State Machine Cat
23
+ * Add support for gnuplot (@MariuszCwikla)
24
+
25
+ == 1.5.18
26
+
27
+ Bug Fixes::
28
+
29
+ * Issue #224: Fix asciidoctor 1.5.x compatibility regression introduced in 1.5.17
30
+
31
+ == 1.5.17
32
+
33
+ Enhancements::
34
+ * Issue #173: Apply path resolution to PlantUML `!includesub` directives
35
+ * Issue #222: Update PlantUML to 1.2019.6
36
+ * Issue #223: Log diagram processing errors using Asciidoctor logging infrastructure
37
+
38
+ == 1.5.16
39
+
40
+ Enhancements::
41
+ * Issue #219: Fix compatibility issue with Asciidoctor 2.0
42
+
43
+ == 1.5.15
44
+
45
+ Enhancements::
46
+ * Issue #217: Relax dependency version constraint to support Asciidoctor 2.x
47
+
48
+ == 1.5.14
49
+
50
+ Enhancements::
51
+ * Add support for Nomnoml (@Mogztter)
52
+ * Use system HTTP(S) proxies in java subprocess (@hakandilek)
53
+ * Issue #214: Improve extension loading performance
54
+
55
+ == 1.5.13
56
+
57
+ Bug Fixes::
58
+
59
+ * Issue #212: Fix regression introduced by fix for #201 in 1.5.12
60
+
61
+ == 1.5.12
62
+
63
+ Bug Fixes::
64
+
65
+ * Issue #201: Respect `destination-dir` CLI flag for diagrams embedded in tables
66
+ * Issue #203: Update Batik to 1.10
67
+ * Issue #205: Resolve errors when executing CLI commands using certain versions of JRuby.
68
+ * Update PlantUML to 2018.13
69
+
70
+ == 1.5.11
71
+
72
+ Enhancements::
73
+
74
+ * Issue #198: Simplify usage of asciidoctor-diagram in combination with the `data-uri` attribute
75
+
76
+ == 1.5.10
77
+
78
+ Bug Fixes::
79
+
80
+ * Issue #186: Avoid preprocessing of PlantUML stdlib !includes (@habamax)
81
+ * Issue #193: Update PlantUML to 2018.10
82
+ * Issue #194: Silence unitialized instance variable warning when using JRuby
83
+
84
+ == 1.5.9
85
+
86
+ Enhancements::
87
+
88
+ * Add support for ASCIIToSVG
89
+ * Issue #181: Add support for Vega and Vega-Lite
90
+
91
+ == 1.5.8
92
+
93
+ Enhancements::
94
+
95
+ * Issue #163: Add support for Mermaid.CLI
96
+ * Update PlantUML to revision 2018.1
97
+ * Add initial SVG support for Ditaa
98
+
99
+ Bug Fixes::
100
+
101
+ * Issue #159: Resolve classloading issue in JRuby (@robertpanzer)
102
+ * Issue #177: Resolve unused variable warning in svgbob integratin
103
+
104
+ == 1.5.7
105
+
106
+ Enhancements::
107
+
108
+ * Update PlantUML to revision 2017.20
109
+ * Add support for Syntrax `--title` argument via the `heading` attribute (@vinipsmaker)
110
+
111
+ Bug Fixes::
112
+
113
+ * Issue #173: Block macro targets are now correctly resolved against the document base directory.
114
+
115
+ == 1.5.6
116
+
117
+ Enhancements::
118
+
119
+ * Issue #167: Add support for Msc diagrams
120
+ * Issue #170: Add support for Syntrax diagrams
121
+ * Add support for SvgBob diagrams
122
+ * The output format can now be configured globally per diagram type using a document attribute with the name `<diagram_type>-format`.
123
+ As an example to generate all plantuml diagrams as SVG set the attribute `plantuml-format` to `svg` in your document header or via the command line.
124
+
125
+ Bug Fixes::
126
+
127
+ * Issue #164: Restore numbered captions for diagrams when using asciidoctor >= 1.5.6
128
+
129
+ == 1.5.5
130
+
131
+ Enhancements::
132
+
133
+ * Update PlantUML to revision 2017.15
134
+ * Issue #147: Add support for PlantUML SVG output (@puffybsd)
135
+
136
+ Bug Fixes::
137
+
138
+ * Issue #145: Incremental runs on documents containing meme diagrams would fail
139
+ * Issue #150: Resolve Ditaa character encoding issues
140
+ * Avoid error when the `PATH` environment variable is not defined (@BrentDouglas)
141
+
142
+ == 1.5.4.1
143
+
144
+ Enhancements::
145
+
146
+ * Resolve compatibility issues with Asciidoctor 1.5.6 (@robertpanzer, @mojavelinux)
147
+
148
+ == 1.5.4
149
+
150
+ Enhancements::
151
+
152
+ * Add support for UMLet (@basejumpa)
153
+ * Issue #141: Allow blockdiag fontpath to be specified via attributes (@bithium)
154
+
155
+ Bug Fixes::
156
+
157
+ * Issue #140: Restore PNG as default format for Graphviz diagrams
158
+
159
+ == 1.5.3
160
+
161
+ Enhancements::
162
+
163
+ * Issue #124: Improve compatibility with Cygwin
164
+ * Issue #133: Support substitutions in block macro target attribute
165
+ * Issue #135: Add support for PDF output for blockdiag and graphviz.
166
+ * Update PlantUML to revision 8053 (21/12/2016)
167
+
168
+ Bug Fixes::
169
+
170
+ * Resolve error when using WaveDromEditor.app on macOS
171
+
172
+ == 1.5.2
173
+
174
+ Enhancements::
175
+
176
+ * Apply anti-aliasing to blockdiag generated images (@bithium)
177
+ * Issue #118: Add support for Erd.
178
+
179
+ Bug Fixes::
180
+
181
+ * Issue #125: Use correct path separator when running under Cygwin.
182
+ * Issue #127: Resolved Ruby warnings when running in verbose mode.
183
+
184
+ == 1.5.1
185
+
186
+ Bug Fixes::
187
+
188
+ * Issue #119: Fixed an issue where 'unresolved constant' errors could occur when using PlantUML diagrams.
189
+
190
+ == 1.5.0
191
+
192
+ Enhancements::
193
+
194
+ * Issue #98: Automatically detect Actdiag, Blockdiag, Nwdiag and Seqdiag executables from Python 3.x Debian packages.
195
+ * Issue #100: Support specifying the layout engine for `dot` (`-K<engine>`) using the `layout` attribute on `graphviz` blocks.
196
+ * Issue #102: Generate cache files in `asciidoctor/diagram` to avoid cluttering the output directory.
197
+ * Issue #105: Support substitutions in diagram blocks.
198
+ * Issue #107: Improve error reporting when Mermaid diagram generation fails.
199
+ * Issue #112: Update PlantUML to revision 8043 (19/06/2016)
200
+ * Issue #114: Asciidoctor Diagram now requires Asciidoctor if it hasn't been loaded already.
201
+ * Issue #116: Resolve relative paths in PlantUML !include directives
202
+ * Add Chinese README translation (@diguage)
203
+
204
+ == 1.4.0
205
+
206
+ Enhancements::
207
+
208
+ * Use wavedrom-cli when available
209
+ * Add meme generator
210
+
211
+ Bug Fixes::
212
+
213
+ * Issue #71: Don't fail early for PlantUML diagrams if `dot` can't be found. PlantUML doesn't need it for all diagrams
214
+ types so invoke PlantUML without specifying the location of `dot` and let PlantUML produce an error when necessary.
215
+ * Issue #85: Support target attribute values containing one or more directory names.
216
+
217
+ == 1.3.2
218
+
219
+ Enhancements::
220
+
221
+ * Add support for WaveDrom diagrams (requires WaveDrom Editor to be installed separately)
222
+ * Allow error handling to be controlled using the `diagram-on-error` attribute.
223
+ Setting this attribute to `log` (default) logs an error message and continues processing of the document.
224
+ Setting it to `abort` triggers an exception and aborts document processing.
225
+ * Resolve relative image references in PlantUML diagrams to absolute ones up front to ensure PlantUML can locate the images
226
+
227
+ Bug Fixes::
228
+
229
+ * Issue #83: Omit stack trace information from error message that gets embedded in the output document
230
+ * Issue #84: Restore support for specifying the location of the `dot` executable using the `graphvizdot` attribute
231
+ * Avoid deprecation warnings with JRuby 9000 (@robertpanzer)
232
+
233
+ == 1.3.1
234
+
235
+ Bug Fixes::
236
+
237
+ * Issue #78: Resolve Java launch issues when running in a Cygwin environment (@chanibal)
238
+
239
+ == 1.3.0
240
+
241
+ Enhancements::
242
+
243
+ * Introduces a documented, public extension API
244
+ * Add support for Actdiag diagrams (requires Actdiag to be installed separately)
245
+ * Add support for Seqdiag diagrams (requires Seqdiag to be installed separately)
246
+ * Add support for Nwdiag diagrams (requires Nwdiag to be installed separately)
247
+ * Add support for Salt UI diagrams (issue #66)
248
+ * Updated PlantUML to revision 8028 (10/07/2015)
249
+ * Remove dependency on RJB to simplify installation (issue #48)
250
+ * Add diagram scaling support using the scale attribute (issue #58)
251
+ * Add Ditaa command line option support using the options attribute (issue #69)
252
+ * Add extra usage instructions to README (@nearnshaw)
253
+
254
+ Bug Fixes::
255
+
256
+ * Issue #49: Resolve issue that made Java 6 installation prompt appear on Mac OS X
257
+ * Issue #51: Resolved issue where PNG files generated by Graphviz were not processed correctly on Windows
258
+ * Fix caching issue on Travis CI (@j-manu)
259
+
3
260
  == 1.2.0
4
261
 
5
262
  Enhancements::
@@ -10,23 +267,21 @@ Enhancements::
10
267
 
11
268
  Enhancements::
12
269
 
13
- * Updated PlantUML to revision 8002 (23/07U/2014)
270
+ * Updated PlantUML to revision 8002 (23/07/2014)
14
271
  * Add support for Shaape diagrams (requires Shaape to be installed separately)
15
272
  * Add support for Blockdiag diagrams (requires Blockdiag to be installed separately)
16
- * Add support for Actdiag diagrams (requires Actdiag to be installed separately)
17
- * Add support for Seqdiag diagrams (requires Seqdiag to be installed separately)
18
- * Add support for Nwdiag diagrams (requires Nwdiag to be installed separately)
19
273
 
20
274
  Bug Fixes::
275
+
21
276
  * Issue #38: Resolved Graphviz syntax errors with certain diagrams
22
277
 
23
278
  == 1.1.5
24
279
 
25
280
  Enhancements::
26
281
 
27
- * Use the output directory (outdir attribute) as base directory if it's specified.
282
+ * Use the output directory (outdir attribute) as base directory if it's specified. (@neher)
28
283
  * Do not auto-generate width/height attributes when outputting to a non-HTML backend. This resolves issues with
29
- oversized images in docbook output.
284
+ oversized images in docbook output. (@neher)
30
285
 
31
286
  == 1.1.4
32
287
 
@@ -74,4 +329,4 @@ Bug Fixes::
74
329
  Initial release::
75
330
 
76
331
  * Provides Asciidoctor extension for `ditaa` and `plantuml` blocks
77
- * PlantUML skin parameters can be injected from an external file using the `plantumlconfig` document attribute
332
+ * PlantUML skin parameters can be injected from an external file using the `plantumlconfig` document attribute