asciidoctor-kroki 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b10096229def31407946a5f7e77eb57a991895d9407d334b6a4ca3dc7e8ba165
-  data.tar.gz: 81497c2124169974c072a57c496b37d8cbd5e96b4793a22d59a3152fb1693c45
+  metadata.gz: 46f326afecfa57d4b918121fdf939c2c8dcf46897daeff74236a551628ffbfdf
+  data.tar.gz: c43629e9e6d4303fa59d761b61e95e6b63006cea1a27faf1dc3e80ceb9994f8c
 SHA512:
-  metadata.gz: 03e1e7d5dc886c9e4ff9d7199f3289aa1a94d8b97a21209ba4ea9c4b505129646297bb62c02cab6390803b157a7a505e3af944ff533c49086af11927647776ce
-  data.tar.gz: ad4cda7ce19c6ffa1223a224c1528c87e7b8864d554662f26a7534937f4bea49433e500373dad215feb09d71f748c84881ad720ea5c52765977383eb393a9f4c
+  metadata.gz: 70eac4468da00da494aa490e3c413189feb13474d25aa778f1d0cb301957c7ce1811bbc82cc7d1e2782a43223452f5b1de75a150b446824c2de7f9380811defc
+  data.tar.gz: e9d6cbbdc63c8f28dd99c1921f1496765ccbb873210756c765d879d1311994243af42f55f3d4dc18e0500be299ef89d5027bbccf5afefee24255d65c71e829d4

data/.rubocop.yml

@@ -1,10 +1,15 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  NewCops: enable
+
 Style/Encoding:
   Enabled: false
 
 Layout/EndOfLine:
   EnforcedStyle: lf
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 180
 
 Metrics/ClassLength:
@@ -20,7 +25,10 @@ Metrics/PerceivedComplexity:
   Max: 10
 
 Metrics/AbcSize:
-  Max: 30
+  Max: 31
 
 Metrics/ParameterLists:
   Max: 7
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.1.2

data/Gemfile.lock

@@ -1,52 +1,57 @@
 PATH
   remote: .
   specs:
-    asciidoctor-kroki (0.5.0)
+    asciidoctor-kroki (0.7.0)
       asciidoctor (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    asciidoctor (2.0.11)
-    ast (2.4.1)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.4)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.6)
+    asciidoctor (2.0.17)
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.2)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.3)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.30.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   asciidoctor-kroki!
-  rake (~> 12.3.2)
-  rspec (~> 3.8.0)
-  rubocop (~> 0.74.0)
+  rake (~> 13.0.6)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.30)
 
 BUNDLED WITH
-   2.2.17
+   2.3.15

data/asciidoctor-kroki.gemspec

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'lib/asciidoctor/extensions/asciidoctor_kroki/version'
+
 Gem::Specification.new do |s|
   s.name = 'asciidoctor-kroki'
-  s.version = '0.5.0'
+  s.version = Asciidoctor::AsciidoctorKroki::VERSION
   s.summary = 'Asciidoctor extension to convert diagrams to images using Kroki'
   s.description = 'An extension for Asciidoctor to convert diagrams to images using https://kroki.io'
 
@@ -12,15 +14,15 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
   s.metadata = {
     'bug_tracker_uri' => 'https://github.com/Mogztter/asciidoctor-kroki/issues',
-    'source_code_uri' => 'https://github.com/Mogztter/asciidoctor-kroki'
+    'source_code_uri' => 'https://github.com/Mogztter/asciidoctor-kroki',
+    'rubygems_mfa_required' => 'true'
   }
   s.files = `git ls-files`.split($RS)
-  s.test_files = s.files.grep(%r{^(test|spec|features|tasks)/})
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'asciidoctor', '~> 2.0'
 
-  s.add_development_dependency 'rake', '~> 12.3.2'
-  s.add_development_dependency 'rspec', '~> 3.8.0'
-  s.add_development_dependency 'rubocop', '~> 0.74.0'
+  s.add_development_dependency 'rake', '~> 13.0.6'
+  s.add_development_dependency 'rspec', '~> 3.10.0'
+  s.add_development_dependency 'rubocop', '~> 1.30'
 end

data/lib/asciidoctor/extensions/asciidoctor_kroki/extension.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'cgi'
 require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 
 # Asciidoctor extensions
@@ -38,6 +39,7 @@ module AsciidoctorExtensions
   # A block macro extension that converts a diagram into an image.
   #
   class KrokiBlockMacroProcessor < Asciidoctor::Extensions::BlockMacroProcessor
+    include Asciidoctor::Logging
     use_dsl
 
     name_positional_attributes 'format'
@@ -61,14 +63,14 @@ module AsciidoctorExtensions
       end
 
       unless (path = resolve_target_path(target))
-        logger.error "#{diagram_type} block macro not found: #{target}."
-        create_block(parent, 'paragraph', unresolved_block_macro_message(diagram_type, target), {})
+        logger.error message_with_context "#{diagram_type} block macro not found: #{target}.", source_location: parent.document.reader.cursor_at_mark
+        return create_block(parent, 'paragraph', unresolved_block_macro_message(diagram_type, target), {})
       end
 
       begin
         diagram_text = read(path)
