asciidoctor-diagram 2.2.7 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d16a4ceac53c9b8aa223e3b22a061ee0c92cc6876b24522c224530f7559c6d9
-  data.tar.gz: 86d434f86830db71ea4369b2e1e08d05b0ca8d6ed8f3ed4927c90cb5458f0154
+  metadata.gz: 0b7d586b723b3485288bc8127bbae0ce102fb2d6b07269a98790c01952aa2434
+  data.tar.gz: 97316ae03795b92cd09fd0baf9ecd86b5a68618a5a653e20d905fe3e66dd4c6f
 SHA512:
-  metadata.gz: d365c1149d8b2d7ce00a0aecdf0d40435518aeda247448adb4bfe81bc7b4c9cefe69477c3c3a6e3cb1fcbd703dc7efe2ad4e519d49aa4f32a10a51ecf523eaab
-  data.tar.gz: 567f9ba04c8bb97e09e6e2d70bfde26cd51700777257a5dd8a7a683ce101f6b0341f00d6729d12116400b620f38d5f4b3bea1113623641989c9d44a26110c04b
+  metadata.gz: 498776729f7aa965ad47f6ff9fe11bd16a09e389eab45a060b80675fd638bd05c4917a686e1effa787afaa67002c549817cdb36c8453453cb9010b9c33effa68
+  data.tar.gz: 6d6dc3314c9163832907cf7a5a45a2802976de6c9c04ef737463cdb2ec7ecb0c87db5f79dcf6bc5001705a10ea959635d66a88af7aa2f8b72bdde40af658d26b

data/CHANGELOG.adoc

@@ -1,5 +1,105 @@
 = Asciidoctor-diagram Changelog
 
+== 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::
@@ -25,6 +125,7 @@ Enhancements::
 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
 

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,19 +23,19 @@ The example below shows an embedded Ditaa diagram block.
 ---------
 [ditaa]
 ----
-              +-------------+
-              | asciidoctor |-----------+
-              |  diagram    |           |
-              +-------------+           | image
-                    ^                   |
-                    | diagram source    |
-                    |                   v
- +--------+   +-----+-------+    /---------------\
- |  adoc  |-->+ asciidoctor +    | HTML + image  |
- +--------+   +-------------+    \---------------/
+                  +-------------+
+                  | asciidoctor |---------------+
+                  |  diagram    |               |
+                  +-------------+               | image
+                         ^                      |
+                         | diagram source       |
+                         |                      v
+ +--------+       +------+------+        /--------------\
+ |  adoc  |------>+ asciidoctor +------->| HTML + image |
+ +--------+       +-------------+  html  \--------------/
 ----
 ---------
 
 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/a2s/converter.rb

@@ -49,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

@@ -23,25 +23,33 @@ module Asciidoctor
           :font_regular => source.attr('font-regular'),
           :font_italic => source.attr('font-italic'),
           :font_bold => source.attr('font-bold')
-        }.delete_if { |key, value| value.nil? }
+        }
       end
 
       def convert(source, format, options)
-        generate_file(source.find_command('d2'), "d2", format.to_s, source.code) do |tool_path, input_path, output_path|
+        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|
-            args << "--#{key.to_s.gsub('_', '-')}"
+            flag = "--#{key.to_s.gsub('_', '-')}"
 
-            if key.to_s.start_with?('font')
+            if key == :sketch && !value.nil? && value != 'false'
+              args << flag
+            elsif key.to_s.start_with?('font') && !value.nil?
               args << Platform.native_path(value)
-            else
+            elsif !value.nil?
+              args << flag
               args << value
             end
           end
 
-          args << Platform.native_path(input_path)
+          args << '-'
           args << Platform.native_path(output_path)
+
+          {
+            :args => args,
+            :chdir => source.base_dir
+          }
         end
       end
     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

data/lib/asciidoctor-diagram/diagram_processor.rb

@@ -64,6 +64,12 @@ module Asciidoctor
         location = parent.document.reader.cursor_at_mark
 
         normalised_attributes = attributes.inject({}) { |h, (k, v)| h[normalise_attribute_name(k)] = v; h }
+        pos_attr_index = config.fetch(:positional_attrs, []).length + 1
+        until attributes[pos_attr_index].nil?
+          normalised_attributes[attributes[pos_attr_index]] = 'true'
+          pos_attr_index = pos_attr_index + 1
+        end
+
         converter = config[:converter].new
 
         supported_formats = supported_formats(converter)
@@ -159,7 +165,9 @@ 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))
 
-        if File.exist? metadata_file
+        use_cache = !source.global_opt('nocache')
+
+        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 = {}
@@ -185,14 +193,18 @@ module Asciidoctor
           metadata = source.create_image_metadata
           metadata[:options] = options
 
-          allow_image_optimisation = source.attr('optimise', 'true') == 'true'
+          allow_image_optimisation = !source.global_opt('nooptimise')
           result, metadata[:width], metadata[:height] = params[:decoder].post_process_image(result, 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 result}
 
-          FileUtils.mkdir_p(File.dirname(metadata_file)) unless Dir.exist?(File.dirname(metadata_file))
-          File.open(metadata_file, 'w') {|f| JSON.dump(metadata, f)}
+          if use_cache
+            FileUtils.mkdir_p(File.dirname(metadata_file)) unless Dir.exist?(File.dirname(metadata_file))
+            File.open(metadata_file, 'w') { |f| JSON.dump(metadata, f) }
+          else
+            File.delete(metadata_file) if File.exist?(metadata_file)
+          end
         end
 
         scale = image_attributes['scale']
@@ -356,6 +368,7 @@ module Asciidoctor
       include DiagramProcessor
 
       def self.inherited(subclass)
+        subclass.use_dsl
         subclass.name_positional_attributes ['target', 'format']
         subclass.contexts [:listing, :literal, :open]
         subclass.content_model :simple
@@ -374,6 +387,7 @@ module Asciidoctor
       include DiagramProcessor
 
       def self.inherited(subclass)
+        subclass.use_dsl
         subclass.name_positional_attributes ['format']
       end
 
@@ -415,7 +429,16 @@ module Asciidoctor
         block = generate_block(parent, reader_or_target, attributes)
         attrs = block.attributes.dup
         target = attrs.delete('target')
-        create_inline(parent, :image, nil, :type => 'image', :target => target, :attributes => attrs).convert
+
+        # Don't let the asciidoctor try to apply substitutions.
+        # The text of inline macros is nil which will cause an error
+        attrs.delete('subs')
+
+        if block.context == :image
+          create_inline(parent, :image, nil, :type => 'image', :target => target, :attributes => attrs)
+        else
+          create_inline(parent, :quoted, block.source, :type => :monospaced, :attributes => attrs)
+        end
       end
 
       def supported_formats(converter)