asciidoctor-kroki 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7ac5f1586d5aa5a1cf3f3031b0bcc1839e40681913f30722703011e133b6a72
-  data.tar.gz: f10b7edc9d3e1092c35b07028b25255c6c2ae0921795d161dc542bdecc0b814f
+  metadata.gz: b10096229def31407946a5f7e77eb57a991895d9407d334b6a4ca3dc7e8ba165
+  data.tar.gz: 81497c2124169974c072a57c496b37d8cbd5e96b4793a22d59a3152fb1693c45
 SHA512:
-  metadata.gz: 613ae500380df383cc2b05720795de55933d5813ebb10f70f9252454727fac61f05d7f9c581641c28be8ed1e9fd42b6dcb9bb86283de455f92e4c41e0e00a78e
-  data.tar.gz: 25e547670dea5f121373ddc402b3740d33a6c1c31a006f3c2dd66dd5a753f4daa9d61aa7b6919543d7ec5c1b641b590a59c95b8de1b9419c6ffba2be7747a938
+  metadata.gz: 03e1e7d5dc886c9e4ff9d7199f3289aa1a94d8b97a21209ba4ea9c4b505129646297bb62c02cab6390803b157a7a505e3af944ff533c49086af11927647776ce
+  data.tar.gz: ad4cda7ce19c6ffa1223a224c1528c87e7b8864d554662f26a7534937f4bea49433e500373dad215feb09d71f748c84881ad720ea5c52765977383eb393a9f4c

data/.rubocop.yml

@@ -1,8 +1,14 @@
 Style/Encoding:
   Enabled: false
 
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
 Metrics/LineLength:
-  Max: 160
+  Max: 180
+
+Metrics/ClassLength:
+  Max: 150
 
 Metrics/MethodLength:
   Max: 50
@@ -15,3 +21,6 @@ Metrics/PerceivedComplexity:
 
 Metrics/AbcSize:
   Max: 30
+
+Metrics/ParameterLists:
+  Max: 7

data/Gemfile.lock

@@ -1,62 +1,19 @@
 PATH
   remote: .
   specs:
-    asciidoctor-kroki (0.2.0)
+    asciidoctor-kroki (0.5.0)
       asciidoctor (~> 2.0)
