asciidoctor-diagram 1.5.18 → 1.5.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c8e3c8549b195285f274052e14c6addc52c5900a80fcf88935cb3820432903ac
-  data.tar.gz: b673dd81b505260bf7fd06e45ef98df1806a22684a4036fb4c4e006317384538
+SHA1:
+  metadata.gz: df890b150a6c0d6baf42b0064ddbc0456ef89dff
+  data.tar.gz: b25f7ca96e4cf5db0d4b319b0f93eded8a876503
 SHA512:
-  metadata.gz: 193b91c7ddac87a1e0fad1a1c65b6dcb6406888c54443f5a6ae8be8f6ffb3845708e6c29a4a0d5d11438411d7281f60be1b0be79d280bf68a8764daf3a0ed4ea
-  data.tar.gz: 18e6d118480da5b4010df9bcc0fa58bd852d5cf70bb48960f55b31235bb6bfe58cfa4fe47eab3d750a56262db9f8a76c390b85cb88dffbbfd9df1f8c512d3fd5
+  metadata.gz: f555b3c805b2903356da1925b888f6d3165418334a8eea10438732fe81ef118cdf28f652e7f0cb77dd85995bd65382bb9e538c05cffa7d38f16f53b081ec475d
+  data.tar.gz: 3ba60e0ef78777920fd654f549488e87be57e87a215a34067574e6aeb04a5764070b4d23f7027ae681a65487c22694e3bbf3f9263ec3eeae2a7df3f1ccc221ed

data/CHANGELOG.adoc

@@ -1,5 +1,23 @@
 = Asciidoctor-diagram Changelog
 
+== 1.5.19
+
+Bug Fixes::
+  * Issue #233: Resolve character encoding issues with Ditaa on Windows with Java runtimes that do not use UTF-8 encoding by default
+  * Fix generation of SVG output for TikZ diagrams (@joelsmith)
+  * Improve TikZ image cropping (@joelsmith)  
+
+Enhancements::
+  * Issue #225: Add support for WaveDrom CLI 2.0.0
+  * Issue #234: Add support for State Machine Cat
+  * Add support for gnuplot (@MariuszCwikla)
+
+== 1.5.18
+
+Bug Fixes::
+
+  * Issue #224: Fix asciidoctor 1.5.x compatibility regression introduced in 1.5.17
+
 == 1.5.17
 
 Enhancements::

data/README.adoc

@@ -21,6 +21,7 @@ ifndef::env-site[:status:]
 :uri-ditaa: http://ditaa.sourceforge.net/
 :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
@@ -35,6 +36,7 @@ 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-smcat: https://github.com/sverweij/state-machine-cat
 :uri-svgbob: https://github.com/ivanceras/svgbobrus
 :uri-syntrax: https://kevinpt.github.io/syntrax/
 :uri-umlet: http://www.umlet.com/
@@ -46,7 +48,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 supports the {uri-a2s}[AsciiToSVG], 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-nomnoml}[Nomnoml], {uri-plantuml}[PlantUML], {uri-shaape}[Shaape], {uri-svgbob}[SvgBob], {uri-syntrax}[Syntrax], {uri-umlet}[UMLet], {uri-vega}[Vega], {uri-vegalite}[Vega-Lite] and {uri-wavedrom}[WaveDrom] syntax.
+The extensions supports the {uri-a2s}[AsciiToSVG], BlockDiag ({uri-blockdiag}[BlockDiag], {uri-seqdiag}[SeqDiag], {uri-actdiag}[ActDiag], {uri-nwdiag}[NwDiag]), {uri-ditaa}[Ditaa], {uri-erd}[Erd], {uri-gnuplot}[Gnuplot], {uri-dot}[GraphViz], {uri-mermaid}[Mermaid], {uri-mscgen}[Msc], {uri-nomnoml}[Nomnoml], {uri-plantuml}[PlantUML], {uri-shaape}[Shaape], {uri-smcat}[State Machine Cat], {uri-svgbob}[SvgBob], {uri-syntrax}[Syntrax], {uri-umlet}[UMLet], {uri-vega}[Vega], {uri-vegalite}[Vega-Lite] 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.
@@ -121,6 +123,7 @@ The following diagram types and output formats are available:
 |{uri-blockdiag}[blockdiag]  |       |{check}|{check}|{check}|
 |{uri-ditaa}[ditaa]          |       |       |{check}|{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}|
