asciidoctor-diagram 2.3.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e68570e8ec8e10bd6815b05ef8a6884716fe9bdeb6da30c30d813fe15eef3514
-  data.tar.gz: 426bebf1b41d3f4f3d262a41d90db635f1dffe711de6bde0ac112ffd03b6e496
+  metadata.gz: 993b52833cbee514282ba62841b0dfafc69760770884a42ea24843b6e9b58224
+  data.tar.gz: 38d9215b0859313c6610ec6876b65e2fee4437b87bcc1f2a01465c39db8dedc4
 SHA512:
-  metadata.gz: f97b8cad30f43d309e2607c8cbcec8e8f64998de86255ea80e717e5886165632b8e5f0ab97674375cf59edb1249807d2a23c475a9b58de64a611a9182b574ccc
-  data.tar.gz: 5d0ff9dd8bed877c2e5db712320779486735b5cc24ea87c0c3623f94a27be949d84849ed6e504e8428535cdf394ffbccaecebdeb4d7e9d98525a8ddf12f66849
+  metadata.gz: 15477c98c7d90da97ce45106f2f6159b26eb60caeeb0e9d36a700959e15aba484449334ba31c4d74e1bb6806f3360d477e1c424242ad2c3657dd2135d4d9b89f
+  data.tar.gz: 18b93c67ac75d7916eab56073b92a49c6a22ec52be0bc48bc5431d967d2c2a7968d570146a2c53acbf773452453b67dc76c539b69e5e3c9ce9df2d857d9d9cff

data/CHANGELOG.adoc

@@ -1,5 +1,16 @@
 = Asciidoctor-diagram Changelog
 
+== 3.0.0
+
+Breaking Changes::
+
+* Asciidoctor Diagram no longer has a runtime dependency on the https://rubygems.org/gems/asciidoctor-diagram-ditaamini[asciidoctor-diagram-ditaamini] and https://rubygems.org/gems/asciidoctor-diagram-plantuml[asciidoctor-diagram-plantuml] gems.
+  These gems will now have to be installed and required explicitly if necessary.
+
+Enhancements::
+
+* Issue #478: Add support for PlantUML native image builds (@fliiiix)
+
 == 2.3.2
 
 Enhancements::

data/README.adoc

@@ -23,19 +23,23 @@ The example below shows an embedded Ditaa diagram block.
 ---------
 [ditaa]
 ----
-                  +-------------+
-                  | asciidoctor |---------------+
-                  |  diagram    |               |
-                  +-------------+               | image
-                         ^                      |
-                         | diagram source       |
-                         |                      v
- +--------+       +------+------+        /--------------\
- |  adoc  |------>+ asciidoctor +------->| HTML + image |
- +--------+       +-------------+  html  \--------------/
+                         +-------------+
+                         |   Diagram   +----------------+
+                         |   Renderer  |                |
+                         +-------------+                |
+                         | Asciidoctor |                |
+                         |   Diagram   |                |
+                         +-------------+                | Image
+                                ^                       |
+                                | Diagram source        |
+ +---------------+              |                       v
+ |    Asciidoc   |       +------+------+        /-------+------\
+ | with embedded +------>+ Asciidoctor +------->|   Beautiful  |
+ |    diagram {d}|       +-------------+  HTML  |    Output    |
+ +---------------+                              \--------------/
 ----
 ---------
 
 After processing by Asciidoctor, the output file will show a rendered version of the diagram instead of the diagram source code.
 
-image::docs/modules/ROOT/images/asciidoctor-diagram-process.png[]
+image::docs/modules/ROOT/images/asciidoctor-diagram-process.png[]

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

@@ -1,5 +1,7 @@
 require_relative '../diagram_converter'
 require_relative '../util/java'
+require_relative '../util/cli'
+require_relative '../util/cli_generator'
 require 'delegate'
 require 'uri'
 
@@ -8,6 +10,7 @@ module Asciidoctor
     # @private
     class PlantUmlConverter
       include DiagramConverter
+      include CliGenerator
 
       CLASSPATH_ENV = Java.environment_variable('DIAGRAM_PLANTUML_CLASSPATH')
       LIB_DIR = File.expand_path('../..', File.dirname(__FILE__))
@@ -27,6 +30,15 @@ module Asciidoctor
         Java.classpath.concat PLANTUML_JARS
       end
 
