asciidoctor-diagram 2.2.3 → 3.0.0

data/docs/modules/ROOT/partials/create_diagram.adoc

@@ -1,134 +0,0 @@
-== Creating a Diagram
-
-A diagram is written inside a literal block, which can accept several attributes.
-
-.Anatomy of a diagram
-----
-[diagram-type, target=output-file-name, format=output-format] // <1> <2> <3>
-.... // <4>
-Diagram in appropriate syntax
-....
-----
-<1> The first value in the attribute list specifies the diagram syntax that is being used.
-<2> The `target` attribute specifies the basename of the image file that will be generated. If this attribute is omitted an auto-generated name will be used instead.
-<3> The `format` attribute determines the output image format to use. If a format is not specified, the default output format for the chosen diagram type will be used.
-<4> Place the attribute list directly on top of the delimited literal block (+....+). You can also use an open block as an alternative (`--`).
-
-The following diagram types and output formats are available:
-
-:check: &#10003;
-
-[cols=">,5*^",options="header"]
-|===
-|Diagram Type                      |gif    |pdf    |png    |svg    |txt
-|{uri-a2s}[a2s]                    |       |       |       |{check}|
-|{uri-actdiag}[actdiag]            |       |{check}|{check}|{check}|
-|<<barcode,barcode>>               |       |       |{check}|       |{check}
-|{uri-blockdiag}[blockdiag]        |       |{check}|{check}|{check}|
-|{uri-bpmn}[bpmn]                  |       |{check}|{check}|{check}|
-|{uri-bytefield}[bytefield]        |       |       |       |{check}|
-|{uri-diagrams}[diagrams]          |       |{check}|{check}|{check}|
-|{uri-ditaa}[ditaa]                |       |       |{check}|{check}|
-|{uri-dpic}[dpic]                  |       |       |       |{check}|
-|{uri-erd}[erd]                    |       |       |{check}|{check}|
-|{uri-gnuplot}[gnuplot]            |{check}|       |{check}|{check}|{check}
-|{uri-dot}[graphviz]               |       |{check}|{check}|{check}|
-|<<meme,meme>>                     |{check}|       |{check}|       |
-|{uri-mermaid}[mermaid]            |       |{check}|{check}|{check}|
-|{uri-mscgen}[msc]                 |       |       |{check}|{check}|
-|{uri-nomnoml}[nomnoml]            |       |       |       |{check}|
-|{uri-nwdiag}[nwdiag]              |       |{check}|{check}|{check}|
-|{uri-packetdiag}[packetdiag]      |       |{check}|{check}|{check}|
-|{uri-pikchr}[pikchr]              |       |       |       |{check}|
-|{uri-plantuml}[plantuml]          |       |       |{check}|{check}|{check}
-|{uri-rackdiag}[rackdiag]          |       |{check}|{check}|{check}|
-|{uri-seqdiag}[seqdiag]            |       |{check}|{check}|{check}|
-|{uri-shaape}[shaape]              |       |       |{check}|{check}|
-|{uri-smcat}[smcat]                |       |       |       |{check}|
-|{uri-svgbob}[svgbob]              |       |       |       |{check}|
-|{uri-symbolator}[symbolator]      |       |{check}|{check}|{check}|
-|{uri-syntrax}[syntrax] (Syntrax)  |       |{check}|{check}|{check}|
-|{uri-jsyntrax}[syntrax] (JSyntrax)|       |       |{check}|{check}|
-|{uri-tikz}[tikz]                  |       |{check}|       |{check}|
-|{uri-umlet}[umlet]                |{check}|{check}|{check}|{check}|
-|{uri-vega}[vega]                  |       |       |{check}|{check}|
-|{uri-vegalite}[vegalite]          |       |       |{check}|{check}|
-|{uri-wavedrom}[wavedrom]          |       |       |{check}|{check}|
-|===
-
-:!check:
-
-The example below illustrates the structure of a basic ditaa block written directly in an AsciiDoc document.
-
-.Basic ditaa block
-[source]
-----
-[ditaa]
-....
-                   +-------------+
-                   | Asciidoctor |-------+
-                   |   diagram   |       |
-                   +-------------+       | PNG out
-                       ^                 |
-                       | ditaa in        |
-                       |                 v
- +--------+   +--------+----+    /---------------\
- |        | --+ Asciidoctor +--> |               |
- |  Text  |   +-------------+    |   Beautiful   |
- |Document|   |   !magic!   |    |    Output     |
- |     {d}|   |             |    |               |
- +---+----+   +-------------+    \---------------/
-     :                                   ^
-     |          Lots of work             |
-     +-----------------------------------+
-....
-----
-
-The ditaa block above results in the following diagram.
-
-.Rendered ditaa diagram
-image::asciidoctor-diagram-process.png[Asciidoctor Diagram process diagram,650,319]
-
-The rendered ditaa diagram above gets the file name `58372f7d2ceffae9e91fd0a7cbb080b6.png`.
-That long number is the checksum of the source code calculated by asciidoctor-diagram.
-If you want to give your image files a more meaningful name, fill in the `target` attribute.
-
-This can be done by either specifying it as the second positional attribute or as a named attribute.
-Both examples below would result in a file called `ditaa-diagram.png`.
-
-....
-[ditaa, target="ditaa-diagram"]
-----
-<snip>
-----
-
-[ditaa, "ditaa-diagram"]
-----
-<snip>
-----
-....
-
-
-The example below illustrates the structure of a basic PlantUML block written directly in an AsciiDoc document.
-
-.PlantUML Diagram Syntax
-[source]
-----
-[plantuml, target=diagram-classes, format=png] // <1> <2> <3>
-....
-class BlockProcessor
-class DiagramBlock
-class DitaaBlock
-class PlantUmlBlock
-
-BlockProcessor <|-- DiagramBlock
-DiagramBlock <|-- DitaaBlock
-DiagramBlock <|-- PlantUmlBlock
-....
-----
-<1> The diagram is written in PlantUML so the first positional attribute is assigned the `plantuml` diagram type.
-<2> The name of the diagram file is given by the `target` attribute.
-<3> The output format is specified using the `format` attribute
-
-.Rendered PlantUML diagram
-image::asciidoctor-diagram-classes.png[Asciidoctor Diagram classes diagram]