-      rescue => e # rubocop:disable RescueStandardError
-        logger.error "Failed to read #{diagram_type} file: #{path}. #{e}."
+      rescue => e # rubocop:disable Style/RescueStandardError
+        logger.error message_with_context "Failed to read #{diagram_type} file: #{path}. #{e}.", source_location: parent.document.reader.cursor_at_mark
         return create_block(parent, 'paragraph', unresolved_block_macro_message(diagram_type, path), {})
       end
       KrokiProcessor.process(self, parent, attrs, diagram_type, diagram_text, @logger)
@@ -89,9 +91,9 @@ module AsciidoctorExtensions
     def read(target)
       if target.start_with?('http://') || target.start_with?('https://')
         require 'open-uri'
-        URI.open(target, &:read)
+        ::OpenURI.open_uri(target, &:read)
       else
-        File.open(target, &:read)
+        File.read(target, mode: 'rb:utf-8:utf-8')
       end
     end
 
@@ -126,15 +128,20 @@ module AsciidoctorExtensions
       vega
       vegalite
       wavedrom
+      structurizr
     ].freeze
   end
 
   # Internal processor
   #
   class KrokiProcessor
+    include Asciidoctor::Logging
+
     TEXT_FORMATS = %w[txt atxt utxt].freeze
+    BUILTIN_ATTRIBUTES = %w[target width height format fallback link float align role caption title cloaked-context subs].freeze
 
     class << self
+      # rubocop:disable Metrics/AbcSize
       def process(processor, parent, attrs, diagram_type, diagram_text, logger)
         doc = parent.document
         diagram_text = prepend_plantuml_config(diagram_text, diagram_type, doc, logger)
@@ -143,20 +150,27 @@ module AsciidoctorExtensions
         if (subs = attrs['subs'])
           diagram_text = parent.apply_subs(diagram_text, parent.resolve_subs(subs))
         end
-        title = attrs.delete('title')
-        caption = attrs.delete('caption')
         attrs.delete('opts')
-        role = attrs['role']
         format = get_format(doc, attrs, diagram_type)
-        attrs['role'] = get_role(format, role)
+        attrs['role'] = get_role(format, attrs['role'])
         attrs['format'] = format
-        kroki_diagram = KrokiDiagram.new(diagram_type, format, diagram_text)
-        kroki_client = KrokiClient.new(server_url(doc), http_method(doc), KrokiHttpClient, logger, max_uri_length(doc))
+        opts = attrs.filter { |key, _| key.is_a?(String) && BUILTIN_ATTRIBUTES.none? { |k| key == k } && !key.end_with?('-option') }
+        kroki_diagram = KrokiDiagram.new(diagram_type, format, diagram_text, attrs['target'], opts)
+        kroki_client = KrokiClient.new({
+                                         server_url: server_url(doc),
+                                         http_method: http_method(doc),
+                                         max_uri_length: max_uri_length(doc),
+                                         source_location: doc.reader.cursor_at_mark,
+                                         http_client: KrokiHttpClient
+                                       }, logger)
+        alt = get_alt(attrs)
+        title = attrs.delete('title')
+        caption = attrs.delete('caption')
         if TEXT_FORMATS.include?(format)
           text_content = kroki_client.text_content(kroki_diagram)
           block = processor.create_block(parent, 'literal', text_content, attrs)
         else
-          attrs['alt'] = get_alt(attrs)
+          attrs['alt'] = alt
           attrs['target'] = create_image_src(doc, kroki_diagram, kroki_client)
           block = processor.create_image_block(parent, attrs)
         end
@@ -164,6 +178,7 @@ module AsciidoctorExtensions
         block.assign_caption(caption, 'figure')
         block
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 
@@ -174,9 +189,10 @@ module AsciidoctorExtensions
           plantuml_include_path = doc.normalize_system_path(doc.attr('kroki-plantuml-include'))
           if ::File.readable? plantuml_include_path
             config = File.read(plantuml_include_path)
-            diagram_text = config + "\n" + diagram_text
+            diagram_text = "#{config}\n#{diagram_text}"
           else
-            logger.warn "Unable to read plantuml-include. File not found or not readable: #{plantuml_include_path}."
+            logger.warn message_with_context "Unable to read plantuml-include. File not found or not readable: #{plantuml_include_path}.",
+                                             source_location: doc.reader.cursor_at_mark
           end
         end
         diagram_text
@@ -205,13 +221,13 @@ module AsciidoctorExtensions
       end
 
       def get_format(doc, attrs, diagram_type)
-        format = attrs['format'] || 'svg'
-        # The JavaFX preview doesn't support SVG well, therefore we'll use PNG format...
-        if doc.attr?('env-idea') && format == 'svg'
-          # ... unless the diagram library does not support PNG as output format!
-          # Currently, mermaid, nomnoml, svgbob, wavedrom only support SVG as output format.
-          svg_only_diagram_types = %w[:mermaid :nomnoml :svgbob :wavedrom]
-          format = 'png' unless svg_only_diagram_types.include?(diagram_type)
+        format = attrs['format'] || doc.attr('kroki-default-format') || 'svg'
+        if format == 'png'
+          # redirect PNG format to SVG if the diagram library only supports SVG as output format.
+          # this is useful when the default format has been set to PNG
+          # Currently, nomnoml, svgbob, wavedrom only support SVG as output format.
+          svg_only_diagram_types = %i[nomnoml svgbob wavedrom]
+          format = 'svg' if svg_only_diagram_types.include?(diagram_type)
         end
         format
       end
@@ -240,10 +256,9 @@ module AsciidoctorExtensions
         images_dir = doc.attr('imagesdir', '')
         if (images_output_dir = doc.attr('imagesoutdir'))
           images_output_dir
