asciidoctor-diagram 2.2.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c2f34fcc568a14ae6c72579b4a9e8ef429cbc1b023ae9c20945084a212ad844
-  data.tar.gz: 7a11bdd3d63d22c3e472671b9a3e74ea3945edf80757350aaf6bfde690a9c392
+  metadata.gz: 993b52833cbee514282ba62841b0dfafc69760770884a42ea24843b6e9b58224
+  data.tar.gz: 38d9215b0859313c6610ec6876b65e2fee4437b87bcc1f2a01465c39db8dedc4
 SHA512:
-  metadata.gz: ec745e7abc74b9ab114922de70fcc2fe01cd367cb60b1d47e90ee28ce120c7082400fa7d7176c2b0c9f47ea0a643a19dde64861d63460920b19e4157ff1aa706
-  data.tar.gz: 9bc01b94478a69b8782e5fe7c3ffffa95cc9dbdbbc5092f64f3dfc340f84bdc65d0cb62c72445fbb3dbcce12befe2f4d6011782542ade71681e2a9636393872d
+  metadata.gz: 15477c98c7d90da97ce45106f2f6159b26eb60caeeb0e9d36a700959e15aba484449334ba31c4d74e1bb6806f3360d477e1c424242ad2c3657dd2135d4d9b89f
+  data.tar.gz: 18b93c67ac75d7916eab56073b92a49c6a22ec52be0bc48bc5431d967d2c2a7968d570146a2c53acbf773452453b67dc76c539b69e5e3c9ce9df2d857d9d9cff

data/CHANGELOG.adoc

@@ -1,5 +1,164 @@
 = 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::
+
+* Issue #465: Add support for https://pintorajs.vercel.app/[Pintora]
+* Issue #476: Use PlantUML's Smetana layout engine by default if Graphviz cannot be located
+* Issue #477: Improve support for using plantuml.com as PlantUML rendering server
+* Add support for Structurizr JSON workspaces
+* Prefer non-PDF formats when rendering with HTML backend
+
+== 2.3.1
+
+Enhancements::
+
+* Issue #423: Add support for loading JSyntrax via the `asciidoctor-diagram-jsyntrax` gem (@inponomarev)
+* Issue #464: Remove usage of 'base64' gem to resolve Ruby 3.3+ compatibility issues
+
+Bugfixes::
+
+* Issue #459: Fix lookup of `wavedrom-cli` location on Windows
+
+== 2.3.0
+
+Enhancements::
+
+* Issue #457: Relaxed Java version requirement from 11 to 1.8 (for tools that support it)
+
+== 2.2.18
+
+Enhancements::
+
+* Add opt-in support for the PlantUML Smetana layout engine
+
+== 2.2.17
+
+Bugfixes::
+
+* Issue #455: Fix regression in reading of UTF-8 source files introduced in 2.2.15
+
+== 2.2.16
+
+Bugfixes::
+
+* Issue #453: Avoid internal error when WaveDrom cannot be located
+
+== 2.2.15
+
+Enhacements::
+
+* Issue #453: Improve error message when WaveDrom cannot be located
+
+Bugfixes::
+
+* Issue #428: Improve support for reading UTF-16 encoded source files
+* Issue #449: Fix resolving of relative `!include` paths in Structurizr DSL input.
+
+== 2.2.14
+
+Bugfixes::
+
+* Issue #441: Fix regression in Wavedrom integration.
+
+== 2.2.13
+
+Enhancements::
+
+* Issue #436: Allow diagram caching to be disabled using the `nocache` option.
+
+Bugfixes::
+
+* Issue #437: Set working directory when generating diagrams.
+* Issue #439: Resolve errors when using relative imports in D2 diagrams
+
+== 2.2.12
+
+Enhancements::
+
+* Issue #431: Reduce gem file size
+* Resolve loading errors when loading the PlantUML and Struturizr extensions individually
+
+== 2.2.11
+
+Bugfixes::
+
+* Issue #424: avoid invalid filename characters on Windows
+
+== 2.2.10
+
+Enhancements::
+
+* The location of JSyntrax and Structurizr can now also be specified using Java system properties when using JRuby.
+* Add initial https://penrose.cs.cmu.edu[Penrose] support
+
+Bugfixes::
+
+* Ensure Structurizr themes are loaded when rendering images
+* Issue #416: Silence Asciidoctor warning when using inline macros
+* Issue #417: Avoid reusing images when block type is different but source code is identical
+* Remove usage of LilyPond's 'safe' option since it's no longer supported
+
+
+== 2.2.9
+
+Bugfixes::
+
+* Resolve UTF-8 encoding error when generating SVG for GS1-128 barcodes
+* Issue #409: Second attempt at fixing handling of the D2 `sketch` attribute
+* Issue #415: Resolve NoMethodError when using Structurizr blocks
+
+== 2.2.8
+
+Enhancements::
+
+* Add support for reusing JSyntrax subprocess instances to improve performance when rendering many syntax diagrams (@gitrbond, @inponomarev)
+* Issue #386: Add basic https://structurizr.com[Structurizr] support
+
+Bugfixes::
+
+* Issue #409: Fix handling of the D2 `sketch` attribute
+* Issue #410: Ensure current directory is always set to document base directory when invoking subprocesses
+
+== 2.2.7
+
+Enhancements::
+
+* Issue #407: Add https://d2lang.com[D2] support
+
+== 2.2.6
+
+Enhancements::
+
+* Add support for PlantUML 1.2023.x
+
+== 2.2.5
+
+Enhancements::
+
+* Issue #401: Add passthrough `txt` output format support for A2S, Ditaa, and Svgbob
+* Issue #402: Add https://github.com/kaishuu0123/erd-go[erd-go] support
+* Issue #404: Add https://github.com/mscgenjs[mscgenjs] support
+
+== 2.2.4
+
+Enhancements::
+
+* Issue #399: Add support for PlantUML theme attribute
+* Add DBML support via https://github.com/softwaretechnik-berlin/dbml-renderer[dbml-renderer]
+
 == 2.2.3
 
 Enhancements::