data/docs/modules/ROOT/partials/generate.adoc

@@ -1,15 +0,0 @@
-== Generating a Diagram from a Terminal
-
-You can load Asciidoctor diagram in a terminal using the `-r` flag.
-
- $ asciidoctor -r asciidoctor-diagram sample.adoc
-
-You can also use Asciidoctor diagram with other converters, such as Asciidoctor EPUB.
-Asciidoctor-epub3 is also loaded with the `-r` flag.
-
- $ asciidoctor -r asciidoctor-diagram -r asciidoctor-epub3 -b epub3 sample.adoc
-
-Or, you can invoke Asciidoctor and the EPUB converter with the `asciidoctor-epub3` command.
-The command implicitly sets the `-r` and `-b` flags for EPUB3 output.
-
- $ asciidoctor-epub3 -r asciidoctor-diagram sample.adoc

data/docs/modules/ROOT/partials/installation.adoc

@@ -1,19 +0,0 @@
-== Installation
-
-Asciidoctor Diagram is a RubyGem, which can be installed using the `gem` or `bundle` commands.
-
-You can install the Asciidoctor Diagram gem by typing `gem install` in the CLI.
-
- $ gem install asciidoctor-diagram
-
-by first adding the following entry to your project's [.path]_Gemfile_.
-
-.Gemfile
-[source,ruby]
-----
-gem 'asciidoctor-diagram'
-----
-
-Then execute `bundle` in the CLI.
-
- $ bundle

data/docs/modules/ROOT/partials/uris.adoc