+      def self.find_plantuml_native(source)
+        source.find_command(
+          'plantuml-full',
+          :raise_on_error => false,
+          :attrs => ['plantuml-native'],
+          :alt_cmds => ['plantuml-headless']
+        )
+      end
+
       def wrap_source(source)
         PlantUMLPreprocessedSource.new(source, self)
       end
@@ -54,6 +66,19 @@ module Asciidoctor
         source.attr('preprocess', 'true') == 'true'
       end
 
+      def convert(source, format, options)
+        plantuml_native = PlantUmlConverter.find_plantuml_native(source)
+        if plantuml_native
+          convert_native(plantuml_native, source, format, options)
+        elsif PLANTUML_JARS
+          convert_http(source, format, options)
+        else
+          raise "Could not load PlantUML. Either require 'asciidoctor-diagram-plantuml' " \
+                  "or specify the location of the PlantUML JAR(s) using the 'DIAGRAM_PLANTUML_CLASSPATH' environment variable. " \
+                  "Alternatively a PlantUML binary can be provided (plantuml-native in $PATH)."
+        end
+      end
+
       def add_common_headers(headers, source)
         base_dir = source.base_dir
 
@@ -78,10 +103,7 @@ module Asciidoctor
         headers['X-PlantUML-SizeLimit'] = limit if limit
       end
 
-      def convert(source, format, options)
-        unless PLANTUML_JARS
-          raise "Could not load PlantUML. Either require 'asciidoctor-diagram-plantuml' or specify the location of the PlantUML JAR(s) using the 'DIAGRAM_PLANTUML_CLASSPATH' environment variable."
-        end
+      def convert_http(source, format, options)
         Java.load
 
         code = source.code
@@ -100,7 +122,7 @@ module Asciidoctor
         end
 
         headers = {
-            'Accept' => mime_type
+          'Accept' => mime_type
         }
 
         unless should_preprocess(source)
@@ -122,9 +144,9 @@ module Asciidoctor
         end
 
         response = Java.send_request(
-            :url => '/plantuml',
-            :body => code,
-            :headers => headers
+          :url => '/plantuml',
+          :body => code,
+          :headers => headers
         )
 
         unless response[:code] == 200
@@ -163,6 +185,77 @@ module Asciidoctor
           response[:body]
         end
       end
+
+      def add_theme_arg(args, theme)
+        if theme
+          args << '-theme' << theme
+        end
+      end
+
+      def add_common_args(args, source)
+        base_dir = File.expand_path(source.base_dir)
+        args << '-filedir'
+        args << base_dir
+
+        config_file = source.attr('plantumlconfig', nil, true) || source.attr('config')
+        if config_file
+          args << '-config'
+          args << File.expand_path(config_file, base_dir)
+        end
+
+        include_dir = source.attr('includedir')
+        if include_dir
+          args << "-Dplantuml.include.path=#{Platform.native_path(File.expand_path(include_dir, base_dir))}"
+        end
+      end
+
+      def convert_native(plantuml, source, format, options)
+        code = source.code
+
+        args = []
+        env = {}
+
+        args << case format
+        when :png
+          '-tpng'
+        when :svg
+          '-tsvg'
+        when :txt, :utxt
+          '-tutxt'
+        when :atxt
+          '-ttxt'
+        else
+          raise "Unsupported format: #{format}"
+        end
+
+        add_common_args(args, source)
+        add_theme_arg(args, options[:theme])
+
+        if options[:size_limit]
+          env['PLANTUML_LIMIT_SIZE'] = options[:size_limit]
+        end
+
+        dot = source.find_command('dot', :alt_attrs => ['graphvizdot'], :raise_on_error => false)
+        if options[:smetana] || !dot
+          args << '-Playout=smetana'
+        else
+          args << '-graphvizdot'
+          args << ::Asciidoctor::Diagram::Platform.host_os_path(dot)
+        end
+
+        generate_stdin_stdout(plantuml, code) do |tool, _|
+          cmd = [tool]
+          cmd << '-pipe'
+          cmd << '-failfast2'
+          cmd << '-stdrpt:1'
+          cmd.concat args
+
+          {
+            :args => cmd,
+            :env => env
+          }
+        end
+      end
     end
 
     class UmlConverter < PlantUmlConverter
@@ -178,6 +271,8 @@ module Asciidoctor
     end
 
     class PlantUMLPreprocessedSource < SimpleDelegator
