asciidoctor-kroki 0.1.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e516cef89499dde5cea46152f3926f6b91c8f81c9e8ff57884dac15d1877fd1c
-  data.tar.gz: 919d391cf9ca8ad118ead138a8338434b7ffa6d6e15e6678a65a084aadbedd15
+  metadata.gz: dfa0c461bdb74571b618747d791e059125dc09a5e67dd6886861101fe972237f
+  data.tar.gz: d882ff8e33c787b3a1578eb7d11b590411e18f594eaec188d7f06ffc182a3b11
 SHA512:
-  metadata.gz: f96a43e66d73647ff2593e74ef695526fa52c6a9cf453c22d34d11bcc035bf8e5bb4256d43eab35f5e8290b32f5f02c0df064a975b7c3164efd83e8d96c320f3
-  data.tar.gz: 1536eb019a5b9fe3bd939ee64b6bd26252dd5096185f919c15536b6405f436baee91ca852a5519c2414b9ceee2215fad1228b28d8995a1da85ac583e7d5b0c86
+  metadata.gz: f72b7293f3fb8c6d37b456c39d4e2691c0b65e1cb908d5f3f29d23466f0c51135b9977dd0977a2ccac7adb667b4fc5071a4a5fc59bed6a3304154bddc8efda3d
+  data.tar.gz: 1e93fbf9df1cab9282f7743f76331ea6caddfdce150fff36fb7aa7222d561d089c31101ec0f16a939f5aa2c0c7dd5a09206059700974b76ae6fadcfc0150acd3

data/.gitignore

@@ -1 +1,2 @@
 pkg/
+.asciidoctor/kroki

data/.rubocop.yml

@@ -1,14 +1,26 @@
 Style/Encoding:
   Enabled: false
 
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
 Metrics/LineLength:
-  Max: 160
+  Max: 180
+
+Metrics/ClassLength:
+  Max: 150
 
 Metrics/MethodLength:
   Max: 50
 
 Metrics/CyclomaticComplexity:
-  Max : 10
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
 
 Metrics/AbcSize:
-  Max: 25
+  Max: 30
+
+Metrics/ParameterLists:
+  Max: 7

data/Gemfile.lock

@@ -1,62 +1,19 @@
 PATH
   remote: .
   specs:
-    asciidoctor-kroki (0.1.2)
+    asciidoctor-kroki (0.4.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

data/asciidoctor-kroki.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'asciidoctor-kroki'
-  s.version = '0.1.2'
+  s.version = '0.4.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.rb

@@ -4,8 +4,7 @@ require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 require_relative 'asciidoctor_kroki/extension'
 
 Asciidoctor::Extensions.register do
-  names = %w[plantuml ditaa graphviz blockdiag seqdiag actdiag nwdiag packetdiag rackdiag c4plantuml erd mermaid nomnoml svgbob umlet vega vegalite wavedrom]
-  names.each do |name|
+  ::AsciidoctorExtensions::Kroki::SUPPORTED_DIAGRAM_NAMES.each do |name|
     block_macro ::AsciidoctorExtensions::KrokiBlockMacroProcessor, name
     block ::AsciidoctorExtensions::KrokiBlockProcessor, name
   end

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
-require 'stringio'
-require 'zlib'
 
 # Asciidoctor extensions
 #
@@ -17,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)
+    # @param logger [Logger] a logger used to log warning and errors (optional)
+    #
+    def initialize(name = nil, config = {}, logger: ::Asciidoctor::LoggerManager.logger)
+      super(name, config)
+      @logger = logger
+    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 +40,50 @@ module AsciidoctorExtensions
   class KrokiBlockMacroProcessor < Asciidoctor::Extensions::BlockMacroProcessor
     use_dsl
 
