asciidoctor-diagram 1.5.19 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: df890b150a6c0d6baf42b0064ddbc0456ef89dff
-  data.tar.gz: b25f7ca96e4cf5db0d4b319b0f93eded8a876503
+SHA256:
+  metadata.gz: d37e7e92d9ff0bcae6607a862a17d8d642a54ad482f896a671c698993c22ad18
+  data.tar.gz: 9da43fb78ccd16a79e341c662f0e6dae0fdb2edf4bd9697005f4321c8e518fe0
 SHA512:
-  metadata.gz: f555b3c805b2903356da1925b888f6d3165418334a8eea10438732fe81ef118cdf28f652e7f0cb77dd85995bd65382bb9e538c05cffa7d38f16f53b081ec475d
-  data.tar.gz: 3ba60e0ef78777920fd654f549488e87be57e87a215a34067574e6aeb04a5764070b4d23f7027ae681a65487c22694e3bbf3f9263ec3eeae2a7df3f1ccc221ed
+  metadata.gz: 5366ef0c9961283fa4df0dd1b59774237dfc78923160e705d739d856f7b8dd64dc0edd4b93bc7cc139e413481dd597a384b952e52483a36a672e3f47eed30e2f
+  data.tar.gz: b2828d5e8987b2f27f2c1c55a0bd80eae39b7c2015c09c9899cf5ad1ce0e264cef2af7782a402225ceea81027f65ef12480a8882af90e0dd4571e98fb1571c5c

data/CHANGELOG.adoc

@@ -1,5 +1,15 @@
 = Asciidoctor-diagram Changelog
 
+== 2.0.0
+
+Enhancements::
+  * Cleaned up internals of the extension
+  * Add support for BPMN (@gtudan)
+  * Update PlantUML to v1.2019.12
+  * #231 Improve PlantUML error reporting
+  * #247 Add support for document-level `diagram-svg-type` and block-level `svg-type` attributes to control SVG interactivity
+  * #250 Add support for Mermaid's `puppeteerConfig` option (@ldz-w)
+
 == 1.5.19
 
 Bug Fixes::

data/README.adoc

@@ -18,6 +18,7 @@ ifndef::env-site[:status:]
 :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-ditaa: http://ditaa.sourceforge.net/
 :uri-dot: https://graphviz.gitlab.io/_pages/doc/info/lang.html
 :uri-erd: https://github.com/BurntSushi/erd
@@ -121,6 +122,7 @@ The following diagram types and output formats are available:
 |{uri-a2s}[a2s]              |       |       |       |{check}|
 |{uri-actdiag}[actdiag]      |       |{check}|{check}|{check}|
 |{uri-blockdiag}[blockdiag]  |       |{check}|{check}|{check}|
+|{uri-bpmn}[bpmn]            |       |{check}|{check}|{check}|
 |{uri-ditaa}[ditaa]          |       |       |{check}|{check}|
 |{uri-erd}[erd]              |       |       |{check}|{check}|
 |{uri-gnuplot}[gnuplot]      |{check}|       |{check}|{check}|{check}
@@ -299,6 +301,7 @@ The following table lists the tools that are required for each diagram type, the
    |a2s          |{uri-a2s}[AsciiToSvg]                                                 |`a2s`
    |actdiag      |{uri-actdiag}[ActDiag]                                                |`actdiag`
    |blockdiag    |{uri-blockdiag}[BlockDiag]                                            |`blockdiag`
+   |bpmn         |{uri-bpmn}[bpmn-js-cmd]                                               |`bpmn`
    |ditaa        |{uri-java}[Java]                                                      |`java`
    |erd          |{uri-erd}[Erd]                                                        |`erd`
    |gnuplot      |{uri-gnuplot}[Gnuplot]                                                |`gnuplot`
@@ -383,6 +386,15 @@ The attribute name at the block level should be prefixed with the name of the di
 |fontpath     |unspecified     |The path to the font that should be used by blockdiag
 |===
 
+==== BPMN
+
+[cols=">,<,<",options="header"]
+|===
+|Name         |Default value   |Description
+|height       |786             |The target height of the diagram. Does not apply for output type `svg`.
+|width        |1024            |The target width of the diagram. Does not apply for output type `svg`.
+|===
+
 ==== Ditaa
 
 [cols=">,<,<",options="header"]