-        elsif (out_dir = doc.attr('outdir'))
+        # the nested document logic will become obsolete once https://github.com/asciidoctor/asciidoctor/commit/7edc9da023522be67b17e2a085d72e056703a438 is released
+        elsif (out_dir = doc.attr('outdir') || (doc.nested? ? doc.parent_document : doc).options[:to_dir])
           File.join(out_dir, images_dir)
-        elsif (to_dir = doc.attr('to_dir'))
-          File.join(to_dir, images_dir)
         else
           File.join(doc.base_dir, images_dir)
         end
@@ -258,18 +273,19 @@ module AsciidoctorExtensions
     require 'zlib'
     require 'digest'
 
-    attr_reader :type
-    attr_reader :text
-    attr_reader :format
+    attr_reader :type, :text, :format, :target, :opts
 
-    def initialize(type, format, text)
+    def initialize(type, format, text, target = nil, opts = {})
       @text = text
       @type = type
       @format = format
+      @target = target
+      @opts = opts
     end
 
     def get_diagram_uri(server_url)
-      _join_uri_segments(server_url, @type, @format, encode)
+      query_params = opts.map { |k, v| "#{k}=#{_url_encode(v.to_s)}" }.join('&') unless opts.empty?
+      _join_uri_segments(server_url, @type, @format, encode) + (query_params ? "?#{query_params}" : '')
     end
 
     def encode
@@ -278,37 +294,39 @@ module AsciidoctorExtensions
 
     def save(output_dir_path, kroki_client)
       diagram_url = get_diagram_uri(kroki_client.server_url)
-      diagram_name = "diag-#{Digest::SHA256.hexdigest diagram_url}.#{@format}"
+      diagram_name = "#{@target || 'diag'}-#{Digest::SHA256.hexdigest diagram_url}.#{@format}"
       file_path = File.join(output_dir_path, diagram_name)
-      encoding = if @format == 'txt' || @format == 'atxt' || @format == 'utxt'
+      encoding = case @format
+                 when 'txt', 'atxt', 'utxt', 'svg'
                    'utf8'
-                 elsif @format == 'svg'
-                   'binary'
                  else
                    'binary'
                  end
       # file is either (already) on the file system or we should read it from Kroki
-      contents = File.exist?(file_path) ? File.open(file_path, &:read) : kroki_client.get_image(self, encoding)
-      FileUtils.mkdir_p(output_dir_path)
-      if encoding == 'binary'
-        File.binwrite(file_path, contents)
-      else
-        File.write(file_path, contents)
+      unless File.exist?(file_path)
+        contents = kroki_client.get_image(self, encoding)
+        FileUtils.mkdir_p(output_dir_path)
+        File.write(file_path, contents, mode: 'wb')
       end
+
       diagram_name
     end
 
     private
 
+    def _url_encode(text)
+      CGI.escape(text).gsub(/\+/, '%20')
+    end
+
     def _join_uri_segments(base, *uris)
       segments = []
       # remove trailing slashes
-      segments.push(base.gsub(%r{[/]+$}, ''))
+      segments.push(base.gsub(%r{/+$}, ''))
       segments.concat(uris.map do |uri|
         # remove leading and trailing slashes
         uri.to_s
-          .gsub(%r{^[/]+}, '')
-          .gsub(%r{[/]+$}, '')
+          .gsub(%r{^/+}, '')
+          .gsub(%r{/+$}, '')
       end)
       segments.join('/')
     end
@@ -317,21 +335,23 @@ module AsciidoctorExtensions
   # Kroki client
   #
   class KrokiClient
-    attr_reader :server_url
-    attr_reader :method
-    attr_reader :max_uri_length
+    include Asciidoctor::Logging
+
+    attr_reader :server_url, :method, :max_uri_length
 
     SUPPORTED_HTTP_METHODS = %w[get post adaptive].freeze
 
-    def initialize(server_url, http_method, http_client, logger = ::Asciidoctor::LoggerManager.logger, max_uri_length = 4000)
-      @server_url = server_url
-      @max_uri_length = max_uri_length
-      @http_client = http_client
-      method = (http_method || 'adaptive').downcase
+    def initialize(opts, logger = ::Asciidoctor::LoggerManager.logger)
+      @server_url = opts[:server_url]
+      @max_uri_length = opts.fetch(:max_uri_length, 4000)
+      @http_client = opts[:http_client]
+      method = opts.fetch(:http_method, 'adaptive').downcase
       if SUPPORTED_HTTP_METHODS.include?(method)
         @method = method
       else
-        logger.warn "Invalid value '#{method}' for kroki-http-method attribute. The value must be either: 'get', 'post' or 'adaptive'. Proceeding using: 'adaptive'."
+        logger.warn message_with_context "Invalid value '#{method}' for kroki-http-method attribute. The value must be either: " \
+                                         "'get', 'post' or 'adaptive'. Proceeding using: 'adaptive'.",
+                                         source_location: opts[:source_location]
         @method = 'adaptive'
       end
     end
@@ -344,6 +364,7 @@ module AsciidoctorExtensions
       type = kroki_diagram.type
       format = kroki_diagram.format
       text = kroki_diagram.text
+      opts = kroki_diagram.opts
       if @method == 'adaptive' || @method == 'get'
         uri = kroki_diagram.get_diagram_uri(server_url)
         if uri.length > @max_uri_length
