asciidoctor-diagram 1.5.5 → 1.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65e470f480837be7f630896e91d0c61368b8a2f5
-  data.tar.gz: 0c674e665f3f412f2181cde62163d116efbfc7de
+  metadata.gz: 320af9d1c2acc687468d82b303007b9a76ed6077
+  data.tar.gz: df304c796960d919f5e8e67978c374d9aa0d9d5d
 SHA512:
-  metadata.gz: 487247e3185db46d245f2c7e78c43524ed4da61a200e92a2b9984ecab45bbf6db2eee009cc3b66239941af4bc3142944e97ca0ff4daad189966f31ab5a78b39e
-  data.tar.gz: 92dfed70c63edf7436f4af7f1ec3b6bdb9e797fcfc953d2d74409cb8d70ed071b104e2bfdd9d597c8f004230f800120bc0ce3cc01f0eeb310ab3af14793db048
+  metadata.gz: afeab72e6cf3da5d2c0170ab2dad7bed50a0d87225ecc3ebdb72b03b46b036ccc1df320152241fb4f4b07a6cf09fb5bdc16061c1f4cdafd971bad16bc81784b3
+  data.tar.gz: 8748508ed16e390815b3f957a559c553f16a2505c8951e5f5dc21af06e15af87034e7529c0bf25a66b08992c10ef0d0b7d0503bc8b55f0c39645c526ca5d390b

data/CHANGELOG.adoc

@@ -1,6 +1,18 @@
 = Asciidoctor-diagram Changelog
 
-== Development
+== 1.5.6
+
+Enhancements::
+
+  * Issue #167: Add support for Msc diagrams
+  * Issue #170: Add support for Syntrax diagrams
+  * Add support for SvgBob diagrams
+  * The output format can now be configured globally per diagram type using a document attribute with the name `<diagram_type>-format`.
+    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.
+
+Bug Fixes::
+
+  * Issue #164: Restore numbered captions for diagrams when using asciidoctor >= 1.5.6
 
 == 1.5.5
 
@@ -8,14 +20,19 @@ Enhancements::
 
   * Update PlantUML to revision 2017.15
   * Issue #147: Add support for PlantUML SVG output (@puffybsd)
-  * Resolve compatibility issues with Asciidoctor 1.5.6 (@robertpanzer, @mojavelinux)
-
+  
 Bug Fixes::
 
   * Issue #145: Incremental runs on documents containing meme diagrams would fail
   * Issue #150: Resolve Ditaa character encoding issues
   * Avoid error when the `PATH` environment variable is not defined (@BrentDouglas)
 
+== 1.5.4.1
+
+Enhancements::
+
+  * Resolve compatibility issues with Asciidoctor 1.5.6 (@robertpanzer, @mojavelinux)
+
 == 1.5.4
 
 Enhancements::

data/README.adoc

@@ -24,6 +24,7 @@ ifndef::env-site[:status:]
 :uri-imagemagick: http://www.imagemagick.org
 :uri-java: http://java.sun.com
 :uri-mermaid: http://knsv.github.io/mermaid/
+:uri-mscgen: http://www.mcternan.me.uk/mscgen/
 :uri-nwdiag: http://blockdiag.com/en/nwdiag/index.html
 :uri-packetdiag: http://blockdiag.com/en/nwdiag/index.html
 :uri-phantomjs: http://phantomjs.org
@@ -32,6 +33,8 @@ ifndef::env-site[:status:]
 :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-svgbob: https://github.com/ivanceras/svgbobrus
+:uri-syntrax: https://kevinpt.github.io/syntrax/
 :uri-umlet: http://www.umlet.com/
 :uri-wavedrom: http://wavedrom.com
 :uri-wavedromeditor: https://github.com/wavedrom/wavedrom.github.io/releases
@@ -39,7 +42,7 @@ ifndef::env-site[:status:]
 
 Asciidoctor Diagram is a set of Asciidoctor extensions that enable you to add diagrams, which you describe using plain text, to your AsciiDoc document.
 