data/README.adoc

@@ -2,9 +2,9 @@
 Pepijn Van_Eeckhoudt <https://github.com/pepijnve[@pepijnve]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
 :description: README for the Asciidoctor Diagram extension for Asciidoctor.
 
-image:https://github.com/asciidoctor/asciidoctor-diagram/workflows/Linux%20unit%20tests/badge.svg?branch=master["Linux Build Status", link="https://github.com/asciidoctor/asciidoctor-diagram/actions?query=workflow%3A%22Linux+unit+tests%22"]
-image:https://github.com/asciidoctor/asciidoctor-diagram/workflows/macOS%20unit%20tests/badge.svg?branch=master["macOS Build Status", link="https://github.com/asciidoctor/asciidoctor-diagram/actions?query=workflow%3A%22macOS+unit+tests%22"]
-image:https://github.com/asciidoctor/asciidoctor-diagram/workflows/Windows%20unit%20tests/badge.svg?branch=master["Windows Build Status", link="https://github.com/asciidoctor/asciidoctor-diagram/actions?query=workflow%3A%22Windows+unit+tests%22"]
+image:https://github.com/asciidoctor/asciidoctor-diagram/workflows/Linux%20unit%20tests/badge.svg?branch=main["Linux Build Status", link="https://github.com/asciidoctor/asciidoctor-diagram/actions?query=workflow%3A%22Linux+unit+tests%22"]
+// image:https://github.com/asciidoctor/asciidoctor-diagram/workflows/macOS%20unit%20tests/badge.svg?branch=main["macOS Build Status", link="https://github.com/asciidoctor/asciidoctor-diagram/actions?query=workflow%3A%22macOS+unit+tests%22"]
+// image:https://github.com/asciidoctor/asciidoctor-diagram/workflows/Windows%20unit%20tests/badge.svg?branch=main["Windows Build Status", link="https://github.com/asciidoctor/asciidoctor-diagram/actions?query=workflow%3A%22Windows+unit+tests%22"]
 image:https://badge.fury.io/rb/asciidoctor-diagram.svg[Gem Version, link=https://rubygems.org/gems/asciidoctor-diagram]
 
 Asciidoctor Diagram is a set of Asciidoctor extensions that enable you to add diagrams, which you describe using plain text, to your AsciiDoc document.
@@ -23,16 +23,20 @@ The example below shows an embedded Ditaa diagram block.
 ---------
 [ditaa]
 ----
