asciidoctor-kroki 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d98287cf9a15751a442de9b1a07565c097206aae0912ca204ecaf4bdede4020
-  data.tar.gz: b1252225ed15a9f093d8a3c1d577e2bfa23c2abe7962981d638f49ea81d90a7b
+  metadata.gz: 46f326afecfa57d4b918121fdf939c2c8dcf46897daeff74236a551628ffbfdf
+  data.tar.gz: c43629e9e6d4303fa59d761b61e95e6b63006cea1a27faf1dc3e80ceb9994f8c
 SHA512:
-  metadata.gz: 46688eb160c567e33ba1f220ab229848a66874af0713962c339bc4d3b7d3352a5ef3f2f74e9c257bae6c579e03bf6c32cdf55e16f9b64d7b189aa103bf2d8550
-  data.tar.gz: 78a231f8b5921330aab30a2cd5c4f56ab84f917e31dc4cc85d2eb126cec84f04bd52756db2ff1fd8991116086b1100184c0644f35929fadb8ae49f95806e1248
+  metadata.gz: 70eac4468da00da494aa490e3c413189feb13474d25aa778f1d0cb301957c7ce1811bbc82cc7d1e2782a43223452f5b1de75a150b446824c2de7f9380811defc
+  data.tar.gz: e9d6cbbdc63c8f28dd99c1921f1496765ccbb873210756c765d879d1311994243af42f55f3d4dc18e0500be299ef89d5027bbccf5afefee24255d65c71e829d4

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    asciidoctor-kroki (0.6.0)
+    asciidoctor-kroki (0.7.0)
       asciidoctor (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    asciidoctor (2.0.11)
+    asciidoctor (2.0.17)
     ast (2.4.2)
     diff-lcs (1.4.4)
     parallel (1.22.1)

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
@@ -137,6 +138,7 @@ module AsciidoctorExtensions
     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
@@ -148,13 +150,12 @@ 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')
         format = get_format(doc, attrs, diagram_type)
         attrs['role'] = get_role(format, attrs['role'])
         attrs['format'] = format
-        kroki_diagram = KrokiDiagram.new(diagram_type, format, diagram_text, attrs['target'])
+        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),
@@ -162,11 +163,14 @@ module AsciidoctorExtensions
                                          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
@@ -221,8 +225,8 @@ module AsciidoctorExtensions
         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, mermaid, nomnoml, svgbob, wavedrom only support SVG as output format.
-          svg_only_diagram_types = %i[mermaid nomnoml svgbob wavedrom]
+          # 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
@@ -269,17 +273,19 @@ module AsciidoctorExtensions
     require 'zlib'
     require 'digest'
 
-    attr_reader :type, :text, :format, :target
+    attr_reader :type, :text, :format, :target, :opts
 
-    def initialize(type, format, text, target = nil)
+    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
@@ -308,6 +314,10 @@ module AsciidoctorExtensions
 
     private
 
+    def _url_encode(text)
+      CGI.escape(text).gsub(/\+/, '%20')
+    end
+
     def _join_uri_segments(base, *uris)
       segments = []
       # remove trailing slashes
@@ -354,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
@@ -361,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
@@ -384,10 +395,11 @@ module AsciidoctorExtensions
     class << self
       REFERER = "asciidoctor/kroki.rb/#{Asciidoctor::AsciidoctorKroki::VERSION}"
 
-      def get(uri, _)
+      def get(uri, opts, _)
         uri = URI(uri)
-        request = ::Net::HTTP::Get.new(uri)
-        request['referer'] = REFERER
+        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,
@@ -397,12 +409,16 @@ module AsciidoctorExtensions
         end
       end
 
-      def 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,
-          'Content-Type' => 'text/plain',
-          'Referer' => REFERER
+          headers
         )
         res.body
       end

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

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module AsciidoctorKroki
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
   end
 end

data/spec/asciidoctor_kroki_client_spec.rb

@@ -37,18 +37,19 @@ 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(_)
@@ -62,22 +63,23 @@ describe ::AsciidoctorExtensions::KrokiClient do
   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(_)

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

data/spec/asciidoctor_kroki_spec.rb

@@ -18,6 +18,35 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
 <div class="content">
 <img src="https://kroki.io/plantuml/svg/eNpLzMlMTlXQtVNIyk-yUshIzcnJBwA9iwZL" alt="Diagram">
 </div>
+</div>)
+    end
+    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
@@ -36,16 +65,18 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
     end
     it 'should use svg if kroki-default-format is set to png and the diagram type does not support png' do
       input = <<~'ADOC'
-        [mermaid]
+        [nomnoml]
         ....
-        graph TD;
-          A-->B;
+        [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/mermaid/svg/eNpLL0osyFAIcbHmUlBw1NW1c7IGADLKBKY=" alt="Diagram">
+<img src="https://kroki.io/nomnoml/svg/eNqLDsgsSixJrUmtTHXOL80rsVLwzCupKUrMTNHQtC7IzMlJTE_V0KzhUlCITkpNLEqJ1dWNLkgsKsoviUUSs7KLTssvzVHIzS8tyYjligUAMhEd0g==" alt="Diagram">
 </div>
 </div>)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-kroki
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Guillaume Grossetie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-22 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor