asciidoctor-diagram 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f13f5d250305d3a9da90af8da4a0b784c247979b9e23462b8b8bd77f6c92ca0a
-  data.tar.gz: 5f757455ea6ba101f8543d87a2bbe06106ed354e09bec89bf3d22959d1674f96
+  metadata.gz: 629ba788527640ff6cd5bd7c0e6cc18a1a2b7afa4071737b667f95859491dbfc
+  data.tar.gz: 762433ab8f23c6d7a4e44fc5d580c77a1fa52b56c47780d1ba28077ae1c309ee
 SHA512:
-  metadata.gz: 2e08ce3f20a0d241e177cbf06680f68149af8adc8e65b6ab25fa57bf1e620aead335d7c8fbe96047bb10b95bf52ce7b22d7c67c3160882e8fd4f0a261c597eb2
-  data.tar.gz: 9ff970387205a3686999220bd37e0d54b08f10f5c95be8d37d05764fbf2f46a5606c9efe4184249b951ad845194e108d7d283fd178216fd42958230dbd50afce
+  metadata.gz: eb2cac4b23d86cc7fb37787208b221a42c839d06b31eff51585a108c674b0517e3c9c72afe1f4ed556e671d4ff5bff06c825cff764098a8925f860975e96146b
+  data.tar.gz: 35a265251153d038515a89aea7322373495e6e72d768df42e200c517e905a6b257f8916b7c3b0ff8645a15a8aeff258b345bd7b744c6e514bd6dc7291bf26bdc

data/CHANGELOG.adoc

@@ -1,5 +1,17 @@
 = Asciidoctor-diagram Changelog
 
+== 2.2.2
+
+Enhancements::
+
+* Issue #375: Add support for PlantUML include directories (@mskyaxl)
+* Add support for `graphviz-py` (@Alwinator)
+* Issue #380: Allow local PlantUML preprocessing to be disabled using the `preprocess` attribute
+
+Bug Fixes::
+
+* Issue #370: Only use absolute paths for 'interactive' style SVGs when 'data-uri' is also in use.
+
 == 2.2.1
 
 Bug Fixes::

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

@@ -317,9 +317,11 @@ No specific attributes.
 
 [cols=">,<,<",options="header"]
 |===
-|Name          |Default value   |Description
-|config        |unspecified     |Path to a config file to pass to PlantUML.
-|size-limit    |4096            |The maximum dimensions (width and height) of generated diagrams.
+|Name            |Default value   |Description
+|config          |unspecified     |Path to a config file to pass to PlantUML.
+|size-limit      |4096            |The maximum dimensions (width and height) of generated diagrams.
+|includedir      |unspecified     |sets a common directory for puml includes (plantuml.include.path)
+|preprocess      |true            |Preprocess PlantUML code before rendering the diagram.
 |===
 
 ==== State Machine Cat

data/examples/features.adoc

@@ -118,6 +118,31 @@ graph ethane {
 }
 ----
 
+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.

data/lib/asciidoctor-diagram/diagram_processor.rb

@@ -249,9 +249,11 @@ module Asciidoctor
           case svg_type
             when nil, 'static'
               # Nothing to do
-            when 'inline', 'interactive'
+            when 'inline'
               node.set_option(svg_type)
               use_absolute_path = true
+            when 'interactive'
+              node.set_option(svg_type)
             else
               raise "Unsupported SVG type: #{svg_type}"
           end

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

@@ -31,7 +31,7 @@ module Asciidoctor
                           require 'asciidoctor-diagram/ditaa/classpath'
                           ::Asciidoctor::Diagram::DitaaClasspath::JAR_FILES
                         rescue LoadError
-                          raise "Could not load PlantUML. Eiter require 'asciidoctor-diagram-ditaamini' or specify the location of the PlantUML JAR(s) using the 'DIAGRAM_DITAA_CLASSPATH' environment variable."
+                          raise "Could not load Ditaa. Eiter require 'asciidoctor-diagram-ditaamini' or specify the location of the Ditaa JAR(s) using the 'DIAGRAM_DITAA_CLASSPATH' environment variable."
                         end
                       end
 
@@ -96,4 +96,4 @@ module Asciidoctor
       end
     end
   end
-end
+end

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

@@ -0,0 +1,42 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class GraphvizPyConverter
+      include DiagramConverter
+      include CliGenerator
+
+      def supported_formats
+        [:png, :pdf, :svg]
+      end
+
+      def collect_options(source)
+        {
+            :layout => source.attr('layout'),
+            :argument => source.attr('argument')
+        }
+      end
+
+      def convert(source, format, options)
+        generate_stdin(source.find_command('graphviz-py'), 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 = options[:layout]
+          args << "-K#{layout}" if layout
+
+          argument = options[:argument]
+
+          if argument
+            args << "-a"
+            args << argument
+          end
+
+          args
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative 'converter'
+require_relative '../diagram_processor'
+
+module Asciidoctor
+  module Diagram
+    class GraphvizPyBlockProcessor < DiagramBlockProcessor
+      use_converter GraphvizPyConverter
+    end
+
+    class GraphvizPyBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter GraphvizPyConverter
+    end
+
+    class GraphvizPyInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter GraphvizPyConverter
+    end
+  end
+end

data/lib/asciidoctor-diagram/graphviz_py.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'graphviz_py/extension'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::GraphvizPyBlockProcessor, :graphviz_py
+  block_macro Asciidoctor::Diagram::GraphvizPyBlockMacroProcessor, :graphviz_py
+  inline_macro Asciidoctor::Diagram::GraphvizPyInlineMacroProcessor, :graphviz_py
+end

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

@@ -113,27 +113,36 @@ module Asciidoctor
 
         code = "@start#{@tag}\n#{code}\n@end#{@tag}" unless code.index("@start") && code.index("@end")
 
-        headers = {}
+        should_preprocess = attr('preprocess', 'true') == 'true'
 
-        config_file = attr('plantumlconfig', nil, true) || attr('config')
-        if config_file
-          headers['X-PlantUML-Config'] = File.expand_path(config_file, base_dir)
-        end
+        if should_preprocess
+          headers = {}
 
-        headers['X-PlantUML-Basedir'] = Platform.native_path(File.expand_path(base_dir))
+          config_file = attr('plantumlconfig', nil, true) || attr('config')
+          if config_file
+            headers['X-PlantUML-Config'] = File.expand_path(config_file, base_dir)
+          end
 
-        response = Java.send_request(
-          :url => '/plantumlpreprocessor',
-          :body => code,
-          :headers => headers
-        )
+          headers['X-PlantUML-Basedir'] = Platform.native_path(File.expand_path(base_dir))
 
-        unless response[:code] == 200
-          raise Java.create_error("PlantUML preprocessing failed", response)
-        end
+          include_dir = attr('includedir')
+          if include_dir
+            headers['X-PlantUML-IncludeDir'] = Platform.native_path(File.expand_path(include_dir, base_dir))
+          end
 
-        code = response[:body]
-        code.force_encoding(Encoding::UTF_8)
+          response = Java.send_request(
+            :url => '/plantumlpreprocessor',
+            :body => code,
+            :headers => headers
+          )
+
+          unless response[:code] == 200
+            raise Java.create_error("PlantUML preprocessing failed", response)
+          end
+
+          code = response[:body]
+          code.force_encoding(Encoding::UTF_8)
+        end
 
         code
       end

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

@@ -44,7 +44,7 @@ module Asciidoctor
           OPTIONS[option].call(flags, value)
         end
         
-        generate_stdin(source.find_command('svgbob'), format.to_s, source.to_s) do |tool_path, output_path|
+        generate_stdin(source.find_command('svgbob', :alt_cmds => ['svgbob_cli']), format.to_s, source.to_s) do |tool_path, output_path|
           ([tool_path, '-o', Platform.native_path(output_path)] + flags)
         end
       end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "2.2.1"
+    VERSION = "2.2.2"
   end
 end

data/lib/asciidoctor-diagram.rb

@@ -9,6 +9,7 @@ require_relative 'asciidoctor-diagram/dpic'
 require_relative 'asciidoctor-diagram/erd'
 require_relative 'asciidoctor-diagram/gnuplot'
 require_relative 'asciidoctor-diagram/graphviz'
+require_relative 'asciidoctor-diagram/graphviz_py'
 require_relative 'asciidoctor-diagram/lilypond'
 require_relative 'asciidoctor-diagram/meme'
 require_relative 'asciidoctor-diagram/mermaid'

data/spec/graphviz_py_spec.rb

@@ -0,0 +1,33 @@
+require_relative 'test_helper'
+
+GRAPHVIZ_PY_CODE = <<-eos
+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"];
+
+}
+eos
+
+describe Asciidoctor::Diagram::GraphvizPyInlineMacroProcessor, :broken_on_github do
+  include_examples "inline_macro", :graphviz_py, GRAPHVIZ_PY_CODE, [:png, :svg]
+end
+
+describe Asciidoctor::Diagram::GraphvizPyBlockMacroProcessor, :broken_on_github do
+  include_examples "block_macro", :graphviz_py, GRAPHVIZ_PY_CODE, [:png, :svg]
+end
+
+describe Asciidoctor::Diagram::GraphvizPyBlockProcessor, :broken_on_github do
+  include_examples "block", :graphviz_py, GRAPHVIZ_PY_CODE, [:png, :svg]
+end

data/spec/lilypond_spec.rb

@@ -4,14 +4,14 @@ LILYPOND_CODE = <<-eos
 \\relative c' { f d f a d f e d cis a cis e a g f e }
 eos
 