-              +-------------+
-              | asciidoctor |-----------+
-              |  diagram    |           |
-              +-------------+           | image
-                    ^                   |
-                    | diagram source    |
-                    |                   v
- +--------+   +-----+-------+    /---------------\
- |  adoc  |-->+ asciidoctor +    | HTML + image  |
- +--------+   +-------------+    \---------------/
+                         +-------------+
+                         |   Diagram   +----------------+
+                         |   Renderer  |                |
+                         +-------------+                |
+                         | Asciidoctor |                |
+                         |   Diagram   |                |
+                         +-------------+                | Image
+                                ^                       |
+                                | Diagram source        |
+ +---------------+              |                       v
+ |    Asciidoc   |       +------+------+        /-------+------\
+ | with embedded +------>+ Asciidoctor +------->|   Beautiful  |
+ |    diagram {d}|       +-------------+  HTML  |    Output    |
+ +---------------+                              \--------------/
 ----
 ---------
 

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

@@ -10,7 +10,7 @@ module Asciidoctor
       include CliGenerator
 
       def supported_formats
-        [:svg]
+        [:svg, :txt]
       end
 
       def collect_options(source)
@@ -24,6 +24,8 @@ module Asciidoctor
       end
 
       def convert(source, format, options)
+        return source.to_s if format == :txt
+
         sx = options[:sx]
         sy = options[:sy]
         scale = options[:scale]
@@ -47,7 +49,10 @@ module Asciidoctor
             args << '-f' << font
           end
 
-          args
+          {
+            :args => args,
+            :chdir => source.base_dir
+          }
         end
       end
 

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

@@ -27,7 +27,7 @@ module Asciidoctor
       include DiagramConverter
 
       def supported_formats
-        [:png, :svg, :txt]
+        [:svg, :png, :txt]
       end
 
       def collect_options(source)
@@ -52,84 +52,88 @@ module Asciidoctor
         code = source.code
         type = source.config[:type]
 
-        case type
-          when :bookland
-            require 'barby/barcode/bookland'
-            barcode = Barby::Bookland.new(code)
-          when :codabar
-            require 'barby/barcode/codabar'
-            barcode = Barby::Codabar.new(code)
-          when :code25
-            require 'barby/barcode/code_25'
-            barcode = Barby::Code25.new(code)
-          when :code25iata
-            require 'barby/barcode/code_25_iata'
-            barcode = Barby::Code25IATA.new(code)
-          when :code25interleaved
-            require 'barby/barcode/code_25_interleaved'
-            barcode = Barby::Code25Interleaved.new(code)
-          when :code39
-            require 'barby/barcode/code_39'
-            barcode = Barby::Code39.new(code)
-          when :code93
-            require 'barby/barcode/code_93'
-            barcode = Barby::Code93.new(code)
-          when :code128
-            require 'barby/barcode/code_128'
-            barcode = Barby::Code128.new(code)
-          when :code128a
-            require 'barby/barcode/code_128'
-            barcode = Barby::Code128A.new(code)
-          when :code128b
-            require 'barby/barcode/code_128'
-            barcode = Barby::Code128B.new(code)
-          when :code128c
-            require 'barby/barcode/code_128'
-            barcode = Barby::Code128C.new(code)
-          when :ean8
-            require 'barby/barcode/ean_8'
-            barcode = Barby::EAN8.new(code)
-          when :ean13
-            require 'barby/barcode/ean_13'
-            barcode = Barby::EAN13.new(code)
-          when :gs1_128
-            require 'barby/barcode/code_128'
-            code = code.gsub /\([^)]+\)/ do |control|
-              case control.upcase
-                when '(FNC1)'
-                  Barby::Code128::FNC1
-                when '(FNC2)'
-                  Barby::Code128::FNC2
-                when '(FNC3)'
-                  Barby::Code128::FNC3
-                when '(FNC4)'
-                  Barby::Code128::FNC4
-                when '(CODEA)'
-                  Barby::Code128::CODEA
-                when '(CODEB)'
-                  Barby::Code128::CODEB
-                when '(CODEC)'
-                  Barby::Code128::CODEC
-                when '(SHIFT)'
-                  Barby::Code128::SHIFT
-                when '(SP)'
-                  ' '
-                else
-                  control
+        begin
+          case type
+            when :bookland
+              require 'barby/barcode/bookland'
+              barcode = Barby::Bookland.new(code)
+            when :codabar
+              require 'barby/barcode/codabar'
+              barcode = Barby::Codabar.new(code)
+            when :code25
+              require 'barby/barcode/code_25'
+              barcode = Barby::Code25.new(code)
+            when :code25iata
+              require 'barby/barcode/code_25_iata'
+              barcode = Barby::Code25IATA.new(code)
+            when :code25interleaved
+              require 'barby/barcode/code_25_interleaved'
+              barcode = Barby::Code25Interleaved.new(code)
+            when :code39
+              require 'barby/barcode/code_39'
+              barcode = Barby::Code39.new(code)
+            when :code93
+              require 'barby/barcode/code_93'
+              barcode = Barby::Code93.new(code)
+            when :code128
+              require 'barby/barcode/code_128'
+              barcode = Barby::Code128.new(code)
+            when :code128a
+              require 'barby/barcode/code_128'
+              barcode = Barby::Code128A.new(code)
+            when :code128b
+              require 'barby/barcode/code_128'
+              barcode = Barby::Code128B.new(code)
+            when :code128c
+              require 'barby/barcode/code_128'
+              barcode = Barby::Code128C.new(code)
+            when :ean8
+              require 'barby/barcode/ean_8'
+              barcode = Barby::EAN8.new(code)
+            when :ean13
+              require 'barby/barcode/ean_13'
+              barcode = Barby::EAN13.new(code)
+            when :gs1_128
+              require 'barby/barcode/code_128'
+              gs1_code = code.gsub /\([^)]+\)/ do |control|
+                case control.upcase
+                  when '(FNC1)'
+                    Barby::Code128::FNC1
+                  when '(FNC2)'
+                    Barby::Code128::FNC2
+                  when '(FNC3)'
+                    Barby::Code128::FNC3
+                  when '(FNC4)'
+                    Barby::Code128::FNC4
+                  when '(CODEA)'
+                    Barby::Code128::CODEA
+                  when '(CODEB)'
+                    Barby::Code128::CODEB
+                  when '(CODEC)'
+                    Barby::Code128::CODEC
+                  when '(SHIFT)'
+                    Barby::Code128::SHIFT
+                  when '(SP)'
+                    ' '
+                  else
+                    control
+                end
               end
