asciidoctor-diagram 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b61be6550e54410780169ba1b9f96a6656547d8c410fb066e7e02653f0926b86
-  data.tar.gz: d8925319d5183c846784ee1d4aa78d7caa622f6beef3f693d7d2ac4e473b0e57
+  metadata.gz: 50d63dc4a063cfe9e7d03d217a2c9067042846dc23a46e27a3556ae7e7bb978c
+  data.tar.gz: f485e1ae1e9e20fce49499f888516339b8d927385704630ffb755de5fd917bff
 SHA512:
-  metadata.gz: '02039d9b5b7657f8bdeab77cf80aa1135f27c293ecf16912378c61add0fbd6e5de8355198f61880af54a79dee9c4fa1fea15fce8b57c09ee872c3dcdfcd8e27a'
-  data.tar.gz: 8d85bac0ac098b5151fdf724cd72eade0d9c9f2b8bf0c6522178b13f3275797d6b777e1a2483c315b19f597557e05dea6e79e206dce58d895116f47950e7aaea
+  metadata.gz: dc96dcd60863d23914cdc3007919093b149b755b66f1dd8fac36915c3b5e5ad24b927bed61ff59403ee82701195f3fc3aa01090f7a07d7f72a7b48b90967db3f
+  data.tar.gz: dd9b97377452d1cb6c519e1a891c570bcd5237ee59464c8f198370c6ca3bc690c8ab0944b4bbccf393d21f40f7aa5fd660745370308a0515bd1d1fc95c47da5d

data/CHANGELOG.adoc

@@ -1,5 +1,21 @@
 = Asciidoctor-diagram Changelog
 
+== 3.1.0
+
+Enhancements::
+
+* Issue #492: Add support for oxdraw
+* Issue #496: Add `cache-images` option to keep a copy of generated images in the cache directory
+* Issue #498: Add support for GoAT (@jmooring)
+* Issue #499: Provide more control over label size in `meme` images
+
+Bugfixes::
+
+* Issue #487: Resolve issue where the `java.class.path` system property was being set to an incorrect value when running in JRuby
+* Resolve compatibility issues with PlantUML 1.2025.9
+* Issue #494: Resolve compatibility issues with Structurizr 5.x
+
+
 == 3.0.1
 
 Bugfixes::

data/lib/asciidoctor-diagram/diagram_processor.rb

@@ -172,18 +172,26 @@ module Asciidoctor
         image_file = parent.normalize_system_path(image_name, image_output_dir(parent))
         metadata_file = parent.normalize_system_path("#{image_name}.cache", cache_dir(source, parent))
 
+        metadata = {}
+        cached_image_file = image_file
+
         use_cache = !source.global_opt('nocache')
+        if use_cache
+          if File.exist?(metadata_file)
+            metadata = File.open(metadata_file, 'r') { |f| JSON.load(f, nil, :symbolize_names => true, :create_additions => false) }
+          end
 
-        if use_cache && File.exist?(metadata_file)
-          metadata = File.open(metadata_file, 'r') {|f| JSON.load(f, nil, :symbolize_names => true, :create_additions => false) }
-        else
-          metadata = {}
+          if source.global_opt('cache-images')
+            cached_image_file = parent.normalize_system_path("#{image_name}", cache_dir(source, parent))
+          end
         end
 
         image_attributes = source.attributes
         options = converter.collect_options(source)
 
-        if !File.exist?(image_file) || source.should_process?(image_file, metadata) || options != metadata[:options]
+        regenerate_image = !File.exist?(cached_image_file) || source.should_process?(cached_image_file, metadata) || options != metadata[:options]
+
+        if regenerate_image
           params = IMAGE_PARAMS[format]
 
           server_url = source.global_attr('server-url')
@@ -209,11 +217,11 @@ module Asciidoctor
           allow_image_optimisation = !source.global_opt('nooptimise')
           image, metadata[:width], metadata[:height] = params[:decoder].post_process_image(image, allow_image_optimisation)
 
-          FileUtils.mkdir_p(File.dirname(image_file)) unless Dir.exist?(File.dirname(image_file))
-          File.open(image_file, 'wb') {|f| f.write image}
+          FileUtils.mkdir_p(File.dirname(cached_image_file)) unless Dir.exist?(File.dirname(cached_image_file))
+          File.open(cached_image_file, 'wb') {|f| f.write image}
 
           extra.each do |name, data|