-      asciidoctor-pdf (= 1.5.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    Ascii85 (1.0.3)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    afm (0.2.2)
-    asciidoctor (2.0.10)
-    asciidoctor-pdf (1.5.3)
-      asciidoctor (>= 1.5.3, < 3.0.0)
-      concurrent-ruby (~> 1.1.0)
-      prawn (~> 2.2.0)
-      prawn-icon (~> 2.5.0)
-      prawn-svg (~> 0.30.0)
-      prawn-table (~> 0.2.0)
-      prawn-templates (~> 0.1.0)
-      safe_yaml (~> 1.0.0)
-      thread_safe (~> 0.3.0)
-      treetop (~> 1.6.0)
-      ttfunk (~> 1.5.0, >= 1.5.1)
+    asciidoctor (2.0.11)
     ast (2.4.1)
-    concurrent-ruby (1.1.6)
-    css_parser (1.7.1)
-      addressable
     diff-lcs (1.3)
-    hashery (2.1.2)
     jaro_winkler (1.5.4)
     parallel (1.19.1)
     parser (2.7.1.3)
       ast (~> 2.4.0)
-    pdf-core (0.7.0)
-    pdf-reader (2.4.0)
-      Ascii85 (~> 1.0.0)
-      afm (~> 0.2.1)
-      hashery (~> 2.0)
-      ruby-rc4
-      ttfunk
-    polyglot (0.3.5)
-    prawn (2.2.2)
-      pdf-core (~> 0.7.0)
-      ttfunk (~> 1.5)
-    prawn-icon (2.5.0)
-      prawn (>= 1.1.0, < 3.0.0)
-    prawn-svg (0.30.0)
-      css_parser (~> 1.6)
-      prawn (>= 0.11.1, < 3)
-    prawn-table (0.2.2)
-      prawn (>= 1.3.0, < 3.0.0)
-    prawn-templates (0.1.2)
-      pdf-reader (~> 2.0)
-      prawn (~> 2.2)
-    public_suffix (4.0.5)
     rainbow (3.0.0)
     rake (12.3.3)
     rspec (3.8.0)
@@ -80,12 +37,6 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    ruby-rc4 (0.1.5)
-    safe_yaml (1.0.5)
-    thread_safe (0.3.6)
-    treetop (1.6.10)
-      polyglot (~> 0.3)
-    ttfunk (1.5.1)
     unicode-display_width (1.6.1)
 
 PLATFORMS
@@ -98,4 +49,4 @@ DEPENDENCIES
   rubocop (~> 0.74.0)
 
 BUNDLED WITH
-   1.17.3
+   2.2.17

data/asciidoctor-kroki.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'asciidoctor-kroki'
-  s.version = '0.2.0'
+  s.version = '0.5.0'
   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'
 
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'asciidoctor', '~> 2.0'
-  s.add_runtime_dependency 'asciidoctor-pdf', '1.5.3'
 
   s.add_development_dependency 'rake', '~> 12.3.2'
   s.add_development_dependency 'rspec', '~> 3.8.0'

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

@@ -15,11 +15,24 @@ module AsciidoctorExtensions
     on_context :listing, :literal
     name_positional_attributes 'target', 'format'
 
+    # @param name [String] name of the block macro (optional)
+    # @param config [Hash] a config hash (optional)
+    #   - :logger a logger used to log warning and errors (optional)
+    #
+    def initialize(name = nil, config = {})
+      @logger = (config || {}).delete(:logger) { ::Asciidoctor::LoggerManager.logger }
+      super(name, config)
+    end
+
     def process(parent, reader, attrs)
       diagram_type = @name
       diagram_text = reader.string
-      KrokiProcessor.process(self, parent, attrs, diagram_type, diagram_text)
+      KrokiProcessor.process(self, parent, attrs, diagram_type, diagram_text, @logger)
     end
+
+    protected
+
+    attr_reader :logger
   end
 
   # A block macro extension that converts a diagram into an image.
@@ -29,11 +42,48 @@ module AsciidoctorExtensions
 
     name_positional_attributes 'format'
 
+    # @param name [String] name of the block macro (optional)
+    # @param config [Hash] a config hash (optional)
+    #   - :logger a logger used to log warning and errors (optional)
+    #
+    def initialize(name = nil, config = {})
+      @logger = (config || {}).delete(:logger) { ::Asciidoctor::LoggerManager.logger }
+      super(name, config)
+    end
+
     def process(parent, target, attrs)
       diagram_type = @name
       target = parent.apply_subs(target, [:attributes])
-      diagram_text = read(target)
-      KrokiProcessor.process(self, parent, attrs, diagram_type, diagram_text)
+
+      unless read_allowed?(target)
+        link = create_inline(parent, :anchor, target, type: :link, target: target)
+        return create_block(parent, :paragraph, link.convert, {}, content_model: :raw)
+      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), {})
+      end
+
+      begin
+        diagram_text = read(path)
+      rescue => e # rubocop:disable RescueStandardError
+        logger.error "Failed to read #{diagram_type} file: #{path}. #{e}."
+        return create_block(parent, 'paragraph', unresolved_block_macro_message(diagram_type, path), {})
+      end
+      KrokiProcessor.process(self, parent, attrs, diagram_type, diagram_text, @logger)
+    end
+
+    protected
+
+    attr_reader :logger
+
+    def resolve_target_path(target)
+      target
+    end
+
+    def read_allowed?(_target)
+      true
     end
 
     def read(target)
@@ -44,32 +94,38 @@ module AsciidoctorExtensions
         File.open(target, &:read)
       end
     end
+
+    def unresolved_block_macro_message(name, target)
+      "Unresolved block macro - #{name}::#{target}[]"
+    end
   end
 
   # Kroki API
   #
   module Kroki
     SUPPORTED_DIAGRAM_NAMES = %w[
-      plantuml
-      ditaa
-      graphviz
-      blockdiag
-      seqdiag
       actdiag
-      nwdiag
-      packetdiag
-      rackdiag
+      blockdiag
+      bpmn
+      bytefield
       c4plantuml
+      ditaa
       erd
+      excalidraw
+      graphviz
       mermaid
       nomnoml
+      nwdiag
+      packetdiag
+      pikchr
+      plantuml
+      rackdiag
+      seqdiag
       svgbob
       umlet
       vega
       vegalite
       wavedrom
-      bytefield
-      bpmn
     ].freeze
   end
 
@@ -79,9 +135,9 @@ module AsciidoctorExtensions
     TEXT_FORMATS = %w[txt atxt utxt].freeze
 
     class << self