@@ -351,15 +372,15 @@ module AsciidoctorExtensions
           if @method == 'get'
             # The request might be rejected by the server with a 414 Request-URI Too Large.
             # Consider using the attribute kroki-http-method with the value 'adaptive'.
-            @http_client.get(uri, encoding)
+            @http_client.get(uri, opts, encoding)
           else
-            @http_client.post("#{@server_url}/#{type}/#{format}", text, encoding)
+            @http_client.post("#{@server_url}/#{type}/#{format}", text, opts, encoding)
           end
         else
-          @http_client.get(uri, encoding)
+          @http_client.get(uri, opts, encoding)
         end
       else
-        @http_client.post("#{@server_url}/#{type}/#{format}", text, encoding)
+        @http_client.post("#{@server_url}/#{type}/#{format}", text, opts, encoding)
       end
     end
   end
@@ -372,12 +393,33 @@ module AsciidoctorExtensions
     require 'json'
 
     class << self
-      def get(uri, _)
-        ::OpenURI.open_uri(uri, 'r', &:read)
+      REFERER = "asciidoctor/kroki.rb/#{Asciidoctor::AsciidoctorKroki::VERSION}"
+
+      def get(uri, opts, _)
+        uri = URI(uri)
+        headers = opts.transform_keys { |key| "Kroki-Diagram-Options-#{key}" }
+                      .merge({ 'referer' => REFERER })
+        request = ::Net::HTTP::Get.new(uri, headers)
+        ::Net::HTTP.start(
+          uri.hostname,
+          uri.port,
+          use_ssl: (uri.scheme == 'https')
+        ) do |http|
+          http.request(request).body
+        end
       end
 
-      def post(uri, data, _)
-        res = ::Net::HTTP.request_post(uri, data)
+      def post(uri, data, opts, _)
+        headers = opts.transform_keys { |key| "Kroki-Diagram-Options-#{key}" }
+                      .merge({
+                               'Content-Type' => 'text/plain',
+                               'referer' => REFERER
+                             })
+        res = ::Net::HTTP.post(
+          URI(uri),
+          data,
+          headers
+        )
         res.body
       end
     end

data/lib/asciidoctor/extensions/asciidoctor_kroki/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module AsciidoctorKroki
+    VERSION = '0.7.0'
+  end
+end

data/lib/asciidoctor/extensions/asciidoctor_kroki.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+require_relative 'asciidoctor_kroki/version'
 require_relative 'asciidoctor_kroki/extension'
 
 Asciidoctor::Extensions.register do

data/spec/asciidoctor_kroki_block_macro_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Lint/ConstantDefinitionInBlock
 # frozen_string_literal: true
 
 require 'rspec_helper'
@@ -88,7 +89,7 @@ describe ::AsciidoctorExtensions::KrokiBlockMacroProcessor do
 </div>
 </div>)
     end
-    it 'should display unresolved block macro message when the traget cannot be resolved' do
+    it 'should display unresolved block macro message when the target cannot be resolved' do
       # noinspection RubyClassModuleNamingConvention
       class UnresolvedTargetKrokiBlockMacroProcessor < ::AsciidoctorExtensions::KrokiBlockMacroProcessor
         def resolve_target_path(_target)
@@ -103,7 +104,7 @@ describe ::AsciidoctorExtensions::KrokiBlockMacroProcessor do
       ADOC
       output = Asciidoctor.convert(input, standalone: false, extension_registry: registry)
       (expect output).to eql %(<div class="paragraph">
-<p>Unresolved block macro - plantuml::[]</p>
+<p>Unresolved block macro - plantuml::alice.puml[]</p>
 </div>)
     end
     it 'should override the unresolved block macro message' do
@@ -126,3 +127,4 @@ describe ::AsciidoctorExtensions::KrokiBlockMacroProcessor do
     end
   end
 end
+# rubocop:enable Lint/ConstantDefinitionInBlock

data/spec/asciidoctor_kroki_client_spec.rb

@@ -7,27 +7,27 @@ require_relative '../lib/asciidoctor/extensions/asciidoctor_kroki'
 describe ::AsciidoctorExtensions::KrokiClient do
   it 'should use adaptive method when http method is invalid' do
     kroki_http_client = ::AsciidoctorExtensions::KrokiHttpClient
-    kroki_client = ::AsciidoctorExtensions::KrokiClient.new('http://localhost:8000', 'patch', kroki_http_client)
+    kroki_client = ::AsciidoctorExtensions::KrokiClient.new(server_url: 'http://localhost:8000', http_method: 'patch', http_client: kroki_http_client)
     expect(kroki_client.method).to eq('adaptive')
   end
   it 'should use post method when http method is post' do
     kroki_http_client = ::AsciidoctorExtensions::KrokiHttpClient
-    kroki_client = ::AsciidoctorExtensions::KrokiClient.new('http://localhost:8000', 'POST', kroki_http_client)
+    kroki_client = ::AsciidoctorExtensions::KrokiClient.new(server_url: 'http://localhost:8000', http_method: 'POST', http_client: kroki_http_client)
     expect(kroki_client.method).to eq('post')
   end
   it 'should use get method when http method is get' do
     kroki_http_client = ::AsciidoctorExtensions::KrokiHttpClient