-describe Asciidoctor::Diagram::LilypondInlineMacroProcessor do
+describe Asciidoctor::Diagram::LilypondInlineMacroProcessor, :broken_on_windows do
   include_examples "inline_macro", :lilypond, LILYPOND_CODE, [:png]
 end
 
-describe Asciidoctor::Diagram::LilypondBlockMacroProcessor do
+describe Asciidoctor::Diagram::LilypondBlockMacroProcessor, :broken_on_windows do
   include_examples "block_macro", :lilypond, LILYPOND_CODE, [:png]
 end
 
-describe Asciidoctor::Diagram::LilypondBlockProcessor do
+describe Asciidoctor::Diagram::LilypondBlockProcessor, :broken_on_windows do
   include_examples "block", :lilypond, LILYPOND_CODE, [:png]
 end

data/spec/msc_spec.rb

@@ -24,14 +24,14 @@ msc {
 }
 eos
 
-describe Asciidoctor::Diagram::MscInlineMacroProcessor do
+describe Asciidoctor::Diagram::MscInlineMacroProcessor, :broken_on_windows do
   include_examples "inline_macro", :msc, MSC_CODE, [:png, :svg]
 end
 
-describe Asciidoctor::Diagram::MscBlockMacroProcessor do
+describe Asciidoctor::Diagram::MscBlockMacroProcessor, :broken_on_windows do
   include_examples "block_macro", :msc, MSC_CODE, [:png, :svg]
 end
 
-describe Asciidoctor::Diagram::MscBlockProcessor do
+describe Asciidoctor::Diagram::MscBlockProcessor, :broken_on_windows do
   include_examples "block", :msc, MSC_CODE, [:png, :svg]
 end

data/spec/plantuml_spec.rb