@@ -1,41 +0,0 @@
-:uri-a2s: https://github.com/asciitosvg/asciitosvg
-:uri-actdiag: http://blockdiag.com/en/actdiag/index.html
-:uri-asciidoctor-api: http://asciidoctor.org/docs/user-manual/#api
-:uri-asciidoctor-extensions: http://asciidoctor.org/docs/user-manual/#extension-points
-:uri-blockdiag: http://blockdiag.com
-:uri-bpmn: https://github.com/gtudan/bpmn-js-cmd
-:uri-bytefield: https://github.com/Deep-Symmetry/bytefield-svg
-:uri-diagrams: https://diagrams.mingrammer.com
-:uri-ditaa: http://ditaa.sourceforge.net/
-:uri-dpic: https://gitlab.com/aplevich/dpic
-:uri-dot: https://graphviz.gitlab.io/_pages/doc/info/lang.html
-:uri-erd: https://github.com/BurntSushi/erd
-:uri-gnuplot: http://gnuplot.info
-:uri-graphviz: https://graphviz.gitlab.io
-:uri-imagemagick: http://www.imagemagick.org
-:uri-java: http://java.sun.com
-:uri-mermaid: https://github.com/mermaid-js/mermaid-cli
-:uri-mscgen: http://www.mcternan.me.uk/mscgen/
-:uri-nomnoml: http://nomnoml.com
-:uri-nwdiag: http://blockdiag.com/en/nwdiag/index.html
-:uri-packetdiag: http://blockdiag.com/en/nwdiag/index.html
-:uri-phantomjs: http://phantomjs.org
-:uri-pikchr: https://pikchr.org
-:uri-plantuml: http://plantuml.sourceforge.net
-:uri-py-plantuml: https://code.google.com/p/asciidoc-plantuml/
-:uri-python: https://www.python.org
-:uri-rackdiag: http://blockdiag.com/en/nwdiag/index.html
-:uri-seqdiag: http://blockdiag.com/en/seqdiag/index.html
-:uri-shaape: https://github.com/christiangoltz/shaape
-:uri-smcat: https://github.com/sverweij/state-machine-cat
-:uri-svgbob: https://github.com/ivanceras/svgbobrus
-:uri-symbolator: https://github.com/kevinpt/symbolator
-:uri-syntrax: https://kevinpt.github.io/syntrax/
-:uri-jsyntrax: https://atp-mipt.github.io/jsyntrax/
-:uri-tikz: https://github.com/pgf-tikz/pgf
-:uri-umlet: http://www.umlet.com/
-:uri-vega: https://vega.github.io/vega/
-:uri-vegalite: https://vega.github.io/vega-lite/
-:uri-wavedrom: http://wavedrom.com
-:uri-wavedromeditor: https://github.com/wavedrom/wavedrom.github.io/releases
-:uri-wavedromcli: https://github.com/wavedrom/cli

data/examples/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gem "asciidoctor-diagram", :path => ".."

data/examples/README.adoc

@@ -1,18 +0,0 @@
-= Asciidoctor-diagram Examples
-
-This directory contains a number of example files that illustrate how to use the asciidoctor-diagram extension.
-
-In order to build the examples correctly the asciidoctor-diagram extension should be loaded.
-This can be done using bundler by running
-
-----
-bundle exec asciidoctor -r asciidoctor-diagram <asciidoc file>
-----
-
-If you do not want to use bundler you can alternatively run
-
-----
-asciidoctor -r asciidoctor-diagram -I ../lib <asciidoc file>
-----
-
-This variant requires you to explicitly specify the load path from which asciidoctor-diagram can be loaded.

data/examples/design.adoc