-    kroki_client = ::AsciidoctorExtensions::KrokiClient.new('http://localhost:8000', 'get', kroki_http_client)
+    kroki_client = ::AsciidoctorExtensions::KrokiClient.new(server_url: 'http://localhost:8000', http_method: 'get', http_client: kroki_http_client)
     expect(kroki_client.method).to eq('get')
   end
   it 'should use 4000 as the default max URI length' do
     kroki_http_client = ::AsciidoctorExtensions::KrokiHttpClient
-    kroki_client = ::AsciidoctorExtensions::KrokiClient.new('http://localhost:8000', 'get', kroki_http_client)
+    kroki_client = ::AsciidoctorExtensions::KrokiClient.new(server_url: 'http://localhost:8000', http_method: 'get', http_client: kroki_http_client)
     expect(kroki_client.max_uri_length).to eq(4000)
   end
   it 'should use a custom value as max URI length' do
     kroki_http_client = ::AsciidoctorExtensions::KrokiHttpClient
-    kroki_client = ::AsciidoctorExtensions::KrokiClient.new('http://localhost:8000', 'get', kroki_http_client, nil, 8000)
+    kroki_client = ::AsciidoctorExtensions::KrokiClient.new(server_url: 'http://localhost:8000', http_method: 'get', http_client: kroki_http_client, max_uri_length: 8000)
     expect(kroki_client.max_uri_length).to eq(8000)
   end
   it 'should get an image with POST request if the URI length is greater than the value configured' do
@@ -37,54 +37,56 @@ describe ::AsciidoctorExtensions::KrokiClient do
           "GET #{uri}"
         end
 
-        def post(uri, data, _)
+        def post(uri, data, _, _)
           "POST #{uri} - #{data}"
         end
       end
     end
     kroki_diagram = Class.new do
-      attr_reader :type, :text, :format
+      attr_reader :type, :text, :format, :opts
 
-      def initialize(type, format, text)
+      def initialize(type, format, text, opts = {})
         @text = text
         @type = type
         @format = format
+        @opts = opts
       end
 
       def get_diagram_uri(_)
         'diagram-uri'
       end
     end.new('type', 'format', 'text')
-    kroki_client = ::AsciidoctorExtensions::KrokiClient.new('http://localhost:8000', 'adaptive', kroki_http_client, nil, 10)
+    kroki_client = ::AsciidoctorExtensions::KrokiClient.new(server_url: 'http://localhost:8000', http_method: 'adaptive', http_client: kroki_http_client, max_uri_length: 10)
     result = kroki_client.get_image(kroki_diagram, 'utf8')
     expect(result).to eq('POST http://localhost:8000/type/format - text')
   end
   it 'should get an image with GET request if the URI length is lower or equals than the value configured' do
     kroki_http_client = Class.new do
       class << self
-        def get(uri, _)
+        def get(uri, _, _)
           "GET #{uri}"
         end
 
-        def post(uri, data, _)
+        def post(uri, data, _, _)
           "POST #{uri} - #{data}"
         end
       end
     end
     kroki_diagram = Class.new do
-      attr_reader :type, :text, :format
+      attr_reader :type, :text, :format, :opts
 
-      def initialize(type, format, text)
+      def initialize(type, format, text, opts = {})
         @text = text
         @type = type
         @format = format
+        @opts = opts
       end
 
       def get_diagram_uri(_)
         'diagram-uri'
       end
     end.new('type', 'format', 'text')
-    kroki_client = ::AsciidoctorExtensions::KrokiClient.new('http://localhost:8000', 'adaptive', kroki_http_client, nil, 11)
+    kroki_client = ::AsciidoctorExtensions::KrokiClient.new(server_url: 'http://localhost:8000', http_method: 'adaptive', http_client: kroki_http_client, max_uri_length: 11)
     result = kroki_client.get_image(kroki_diagram, 'utf8')
     expect(result).to eq('GET diagram-uri')
   end

data/spec/asciidoctor_kroki_diagram_spec.rb

@@ -20,6 +20,24 @@ describe ::AsciidoctorExtensions::KrokiDiagram do
     diagram_uri = kroki_diagram.get_diagram_uri('https://my-server/kroki//')
     expect(diagram_uri).to eq('https://my-server/kroki/vegalite/png/eNqrrgUAAXUA-Q==')
   end