-            end
-            code = code.gsub(/\s+/, '')
-            code = code.prepend(Barby::Code128::FNC1) unless code[0] == Barby::Code128::FNC1
-            barcode = Barby::Code128.new(code)
-          when :qrcode
-            BarcodeDependencies::QRCODE_DEPENDENCIES.each_pair { |n, v| source.ensure_gem(n, v) }
-            require 'barby/barcode/qr_code'
-            barcode = Barby::QrCode.new(code)
-          when :upca
-            require 'barby/barcode/ean_13'
-            barcode = Barby::UPCA.new(code)
-          else
-            raise "Unsupported barcode type: #{type}"
+              gs1_code = gs1_code.gsub(/\s+/, '')
+              gs1_code = gs1_code.prepend(Barby::Code128::FNC1) unless gs1_code[0] == Barby::Code128::FNC1
+              barcode = Barby::Code128.new(gs1_code)
+            when :qrcode
+              BarcodeDependencies::QRCODE_DEPENDENCIES.each_pair { |n, v| source.ensure_gem(n, v) }
+              require 'barby/barcode/qr_code'
+              barcode = Barby::QrCode.new(code)
+            when :upca
+              require 'barby/barcode/ean_13'
+              barcode = Barby::UPCA.new(code)
+            else
+              raise "Unsupported barcode type: #{type}"
+          end
+        rescue ArgumentError
+          raise "Invalid #{type} data"
         end
 
         case format
@@ -142,6 +146,7 @@ module Asciidoctor
             barcode.to_png(options)
           when :svg
             require_relative 'svg_outputter'
+            options[:title] = code
             options[:foreground] = "##{options[:foreground]}" if options[:foreground] =~ /^[0-9a-f]+$/i
             options[:background] = "##{options[:background]}" if options[:background] =~ /^[0-9a-f]+$/i
             barcode.to_svg(options)

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

@@ -13,19 +13,29 @@ module Asciidoctor
           [:png, :pdf, :svg]
         end
 