@@ -132,6 +135,7 @@ The following diagram types and output formats are available:
 |{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-syntrax}[syntrax]      |       |{check}|{check}|{check}|
 |{uri-umlet}[umlet]          |{check}|{check}|{check}|{check}|
@@ -249,7 +253,7 @@ or load and register each extension individually.
 require 'asciidoctor-diagram/<extension_name>'
 ----
 
-`<extension_name>` can be one of `a2s`, `blockdiag`, `ditaa`, `erd`, `graphviz`, `meme`, `mermaid`, `msc`, `plantuml`, `shaape`, `svgbob`, `syntrax`, `umlet`, `vega` or `wavedrom`.
+`<extension_name>` can be one of `a2s`, `blockdiag`, `ditaa`, `erd`, `gnuplot`, `graphviz`, `meme`, `mermaid`, `msc`, `plantuml`, `shaape`, `smcat`, `svgbob`, `syntrax`, `umlet`, `vega` or `wavedrom`.
 
 Requiring one or more of these files will automatically register the extensions for all processed documents.
 
@@ -297,6 +301,7 @@ The following table lists the tools that are required for each diagram type, the
    |blockdiag    |{uri-blockdiag}[BlockDiag]                                            |`blockdiag`
    |ditaa        |{uri-java}[Java]                                                      |`java`
    |erd          |{uri-erd}[Erd]                                                        |`erd`
+   |gnuplot      |{uri-gnuplot}[Gnuplot]                                                |`gnuplot`
    |graphviz     |{uri-graphviz}[GraphViz]                                              |`dot` or `graphvizdot`
    |meme         |{uri-imagemagick}[ImageMagick]                                        |`convert` and `identify`
    |mermaid      |{uri-mermaid}[Mermaid.cli]                                            |`mermaid`
@@ -308,13 +313,14 @@ The following table lists the tools that are required for each diagram type, the
    |rackdiag     |{uri-nwdiag}[NwDiag]                                                  |`rackdiag`
    |seqdiag      |{uri-seqdiag}[SeqDiag]                                                |`seqdiag`
    |shaape       |{uri-shaape}[Shaape]                                                  |`shaape`
+   |smcat        |{uri-smcat}[State Machine Cat]                                        |`smcat`
    |svgbob       |{uri-svgbob}[SvgBob]                                                  |`svgbob`
    |syntrax      |{uri-syntrax}[Syntrax]                                                |`syntrax`
    |umlet        |{uri-umlet}[Umlet]                                                    |`umlet`
    |vega         |{uri-vega}[vg2png] and/or {uri-vega}[vg2png]                          |`vg2png` and `vg2svg`
    |vegalite     |{uri-vegalite}[vl2vg] and {uri-vega}[vg2png] and/or {uri-vega}[vg2svg]|`vl2vg`, `vg2png` and `vg2svg`
 .2+|wavedrom     |{uri-wavedromeditor}[WaveDrom Editor]                                 |`wavedrom`
-                 |{uri-wavedromcli}[WaveDrom CLI] and {uri-phantomjs}[PhantomJS]        |`wavedrom` and `phantomjs`
+                 |{uri-wavedromcli}[WaveDrom CLI] (and {uri-phantomjs}[PhantomJS] for WaveDrom CLI v1)      |`wavedrom` (and `phantomjs`)
 |===
 
 If for instance you installed `actdiag` in `/home/me/actdiag/bin` and this path is not included in the `PATH` you can specify its location on the command line
@@ -328,12 +334,12 @@ The meme extension provides a basic '`Advice Animal`' style image generator.
 It's usage is easiest to explain with an example.
 
 ----