-      def process(processor, parent, attrs, diagram_type, diagram_text)
+      def process(processor, parent, attrs, diagram_type, diagram_text, logger)
         doc = parent.document
-        diagram_text = prepend_plantuml_config(diagram_text, diagram_type, doc)
+        diagram_text = prepend_plantuml_config(diagram_text, diagram_type, doc, logger)
         # If "subs" attribute is specified, substitute accordingly.
         # Be careful not to specify "specialcharacters" or your diagram code won't be valid anymore!
         if (subs = attrs['subs'])
@@ -95,7 +151,7 @@ module AsciidoctorExtensions
         attrs['role'] = get_role(format, role)
         attrs['format'] = format
         kroki_diagram = KrokiDiagram.new(diagram_type, format, diagram_text)
-        kroki_client = KrokiClient.new(server_url(doc), http_method(doc), KrokiHttpClient)
+        kroki_client = KrokiClient.new(server_url(doc), http_method(doc), KrokiHttpClient, logger, max_uri_length(doc))
         if TEXT_FORMATS.include?(format)
           text_content = kroki_client.text_content(kroki_diagram)
           block = processor.create_block(parent, 'literal', text_content, attrs)
@@ -111,12 +167,17 @@ module AsciidoctorExtensions
 
       private
 
-      def prepend_plantuml_config(diagram_text, diagram_type, doc)
-        if diagram_type == :plantuml && doc.attr?('kroki-plantuml-include')
-          # TODO: this behaves different than the JS version
-          # The file should be added by !include #{plantuml_include}" once we have a preprocessor for ruby
-          config = File.read(doc.attr('kroki-plantuml-include'))
-          diagram_text = config + '\n' + diagram_text
+      def prepend_plantuml_config(diagram_text, diagram_type, doc, logger)
+        if diagram_type == :plantuml && doc.safe < ::Asciidoctor::SafeMode::SECURE && doc.attr?('kroki-plantuml-include')
+          # REMIND: this behaves different than the JS version
+          # Once we have a preprocessor for Ruby, the value should be added in the diagram source as "!include #{plantuml_include}"
+          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
+          else
+            logger.warn "Unable to read plantuml-include. File not found or not readable: #{plantuml_include_path}."
+          end
         end
         diagram_text
       end
@@ -156,7 +217,7 @@ module AsciidoctorExtensions
       end
 
       def create_image_src(doc, kroki_diagram, kroki_client)
-        if doc.attr('kroki-fetch-diagram')
+        if doc.attr('kroki-fetch-diagram') && doc.safe < ::Asciidoctor::SafeMode::SECURE
           kroki_diagram.save(output_dir_path(doc), kroki_client)
         else
           kroki_diagram.get_diagram_uri(server_url(doc))
@@ -171,20 +232,20 @@ module AsciidoctorExtensions
         doc.attr('kroki-http-method', 'adaptive').downcase
       end
 
+      def max_uri_length(doc)
+        doc.attr('kroki-max-uri-length', '4000').to_i
+      end
+
       def output_dir_path(doc)
-        images_output_dir = doc.attr('imagesoutdir')
-        out_dir = doc.attr('outdir')
-        to_dir = doc.attr('to_dir')
-        base_dir = doc.base_dir
         images_dir = doc.attr('imagesdir', '')
-        if images_output_dir
+        if (images_output_dir = doc.attr('imagesoutdir'))
           images_output_dir
-        elsif out_dir
+        elsif (out_dir = doc.attr('outdir'))
           File.join(out_dir, images_dir)
-        elsif to_dir
+        elsif (to_dir = doc.attr('to_dir'))
           File.join(to_dir, images_dir)
         else
-          File.join(base_dir, images_dir)
+          File.join(doc.base_dir, images_dir)
         end
       end
     end
@@ -258,18 +319,19 @@ module AsciidoctorExtensions
   class KrokiClient
     attr_reader :server_url
     attr_reader :method
+    attr_reader :max_uri_length
 
     SUPPORTED_HTTP_METHODS = %w[get post adaptive].freeze
 
-    def initialize(server_url, http_method, http_client)
+    def initialize(server_url, http_method, http_client, logger = ::Asciidoctor::LoggerManager.logger, max_uri_length = 4000)
       @server_url = server_url