@@ -1,78 +0,0 @@
-= The design of Asciidoctor-diagram
-
-This document explains the design of Asciidoctor-diagram using PlantUML syntax.
-A detailed explanation of the PlantUML syntax is out scope for this document.
-This can be found on the http://www.plantuml.com[PlantUML web site].
-
-Asciidoctor-diagram is a simple Asciidoctor extension that enables embedding of diagrams inside asciidoc documents using various plain text diagram syntaxes.
-The current version of Asciidoctor-diagram support the Ditaa, Graphviz DOT and PlantUML syntax.
-
-Asciidoctor-diagram enables a number of new block types using the Asciidoctor `BlockProcessor` extension API.
-
-The main logic of the diagram generation is provided by the `DiagramBlock` module.
-This includes the shared options for the various blocks, checksum calculation of the diagram source code, cache validation and attribute generation for the generated output blocks.
-The DiagramBlock module also provides a means to register diagram output formats.
-
-When registering an output format, the registering code must specify a number of control parameters.
-The first parameter is the format name which controls when the generator is activated.
-The generator that is registered first determines the default format for the block.
-The second parameter is the output type of the generator.
-This is either `:image` or `:literal`.
-This parameter controls what type of block the `DiagramBlock` code will generate.
-Finally, a block should be provided that generates the diagram and returns it as a String.
-When called these blocks will receive the diagram source code and the parent Block as arguments.
-
-The actual `BlockProcessor` implementations include the `DiagramBlock` module and the appropriate generator module.
-The remainder of the implementation consists of registering format.
-
-The diagram below illustrates the relationship between the various classes and modules.
-
-.Asciidoctor-diagram class diagram
-[plantuml, "classes", align="center"]
-----
-namespace asciidoctor.extensions {
-  class BlockProcessor
-}
-
-namespace asciidoctor.diagram {
-  asciidoctor.extensions.BlockProcessor <|-- DitaaBlock
-  class DitaaGenerator << (M,#FF7700) >>
-
-  asciidoctor.extensions.BlockProcessor <|-- GraphvizBlock
-  asciidoctor.extensions.BlockProcessor <|-- PlantUmlBlock
-  class PlantUmlGenerator << (M,#FF7700) >>
-
-  class DiagramBlock << (M,#FF7700) >>
-
-  DitaaBlock --|> DitaaGenerator
-  DitaaBlock --|> DiagramBlock
-  GraphvizBlock --|> PlantUmlGenerator
-  GraphvizBlock --|> DiagramBlock
-  PlantUmlBlock --|> PlantUmlGenerator
-  PlantUmlBlock --|> DiagramBlock
-}
-----
-
-When Asciidoctor process a document it will invoke the block processors at the appropriate moment.
-The sequence of method calls for a Ditaa block is shown below.
-
-.Processing a Ditaa block
-[plantuml, "processing", align="center"]
-----
-Lexer->DiagramBlock : process
-activate DiagramBlock #FFBBBB
-
-DiagramBlock -> DiagramBlock: create_image_block
-activate DiagramBlock #DarkSalmon
-
-DiagramBlock -> DiagramBlock: code_checksum
-
-DiagramBlock -> DitaaGenerator: ditaa
-activate DitaaGenerator
-DiagramBlock <-- DitaaGenerator: image as String
-deactivate DitaaGenerator
-deactivate DiagramBlock
-
-Lexer <-- DiagramBlock: generated Block
-deactivate DiagramBlock
-----

data/examples/features.adoc

@@ -1,189 +0,0 @@
-= Asciidoctor-diagram features
-
-This document explains the various features of asciidoctor-diagram blocks using ditaa diagrams as an example.
-
-== Simple diagrams
-
-To mark a block as a diagram the appropriate style should be applied. This can be either `ditaa`, `graphviz` or `plantuml`.
-These styles can be applied to literal, listing or open blocks.
-
-A basic ditaa listing can be written as follows:
-
----------
-[ditaa]
-----
-                   +-------------+
-                   | asciidoctor |-------+
-                   |  diagram    |       |
-                   +-------------+       | png out
-                       ^                 |
-                       | ditaa in        |
-                       |                 v
- +--------+   +--------+----+    /---------------\
- |        | --+ asciidoctor +--> |               |
- |  Text  |   +-------------+    |Beatiful output|
- |Document|   |   !magic!   |    |               |
- |     {d}|   |             |    |               |
- +---+----+   +-------------+    \---------------/
-     :                                   ^
-     |          Lots of work             |
-     +-----------------------------------+
-----
----------
-
-results in the following image.
-
-[ditaa]
-----
-                   +-------------+
-                   | asciidoctor |-------+
-                   |  diagram    |       |
-                   +-------------+       | png out
-                       ^                 |
-                       | ditaa in        |
-                       |                 v
- +--------+   +--------+----+    /---------------\
- |        | --+ asciidoctor +--> |               |
- |  Text  |   +-------------+    |Beatiful output|
- |Document|   |   !magic!   |    |               |
- |     {d}|   |             |    |               |
- +---+----+   +-------------+    \---------------/
-     :                                   ^
-     |          Lots of work             |
-     +-----------------------------------+
-----
-
-== Controlling the file name
-
-The image above gets the file name `58372f7d2ceffae9e91fd0a7cbb080b6.png`.
-That long number is the checksum of the source code that was calculated by asciidoctor-diagram.
-If you want to give your generated files a more meaningful name, simply fill in the `target` attribute.
-
-This can be done by either specifying it as the first positional attribute or as a named attribute.
-Both examples below would result in a file called `ditaa-diagram.png`.
-
----------
-[ditaa, "ditaa-diagram"]
-----
-<snip>
-----
-
-[ditaa, target="ditaa-diagram"]
-----
-<snip>
-----
----------
-
-== Choosing an output format
-
-By default images are generated in `PNG` format.
-This can be overridden by defining the `format` (or 2nd positional) attribute.
-The set of supported formats is diagram type dependent.
-`ditaa` only supports the `png` format.
-`graphviz` supports `png` and `svg`.
-`plantuml` supports `png`, `svg` and `txt`.
-
-The `txt` format is perhaps a bit non-obvious.
-This generates an ascii art version of the UML diagrams.
-
-The following Graphviz DOT script
-
----------
-[graphviz, "dot_example", "svg"]
-----
-graph ethane {
-     C_0 -- H_0 [type=s];
-     C_0 -- H_1 [type=s];
-     C_0 -- H_2 [type=s];
-     C_0 -- C_1 [type=s];
-     C_1 -- H_3 [type=s];
-     C_1 -- H_4 [type=s];
-     C_1 -- H_5 [type=s];
-}
-----
----------
-
-generates an SVG representation of an ethane molecule footnote:[From http://en.wikipedia.org/wiki/DOT_(graph_description_language)#A_simple_example]
-
-[graphviz, "dot_example", "svg"]
-----
-graph ethane {
-     C_0 -- H_0 [type=s];
-     C_0 -- H_1 [type=s];
-     C_0 -- H_2 [type=s];
-     C_0 -- C_1 [type=s];
-     C_1 -- H_3 [type=s];
-     C_1 -- H_4 [type=s];
-     C_1 -- H_5 [type=s];
-}
-----
-
-With https://github.com/Alwinator/graphviz-py[graphviz_py] you can also use variables and Python code to do calculations:
-
-[graphviz_py, "graphviz_py_example", "svg"]
-----
-graph python_graph {
-{{
-import math
-
-value = 0.5
-sin = math.sin(value)
-cos = math.cos(value)
-}}
-
-A [label="{{= value }}"];
-B [label="{{= sin }}"];
-C [label="{{= cos }}"];
-
-A -- B [headlabel="sin"];
-A -- C [headlabel="cos"];
-
-}
-----
-
-Don't forget to install graphviz-py as described https://github.com/Alwinator/graphviz-py#installation[here].
-
-== Using standard asciidoc features
-
-Any remaining other attributes that are specified on a diagram block are copied over to the generated block.
-This means you can use the regular http://asciidoctor.org/docs/user-manual/#put-images-in-their-place[asciidoc positioning attributes] to place the diagrams where you want to.
-
-Block titles and block ids can also be applied in the same way to diagram blocks.
-
-As an example, the following block
-
---------
-[[plan]]
-.My plan to conquer the world
-[plantuml, align="center"]
---------
-
-results in a block with the correct caption and id applied to it.
-
-[[plan]]
-.My plan to conquer the world
-[plantuml, "activity_diagram", "svg", align="center"]
-----
-(*) --> "Create an Asciidoctor extension"
-"Create an Asciidoctor extension" --> " ? "
-" ? " --> "Profits!"
-"Profits!" --> (*)
-----
-
-== Loading diagrams from external files
-
-Asciidoctor-diagram also supports the various diagram block in block macro form.
-These are macros of the form `<name>::<target>[<attrlist>]`.
-
-In asciidoctor-diagram the macro names are identical to the block styles: `ditaa`, `graphviz` and `plantuml`
-The target is the path to the file containing the diagram source code.
-When the target is a relative path it is resolved with respect to the location of the document being processed.
-The attribute list behaves mostly the same as with the block styles.
-The only difference is that the `target` attribute is not supported.
-Instead the name of the generated image is derived from the target propery of the macro.
-
-The previous example in block macro form would look something like this with the text from the block located in a file called `activity_diagram.txt` instead of inline in the document.
-
-----
-plantuml::activity_diagram.txt[format="svg", align="center"]
-----

data/spec/a2s_spec.rb

@@ -1,33 +0,0 @@
-require_relative 'test_helper'
-
-A2S_CODE = <<-eos
-                      .--.            .---.  .---. .---.  .---.    .---.  .---. 
-                      |  |   OS API   '---'  '---' '---'  '---'    '---'  '---' 
-                      v  |              |      |     |      |        |      |   
-             .-. .-. .-. |              v      v     |      v        |      v   
-         .-->'-' '-' '-' |            .------------. | .-----------. |  .-----. 
-         |     \\  |  /   |            | Filesystem | | | Scheduler | |  | MMU | 
-         |      v . v    |            '------------' | '-----------' |  '-----' 
-         '_______/ \\_____|                   |       |      |        |          
-                 \\ /                         v       |      |        v          
-                  |     ____              .----.     |      |    .---------.    
-                  '--> /___/              | IO |<----'      |    | Network |    
-                                          '----'            |    '---------'    
-                                             |              |         |         
-                                             v              v         v         
-                                      .---------------------------------------. 
-                                      |                  HAL                  | 
-                                      '---------------------------------------'
-eos
-
-describe Asciidoctor::Diagram::AsciiToSvgInlineMacroProcessor do
-  include_examples "inline_macro", :a2s, A2S_CODE, [:svg]
-end
-
-describe Asciidoctor::Diagram::AsciiToSvgBlockMacroProcessor do
-  include_examples "block_macro", :a2s, A2S_CODE, [:svg]
-end
-
-describe Asciidoctor::Diagram::AsciiToSvgBlockProcessor do
-  include_examples "block", :svgbob, A2S_CODE, [:svg]
-end