+    name_positional_attributes 'format'
+
+    # @param name [String] name of the block macro (optional)
+    # @param config [Hash] a config hash (optional)
+    # @param logger [Logger] a logger used to log warning and errors (optional)
+    #
+    def initialize(name = nil, config = {}, logger: ::Asciidoctor::LoggerManager.logger)
+      super(name, config)
+      @logger = logger
+    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)
+      target = parent.apply_subs(target, [:attributes])
+
+      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,15 +94,49 @@ 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[
+      actdiag
+      blockdiag
+      bpmn
+      bytefield
+      c4plantuml
+      ditaa
+      erd
+      excalidraw
+      graphviz
+      mermaid
+      nomnoml
+      nwdiag
+      packetdiag
+      plantuml
+      rackdiag
+      seqdiag
+      svgbob
+      umlet
+      vega
+      vegalite
+      wavedrom
+    ].freeze
   end
 
   # Internal processor
   #
   class KrokiProcessor
+    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'])
@@ -64,23 +148,35 @@ module AsciidoctorExtensions
         role = attrs['role']
         format = get_format(doc, attrs, diagram_type)
         attrs['role'] = get_role(format, role)
-        attrs['alt'] = get_alt(attrs)
-        attrs['target'] = create_image_src(doc, diagram_type, format, diagram_text)
         attrs['format'] = format
-        block = processor.create_image_block(parent, attrs)
-        block.title = title
+        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))
+        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['target'] = create_image_src(doc, kroki_diagram, kroki_client)
+          block = processor.create_image_block(parent, attrs)
+        end
+        block.title = title if title
         block.assign_caption(caption, 'figure')
         block
       end
 
       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
@@ -119,13 +215,169 @@ module AsciidoctorExtensions
         format
       end
 
-      def create_image_src(doc, type, format, text)
-        data = Base64.urlsafe_encode64(Zlib::Deflate.deflate(text, 9))
-        "#{server_url(doc)}/#{type}/#{format}/#{data}"
+      def create_image_src(doc, kroki_diagram, kroki_client)
+        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))
+        end
       end
 
       def server_url(doc)
-        doc.attr('kroki-server-url') || 'https://kroki.io'
+        doc.attr('kroki-server-url', 'https://kroki.io')
+      end
+
+      def http_method(doc)
+        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_dir = doc.attr('imagesdir', '')
+        if (images_output_dir = doc.attr('imagesoutdir'))
+          images_output_dir
+        elsif (out_dir = doc.attr('outdir'))
+          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
+      end
+    end
+  end
+
+  # Kroki diagram
+  #
+  class KrokiDiagram
+    require 'fileutils'
+    require 'zlib'
+    require 'digest'
+
+    attr_reader :type
+    attr_reader :text
+    attr_reader :format
+
+    def initialize(type, format, text)
+      @text = text
+      @type = type
+      @format = format
+    end
+
+    def get_diagram_uri(server_url)
+      _join_uri_segments(server_url, @type, @format, encode)
+    end
+
+    def encode
+      Base64.urlsafe_encode64(Zlib::Deflate.deflate(@text, 9))
+    end
+
+    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}"
+      file_path = File.join(output_dir_path, diagram_name)
+      encoding = if @format == 'txt' || @format == 'atxt' || @format == 'utxt'
+                   '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)
+      end
+      diagram_name
+    end
+
+    private
+
+    def _join_uri_segments(base, *uris)
+      segments = []
+      # remove trailing slashes
+      segments.push(base.gsub(%r{[/]+$}, ''))
+      segments.concat(uris.map do |uri|
+        # remove leading and trailing slashes
+        uri.to_s
+          .gsub(%r{^[/]+}, '')
+          .gsub(%r{[/]+$}, '')
+      end)
+      segments.join('/')
+    end
+  end
+
+  # Kroki client
+  #
+  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, 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
+      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'."
+        @method = 'adaptive'
+      end
+    end
+
+    def text_content(kroki_diagram)
+      get_image(kroki_diagram, 'utf-8')
+    end
+
+    def get_image(kroki_diagram, encoding)
+      type = kroki_diagram.type
+      format = kroki_diagram.format
+      text = kroki_diagram.text
+      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 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'.
+            @http_client.get(uri, encoding)
+          else
+            @http_client.post("#{@server_url}/#{type}/#{format}", text, encoding)
+          end
+        else
+          @http_client.get(uri, encoding)
+        end
+      else
+        @http_client.post("#{@server_url}/#{type}/#{format}", text, encoding)
+      end
+    end
+  end
+
+  # Kroki HTTP client
+  #
+  class KrokiHttpClient
+    require 'net/http'
+    require 'uri'
+    require 'json'
+
+    class << self
+      def get(uri, _)
+        ::OpenURI.open_uri(uri, 'r', &:read)
+      end
+
+      def post(uri, data, _)
+        res = ::Net::HTTP.request_post(uri, data)
+        res.body
       end
     end
   end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'rspec_helper'