-      @max_uri_length = 4096
+      @max_uri_length = max_uri_length
       @http_client = http_client
       method = (http_method || 'adaptive').downcase
       if SUPPORTED_HTTP_METHODS.include?(method)
         @method = method
       else
-        puts "Invalid value '#{method}' for kroki-http-method attribute. The value must be either: 'get', 'post' or 'adaptive'. Proceeding using: 'adaptive'."
+        logger.warn "Invalid value '#{method}' for kroki-http-method attribute. The value must be either: 'get', 'post' or 'adaptive'. Proceeding using: 'adaptive'."
         @method = 'adaptive'
       end
     end
@@ -285,7 +347,7 @@ module AsciidoctorExtensions
       if @method == 'adaptive' || @method == 'get'
         uri = kroki_diagram.get_diagram_uri(server_url)
         if uri.length > @max_uri_length
-          # The request URI is longer than 4096.
+          # The request URI is longer than the max URI length.
           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'.

data/spec/asciidoctor_kroki_block_macro_spec.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'rspec_helper'
+require 'asciidoctor'
+require_relative '../lib/asciidoctor/extensions/asciidoctor_kroki'
+require_relative '../lib/asciidoctor/extensions/asciidoctor_kroki/extension'
+
+describe ::AsciidoctorExtensions::KrokiBlockMacroProcessor do
+  context 'convert to html5' do
+    it 'should catch exception if target is not readable' do
+      input = <<~'ADOC'
+        plantuml::spec/fixtures/missing.puml[svg,role=sequence]
+      ADOC
+      output = Asciidoctor.convert(input, standalone: false)
+      (expect output).to eql %(<div class="paragraph">
+<p>Unresolved block macro - plantuml::spec/fixtures/missing.puml[]</p>
+</div>)
+    end
+  end
+  context 'using a custom block macro' do
+    it 'should disallow read' do
+      # noinspection RubyClassModuleNamingConvention
+      class DisallowReadKrokiBlockMacroProcessor < ::AsciidoctorExtensions::KrokiBlockMacroProcessor
+        def read_allowed?(_target)
+          false
+        end
+      end
+      registry = Asciidoctor::Extensions.create do
+        block_macro DisallowReadKrokiBlockMacroProcessor, 'plantuml'
+      end
+      input = <<~'ADOC'
+        plantuml::spec/fixtures/alice.puml[svg,role=sequence]
+      ADOC
+      output = Asciidoctor.convert(input, standalone: false, extension_registry: registry)
+      (expect output).to eql %(<div class="paragraph">
+<p><a href="spec/fixtures/alice.puml">spec/fixtures/alice.puml</a></p>
+</div>)
+    end
+    it 'should allow read if target is not a URI' do
+      # noinspection RubyClassModuleNamingConvention
+      class DisallowUriReadKrokiBlockMacroProcessor < ::AsciidoctorExtensions::KrokiBlockMacroProcessor
+        def read_allowed?(target)
+          return false if ::Asciidoctor::Helpers.uriish?(target)
+
+          true
+        end
+      end
+      registry = Asciidoctor::Extensions.create do
+        block_macro DisallowUriReadKrokiBlockMacroProcessor, 'plantuml'
+      end
+      input = <<~'ADOC'
+        plantuml::https://domain.org/alice.puml[svg,role=sequence]
+
+        plantuml::file://path/to/alice.puml[svg,role=sequence]
+
+        plantuml::spec/fixtures/alice.puml[svg,role=sequence]
+      ADOC
+      output = Asciidoctor.convert(input, standalone: false, extension_registry: registry)
+      (expect output).to eql %(<div class="paragraph">
+<p><a href="https://domain.org/alice.puml">https://domain.org/alice.puml</a></p>
+</div>
+<div class="paragraph">
+<p><a href="file://path/to/alice.puml">file://path/to/alice.puml</a></p>
+</div>
+<div class="imageblock sequence kroki-format-svg kroki">
+<div class="content">
+<img src="https://kroki.io/plantuml/svg/eNpLzMlMTlXQtVNIyk-yUshIzcnJ5wIAQ-AGVQ==" alt="Diagram">
+</div>
+</div>)
+    end
+    it 'should override the resolve target method' do
+      # noinspection RubyClassModuleNamingConvention
+      class FixtureResolveTargetKrokiBlockMacroProcessor < ::AsciidoctorExtensions::KrokiBlockMacroProcessor
+        def resolve_target_path(target)
+          "spec/fixtures/#{target}"
+        end
+      end
+      registry = Asciidoctor::Extensions.create do
+        block_macro FixtureResolveTargetKrokiBlockMacroProcessor, 'plantuml'
+      end
+      input = <<~'ADOC'
+        plantuml::alice.puml[svg,role=sequence]
+      ADOC
+      output = Asciidoctor.convert(input, standalone: false, extension_registry: registry)
+      (expect output).to eql %(<div class="imageblock sequence kroki-format-svg kroki">
+<div class="content">
+<img src="https://kroki.io/plantuml/svg/eNpLzMlMTlXQtVNIyk-yUshIzcnJ5wIAQ-AGVQ==" alt="Diagram">
+</div>
+</div>)
+    end
+    it 'should display unresolved block macro message when the traget cannot be resolved' do
+      # noinspection RubyClassModuleNamingConvention
+      class UnresolvedTargetKrokiBlockMacroProcessor < ::AsciidoctorExtensions::KrokiBlockMacroProcessor
+        def resolve_target_path(_target)
+          nil
+        end
+      end
+      registry = Asciidoctor::Extensions.create do
+        block_macro UnresolvedTargetKrokiBlockMacroProcessor, 'plantuml'
+      end
+      input = <<~'ADOC'
+        plantuml::alice.puml[svg,role=sequence]
+      ADOC
+      output = Asciidoctor.convert(input, standalone: false, extension_registry: registry)
+      (expect output).to eql %(<div class="paragraph">
+<p>Unresolved block macro - plantuml::[]</p>
+</div>)
+    end
+    it 'should override the unresolved block macro message' do
+      # noinspection RubyClassModuleNamingConvention
+      class CustomUnresolvedTargetMessageKrokiBlockMacroProcessor < ::AsciidoctorExtensions::KrokiBlockMacroProcessor
+        def unresolved_block_macro_message(name, target)
+          "*[ERROR: #{name}::#{target}[] - unresolved block macro]*"
+        end
+      end
+      registry = Asciidoctor::Extensions.create do
+        block_macro CustomUnresolvedTargetMessageKrokiBlockMacroProcessor, 'plantuml'
+      end
+      input = <<~'ADOC'
+        plantuml::spec/fixtures/missing.puml[svg,role=sequence]
+      ADOC
+      output = Asciidoctor.convert(input, standalone: false, extension_registry: registry)
+      (expect output).to eql %(<div class="paragraph">
+<p><strong>[ERROR: plantuml::spec/fixtures/missing.puml[] - unresolved block macro]</strong></p>
+</div>)
+    end
+  end
+end