@@ -438,15 +450,16 @@ The attribute name at the block level should be prefixed with the name of the di
 
 [cols=">,<,<",options="header"]
 |===
-|Name          |Default value   |Description
-|background    |FFFFFF          |The background colour of the image. The format should be a six-digit hexadecimal number (as in HTML, FF0000 for red). Pass an eight-digit hex to define transparency.
-|css           |unspecified     |Path to a CSS file to pass to mermaid.
-|config        |unspecified     |Path to a JSON config file to pass to mermaid.
-|ganttconfig   |unspecified     |Path to a gantt config file to pass to mermaid.
-|sequenceconfig|unspecified     |Path to a sequence config file to pass to mermaid.
-|theme         |unspecified     |Theme of the chart, could be default, forest, dark or neutral.
-|width         |unspecified     |Width of the page.
-|height        |unspecified     |Height of the page.
+|Name            |Default value   |Description
+|background      |FFFFFF          |The background colour of the image. The format should be a six-digit hexadecimal number (as in HTML, FF0000 for red). Pass an eight-digit hex to define transparency.
+|css             |unspecified     |Path to a CSS file to pass to mermaid.
+|config          |unspecified     |Path to a JSON config file to pass to mermaid.
+|ganttConfig     |unspecified     |Path to a gantt config file to pass to mermaid.
+|puppeteerConfig |unspecified     |Path to a puppeteer config file to pass to mermaid.
+|sequenceConfig  |unspecified     |Path to a sequence config file to pass to mermaid.
+|theme           |unspecified     |Theme of the chart, could be default, forest, dark or neutral.
+|width           |unspecified     |Width of the page.
+|height          |unspecified     |Height of the page.
 |===
 
 ==== Msc

data/examples/features.adoc

@@ -160,5 +160,5 @@ Instead the name of the generated image is derived from the target propery of th
 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"]
-----
+plantuml::activity_diagram.txt[format="svg", align="center"]
+----

data/lib/asciidoctor-diagram.rb

@@ -1,5 +1,6 @@
 require_relative 'asciidoctor-diagram/a2s'
 require_relative 'asciidoctor-diagram/blockdiag'
+require_relative 'asciidoctor-diagram/bpmn'
 require_relative 'asciidoctor-diagram/ditaa'
 require_relative 'asciidoctor-diagram/erd'
 require_relative 'asciidoctor-diagram/gnuplot'

data/lib/asciidoctor-diagram/a2s/converter.rb

@@ -0,0 +1,55 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class AsciiToSvgConverter
+      include DiagramConverter
+      include CliGenerator
+
+      def supported_formats
+        [:svg]
+      end
+
+      def collect_options(source, name)
+        options = {}
+        options[:sx] = source.attr('scalex', nil, name)
+        options[:sy] = source.attr('scaley', nil, name)
+        options[:scale] = source.attr('scale', nil, name)
+        options[:noblur] = source.attr('noblur', nil, name) == 'true'
+        options[:font] = source.attr('fontfamily', nil, name)
+        options
+      end
+
+      def convert(source, format, options)
+        sx = options[:sx]
+        sy = options[:sy]
+        scale = options[:scale]
+        noblur = options[:noblur]
+        font = options[:font]
+
+        generate_stdin(source.find_command('a2s'), format.to_s, source.to_s) do |tool_path, output_path|
+          args = [tool_path, '-o', Platform.native_path(output_path)]
+
+          if sx && sy
+            args << '-s' << "#{sx},#{sy}"
+          elsif scale
+            args << '-s' << "#{scale},#{scale}"
+          end
+
+          if noblur
+            args << '-b'
+          end
+
+          if font
+            args << '-f' << font
+          end
+
+          args
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/a2s/extension.rb

@@ -1,60 +1,14 @@
-require_relative '../extensions'
-require_relative '../util/cli_generator'
-require_relative '../util/platform'
-require_relative '../util/which'
+require_relative 'converter'
+require_relative '../diagram_processor'
 
 module Asciidoctor
   module Diagram