-meme::yunoguy.jpg[Doc writers,Y U NO \\ AsciiDoc]
+meme::yunoguy.jpg[Doc writers,Y U NO // AsciiDoc]
 ----
 
 The target of the block macro tells the extension which image to use as background.
 The first two positional attributes are `top` and `bottom` and are used for the top and bottom label.
-Occurrences of `\\` surrounded by whitespace are interpreted as line breaks.
+Occurrences of `//` surrounded by whitespace are interpreted as line breaks.
 
 === Diagram Attributes
 
@@ -394,6 +400,20 @@ The attribute name at the block level should be prefixed with the name of the di
 |transparent  |false           |Makes the background of the image transparent instead of using the background color.
 |===
 
+==== Gnuplot
+
+[cols=">,<,<",options="header"]
+|===
+|Name         |Default value   |Description
+|background   |unspecified     |Background color, e.g. `red`, `#FF0000`. Does not work with `txt`.
+|height       |unspecified     |The height of the plot. Must be specified together with `width`.
+|width        |unspecified     |The width of the plot. Must be specified together with `height`.
+|crop         |unspecified     |Trims blank space from the edges of the completed plot (true/false). Does not work with `svg`, `pdf`.
+|transparent  |unspecified     |Generate transparent background (true/false). Does not work with `svg`, `pdf`, `txt`. 
+|font         |unspecified     |The font face with optional font size to use for the text, e.g. `font="Arial"`, `font="Arial,11"`. Does not work with `txt`.
+|fontscale    |unspecified     |Scales all label for given factor. Does not work with `txt`.
+|===
+
 ==== GraphViz
 
 [cols=">,<,<",options="header"]
@@ -445,6 +465,15 @@ The attribute name at the block level should be prefixed with the name of the di
 |config        |unspecified     |Path to a config file to pass to PlantUML.
 |===
 
+==== State Machine Cat
+
+[cols=">,<,<",options="header"]
+|===
+|Name          |Default value   |Description
+|direction     |unspecifed      |The direction of the state machine diagram. One of `top-down`, `bottom-top`, `left-right` or `right-left`.
+|engine        |unspecified     |The layout engine to use. One of `dot`, `circo`, `fdp`, `neato`, `osage`, or `twopi`
+|===
+
 ==== Syntrax
 
 [cols=">,<,<",options="header"]

data/lib/asciidoctor-diagram.rb

@@ -2,7 +2,9 @@ require_relative 'asciidoctor-diagram/a2s'
 require_relative 'asciidoctor-diagram/blockdiag'
 require_relative 'asciidoctor-diagram/ditaa'
 require_relative 'asciidoctor-diagram/erd'
+require_relative 'asciidoctor-diagram/gnuplot'
 require_relative 'asciidoctor-diagram/graphviz'
+require_relative 'asciidoctor-diagram/lilypond'
 require_relative 'asciidoctor-diagram/meme'
 require_relative 'asciidoctor-diagram/mermaid'
 require_relative 'asciidoctor-diagram/msc'
@@ -10,6 +12,7 @@ require_relative 'asciidoctor-diagram/nomnoml'
 require_relative 'asciidoctor-diagram/plantuml'
 require_relative 'asciidoctor-diagram/salt'
 require_relative 'asciidoctor-diagram/shaape'
+require_relative 'asciidoctor-diagram/smcat'
 require_relative 'asciidoctor-diagram/svgbob'
 require_relative 'asciidoctor-diagram/syntrax'
 require_relative 'asciidoctor-diagram/tikz'

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

@@ -20,7 +20,7 @@ module Asciidoctor
           'transparent' => lambda { |o, v| o  << '--transparent' if v == 'true'}
       }
 
-      JARS = ['ditaa-1.3.13.jar', 'ditaamini-0.11.jar'].map do |jar|
+      JARS = ['ditaa-1.3.13.jar', 'ditaamini-0.12.jar'].map do |jar|
         File.expand_path File.join('../..', jar), File.dirname(__FILE__)
       end
       Java.classpath.concat JARS