-The extensions support BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag), Ditaa, GraphViz, Mermaid, PlantUML, Shaape and WaveDrom syntax.
+The extensions supports the BlockDiag ({uri-blockdiag}[BlockDiag], {uri-seqdiag}[SeqDiag], {uri-actdiag}[ActDiag], {uri-nwdiag}[NwDiag]), {uri-ditaa}[Ditaa], {uri-erd}[Erd], {uri-dot}[GraphViz], {uri-mermaid}[Mermaid], {uri-mscgen}[Msc], {uri-plantuml}[PlantUML], {uri-shaape}[Shaape], {uri-svgbob}[SvgBob], {uri-syntrax}[Syntrax], {uri-umlet}[UMLet] and {uri-wavedrom}[WaveDrom] syntax.
 
 Each extension runs the diagram processor to generate an SVG, PNG, or TXT file from the input text.
 The generated file is then inserted into your converted document.
@@ -114,12 +117,15 @@ The following diagram types and output formats are available:
 |{uri-dot}[graphviz]         |       |{check}|{check}|{check}|
 |<<meme,meme>>               |{check}|       |{check}|       |
 |{uri-mermaid}[mermaid]      |       |       |{check}|{check}|
+|{uri-mscgen}[msc]           |       |       |{check}|{check}|
 |{uri-nwdiag}[nwdiag]        |       |{check}|{check}|{check}|
 |{uri-packetdiag}[packetdiag]|       |{check}|{check}|{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-svgbob}[svgbob]        |       |       |       |{check}|
+|{uri-syntrax}[syntrax]      |       |{check}|{check}|{check}|
 |{uri-umlet}[umlet]          |{check}|{check}|{check}|{check}|
 |{uri-wavedrom}[wavedrom]    |       |       |{check}|{check}|
 |===
@@ -233,7 +239,7 @@ or load and register each extension individually.
 require 'asciidoctor-diagram/<extension_name>'
 ----
 
-`<extension_name>` can be one of `blockdiag`, `ditaa`, `erd`, `graphviz`, `meme`, `mermaid`, `plantuml`, `shaape`, or `wavedrom`.
+`<extension_name>` can be one of `blockdiag`, `ditaa`, `erd`, `graphviz`, `meme`, `mermaid`, `msc`, `plantuml`, `shaape`, `svgbob`, `syntrax`, or `wavedrom`.
 
 Requiring one or more of these files will automatically register the extensions for all processed documents.
 
@@ -283,12 +289,15 @@ The following table lists the tools that are required for each diagram type, the
    |graphviz     |{uri-graphviz}[GraphViz]                                              |`dot` or `graphvizdot`
    |meme         |{uri-imagemagick}[ImageMagick]                                        |`convert` and `identify`
    |mermaid      |{uri-mermaid}[Mermaid]                                                |`mermaid`
+   |msc          |{uri-mscgen}[Mscgen]                                                  |`mscgen`
    |nwdiag       |{uri-nwdiag}[NwDiag]                                                  |`nwdiag`
    |packetdiag   |{uri-nwdiag}[NwDiag]                                                  |`packetdiag`
    |plantuml     |{uri-java}[Java]                                                      |`java`
    |rackdiag     |{uri-nwdiag}[NwDiag]                                                  |`rackdiag`
    |seqdiag      |{uri-seqdiag}[SeqDiag]                                                |`seqdiag`
    |shaape       |{uri-shaape}[Shaape]                                                  |`shaape`
+   |svgbob       |{uri-svgbob}[SvgBob]                                                  |`svgbob`
+   |syntrax      |{uri-syntrax}[Syntrax]                                                |`syntrax`
    |umlet        |{uri-umlet}[Umlet]                                                    |`umlet`
 .2+|wavedrom     |{uri-wavedromeditor}[WaveDrom Editor]                                 |`wavedrom`
                  |{uri-wavedromcli}[WaveDrom CLI] and {uri-phantomjs}[PhantomJS]        |`wavedrom` and `phantomjs`