+  it 'should compute a diagram URI with query parameters' do
+    text = %q{
+       .---.
+      /-o-/--
+   .-/ / /->
+  ( *  \/
+   '-.  \
+    \ /
+     '
+    }
+    opts = {
+      'stroke-width' => 1,
+      'background' => 'black'
+    }
+    kroki_diagram = ::AsciidoctorExtensions::KrokiDiagram.new('svgbob', 'png', text, nil, opts)
+    diagram_uri = kroki_diagram.get_diagram_uri('http://localhost:8000')
+    expect(diagram_uri).to eq('http://localhost:8000/svgbob/png/eNrjUoAAPV1dXT0uCFtfN19XX1eXCyysrwCEunZAjoaCloJCjD5IWF1XD8gEK49R0IdoUwdTAN3kC7U=?stroke-width=1&background=black')
+  end
   it 'should encode a diagram text definition' do
     kroki_diagram = ::AsciidoctorExtensions::KrokiDiagram.new('plantuml', 'txt', ' alice -> bob: hello')
     diagram_definition_encoded = kroki_diagram.encode
@@ -28,11 +46,32 @@ describe ::AsciidoctorExtensions::KrokiDiagram do
   it 'should fetch a diagram from Kroki and save it to disk' do
     kroki_diagram = ::AsciidoctorExtensions::KrokiDiagram.new('plantuml', 'txt', ' alice -> bob: hello')
     kroki_http_client = ::AsciidoctorExtensions::KrokiHttpClient
-    kroki_client = ::AsciidoctorExtensions::KrokiClient.new('https://kroki.io', 'get', kroki_http_client)
+    kroki_client = ::AsciidoctorExtensions::KrokiClient.new(server_url: 'https://kroki.io', http_method: 'get', http_client: kroki_http_client)
+    output_dir_path = "#{__dir__}/../.asciidoctor/kroki"
+    diagram_name = kroki_diagram.save(output_dir_path, kroki_client)
+    diagram_path = File.join(output_dir_path, diagram_name)
+    expect(File.exist?(diagram_path)).to be_truthy, "diagram should be saved at: #{diagram_path}"
+    content = <<-TXT.chomp
+     ,-----.          ,---.
+     |alice|          |bob|
+     `--+--'          `-+-'
+        |    hello      |
+        |-------------->|
+     ,--+--.          ,-+-.
+     |alice|          |bob|
+     `-----'          `---'
+    TXT
+    expect(File.read(diagram_path).split("\n").map(&:rstrip).join("\n")).to eq(content)
+  end
+  it 'should fetch a diagram from Kroki and save it to disk using the target name' do
+    kroki_diagram = ::AsciidoctorExtensions::KrokiDiagram.new('plantuml', 'txt', ' alice -> bob: hello', 'hello-world')
+    kroki_http_client = ::AsciidoctorExtensions::KrokiHttpClient
+    kroki_client = ::AsciidoctorExtensions::KrokiClient.new(server_url: 'https://kroki.io', http_method: 'get', http_client: kroki_http_client)
     output_dir_path = "#{__dir__}/../.asciidoctor/kroki"
     diagram_name = kroki_diagram.save(output_dir_path, kroki_client)
     diagram_path = File.join(output_dir_path, diagram_name)
-    expect(File.exist?(diagram_path)).to be_truthy, "expected diagram to be saved at #{diagram_path}"
+    expect(diagram_name).to start_with('hello-world-'), "diagram name should use the target as a prefix, got: #{diagram_name}"
+    expect(File.exist?(diagram_path)).to be_truthy, "diagram should be saved at: #{diagram_path}"
     content = <<-TXT.chomp
      ,-----.          ,---.
      |alice|          |bob|
@@ -48,14 +87,16 @@ describe ::AsciidoctorExtensions::KrokiDiagram do
   it 'should fetch a diagram from Kroki with the same definition only once' do
     kroki_diagram = ::AsciidoctorExtensions::KrokiDiagram.new('plantuml', 'png', ' guillaume -> dan: hello')
     kroki_http_client = ::AsciidoctorExtensions::KrokiHttpClient
-    kroki_client = ::AsciidoctorExtensions::KrokiClient.new('https://kroki.io', 'get', kroki_http_client)
+    kroki_client = ::AsciidoctorExtensions::KrokiClient.new(server_url: 'https://kroki.io', http_method: 'get', http_client: kroki_http_client)
     output_dir_path = "#{__dir__}/../.asciidoctor/kroki"
     # make sure that we are doing only one GET request
-    expect(kroki_http_client).to receive(:get).once
+    diagram_contents = File.read("#{__dir__}/fixtures/plantuml-diagram.png", mode: 'rb')
+    expect(kroki_http_client).to receive(:get).once.and_return(diagram_contents)
     diagram_name = kroki_diagram.save(output_dir_path, kroki_client)
     diagram_path = File.join(output_dir_path, diagram_name)
-    expect(File.exist?(diagram_path)).to be_truthy, "expected diagram to be saved at #{diagram_path}"
+    expect(File.exist?(diagram_path)).to be_truthy, "diagram should be saved at: #{diagram_path}"
     # calling again... should read the file from disk (and not do a GET request)
     kroki_diagram.save(output_dir_path, kroki_client)
+    expect(File.size(diagram_path)).to be_eql(diagram_contents.length), 'diagram should be fully saved on disk'
   end
 end

data/spec/asciidoctor_kroki_processor_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rspec_helper'
+require 'asciidoctor'
+require_relative '../lib/asciidoctor/extensions/asciidoctor_kroki'
+
+describe '::AsciidoctorExtensions::KrokiProcessor' do
+  it 'should return the images output directory (imagesoutdir attribute)' do
+    doc = Asciidoctor.load('hello', attributes: { 'imagesoutdir' => '.asciidoctor/kroki/images', 'imagesdir' => '../images' })
+    output_dir_path = AsciidoctorExtensions::KrokiProcessor.send(:output_dir_path, doc)
+    expect(output_dir_path).to eq '.asciidoctor/kroki/images'
+  end
+  it 'should return a path relative to output directory (to_dir option)' do
+    doc = Asciidoctor.load('hello', to_dir: '.asciidoctor/kroki/relative', attributes: { 'imagesdir' => '../images' })
+    output_dir_path = AsciidoctorExtensions::KrokiProcessor.send(:output_dir_path, doc)
+    expect(output_dir_path).to eq '.asciidoctor/kroki/relative/../images'
+  end
+  it 'should return a path relative to output directory (outdir attribute)' do
+    doc = Asciidoctor.load('hello', attributes: { 'imagesdir' => 'resources/images', 'outdir' => '.asciidoctor/kroki/out' })
+    output_dir_path = AsciidoctorExtensions::KrokiProcessor.send(:output_dir_path, doc)
+    expect(output_dir_path).to eq '.asciidoctor/kroki/out/resources/images'
+  end
+  it 'should return a path relative to the base directory (base_dir option)' do
+    doc = Asciidoctor.load('hello', base_dir: '.asciidoctor/kroki', attributes: { 'imagesdir' => 'img' })
+    output_dir_path = AsciidoctorExtensions::KrokiProcessor.send(:output_dir_path, doc)
+    expect(output_dir_path).to eq "#{::Dir.pwd}/.asciidoctor/kroki/img"
+  end
+  it 'should return a path relative to the base directory (default value is current working directory)' do
+    doc = Asciidoctor.load('hello', attributes: { 'imagesdir' => 'img' })
+    output_dir_path = AsciidoctorExtensions::KrokiProcessor.send(:output_dir_path, doc)
+    expect(output_dir_path).to eq "#{::Dir.pwd}/img"
+  end
+end

data/spec/asciidoctor_kroki_spec.rb

@@ -20,18 +20,64 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
 </div>
 </div>)
     end