-    # @private
-    module AsciiToSvg
-      include CliGenerator
-      include Which
-
-      def self.included(mod)
-        [:svg].each do |f|
-          mod.register_format(f, :image) do |parent, source|
-            a2s(parent, source, f)
-          end
-        end
-      end
-
-      def a2s(parent, source, format)
-        inherit_prefix = name
-
-        sx = source.attr('scalex', nil, inherit_prefix)
-        sy = source.attr('scaley', nil, inherit_prefix)
-        scale = source.attr('scale', nil, inherit_prefix)
-        noblur = source.attr('noblur', 'false', inherit_prefix) == 'true'
-        font = source.attr('fontfamily', nil, inherit_prefix)
-
-        generate_stdin(which(parent, 'a2s'), format.to_s, source.to_s) do |tool_path, output_path|
-          args = [tool_path, '-o', Platform.native_path(output_path)]
-
-          if sx && sy
-            args << '-s' << "#{sx},#{sy}"
-          elsif scale
-            args << '-s' << "#{scale},#{scale}"
-          end
-
-          if noblur
-            args << '-b'
-          end
-
-          if font
-            args << '-f' << font
-          end
-
-          args
-        end
-      end
-    end
-
-    class AsciiToSvgBlockProcessor < Extensions::DiagramBlockProcessor
-      include AsciiToSvg
+    class AsciiToSvgBlockProcessor < DiagramBlockProcessor
+      use_converter AsciiToSvgConverter
     end
 
-    class AsciiToSvgBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
-      include AsciiToSvg
+    class AsciiToSvgBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter AsciiToSvgConverter
     end
   end
 end

data/lib/asciidoctor-diagram/blockdiag/converter.rb

@@ -0,0 +1,37 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    ['BlockDiag', 'SeqDiag', 'ActDiag', 'NwDiag', 'RackDiag', 'PacketDiag'].each do |name|
+      converter = Class.new do
+        include DiagramConverter
+        include CliGenerator
+
+        def supported_formats
+          [:png, :pdf, :svg]
+        end
+
+        def convert(source, format, options)
+          # On Debian based systems the Python 3.x packages python3-(act|block|nw|seq)diag executables with
+          # a '3' suffix.
+          cmd_name = self.class.const_get(:TOOL)
+          alt_cmd_name = "#{cmd_name}3"
+
+          font_path = source.attr('fontpath', nil, cmd_name)
+
+          generate_stdin(source.find_command(cmd_name, :alt_cmds => [alt_cmd_name]), format.to_s, source.to_s) do |tool_path, output_path|
+            args = [tool_path, '-a', '-o', Platform.native_path(output_path), "-T#{format.to_s}"]
+            args << "-f#{Platform.native_path(font_path)}" if font_path
+            args << '-'
+            args
+          end
+        end
+      end
+      converter.const_set(:TOOL, name.downcase)
+
+      ::Asciidoctor::Diagram.const_set("#{name}Converter", converter)
+    end
+  end
+end

data/lib/asciidoctor-diagram/blockdiag/extension.rb

@@ -1,125 +1,18 @@
-require_relative '../extensions'
-require_relative '../util/cli_generator'
-require_relative '../util/platform'
-require_relative '../util/which'
+require_relative '../diagram_processor'
+require_relative 'converter'
 
 module Asciidoctor
   module Diagram
-    # @!parse
-    #   # Block processor converts blockdiag code into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class BlockDiagBlockProcessor < API::DiagramBlockProcessor; end
-    #
-    #   # Block macro processor converts blockdiag source files into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class BlockDiagBlockMacroProcessor < DiagramBlockMacroProcessor; end
-
-    # @!parse
-    #   # Block processor converts seqdiag code into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class SeqDiagBlockProcessor < API::DiagramBlockProcessor; end
-    #
-    #   # Block macro processor converts seqdiag source files into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class SeqDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
-
-    # @!parse
-    #   # Block processor converts actdiag code into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class ActDiagBlockProcessor < API::DiagramBlockProcessor; end
-    #
-    #   # Block macro processor converts actdiag source files into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class ActDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
-
-    # @!parse
-    #   # Block processor converts nwdiag code into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class NwDiagBlockProcessor < API::DiagramBlockProcessor; end
-    #
-    #   # Block macro processor converts nwdiag source files into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class NwDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
-
-    # @!parse
-    #   # Block processor converts rackdiag code into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class RackDiagBlockProcessor < API::DiagramBlockProcessor; end
-    #
-    #   # Block macro processor converts rackdiag source files into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class RackDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
-
-    # @!parse
-    #   # Block processor converts packetdiag code into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class PacketDiagBlockProcessor < API::DiagramBlockProcessor; end
-    #
-    #   # Block macro processor converts packetdiag source files into images.
-    #   #
-    #   # Supports PNG and SVG output.
-    #   class PacketDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
-
-    # @private
-    module BlockDiag
-      def self.define_processors(name)
-        init = Proc.new do
-          include ::Asciidoctor::Diagram::BlockDiag
-
-          [:png, :pdf, :svg].each do |f|
-            register_format(f, :image) do |p, c|
-              blockdiag(name, p, c, f)
-            end
-          end
-        end
-
-        block = Class.new(Extensions::DiagramBlockProcessor) do
-          self.instance_eval(&init)
-        end
-        ::Asciidoctor::Diagram.const_set("#{name}BlockProcessor", block)
-
-        block_macro = Class.new(Extensions::DiagramBlockMacroProcessor) do
-          self.instance_eval(&init)
-        end
-
-        ::Asciidoctor::Diagram.const_set("#{name}BlockMacroProcessor", block_macro)
+    ['BlockDiag', 'SeqDiag', 'ActDiag', 'NwDiag', 'RackDiag', 'PacketDiag'].each do |tool|
+      block = Class.new(DiagramBlockProcessor) do
+        use_converter ::Asciidoctor::Diagram.const_get("#{tool}Converter")
       end