+        def collect_options(source)
+          {
+            :font_path => source.attr('fontpath')
+          }
+        end
+
         def convert(source, format, options)
           # On Debian based systems the Python 3.x packages python3-(act|block|nw|seq)diag executables with
           # a '3' suffix.
           cmd_name = self.class.const_get(:TOOL)
           alt_cmd_name = "#{cmd_name}3"
 
-          font_path = source.attr('fontpath')
+          font_path = options[:font_path]
 
           generate_stdin(source.find_command(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}"]
             args << "-f#{Platform.native_path(font_path)}" if font_path
             args << '-'
-            args
+
+            {
+              :args => args,
+              :chdir => source.base_dir
+            }
           end
         end
       end

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

@@ -54,7 +54,10 @@ module Asciidoctor
             args << '--height' << options[:height]
           end
 
-          args
+          {
+            :args => args,
+            :chdir => source.base_dir
+          }
         end
       end
     end

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

@@ -18,7 +18,10 @@ module Asciidoctor
         bytefield_path = source.find_command('bytefield-svg')
 
         generate_stdin(bytefield_path, format.to_s, source.to_s) do |tool_path, output_path|
-          [tool_path, "--output", Platform.native_path(output_path)]
+          {
+            :args => [tool_path, "--output", Platform.native_path(output_path)],
+            :chdir => source.base_dir
+          }
         end
       end
     end

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

@@ -0,0 +1,57 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class D2Converter
+      include DiagramConverter
+      include CliGenerator
+
+      def supported_formats
+        [:svg, :png, :pdf]
+      end
+
+      def collect_options(source)
+        {
+          :layout => source.attr('layout'),
+          :theme => source.attr('theme'),
+          :pad => source.attr('pad'),
+          :animate_interval => source.attr('animate-interval'),
+          :sketch => source.attr('sketch'),
+          :font_regular => source.attr('font-regular'),
+          :font_italic => source.attr('font-italic'),
+          :font_bold => source.attr('font-bold')
+        }
+      end
+
+      def convert(source, format, options)
+        generate_stdin(source.find_command('d2'), format.to_s, source.code) do |tool_path, output_path|
+          args = [tool_path, '--browser', 'false']
+
+          options.each_pair do |key, value|
+            flag = "--#{key.to_s.gsub('_', '-')}"
+
+            if key == :sketch && !value.nil? && value != 'false'
+              args << flag
+            elsif key.to_s.start_with?('font') && !value.nil?
+              args << Platform.native_path(value)
+            elsif !value.nil?
+              args << flag
+              args << value
+            end
+          end
+
+          args << '-'
+          args << Platform.native_path(output_path)
+
+          {
+            :args => args,
+            :chdir => source.base_dir
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative 'converter'
+require_relative '../diagram_processor'
+
+module Asciidoctor
+  module Diagram
+    class D2BlockProcessor < DiagramBlockProcessor
+      use_converter D2Converter
+    end
+
+    class D2BlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter D2Converter
+    end
+
+    class D2InlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter D2Converter
+    end
+  end
+end

data/lib/asciidoctor-diagram/d2.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'd2/extension'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::D2BlockProcessor, :d2
+  block_macro Asciidoctor::Diagram::D2BlockMacroProcessor, :d2
+  inline_macro Asciidoctor::Diagram::D2InlineMacroProcessor, :d2
+end

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

@@ -0,0 +1,27 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class DbmlConverter
+      include DiagramConverter
+      include CliGenerator
+
+
+      def supported_formats
+        [:svg]
+      end
+
+      def convert(source, format, options)
+        generate_stdin_stdout(source.find_command('dbml-renderer'), source.code) do |tool|
+          {
+            :args => [tool],
+            :chdir => source.base_dir
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative 'converter'
+require_relative '../diagram_processor'
+
+module Asciidoctor
+  module Diagram
+    class DbmlBlockProcessor < DiagramBlockProcessor
+      use_converter DbmlConverter
+    end
+
+    class DbmlBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter DbmlConverter
+    end
+
+    class DbmlInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter DbmlConverter
+    end
+  end
+end

data/lib/asciidoctor-diagram/dbml.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'dbml/extension'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::DbmlBlockProcessor, :dbml
+  block_macro Asciidoctor::Diagram::DbmlBlockMacroProcessor, :dbml
+  inline_macro Asciidoctor::Diagram::DbmlInlineMacroProcessor, :dbml
+end