data/spec/asciidoctor_kroki_client_spec.rb

@@ -20,4 +20,72 @@ describe ::AsciidoctorExtensions::KrokiClient do
     kroki_client = ::AsciidoctorExtensions::KrokiClient.new('http://localhost:8000', 'get', 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)
+    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)
+    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
+    kroki_http_client = Class.new do
+      class << self
+        def get(uri, _)
+          "GET #{uri}"
+        end
+
+        def post(uri, data, _)
+          "POST #{uri} - #{data}"
+        end
+      end
+    end
+    kroki_diagram = Class.new do
+      attr_reader :type, :text, :format
+
+      def initialize(type, format, text)
+        @text = text
+        @type = type
+        @format = format
+      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)
+    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, _)
+          "GET #{uri}"
+        end
+
+        def post(uri, data, _)
+          "POST #{uri} - #{data}"
+        end
+      end
+    end
+    kroki_diagram = Class.new do
+      attr_reader :type, :text, :format
+
+      def initialize(type, format, text)
+        @text = text
+        @type = type
+        @format = format
+      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)
+    result = kroki_client.get_image(kroki_diagram, 'utf8')
+    expect(result).to eq('GET diagram-uri')
+  end
 end

data/spec/asciidoctor_kroki_spec.rb

@@ -34,17 +34,59 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
 </div>
 </div>)
     end
-    it 'should include the plantuml-include file' do
+    it 'should include the plantuml-include file when safe mode is safe' do
       input = <<~'ADOC'
         [plantuml]
         ....
         alice -> bob: hello
         ....
       ADOC