+      include CliGenerator
+
       def initialize(source, converter)
         super(source)
         @converter = converter
@@ -188,34 +283,82 @@ module Asciidoctor
       end
 
       def load_code
-        Java.load
-
         code = __getobj__.code
 
         tag = @converter.class.tag
         code = "@start#{tag}\n#{code}\n@end#{tag}" unless code.index("@start") && code.index("@end")
 
         if @converter.should_preprocess(self)
-          headers = {}
-          @converter.add_common_headers(headers, self)
-          @converter.add_theme_header(headers, @converter.collect_options(self)[:theme])
-
-          response = Java.send_request(
-            :url => '/plantumlpreprocessor',
-            :body => code,
-            :headers => headers
-          )
-
-          unless response[:code] == 200
-            raise Java.create_error("PlantUML preprocessing failed", response)
+          plantuml_native = PlantUmlConverter.find_plantuml_native(self)
+          if plantuml_native
+            code = preprocess_native(plantuml_native, code)
+          else
+            code = preprocess_http(code)
           end
-
-          code = response[:body]
-          code.force_encoding(Encoding::UTF_8)
         end
 
         code
       end
+
+      private
+
+      def preprocess_http(code)
+        Java.load
+
+        headers = {}
+        @converter.add_common_headers(headers, self)
+        @converter.add_theme_header(headers, @converter.collect_options(self)[:theme])
+
+        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
+
+      def preprocess_native(plantuml, code)
+        generate_stdin_stdout(plantuml, code) do |tool, _|
+          cmd = [tool]
+          cmd << '-pipe'
+          cmd << '-preproc'
+          cmd << '-failfast2'
+          cmd << '-stdrpt:1'
+
+          @converter.add_common_args(cmd, self)
+          @converter.add_theme_arg(cmd, @converter.collect_options(self)[:theme])
+
+          base_dir = File.expand_path(self.base_dir)
+          cmd << '-filedir'
+          cmd << base_dir
+
+          config_file = self.attr('plantumlconfig', nil, true) || self.attr('config')
+          if config_file
+            cmd << '-config'
+            cmd <<  File.expand_path(config_file, base_dir)
+          end
+
+          include_dir = self.attr('includedir')
+          if include_dir
+            cmd << "-Dplantuml.include.path=#{Platform.native_path(File.expand_path(include_dir, base_dir))}"
+          end
+
+          theme = @converter.collect_options(self)[:theme]
+          if theme
+            cmd << '-theme' << theme
+          end
+
+          {
+            :args => cmd
+          }
+        end
+      end
     end
   end
 end

data/lib/asciidoctor-diagram/util/cli.rb

@@ -100,7 +100,7 @@ module Asciidoctor
           exit = status.exitstatus
 
           if exit != 0
-            raise "#{cmd} failed: #{stdout.empty? ? stderr : stdout}"
+            raise "#{cmd} failed: #{stderr.empty? ? stdout : stderr}"
           end
 
           {

data/lib/asciidoctor-diagram/util/java_jruby.rb

@@ -18,6 +18,16 @@ module Asciidoctor
           raise "Classpath item #{j} does not exist" unless File.exist?(j)
           require j
         end
+
+        # Strange issue seen with JRuby where 'java.class.path' has the value ':'.
+        # This causes issue in PlantUML which splits the class path string and then
+        # raises errors when trying to handle empty strings.
+        java_cp = ::Java.java.lang.System.getProperty("java.class.path")
+        new_java_cp = java_cp.split(File::PATH_SEPARATOR)
+                             .reject { |p| p.empty? }
+                             .join "File::PATH_SEPARATOR"
+        ::Java.java.lang.System.setProperty("java.class.path", new_java_cp)
+
         @loaded = true
       end
 

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "2.3.2"
+    VERSION = "3.0.0"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-24 00:00:00.000000000 Z
+date: 2025-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,34 +71,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.x
-- !ruby/object:Gem::Dependency
-  name: asciidoctor-diagram-ditaamini
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: asciidoctor-diagram-plantuml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2021'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2021'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
@@ -261,7 +232,6 @@ metadata:
   documentation_uri: https://docs.asciidoctor.org/diagram-extension/latest/
   homepage_uri: https://github.com/asciidoctor/asciidoctor-diagram
   source_code_uri: https://github.com/asciidoctor/asciidoctor-diagram.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -276,8 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.6.3
 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