-    it 'should use png if env-idea is defined' do
+    it 'should only pass diagram options as query parameters' do
+      input = <<~'ADOC'
+        [plantuml,alice-bob,svg,role=sequence,width=100,format=svg,link=https://asciidoc.org/,align=center,float=right,theme=bluegray]
+        ....
+        alice -> bob: hello
+        ....
+      ADOC
+      output = Asciidoctor.convert(input, standalone: false)
+      (expect output).to eql %(<div class="imageblock right text-center sequence kroki-format-svg kroki">
+<div class="content">
+<a class="image" href="https://asciidoc.org/"><img src="https://kroki.io/plantuml/svg/eNpLzMlMTlXQtVNIyk-yUshIzcnJBwA9iwZL?theme=bluegray" alt="alice-bob" width="100"></a>
+</div>
+</div>)
+    end
+    it 'should use the title attribute as the alt value' do
+      input = <<~'ADOC'
+        [plantuml,title="Alice saying hello to Bob"]
+        ....
+        alice -> bob: hello
+        ....
+      ADOC
+      output = Asciidoctor.convert(input, standalone: false)
+      (expect output).to eql %(<div class="imageblock kroki">
+<div class="content">
+<img src="https://kroki.io/plantuml/svg/eNpLzMlMTlXQtVNIyk-yUshIzcnJBwA9iwZL" alt="Alice saying hello to Bob">
+</div>
+<div class="title">Figure 1. Alice saying hello to Bob</div>
+</div>)
+    end
+    it 'should use png if kroki-default-format is set to png' do
       input = <<~'ADOC'
         [plantuml]
         ....
         alice -> bob: hello
         ....
       ADOC
-      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '' }, standalone: false)
+      output = Asciidoctor.convert(input, attributes: { 'kroki-default-format' => 'png' }, standalone: false)
       (expect output).to eql %(<div class="imageblock kroki">
 <div class="content">
 <img src="https://kroki.io/plantuml/png/eNpLzMlMTlXQtVNIyk-yUshIzcnJBwA9iwZL" alt="Diagram">
 </div>
+</div>)
+    end
+    it 'should use svg if kroki-default-format is set to png and the diagram type does not support png' do
+      input = <<~'ADOC'
+        [nomnoml]
+        ....
+        [Pirate|eyeCount: Int|raid();pillage()|
+          [beard]--[parrot]
+          [beard]-:>[foul mouth]
+        ]
+        ....
+      ADOC
+      output = Asciidoctor.convert(input, attributes: { 'kroki-default-format' => 'png' }, standalone: false)
+      (expect output).to eql %(<div class="imageblock kroki">
+<div class="content">
+<img src="https://kroki.io/nomnoml/svg/eNqLDsgsSixJrUmtTHXOL80rsVLwzCupKUrMTNHQtC7IzMlJTE_V0KzhUlCITkpNLEqJ1dWNLkgsKsoviUUSs7KLTssvzVHIzS8tyYjligUAMhEd0g==" alt="Diagram">
+</div>
 </div>)
     end
     it 'should include the plantuml-include file when safe mode is safe' do
@@ -41,10 +87,12 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
         alice -> bob: hello
         ....
       ADOC
-      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '', 'kroki-plantuml-include' => 'spec/fixtures/config.puml' }, standalone: false, safe: :safe)
+      output = Asciidoctor.convert(input,
+                                   attributes: { 'kroki-plantuml-include' => 'spec/fixtures/config.puml' },
+                                   standalone: false, safe: :safe)
       (expect output).to eql %(<div class="imageblock kroki">
 <div class="content">
-<img src="https://kroki.io/plantuml/png/eNorzs7MK0gsSsxVyM3Py0_OKMrPTVUoKSpN5eJKzMlMTlXQtVNIyk-yUshIzcnJBwCT9xBc" alt="Diagram">
+<img src="https://kroki.io/plantuml/svg/eNorzs7MK0gsSsxVyM3Py0_OKMrPTVUoKSpN5eJKzMlMTlXQtVNIyk-yUshIzcnJBwCT9xBc" alt="Diagram">
 </div>
 </div>)
     end
@@ -55,10 +103,10 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
         alice -> bob: hello
         ....
       ADOC