+require 'asciidoctor'
+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)
+    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)
+    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)
+    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_diagram_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'rspec_helper'
+require 'asciidoctor'
+require_relative '../lib/asciidoctor/extensions/asciidoctor_kroki'
+
+describe ::AsciidoctorExtensions::KrokiDiagram do
+  it 'should compute a diagram URI' do
+    kroki_diagram = ::AsciidoctorExtensions::KrokiDiagram.new('vegalite', 'png', '{}')
+    diagram_uri = kroki_diagram.get_diagram_uri('http://localhost:8000')
+    expect(diagram_uri).to eq('http://localhost:8000/vegalite/png/eNqrrgUAAXUA-Q==')
+  end
+  it 'should compute a diagram URI with a trailing slashes' do
+    kroki_diagram = ::AsciidoctorExtensions::KrokiDiagram.new('vegalite', 'png', '{}')
+    diagram_uri = kroki_diagram.get_diagram_uri('https://my.domain.org/kroki/')
+    expect(diagram_uri).to eq('https://my.domain.org/kroki/vegalite/png/eNqrrgUAAXUA-Q==')
+  end
+  it 'should compute a diagram URI with trailing slashes' do
+    kroki_diagram = ::AsciidoctorExtensions::KrokiDiagram.new('vegalite', 'png', '{}')
+    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 encode a diagram text definition' do
+    kroki_diagram = ::AsciidoctorExtensions::KrokiDiagram.new('plantuml', 'txt', ' alice -> bob: hello')
+    diagram_definition_encoded = kroki_diagram.encode
+    expect(diagram_definition_encoded).to eq('eNpTSMzJTE5V0LVTSMpPslLISM3JyQcAQAwGaw==')
+  end
+  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)
+    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}"
+    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 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)
+    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_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}"
+    # calling again... should read the file from disk (and not do a GET request)
+    kroki_diagram.save(output_dir_path, kroki_client)
+  end
+end

data/spec/asciidoctor_kroki_spec.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'rspec_helper'
 require 'asciidoctor'
 require_relative '../lib/asciidoctor/extensions/asciidoctor_kroki'
 
@@ -33,19 +34,116 @@ 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
+    it 'should create SVG diagram in imagesdir if kroki-fetch-diagram is set' 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, 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
+      input = <<~'ADOC'
+        :imagesdir: .asciidoctor/kroki
+
+        plantuml::spec/fixtures/alice.puml[png,role=sequence]
+      ADOC
+      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">
+</div>
+</div>)
+    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', 'excalidraw', 'wavedrom')
+  end
+  it 'should register the extension for the list of supported diagrams' do
+    doc = Asciidoctor::Document.new
+    registry = Asciidoctor::Extensions::Registry.new
+    registry.activate doc
+    ::AsciidoctorExtensions::Kroki::SUPPORTED_DIAGRAM_NAMES.each do |name|
+      expect(registry.find_block_extension(name)).to_not be_nil, "expected block extension named '#{name}' to be registered"
+      expect(registry.find_block_macro_extension(name)).to_not be_nil, "expected block macro extension named '#{name}' to be registered "
+    end
   end
 end

data/spec/fixtures/alice.puml

@@ -0,0 +1 @@
+alice -> bob: hello

data/spec/rspec_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    FileUtils.rm(Dir.glob("#{__dir__}/../.asciidoctor/kroki/diag-*"))
+  end
+  config.after(:suite) do
+    FileUtils.rm(Dir.glob("#{__dir__}/../.asciidoctor/kroki/diag-*")) unless ENV['DEBUG']
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-kroki
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Guillaume Grossetie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2021-02-16 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
@@ -87,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".asciidoctor/kroki/.gitkeep"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -98,9 +85,14 @@ 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
+- 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
@@ -131,9 +123,14 @@ 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