data/lib/asciidoctor-diagram/gnuplot.rb

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

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

@@ -0,0 +1,70 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Gnuplot
+      include CliGenerator
+      include Which
+
+      def self.included(mod)
+        [:png, :svg, :gif].each do |f|
+          mod.register_format(f, :image) do |parent, source|
+            gnuplot(parent, source, f)
+          end
+        end
+
+        mod.register_format(:txt, :literal) do |parent, source|
+            gnuplot(parent, source, :txt)
+        end          
+      end
+
+      def gnuplot(parent, source, format)
+        inherit_prefix = name        
+        
+        width = source.attr("width", nil, inherit_prefix)
+        height = source.attr("height", nil, inherit_prefix)
+
+        if format == :txt
+          format = 'dumb'
+        end
+
+        code = "set term #{format}"
+        code << " size #{width},#{height}" unless width.nil? or height.nil?
+
+        transparent = source.attr("transparent", nil, inherit_prefix)
+        code << (transparent ? " transparent" : " notransparent") unless transparent.nil?
+
+        crop = source.attr("crop", nil, inherit_prefix)
+        code << (crop ? " crop" : " nocrop") unless crop.nil?
+
+        font = source.attr("font", nil, inherit_prefix)
+        code << %( font "#{font}") unless font.nil?
+
+        font_scale = source.attr("fontscale", nil, inherit_prefix)
+        code << " fontscale #{font_scale}" unless font_scale.nil?
+
+        background = source.attr("background", nil, inherit_prefix)
+        code << %( background "#{background}") unless background.nil?
+  
+        code << "\n"
+        code << source.to_s 
+        generate_stdin_stdout(which(parent, 'gnuplot'), code) do |tool_path|
+          [tool_path]
+        end
+ 
+      end
+    end
+
+    class GnuplotBlockProcessor < Extensions::DiagramBlockProcessor
+      include Gnuplot
+    end
+
+    class GnuplotBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Gnuplot
+    end
+  end
+end

data/lib/asciidoctor-diagram/lilypond.rb

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

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

@@ -0,0 +1,61 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Lilypond
+      include CliGenerator
+      include Which
+
+      def self.included(mod)
+        [:png, :pdf].each do |f|
+          mod.register_format(f, :image) do |parent, source|
+            lilypond(parent, source, f)
+          end
+        end
+      end
+
+      def lilypond(parent, source, format)
+        code = <<-EOF
+\\paper{
+  oddFooterMarkup=##f
+  oddHeaderMarkup=##f
+  bookTitleMarkup=##f
+  scoreTitleMarkup=##f
+}
+
+        EOF
+        code << source.to_s
+
+        inherit_prefix = name
+        resolution = source.attr('resolution', nil, inherit_prefix)
+
+        generate_stdin(which(parent, 'lilypond'), format.to_s, code) do |tool_path, output_path|
+          args = [tool_path, '-daux-files=#f', '-dbackend=eps', '-dno-gs-load-fonts', '-dinclude-eps-fonts', '-o', Platform.native_path(output_path), '-f', format.to_s]
+
+          args << '-dsafe'
+          args << "-dresolution=#{resolution}" if resolution
+          args << "-dpixmap-format=pngalpha" if format == :png
+
+          args << '-'
+
+          {
+              :args => args,
+              :out_file => "#{output_path}.#{format.to_s}"
+          }
+        end
+      end
+    end
+
+    class LilypondBlockProcessor < Extensions::DiagramBlockProcessor
+      include Lilypond
+    end
+
+    class LilypondBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Lilypond
+    end
+  end
+end

data/lib/asciidoctor-diagram/smcat.rb

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

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