+      ::Asciidoctor::Diagram.const_set("#{tool}BlockProcessor", block)
 
-      include CliGenerator
-      include Which
-
-      def blockdiag(tool, parent, source, format)
-        inherit_prefix = name
-        cmd_name = tool.downcase
-
-        # On Debian based systems the Python 3.x packages python3-(act|block|nw|seq)diag executables with
-        # a '3' suffix.
-        alt_cmd_name = "#{tool.downcase}3"
-
-        font_path = source.attr('fontpath', nil, inherit_prefix)
-
-        generate_stdin(which(parent, cmd_name, :alt_cmds => [alt_cmd_name]), format.to_s, source.to_s) do |tool_path, output_path|
-          args = [tool_path, '-a', '-o', Platform.native_path(output_path), "-T#{format.to_s}"]
-          args << "-f#{Platform.native_path(font_path)}" if font_path
-          args << '-'
-          args
-        end
+      block_macro = Class.new(DiagramBlockMacroProcessor) do
+        use_converter ::Asciidoctor::Diagram.const_get("#{tool}Converter")
       end
-    end
-
-    ['BlockDiag', 'SeqDiag', 'ActDiag', 'NwDiag', 'RackDiag', 'PacketDiag'].each do |tool|
-      BlockDiag.define_processors(tool)
+      ::Asciidoctor::Diagram.const_set("#{tool}BlockMacroProcessor", block_macro)
     end
   end
 end

data/lib/asciidoctor-diagram/bpmn.rb

@@ -0,0 +1,7 @@
+require 'asciidoctor/extensions'
+require_relative 'bpmn/extension'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::BpmnBlockProcessor, :bpmn
+  block_macro Asciidoctor::Diagram::BpmnBlockMacroProcessor, :bpmn
+end

data/lib/asciidoctor-diagram/bpmn/converter.rb

@@ -0,0 +1,62 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class BpmnConverter
+      include DiagramConverter
+      include CliGenerator
+
+
+      def supported_formats
+        [:png, :svg, :pdf, :jpeg]
+      end
+
+      def collect_options(source, name)
+        options = {}
+
+        options[:width] = source.attr('width', nil, name)
+        options[:height] = source.attr('height', nil, name)
+
+        options
+      end
+
+      def convert(source, format, options)
+        opts = {}
+
+        opts[:width] = options[:width]
+
+        bpmnjs = source.find_command('bpmn-js', :raise_on_error => false)
+        opts[:height] = options[:height]
+        opts[:theme] = options[:theme]
+        config = options[:config]
+        if config
+          opts[:config] = source.resolve_path(config)
+        end
+        run_bpmnjs(bpmnjs, source, format, opts)
+      end
+
+      private
+
+      def run_bpmnjs(bpmnjs, source, format, options = {})
+        generate_file(bpmnjs, 'bpmn', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+          args = [tool_path, Platform.native_path(input_path), '-o', Platform.native_path(output_path), '-t', format.to_s]
+
+
+          if options[:width]
+            args << '--width' << options[:width]
+          end
+
+          if options[:height]
+            args << '--height' << options[:height]
+          end
+
+          args
+        end
+      end
+    end
+  end
+end