-      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '', 'kroki-plantuml-include' => '../../../spec/fixtures/config.puml' }, standalone: false, safe: :safe)
+      output = Asciidoctor.convert(input, attributes: { 'kroki-plantuml-include' => '../../../spec/fixtures/config.puml' }, standalone: false, safe: :safe)
       (expect output).to eql %(<div class="imageblock kroki">
 <div class="content">
-<img src="https://kroki.io/plantuml/png/eNorzs7MK0gsSsxVyM3Py0_OKMrPTVUoKSpN5eJKzMlMTlXQtVNIyk-yUshIzcnJBwCT9xBc" alt="Diagram">
+<img src="https://kroki.io/plantuml/svg/eNorzs7MK0gsSsxVyM3Py0_OKMrPTVUoKSpN5eJKzMlMTlXQtVNIyk-yUshIzcnJBwCT9xBc" alt="Diagram">
 </div>
 </div>)
     end
@@ -69,10 +117,10 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
         alice -> bob: hello
         ....
       ADOC
-      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '', 'kroki-plantuml-include' => '/etc/passwd' }, standalone: false, safe: :safe)
+      output = Asciidoctor.convert(input, attributes: { 'kroki-plantuml-include' => '/etc/passwd' }, standalone: false, safe: :safe)
       (expect output).to eql %(<div class="imageblock kroki">
 <div class="content">
-<img src="https://kroki.io/plantuml/png/eNpLzMlMTlXQtVNIyk-yUshIzcnJBwA9iwZL" alt="Diagram">
+<img src="https://kroki.io/plantuml/svg/eNpLzMlMTlXQtVNIyk-yUshIzcnJBwA9iwZL" alt="Diagram">
 </div>
 </div>)
     end
@@ -83,10 +131,10 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
         alice -> bob: hello
         ....
       ADOC
-      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '', 'kroki-plantuml-include' => 'spec/fixtures/config.puml' }, standalone: false, safe: :secure)
+      output = Asciidoctor.convert(input, attributes: { 'kroki-plantuml-include' => 'spec/fixtures/config.puml' }, standalone: false, safe: :secure)
       (expect output).to eql %(<div class="imageblock kroki">
 <div class="content">
-<img src="https://kroki.io/plantuml/png/eNpLzMlMTlXQtVNIyk-yUshIzcnJBwA9iwZL" alt="Diagram">
+<img src="https://kroki.io/plantuml/svg/eNpLzMlMTlXQtVNIyk-yUshIzcnJBwA9iwZL" alt="Diagram">
 </div>
 </div>)
     end
@@ -134,7 +182,7 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
     it 'should instantiate block processor without warning' do
       original_stderr = $stderr
       $stderr = StringIO.new
-      ::AsciidoctorExtensions::KrokiBlockProcessor.new 'plantuml'.to_sym, {}
+      ::AsciidoctorExtensions::KrokiBlockProcessor.new :plantuml, {}
       output = $stderr.string
       (expect output).to eql ''
     ensure
@@ -146,7 +194,7 @@ end
 describe ::AsciidoctorExtensions::Kroki do
   it 'should return the list of supported diagrams' do
     diagram_names = ::AsciidoctorExtensions::Kroki::SUPPORTED_DIAGRAM_NAMES
-    expect(diagram_names).to include('vegalite', 'plantuml', 'bytefield', 'bpmn', 'excalidraw', 'wavedrom', 'pikchr')
+    expect(diagram_names).to include('vegalite', 'plantuml', 'bytefield', 'bpmn', 'excalidraw', 'wavedrom', 'pikchr', 'structurizr')
   end
   it 'should register the extension for the list of supported diagrams' do
     doc = Asciidoctor::Document.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-kroki
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Guillaume Grossetie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '1.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '1.30'
 description: An extension for Asciidoctor to convert diagrams to images using https://kroki.io
 email:
 - ggrossetie@yuzutech.fr
@@ -84,13 +84,16 @@ files:
 - lib/asciidoctor-kroki.rb
 - lib/asciidoctor/extensions/asciidoctor_kroki.rb
 - lib/asciidoctor/extensions/asciidoctor_kroki/extension.rb
+- lib/asciidoctor/extensions/asciidoctor_kroki/version.rb
 - spec/.rubocop.yml
 - spec/asciidoctor_kroki_block_macro_spec.rb
 - spec/asciidoctor_kroki_client_spec.rb
 - spec/asciidoctor_kroki_diagram_spec.rb
+- spec/asciidoctor_kroki_processor_spec.rb
 - spec/asciidoctor_kroki_spec.rb
 - spec/fixtures/alice.puml
 - spec/fixtures/config.puml
+- spec/fixtures/plantuml-diagram.png
 - spec/require_spec.rb
 - spec/rspec_helper.rb
 - tasks/bundler.rake
@@ -102,6 +105,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/Mogztter/asciidoctor-kroki/issues
   source_code_uri: https://github.com/Mogztter/asciidoctor-kroki
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -121,16 +125,4 @@ rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Asciidoctor extension to convert diagrams to images using Kroki
-test_files:
-- spec/.rubocop.yml
-- spec/asciidoctor_kroki_block_macro_spec.rb
-- spec/asciidoctor_kroki_client_spec.rb
-- spec/asciidoctor_kroki_diagram_spec.rb
-- spec/asciidoctor_kroki_spec.rb
-- spec/fixtures/alice.puml
-- spec/fixtures/config.puml
-- spec/require_spec.rb
-- spec/rspec_helper.rb
-- tasks/bundler.rake
-- tasks/lint.rake
-- tasks/rspec.rake
+test_files: []