-            File.open(image_file + ".#{name}", 'wb') {|f| f.write data}
+            File.open(cached_image_file + ".#{name}", 'wb') {|f| f.write data}
           end
 
           if use_cache
@@ -224,6 +232,21 @@ module Asciidoctor
           end
         end
 
+        if cached_image_file != image_file && (!File.exist?(image_file) || regenerate_image)
+          FileUtils.mkdir_p(File.dirname(image_file)) unless Dir.exist?(File.dirname(image_file))
+
+          if Platform.os != :windows
+            begin
+              FileUtils.rm_f(image_file) if File.exist?(image_file)
+              File.link(cached_image_file, image_file)
+            rescue Errno::EXDEV
+              FileUtils.cp(cached_image_file, image_file, preserve: true)
+            end
+          else
+            FileUtils.cp(cached_image_file, image_file, preserve: true)
+          end
+        end
+
         scale = image_attributes['scale']
         if !converter.native_scaling? && scalematch = /([0-9]+(?:\.[0-9]+)?)/.match(scale)
           scale_factor = scalematch[1].to_f

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

@@ -0,0 +1,37 @@
+require_relative "../diagram_converter"
+require_relative "../util/cli_generator"
+require_relative "../util/platform"
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class GoATConverter
+      include DiagramConverter
+      include CliGenerator
+
+      def supported_formats
+        [:svg]
+      end
+
+      def collect_options(source)
+        {
+          sds: source.attr("svg-color-dark-scheme"),
+          sls: source.attr("svg-color-light-scheme"),
+        }
+      end
+
+      def convert(source, format, options)
+        sds, sls = options.values_at(:sds, :sls)
+        generate_stdin_stdout(source.find_command("goat"), source.code) do |tool|
+          args = [tool]
+          args.push("-sds", sds) if sds
+          args.push("-sls", sls) if sls
+          {
+            args: args,
+            chdir: source.base_dir,
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "converter"
+require_relative "../diagram_processor"
+
+module Asciidoctor
+  module Diagram
+    class GoATBlockProcessor < DiagramBlockProcessor
+      use_converter GoATConverter
+    end
+
+    class GoATBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter GoATConverter
+    end
+
+    class GoATInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter GoATConverter
+    end
+  end
+end

data/lib/asciidoctor-diagram/goat.rb

@@ -0,0 +1,8 @@
+require "asciidoctor/extensions"
+require_relative "goat/extension"
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::GoATBlockProcessor, :goat
+  block_macro Asciidoctor::Diagram::GoATBlockMacroProcessor, :goat
+  inline_macro Asciidoctor::Diagram::GoATInlineMacroProcessor, :goat
+end

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

@@ -19,27 +19,7 @@ module Asciidoctor
         bg_img = source.attr('background')
         raise "background attribute is required" unless bg_img
 
-        margin = source.attr('margin', '')
-        margin_parts = margin.split(' ')
-        case margin_parts.length
-          when 0
-            ml = mr = mt = mb = nil
-          when 1
-            ml = mr = mt = mb = margin_parts[0]
-          when 2
-            mt = mb = margin_parts[0]
-            ml = mr = margin_parts[1]
-          when 3
-            mt = margin_parts[0]
-            ml = mr = margin_parts[1]
-            mb = margin_parts[2]
-          else
-            mt = margin_parts[0]
-            mr = margin_parts[1]
-            mb = margin_parts[2]
-            ml = margin_parts[3]
-        end
-
+        height = source.attr('height-fraction', '20%')
         {
             :bg_img => bg_img,
             :top_label => source.attr('top'),
@@ -48,12 +28,9 @@ module Asciidoctor
             :stroke_color => source.attr(['strokecolor', 'stroke-color']),
             :stroke_width => source.attr(['strokewidth', 'stroke-width']),
             :font => source.attr('font', 'Impact'),
-            :font_size => source.attr('font_size', nil),
-            :alignment => source.attr('alignment', nil),
-            :margin_left => ml,
-            :margin_right => mr,
-            :margin_top => mt,
-            :margin_bottom => mb,
+            :height => height,
+            :top_height => source.attr('top-height', height),
+            :bottom_height => source.attr('bottom-height', height),
             :noupcase => source.opt('noupcase'),
             :imagesdir => source.attr('imagesdir')
         }
@@ -88,7 +65,8 @@ module Asciidoctor
         bg_width = dimensions['w'].to_i
         bg_height = dimensions['h'].to_i
         label_width = bg_width
-        label_height = bg_height / 5
+        top_label_height = calculate_height(bg_height, options[:top_height])
+        bottom_label_height = calculate_height(bg_height, options[:bottom_height])
 
         if top_label
           top_img = Tempfile.new(['meme', '.png'])
@@ -98,7 +76,7 @@ module Asciidoctor
               '-stroke', stroke_color,
               '-strokewidth', stroke_width,
               '-font', font,
-              '-size', "#{label_width}x#{label_height}",
+              '-size', "#{label_width}x#{top_label_height}",
               '-gravity', 'north',
               "label:#{prepare_label(top_label, noupcase)}",
               top_img.path
@@ -115,7 +93,7 @@ module Asciidoctor
               '-stroke', stroke_color,
               '-strokewidth', stroke_width,
               '-font', font,
-              '-size', "#{label_width}x#{label_height}",
+              '-size', "#{label_width}x#{bottom_label_height}",
               '-gravity', 'south',
               "label:#{prepare_label(bottom_label, noupcase)}",
               bottom_img.path
@@ -132,7 +110,7 @@ module Asciidoctor
         end
 
         if bottom_img
-          args << bottom_img.path << '-geometry' << "+0+#{bg_height - label_height}" << '-composite'
+          args << bottom_img.path << '-geometry' << "+0+#{bg_height - bottom_label_height}" << '-composite'
         end
 
         args << final_img.path
@@ -149,6 +127,16 @@ module Asciidoctor
         label = label.gsub(' // ', '\n')
         label
       end
+
+      def calculate_height(total_height, fraction_or_absolute_height)
+        if fraction_or_absolute_height.match(/^(\d+)%$/)
+          total_height * $1.to_i / 100
+        elsif fraction_or_absolute_height.match(/^(\d+)(px)?$/)
+          $1.to_i
+        else
+          raise "Invalid height value '#{fraction_or_absolute_height}'"
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,64 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class OxdrawConverter
+      include DiagramConverter
+      include CliGenerator
+
+      def supported_formats
+        [:svg, :png]
+      end
+
+      def native_scaling?
+        true
+      end
+
+      def collect_options(source)
+        {
+          :background => source.attr('background'),
+          :scale => source.attr('scale')
+        }
+      end
+
+      def convert(source, format, options)
+        data = generate_stdin(source.find_command('oxdraw'), format.to_s, source.code) do |tool_path, output_path|
+          args = [tool_path]
+
+          options.each_pair do |key, value|
+            unless value.nil?
+              args << "--#{key.to_s.gsub('_', '-')}"
+              args << value
+            end
+          end
+
+          args << '--input'
+          args << '-'
+          args << '--output'
+          args << Platform.native_path(output_path)
+          args << '--output-format'
+          args << format.to_s
+          args << '--quiet'
+
+          {
+            :args => args,
+            :chdir => source.base_dir
+          }
+        end
+
+        # oxdraw doesn't perform scaling for SVG files, so we have to do it ourselves since we claim to support native
+        # scaling
+        if format == :svg && options[:scale]
+          scale = options[:scale].to_f
+          data.sub!(/(<svg.*width=")([0-9]+)(".*>)/) { |_| $1 + ($2.to_i * scale).to_i.to_s + $3 }
+          data.sub!(/(<svg.*height=")([0-9]+)(".*>)/) { |_| $1 + ($2.to_i * scale).to_i.to_s + $3 }
+        end
+
+        data
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative 'converter'
+require_relative '../diagram_processor'
+
+module Asciidoctor
+  module Diagram
+    class OxdrawBlockProcessor < DiagramBlockProcessor
+      use_converter OxdrawConverter
+    end
+
+    class OxdrawBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter OxdrawConverter
+    end
+
+    class OxdrawInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter OxdrawConverter
+    end
+  end
+end

data/lib/asciidoctor-diagram/oxdraw.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'oxdraw/extension'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::OxdrawBlockProcessor, :oxdraw
+  block_macro Asciidoctor::Diagram::OxdrawBlockMacroProcessor, :oxdraw
+  inline_macro Asciidoctor::Diagram::OxdrawInlineMacroProcessor, :oxdraw
+end

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

@@ -50,7 +50,7 @@ module Asciidoctor
         }
         headers['X-Structurizr-View'] = options[:view] if options[:view]
         headers['X-Structurizr-IncludeDir'] = Platform.native_path(source.base_dir)