@@ -394,6 +403,14 @@ The attribute name at the block level should be prefixed with the name of the di
 |width         |unspecified     |The width of the generated image.
 |===
 
+==== Msc
+
+[cols=">,<,<",options="header"]
+|===
+|Name         |Default value   |Description
+|font         |unspecified     |The name of the font that should be used by mscgen
+|===
+
 ==== PlantUML
 
 [cols=">,<,<",options="header"]
@@ -401,3 +418,13 @@ The attribute name at the block level should be prefixed with the name of the di
 |Name          |Default value   |Description
 |config        |unspecified     |Path to a config file to pass to PlantUML.
 |===
+
+==== Syntrax
+
+[cols=">,<,<",options="header"]
+|===
+|Name          |Default value   |Description
+|scale         |1               |A scale factor that is applied to the image.
+|style         |unspecifed      |Path to a style config file to pass to Syntrax.
+|transparent   |false           |Makes the background of the image transparent instead of opaque white.
+|===

data/Rakefile

@@ -3,11 +3,6 @@ require 'rspec/core/rake_task'
 
 test = RSpec::Core::RakeTask.new(:test)
 
-if ENV['APPVEYOR']
-  # Exclude diagram types that require external libraries that are difficult to build on Windows.
-  test.exclude_pattern = 'spec/**/{blockdiag,shaape}_spec.rb'
-end
-
 task :default => :test
 
 spec = Gem::Specification.load('asciidoctor-diagram.gemspec')

data/lib/asciidoctor-diagram.rb

@@ -4,8 +4,11 @@ require_relative 'asciidoctor-diagram/erd'
 require_relative 'asciidoctor-diagram/graphviz'
 require_relative 'asciidoctor-diagram/meme'
 require_relative 'asciidoctor-diagram/mermaid'
+require_relative 'asciidoctor-diagram/msc'
 require_relative 'asciidoctor-diagram/plantuml'
 require_relative 'asciidoctor-diagram/salt'
 require_relative 'asciidoctor-diagram/shaape'
+require_relative 'asciidoctor-diagram/svgbob'
+require_relative 'asciidoctor-diagram/syntrax'
 require_relative 'asciidoctor-diagram/umlet'
 require_relative 'asciidoctor-diagram/wavedrom'

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

@@ -100,13 +100,14 @@ module Asciidoctor
       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, tool.downcase)
+        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}"]

data/lib/asciidoctor-diagram/extensions.rb

@@ -98,7 +98,7 @@ module Asciidoctor
         def process(parent, reader_or_target, attributes)
           source = create_source(parent, reader_or_target, attributes.dup)
 
-          format = source.attributes.delete('format') || self.class.default_format
+          format = source.attributes.delete('format') || source.attr('format', self.class.default_format, name)
           format = format.to_sym if format.respond_to?(:to_sym)
 
           raise "Format undefined" unless format
@@ -108,14 +108,21 @@ module Asciidoctor
           raise "#{self.class.name} does not support output format #{format}" unless generator_info
 
           begin
+            title = source.attributes.delete 'title'
+            caption = source.attributes.delete 'caption'
+
             case generator_info[:type]
               when :literal
-                create_literal_block(parent, source, generator_info)
+                block = create_literal_block(parent, source, generator_info)
               else
-                create_image_block(parent, source, format, generator_info)
+                block = create_image_block(parent, source, format, generator_info)
             end
+
+            block.title = title
+            block.assign_caption(caption, 'figure')
+            block
           rescue => e
-            case parent.attr('diagram-on-error') || 'log'
+            case source.attr('on-error', 'log', 'diagram')
               when 'abort'
                 raise e
               else
@@ -151,6 +158,8 @@ module Asciidoctor
         end
 
         private
+        DIGIT_CHAR_RANGE = ('0'.ord)..('9'.ord)
+
         def create_image_block(parent, source, format, generator_info)
           image_name = "#{source.image_name}.#{format}"
           image_dir = image_output_dir(parent)
@@ -210,6 +219,16 @@ module Asciidoctor
                                         'Diagram'
                                       end
 