@@ -0,0 +1,50 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Smcat
+      include CliGenerator
+      include Which
+
+      def self.included(mod)
+        [:svg].each do |f|
+          mod.register_format(f, :image) do |parent, source|
+            smcat(parent, source, f)
+          end
+        end
+      end
+
+      def smcat(parent, source, format)
+        inherit_prefix = name
+        direction = source.attr('direction', nil, inherit_prefix)
+        engine = source.attr('engine', nil, inherit_prefix)
+
+        generate_stdin(which(parent, 'smcat'), 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 direction
+            args << '-d' << direction
+          end
+
+          if engine
+            args << '-E' << engine
+          end
+
+          args << '-'
+          args
+        end
+      end
+    end
+
+    class SmcatBlockProcessor < Extensions::DiagramBlockProcessor
+      include Smcat
+    end
+
+    class SmcatBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Smcat
+    end
+  end
+end

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

@@ -28,7 +28,7 @@ module Asciidoctor
         end
 
         latex = <<'END'
-\documentclass[border=2bp]{standalone}
+\documentclass[border=2bp, tikz]{standalone}
 \usepackage{tikz}
 \begin{document}
 \begingroup
@@ -49,7 +49,7 @@ END
 
         if svgpath
           generate_file(svgpath, 'pdf', 'svg', pdf) do |tool_path, input_path, output_path|
-            [tool_path, Platform.native_path(File.dirname(input_path)), Platform.native_path(File.dirname(output_path))]
+            [tool_path, Platform.native_path(input_path), Platform.native_path(output_path)]
           end
         else
           pdf

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.5.18"
+    VERSION = "1.5.19"
   end
 end

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

@@ -19,25 +19,33 @@ module Asciidoctor
       end
 
       def wavedrom(parent, source, format)
-        wavedrom_cli = which(parent, 'wavedrom', :raise_on_error => false)
-        phantomjs = which(parent, 'phantomjs', :alt_attrs => ['phantomjs_2'], :raise_on_error => false)
+        wavedrom_cli = which(parent, 'wavedrom-cli', :raise_on_error => false)
 
-        if wavedrom_cli && !wavedrom_cli.include?('WaveDromEditor') && phantomjs
+        if wavedrom_cli
           generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
-            [phantomjs, Platform.native_path(tool_path), '-i', Platform.native_path(input_path), "-#{format.to_s[0]}", Platform.native_path(output_path)]
+            [Platform.native_path(tool_path), '--input', Platform.native_path(input_path), "--#{format.to_s}", Platform.native_path(output_path)]
           end
         else
-          if ::Asciidoctor::Diagram::Platform.os == :macosx
-            wavedrom = which(parent, 'WaveDromEditor.app', :alt_cmds => ['wavedrom-editor.app'], :attrs => ['WaveDromEditorApp'],:path => ['/Applications'])
-            if wavedrom
-              wavedrom = File.join(wavedrom, 'Contents/MacOS/nwjs')
+          wavedrom_cli = which(parent, 'wavedrom', :raise_on_error => false)
+          phantomjs = which(parent, 'phantomjs', :alt_attrs => ['phantomjs_2'], :raise_on_error => false)
+
+          if wavedrom_cli && !wavedrom_cli.include?('WaveDromEditor') && phantomjs
+            generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+              [phantomjs, Platform.native_path(tool_path), '-i', Platform.native_path(input_path), "-#{format.to_s[0]}", Platform.native_path(output_path)]
             end
           else
-            wavedrom = which(parent, 'WaveDromEditor')
-          end
+            if ::Asciidoctor::Diagram::Platform.os == :macosx
+              wavedrom = which(parent, 'WaveDromEditor.app', :alt_cmds => ['wavedrom-editor.app'], :attrs => ['WaveDromEditorApp'],:path => ['/Applications'])
+              if wavedrom
+                wavedrom = File.join(wavedrom, 'Contents/MacOS/nwjs')
+              end
+            else
+              wavedrom = which(parent, 'WaveDromEditor')
+            end
 
-          generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
-            [tool_path, 'source', Platform.native_path(input_path), format.to_s, Platform.native_path(output_path)]
+            generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+              [tool_path, 'source', Platform.native_path(input_path), format.to_s, Platform.native_path(output_path)]
+            end
           end
         end
       end