-
+        headers['X-Structurizr-Secure'] = 'false'
 
         response = Java.send_request(
           :url => '/structurizr',

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

@@ -25,7 +25,7 @@ module Asciidoctor
         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"
+                             .join(File::PATH_SEPARATOR)
         ::Java.java.lang.System.setProperty("java.class.path", new_java_cp)
 
         @loaded = true

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "3.0.1"
+    VERSION = "3.1.0"
   end
 end

data/lib/asciidoctor-diagram.rb

@@ -9,6 +9,7 @@ require_relative 'asciidoctor-diagram/diagrams'
 require_relative 'asciidoctor-diagram/ditaa'
 require_relative 'asciidoctor-diagram/dpic'
 require_relative 'asciidoctor-diagram/erd'
+require_relative 'asciidoctor-diagram/goat'
 require_relative 'asciidoctor-diagram/gnuplot'
 require_relative 'asciidoctor-diagram/graphviz'
 require_relative 'asciidoctor-diagram/graphviz_py'
@@ -17,6 +18,7 @@ require_relative 'asciidoctor-diagram/meme'
 require_relative 'asciidoctor-diagram/mermaid'
 require_relative 'asciidoctor-diagram/msc'
 require_relative 'asciidoctor-diagram/nomnoml'
+require_relative 'asciidoctor-diagram/oxdraw'
 require_relative 'asciidoctor-diagram/penrose'
 require_relative 'asciidoctor-diagram/pikchr'
 require_relative 'asciidoctor-diagram/pintora'

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-19 00:00:00.000000000 Z
+date: 2025-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,6 +139,9 @@ files:
 - lib/asciidoctor-diagram/gnuplot.rb
 - lib/asciidoctor-diagram/gnuplot/converter.rb
 - lib/asciidoctor-diagram/gnuplot/extension.rb
+- lib/asciidoctor-diagram/goat.rb
+- lib/asciidoctor-diagram/goat/converter.rb
+- lib/asciidoctor-diagram/goat/extension.rb
 - lib/asciidoctor-diagram/graphviz.rb
 - lib/asciidoctor-diagram/graphviz/converter.rb
 - lib/asciidoctor-diagram/graphviz/extension.rb
@@ -161,6 +165,9 @@ files:
 - lib/asciidoctor-diagram/nomnoml.rb
 - lib/asciidoctor-diagram/nomnoml/converter.rb
 - lib/asciidoctor-diagram/nomnoml/extension.rb
+- lib/asciidoctor-diagram/oxdraw.rb
+- lib/asciidoctor-diagram/oxdraw/converter.rb
+- lib/asciidoctor-diagram/oxdraw/extension.rb
 - lib/asciidoctor-diagram/penrose.rb
 - lib/asciidoctor-diagram/penrose/converter.rb
 - lib/asciidoctor-diagram/penrose/extension.rb
@@ -173,7 +180,7 @@ files:
 - lib/asciidoctor-diagram/plantuml.rb
 - lib/asciidoctor-diagram/plantuml/converter.rb
 - lib/asciidoctor-diagram/plantuml/extension.rb
-- lib/asciidoctor-diagram/plantuml/plantuml-2.2.5.jar
+- lib/asciidoctor-diagram/plantuml/plantuml-2.2.6.jar
 - lib/asciidoctor-diagram/salt.rb
 - lib/asciidoctor-diagram/shaape.rb
 - lib/asciidoctor-diagram/shaape/converter.rb
@@ -185,7 +192,7 @@ files:
 - lib/asciidoctor-diagram/structurizr/converter.rb
 - lib/asciidoctor-diagram/structurizr/extension.rb
 - lib/asciidoctor-diagram/structurizr/renderers.rb
-- lib/asciidoctor-diagram/structurizr/structurizr-2.2.2.jar
+- lib/asciidoctor-diagram/structurizr/structurizr-2.2.9.jar
 - lib/asciidoctor-diagram/svgbob.rb
 - lib/asciidoctor-diagram/svgbob/converter.rb
 - lib/asciidoctor-diagram/svgbob/extension.rb
@@ -232,6 +239,7 @@ 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
@@ -246,7 +254,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.5.16
+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