+          image_attributes['alt'] = parent.sub_specialchars image_attributes['alt']
+
+          parent.document.register(:images, image_name)
+          if (scaledwidth = image_attributes['scaledwidth'])
+            # append % to scaledwidth if ends in number (no units present)
+            if DIGIT_CHAR_RANGE.include?((scaledwidth[-1] || 0).ord)
+              image_attributes['scaledwidth'] = %(#{scaledwidth}%)
+            end
+          end
+
           Asciidoctor::Block.new parent, :image, :content_model => :empty, :attributes => image_attributes
         end
 
@@ -384,8 +403,8 @@ module Asciidoctor
 
           if value.nil? && inherit
             case inherit
-              when String
-                value = @parent_block.attr("#{inherit}-#{name}", default_value, true)
+              when String, Symbol
+                value = @parent_block.attr("#{inherit.to_s}-#{name}", default_value, true)
               else
                 value = @parent_block.attr(name, default_value, true)
             end

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

@@ -19,10 +19,12 @@ module Asciidoctor
       end
 
       def graphviz(parent, source, format)
+        inherit_prefix = name
+
         generate_stdin(which(parent, 'dot', :alt_attrs => ['graphvizdot']), format.to_s, source.to_s) do |tool_path, output_path|
           args = [tool_path, "-o#{Platform.native_path(output_path)}", "-T#{format.to_s}"]
 
-          layout = source.attr('layout', nil, 'graphviz')
+          layout = source.attr('layout', nil, inherit_prefix)
           args << "-K#{layout}" if layout
 
           args

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

@@ -21,19 +21,20 @@ module Asciidoctor
       def meme(parent_block, source, format)
         convert = which(parent_block, 'convert')
         identify = which(parent_block, 'identify')
+        inherit_prefix = name
 
-        bg_img = source.attr('background', nil, 'meme')
+        bg_img = source.attr('background', nil, inherit_prefix)
         raise "background attribute is required" unless bg_img
 
         bg_img = parent_block.normalize_system_path(bg_img, parent_block.attr('imagesdir'))
 
         top_label = source.attr('top')
         bottom_label = source.attr('bottom')
-        fill_color = source.attr('fillColor', 'white', 'meme')
-        stroke_color = source.attr('strokeColor', 'black', 'meme')
-        stroke_width = source.attr('strokeWidth', '2', 'meme')
-        font = source.attr('font', 'Impact', 'meme')
-        options = source.attr('options', '', 'meme').split(',')
+        fill_color = source.attr('fillColor', 'white', inherit_prefix)
+        stroke_color = source.attr('strokeColor', 'black', inherit_prefix)
+        stroke_width = source.attr('strokeWidth', '2', inherit_prefix)
+        font = source.attr('font', 'Impact', inherit_prefix)
+        options = source.attr('options', '', inherit_prefix).split(',')
         noupcase = options.include?('noupcase')
 
         dimensions = Cli.run(identify, '-format', '%w %h', bg_img).match(/(?<w>\d+) (?<h>\d+)/)

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

@@ -20,27 +20,28 @@ module Asciidoctor
       end
 
       def mermaid(parent_block, source, format)
+        inherit_prefix = name
         mermaid = which(parent_block, 'mermaid')
         config['mermaid>=6'] ||= ::Asciidoctor::Diagram::Cli.run(mermaid, '--version').split('.')[0].to_i >= 6
         # Mermaid >= 6.0.0 requires PhantomJS 2.1; older version required 1.9
         phantomjs = which(parent_block, 'phantomjs', :alt_attrs => [config['mermaid>=6'] ? 'phantomjs_2' : 'phantomjs_19'])
 
-        css = source.attr('css', nil, 'mermaid')
+        css = source.attr('css', nil, inherit_prefix)
         if css
           css = parent_block.normalize_system_path(css, source.base_dir)
         end
 
-        gantt_config = source.attr('ganttConfig', nil, 'mermaid') || source.attr('ganttconfig', nil, 'mermaid')
+        gantt_config = source.attr('ganttConfig', nil, inherit_prefix) || source.attr('ganttconfig', nil, inherit_prefix)
         if gantt_config
           gantt_config = parent_block.normalize_system_path(gantt_config, source.base_dir)
         end
 
-        seq_config = source.attr('sequenceConfig', nil, 'mermaid') || source.attr('sequenceconfig', nil, 'mermaid')
+        seq_config = source.attr('sequenceConfig', nil, inherit_prefix) || source.attr('sequenceconfig', nil, inherit_prefix)
         if seq_config
           seq_config = parent_block.normalize_system_path(seq_config, source.base_dir)
         end
 
-        width = source.attr('width', nil, 'mermaid')
+        width = source.attr('width', nil, inherit_prefix)
 
         generate_file(mermaid, 'mmd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
           output_dir = File.dirname(output_path)

data/lib/asciidoctor-diagram/msc.rb

@@ -0,0 +1,8 @@
+require_relative 'extensions'
+
+Asciidoctor::Extensions.register do
+  require_relative 'msc/extension'
+
+  block Asciidoctor::Diagram::MscBlockProcessor, :msc
+  block_macro Asciidoctor::Diagram::MscBlockMacroProcessor, :msc
+end

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

@@ -0,0 +1,44 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Mscgen
+      include CliGenerator
+      include Which
+
+      def self.included(mod)
+        [:png, :svg].each do |f|
+          mod.register_format(f, :image) do |parent, source|
+            mscgen(parent, source, f)
+          end
+        end
+      end
+
+      def mscgen(parent, source, format)
+        inherit_prefix = name
+        font = source.attr('font', nil, inherit_prefix)
+
+        generate_stdin(which(parent, 'mscgen'), format.to_s, source.to_s) do |tool_path, output_path|
+          args = [tool_path, '-o', Platform.native_path(output_path), '-T', format.to_s]
+          if font
+            args << '-F' << font
+          end
+          args << '-'
+          args
+        end
+      end
+    end
+
+    class MscBlockProcessor < Extensions::DiagramBlockProcessor
+      include Mscgen
+    end
+
+    class MscBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Mscgen
+    end
+  end
+end

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

@@ -18,13 +18,14 @@ module Asciidoctor
       def plantuml(parent_block, source, tag, mime_type)
         Java.load
 
+        inherit_prefix = name
         code = preprocess_code(parent_block, source, tag)
 
         headers = {
             'Accept' => mime_type
         }
 
-        config_file = source.attr('plantumlconfig', nil, true) || source.attr('config', nil, 'plantuml')
+        config_file = source.attr('plantumlconfig', nil, true) || source.attr('config', nil, inherit_prefix)
         if config_file
           headers['X-PlantUML-Config'] = File.expand_path(config_file, source.attr('docdir', nil, true))
         end

data/lib/asciidoctor-diagram/svgbob.rb

@@ -0,0 +1,8 @@
+require_relative 'extensions'
+
+Asciidoctor::Extensions.register do
+  require_relative 'svgbob/extension'
+
+  block Asciidoctor::Diagram::SvgBobBlockProcessor, :svgbob
+  block_macro Asciidoctor::Diagram::SvgBobBlockMacroProcessor, :svgbob
+end

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

@@ -0,0 +1,38 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Svgbob
+      include CliGenerator
+      include Which
+
+      def self.included(mod)
+        [:svg].each do |f|
+          mod.register_format(f, :image) do |parent, source|
+            svgbob(parent, source, f)
+          end
+        end
+      end
+
+      def svgbob(parent, source, format)
+        inherit_prefix = name
+
+        generate_stdin(which(parent, 'svgbob'), format.to_s, source.to_s) do |tool_path, output_path|
+          [tool_path, '-o', Platform.native_path(output_path)]
+        end
+      end
+    end
+
+    class SvgBobBlockProcessor < Extensions::DiagramBlockProcessor
+      include Svgbob
+    end
+
+    class SvgBobBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Svgbob
+    end
+  end
+end