@@ -253,6 +253,43 @@ skinparam ArrowColor #DEADBE
     expect(svg).to match(/<[^<]+ fill=["']#DEADBE["']/)
   end
 
+  it 'should use plantuml include dir when specified as a document attribute' do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+:plantuml-includedir: include
+:plantuml-format: svg
+
+== First Section
+
+[plantuml]
+----
+!include common.puml
+actor Foo1
+boundary Foo2
+Foo1 -> Foo2 : To boundary
+----
+    eos
+
+    includefile = <<-eos
+skinparam ArrowColor #DEADBE
+    eos
+    Dir.mkdir('include')
+    File.open('include/common.puml', 'w') do |f|
+      f.write includefile
+    end
+
+    d = load_asciidoc doc
+    b = d.find { |bl| bl.context == :image }
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(File.exist?(target)).to be true
+
+    svg = File.read(target, :encoding => Encoding::UTF_8)
+    expect(svg).to match(/<[^<]+ fill=["']#DEADBE["']/)
+  end
+
   it 'should support salt diagrams using salt block type' do
     doc = <<-eos
 = Hello, PlantUML!

data/spec/symbolator_spec.rb

@@ -14,14 +14,14 @@ package demo is
 end package;
 eos
 
-describe Asciidoctor::Diagram::SymbolatorInlineMacroProcessor, :broken_on_windows do
+describe Asciidoctor::Diagram::SymbolatorInlineMacroProcessor, :broken_on_windows, :broken_on_github do
   include_examples "inline_macro", :symbolator, SYMBOLATOR_CODE, [:png, :svg, :pdf]
 end
 
-describe Asciidoctor::Diagram::SymbolatorBlockMacroProcessor, :broken_on_windows do
+describe Asciidoctor::Diagram::SymbolatorBlockMacroProcessor, :broken_on_windows, :broken_on_github do
   include_examples "block_macro", :symbolator, SYMBOLATOR_CODE, [:png, :svg, :pdf]
 end
 
-describe Asciidoctor::Diagram::SymbolatorBlockProcessor, :broken_on_windows do
+describe Asciidoctor::Diagram::SymbolatorBlockProcessor, :broken_on_windows, :broken_on_github do
   include_examples "block", :symbolator, SYMBOLATOR_CODE, [:png, :svg, :pdf]
 end

data/spec/syntrax_spec.rb

@@ -9,14 +9,14 @@ indentstack(10,
 )
 eos
 
-describe Asciidoctor::Diagram::SyntraxInlineMacroProcessor, :broken_on_windows do
+describe Asciidoctor::Diagram::SyntraxInlineMacroProcessor, :broken_on_windows, :broken_on_github do
   include_examples "inline_macro", :syntrax, SYNTRAX_CODE, [:png, :svg]
 end
 
-describe Asciidoctor::Diagram::SyntraxBlockMacroProcessor, :broken_on_windows do
+describe Asciidoctor::Diagram::SyntraxBlockMacroProcessor, :broken_on_windows, :broken_on_github do
   include_examples "block_macro", :syntrax, SYNTRAX_CODE, [:png, :svg]
 end
 
-describe Asciidoctor::Diagram::SyntraxBlockProcessor, :broken_on_windows do
+describe Asciidoctor::Diagram::SyntraxBlockProcessor, :broken_on_windows, :broken_on_github do
   include_examples "block", :syntrax, SYNTRAX_CODE, [:png, :svg]
 end

data/spec/wavedrom_spec.rb

@@ -8,14 +8,14 @@ WAVEDROM_CODE = <<-eos
 ]}
 eos
 
-describe Asciidoctor::Diagram::WavedromInlineMacroProcessor, :broken_on_windows do
+describe Asciidoctor::Diagram::WavedromInlineMacroProcessor, :broken_on_windows, :broken_on_github do
   include_examples "inline_macro", :wavedrom, WAVEDROM_CODE, [:png, :svg]
 end
 
-describe Asciidoctor::Diagram::WavedromBlockMacroProcessor, :broken_on_windows do
+describe Asciidoctor::Diagram::WavedromBlockMacroProcessor, :broken_on_windows, :broken_on_github do
   include_examples "block_macro", :wavedrom, WAVEDROM_CODE, [:png, :svg]
 end
 
-describe Asciidoctor::Diagram::WavedromBlockProcessor, :broken_on_windows do
+describe Asciidoctor::Diagram::WavedromBlockProcessor, :broken_on_windows, :broken_on_github do
   include_examples "block", :wavedrom, WAVEDROM_CODE, [:png, :svg]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2022-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,7 +164,7 @@ files:
 - lib/asciidoctor-diagram/diagrams/extension.rb
 - lib/asciidoctor-diagram/ditaa.rb
 - lib/asciidoctor-diagram/ditaa/converter.rb
-- lib/asciidoctor-diagram/ditaa/ditaa-1.3.20.jar
+- lib/asciidoctor-diagram/ditaa/ditaa-1.3.21.jar
 - lib/asciidoctor-diagram/ditaa/extension.rb
 - lib/asciidoctor-diagram/dpic.rb
 - lib/asciidoctor-diagram/dpic/converter.rb
@@ -178,6 +178,9 @@ files:
 - lib/asciidoctor-diagram/graphviz.rb
 - lib/asciidoctor-diagram/graphviz/converter.rb
 - lib/asciidoctor-diagram/graphviz/extension.rb
+- lib/asciidoctor-diagram/graphviz_py.rb
+- lib/asciidoctor-diagram/graphviz_py/converter.rb
+- lib/asciidoctor-diagram/graphviz_py/extension.rb
 - lib/asciidoctor-diagram/http/converter.rb
 - lib/asciidoctor-diagram/http/server.rb
 - lib/asciidoctor-diagram/lilypond.rb
@@ -201,7 +204,7 @@ files:
 - lib/asciidoctor-diagram/plantuml.rb
 - lib/asciidoctor-diagram/plantuml/converter.rb
 - lib/asciidoctor-diagram/plantuml/extension.rb
-- lib/asciidoctor-diagram/plantuml/plantuml-1.3.20.jar
+- lib/asciidoctor-diagram/plantuml/plantuml-1.3.21.jar
 - lib/asciidoctor-diagram/salt.rb
 - lib/asciidoctor-diagram/shaape.rb
 - lib/asciidoctor-diagram/shaape/converter.rb
@@ -234,7 +237,7 @@ files:
 - lib/asciidoctor-diagram/util/pdf.rb
 - lib/asciidoctor-diagram/util/platform.rb
 - lib/asciidoctor-diagram/util/png.rb
-- lib/asciidoctor-diagram/util/server-1.3.20.jar
+- lib/asciidoctor-diagram/util/server-1.3.21.jar
 - lib/asciidoctor-diagram/util/svg.rb
 - lib/asciidoctor-diagram/util/which.rb
 - lib/asciidoctor-diagram/vega.rb
@@ -254,6 +257,7 @@ files:
 - spec/dpic_spec.rb
 - spec/erd_spec.rb
 - spec/gnuplot_spec.rb
+- spec/graphviz_py_spec.rb
 - spec/graphviz_spec.rb
 - spec/lilypond_spec.rb
 - spec/man.jpg
@@ -278,7 +282,7 @@ homepage: https://github.com/asciidoctor/asciidoctor-diagram
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -293,8 +297,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A family of Asciidoctor extensions that generate images from a broad range
   of embedded plain text diagram descriptions, including PlantUML, ditaa, Kroki, and
@@ -310,6 +314,7 @@ test_files:
 - spec/dpic_spec.rb
 - spec/erd_spec.rb
 - spec/gnuplot_spec.rb
+- spec/graphviz_py_spec.rb
 - spec/graphviz_spec.rb
 - spec/lilypond_spec.rb
 - spec/man.jpg