-      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '', 'kroki-plantuml-include' => 'spec/fixtures/config.puml' }, standalone: false)
+      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '', '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_OKMrPTVUoKSpN5YrJS8zJTE5V0LVTSMpPslLISM3JyQcArVsRHA==" alt="Diagram">
+<img src="https://kroki.io/plantuml/png/eNorzs7MK0gsSsxVyM3Py0_OKMrPTVUoKSpN5eJKzMlMTlXQtVNIyk-yUshIzcnJBwCT9xBc" alt="Diagram">
+</div>
+</div>)
+    end
+    it 'should normalize plantuml-include path when safe mode is safe' do
+      input = <<~'ADOC'
+        [plantuml]
+        ....
+        alice -> bob: hello
+        ....
+      ADOC
+      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '', '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">
+</div>
+</div>)
+    end
+    it 'should not include file which reside outside of the parent directory of the source when safe mode is safe' do
+      input = <<~'ADOC'
+        [plantuml]
+        ....
+        alice -> bob: hello
+        ....
+      ADOC
+      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '', '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">
+</div>
+</div>)
+    end
+    it 'should not include file when safe mode is secure' do
+      input = <<~'ADOC'
+        [plantuml]
+        ....
+        alice -> bob: hello
+        ....
+      ADOC
+      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '', '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">
 </div>
 </div>)
     end
@@ -54,11 +96,24 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
 
         plantuml::spec/fixtures/alice.puml[svg,role=sequence]
       ADOC
-      output = Asciidoctor.convert(input, attributes: { 'kroki-fetch-diagram' => '' }, standalone: false)
+      output = Asciidoctor.convert(input, attributes: { 'kroki-fetch-diagram' => '' }, standalone: false, safe: :safe)
       (expect output).to eql %(<div class="imageblock sequence kroki-format-svg kroki">
 <div class="content">
 <img src=".asciidoctor/kroki/diag-f6acdc206506b6ca7badd3fe722f252af992871426e580c8361ff4d47c2c7d9b.svg" alt="Diagram">
 </div>
+</div>)
+    end
+    it 'should not fetch diagram when safe mode is secure' do
+      input = <<~'ADOC'
+        :imagesdir: .asciidoctor/kroki
+
+        plantuml::spec/fixtures/alice.puml[svg,role=sequence]
+      ADOC
+      output = Asciidoctor.convert(input, attributes: { 'kroki-fetch-diagram' => '' }, standalone: false)
+      (expect output).to eql %(<div class="imageblock sequence kroki-format-svg kroki">
+<div class="content">
+<img src="https://kroki.io/plantuml/svg/eNpLzMlMTlXQtVNIyk-yUshIzcnJ5wIAQ-AGVQ==" alt="Diagram">
+</div>
 </div>)
     end
     it 'should create PNG diagram in imagesdir if kroki-fetch-diagram is set' do
@@ -67,7 +122,7 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
 
         plantuml::spec/fixtures/alice.puml[png,role=sequence]
       ADOC
-      output = Asciidoctor.convert(input, attributes: { 'kroki-fetch-diagram' => '' }, standalone: false)
+      output = Asciidoctor.convert(input, attributes: { 'kroki-fetch-diagram' => '' }, standalone: false, safe: :safe)
       (expect output).to eql %(<div class="imageblock sequence kroki-format-png kroki">
 <div class="content">
 <img src=".asciidoctor/kroki/diag-d4f314b2d4e75cc08aa4f8c2c944f7bf78321895d8ec5f665b42476d4e67e610.png" alt="Diagram">
@@ -75,12 +130,23 @@ describe ::AsciidoctorExtensions::KrokiBlockProcessor do
 </div>)
     end
   end
+  context 'instantiate' do
+    it 'should instantiate block processor without warning' do
+      original_stderr = $stderr
+      $stderr = StringIO.new
+      ::AsciidoctorExtensions::KrokiBlockProcessor.new 'plantuml'.to_sym, {}
+      output = $stderr.string
+      (expect output).to eql ''
+    ensure
+      $stderr = original_stderr
+    end
+  end
 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')
+    expect(diagram_names).to include('vegalite', 'plantuml', 'bytefield', 'bpmn', 'excalidraw', 'wavedrom', 'pikchr')
   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.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Guillaume Grossetie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: asciidoctor-pdf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.5.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +85,7 @@ files:
 - lib/asciidoctor/extensions/asciidoctor_kroki.rb
 - lib/asciidoctor/extensions/asciidoctor_kroki/extension.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_spec.rb
@@ -130,12 +117,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+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