kramdown-plantuml 1.1.1 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 488e793ad6c95b20619319fdec43866b7a96369321767eb415c441b2d8946c0c
-  data.tar.gz: 2f9b7957b2b7d09ebe2758d1fc3f3600c7464f2ccee53d5ea11f04bf25b0df33
+  metadata.gz: 3968b5c182c334e7dbe020e7cd02309f6349fedeab4c6011b63178aa570b5c7f
+  data.tar.gz: 804e7e4c062c10f1f1c7578c338a8b19ec70a23031081a129f90dc44fa087926
 SHA512:
-  metadata.gz: 4e4547033622f876ea2c63eb4af2f73433e57fa4cbe8bdd818bbcb5261f4bef829f50da55b9f5485023e5c040d7c260844f27fcf2a67f17858839aa4e9f0dab3
-  data.tar.gz: cd38086b669bf27b64ccae97f45005a23a508fdfd94647e40c2f8e9960a89edc0abd2781c74fb42493c1b1df7bd5c0aaee6c19acd63cf20394d594c077cc072d
+  metadata.gz: ad3f371c0c4608c8d613ba9ec73414f6eea92c8eccf9a087fe7ccc487403b4742afc68c63574937aaf8ea30c9f90aaf56b7e5636764647b442137e7a683cbecd
+  data.tar.gz: c437216460a278794c2caeb20c151c5c2a98cce5d5a72e2a4d1b1fb077cc970ceb50fbb0fb3d832b92a7991d35b36776e019a295cbe9884ff928fee073dd9938

data/.github/mergify.yml

@@ -17,6 +17,7 @@ pull_request_rules:
   - name: Thank contributor
     conditions:
       - merged
+      - -author~=^.*\[bot\]$
     actions:
       comment:
         message: "Thank you @{{author}} for your contribution!"

data/.github/scripts/build-gem.sh

@@ -1,6 +1,73 @@
 #!/usr/bin/env bash
 set -o errexit # Abort if any command fails
 
-gem_build_name=$(gem build kramdown-plantuml.gemspec | awk '/File/ {print $2}')
-echo "Gem filename: '${gem_build_name}'"
-echo "::set-output name=name::${gem_build_name}"
+me=$(basename "$0")
+help_message="\
+Usage:
+  ${me} [--ref <ref>] [--verbose]
+  ${me} --help
+Arguments:
+  -r, --ref         The Git reference that is being built.
+  -h, --help        Displays this help screen.
+  -v, --verbose     Increase verbosity. Useful for debugging."
+
+parse_args() {
+    while : ; do
+        if [[ $1 = "-h" || $1 = "--help" ]]; then
+            echo "${help_message}"
+            return 0
+        elif [[ $1 = "-v" || $1 = "--verbose" ]]; then
+            verbose=true
+            shift
+        elif [[ $1 = "-r" || $1 = "--ref" ]]; then
+            ref=${2// }
+
+            if [[ "${ref}" = "--"* ]]; then
+                ref=""
+                shift 1
+            else
+                shift 2
+            fi
+        else
+            break
+        fi
+    done
+}
+
+# Echo expanded commands as they are executed (for debugging)
+enable_expanded_output() {
+    if [ "${verbose}" = true ]; then
+        set -o xtrace
+        set +o verbose
+        export VERBOSE=true
+    fi
+}
+
+add_coverage() {
+    # If we're not building a tag, bootstrap code coverage.
+    if [[ "${ref}" != "refs/tags/"* ]]; then
+        [[ "${verbose}" = true ]] && echo "Bootstrapping code coverage."
+        export COVER=true
+        export COVERAGE=true
+        printf "require 'simplecov'\nSimpleCov.start\n" >> lib/kramdown-plantuml.rb
+    elif [[ "${verbose}" = true ]]; then
+        echo "Skipping coverage report since a tag ref was pushed."
+    fi
+}
+
+build_gem() {
+    gem_build_name=$(gem build kramdown-plantuml.gemspec | awk '/File/ {print $2}')
+
+    [[ "${verbose}" = true ]] && echo "Gem filename: '${gem_build_name}'"
+
+    echo "::set-output name=name::${gem_build_name}"
+}
+
+main() {
+    parse_args "$@"
+    enable_expanded_output
+    add_coverage
+    build_gem
+}
+
+main "$@"

data/.github/scripts/test-gem.sh

@@ -6,7 +6,7 @@ me=$(basename "$0")
 
 help_message="\
 Usage:
-  ${me} --workdir <workdir> [--gemdir <gemdir> | --version <version> --token <token>] [--verbose]
+  ${me} --workdir <workdir> [--gemdir <gemdir> | --version <version> --token <token>] [--verbose] [--theme <name> [--theme-directory <path>]]
   ${me} --help
 Arguments:
   -w, --workdir <workdir>       The path to the working directory.
@@ -14,6 +14,8 @@ Arguments:
   -v, --version <version>       The version of the Gem to test.
   -t, --token <token>           The GitHub token to use for retrieving the gem
                                 from the GitHub Package Registry.
+  -T, --theme-name <name>       The theme name to use for the test.
+  -p, --theme-directory <path>  The directory in which the [--theme-name] is placed.
   -h, --help                    Displays this help screen.
   -v, --verbose                 Increase verbosity. Useful for debugging."
 
@@ -52,6 +54,24 @@ parse_args() {
             else
                 shift 2
             fi
+        elif [[ $1 = "-T" || $1 = "--theme-name" ]]; then
+            theme_name=${2// }
+
+            if [[ "${theme_name}" = "--"* ]]; then
+                theme_name=""
+                shift 1
+            else
+                shift 2
+            fi
+        elif [[ $1 = "-p" || $1 = "--theme-directory" ]]; then
+            theme_directory=${2// }
+
+            if [[ "${theme_directory}" = "--"* ]]; then
+                theme_directory=""
+                shift 1
+            else
+                shift 2
+            fi
         elif [[ $1 = "-w" || $1 = "--workdir" ]]; then
             workdir=${2// }
 
@@ -67,22 +87,29 @@ parse_args() {
     done
 
     if [[ -z "${workdir}" ]]; then
-        echo "Missing required argument: --workdir <workdir>."
-        echo "${help_message}"
+        echo "Missing required argument: --workdir <workdir>." >&2
+        echo "${help_message}" >&2
         return 1
     fi
 
     if [[ (-z "${gemdir}" && -z "${token}") || (-n "${gemdir}" && -n "${token}") ]]; then
-        echo "Missing or invalid required arguments: --gemdir <gem-path> or --token <token>."
-        echo "Either [--gemdir] or [--token] needs to be provided, but not both."
+        echo "Missing or invalid required arguments: --gemdir <gem-path> or --token <token>." >&2
+        echo "Either [--gemdir] or [--token] needs to be provided, but not both." >&2
         echo "${help_message}"
         return 1
     fi
 
     if [[ (-n "${version}" && -z "${token}") || (-z "${version}" && -n "${token}") ]]; then
-        echo "Missing or invalid required arguments: --version <gem-path> and --token <token>."
-        echo "When either argument is present, both must be."
-        echo "${help_message}"
+        echo "Missing or invalid required arguments: --version <gem-path> and --token <token>." >&2
+        echo "When either argument is present, both must be." >&2
+        echo "${help_message}" >&2
+        return 1
+    fi
+
+    if [[ -z "${theme_name}" && -n "${theme_directory}" ]]; then
+        echo "Missing or invalid required arguments: --theme-name <name>." >&2
+        echo "[--theme-name] is required when [--theme-directory] is provided." >&2
+        echo "${help_message}" >&2
         return 1
     fi
 }
@@ -101,28 +128,47 @@ test_gem() {
 
     cd "${workdir}"
 
-    gem install bundler
+    # Recreate Gemfile
+    printf "# frozen_string_literal: true\nsource 'https://rubygems.org'\ngem 'jekyll'\ngem 'simplecov'\n" > Gemfile
 
     if [[ -n "${token}" ]]; then
         # A non-empty $token means we should install the Gem from GPR
         repository="https://rubygems.pkg.github.com/swedbankpay"
         bundle config "${repository}" "SwedbankPay:${token}"
-        printf "source '%s' do\n\tgem 'kramdown-plantuml', '%s'\nend" "${repository}" "${version}" >> Gemfile
+        printf "source '%s' do\n\tgem 'kramdown-plantuml', '%s'\nend\n" "${repository}" "${version}" >> Gemfile
     else
-        echo "gem 'kramdown-plantuml', path: '${gemdir}'" >> Gemfile
+        printf "gem 'kramdown-plantuml', path: '%s'\n" "${gemdir}" >> Gemfile
+    fi
+
+    # Recreate _config.yml
+    printf "plugins:\n- kramdown-plantuml\n" > _config.yml
+
+    if [[ -n "${theme_name}" ]]; then
+        printf "kramdown:\n  plantuml:\n    theme:\n      name: %s\n" "${theme_name}" >> _config.yml
+        class="plantuml theme-${theme_name}"
+    else
+        class='plantuml'
+    fi
+
+    if [[ -n "${theme_directory}" ]]; then
+        printf "      directory: %s\n" "${theme_directory}" >> _config.yml
     fi
 
     if [[ "${verbose}" = true ]]; then
+        printf "\nGemfile:\n"
         cat Gemfile
+        printf "\n_config.yml\n"
+        cat _config.yml
         jekyll_build_args+=(--verbose)
     fi
 
     bundle install
     bundle exec jekyll build "${jekyll_build_args[@]}"
 
+
     file="${workdir}/_site/index.html"
 
-    file_contains "${file}" "class=\"plantuml theme-spacelab\""
+    file_contains "${file}" "class=\"${class}\""
     file_contains "${file}" "<svg"
     file_contains "${file}" "<ellipse"
     file_contains "${file}" "<polygon"

data/.github/workflows/ruby.yml

@@ -91,20 +91,35 @@ jobs:
     - name: rubocop
       run: bundle exec rubocop --fail-level warning --display-only-fail-level-offenses
 
-    - name: Test with Rake
-      run: bundle exec rake
-
     - name: RSPec (debug)
       env:
         DEBUG: 1
       run: bundle exec rspec --tag debug
 
+    - name: Upload code coverage (debug)
+      uses: actions/upload-artifact@v2
+      with:
+        name: rspec-debug-coverage
+        path: ./coverage
+
+    - name: Codecov upload (debug)
+      run: bundle exec rake codecov:upload || echo 'Codecov upload failed'
+
+    - name: Test with Rake
+      run: bundle exec rake
+
+    - name: Upload code coverage
+      uses: actions/upload-artifact@v2
+      with:
+        name: rspec-coverage
+        path: ./coverage
+
     - name: Codecov upload
       run: bundle exec rake codecov:upload || echo 'Codecov upload failed'
 
     - name: Build gem
       id: gem
-      run: .github/scripts/build-gem.sh
+      run: .github/scripts/build-gem.sh --ref ${{ github.ref }} --verbose
 
     - name: Upload gem
       uses: actions/upload-artifact@v2-preview
@@ -116,7 +131,16 @@ jobs:
       run: .github/scripts/inspect-gem.sh --gem "${{ github.workspace }}/${{ steps.gem.outputs.name }}" --verbose
 
     - name: Test gem
-      run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/fixture" --gemdir "${{ github.workspace }}" --verbose
+      run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/examples" --gemdir "${{ github.workspace }}" --verbose
+
+    - name: Upload code coverage (gem)
+      uses: actions/upload-artifact@v2
+      with:
+        name: gem-coverage
+        path: ./coverage
+
+    - name: Codecov upload (gem)
+      run: bundle exec rake codecov:upload || echo 'Codecov upload failed'
 
   publish-dev:
     needs: [version, gem]
@@ -150,15 +174,21 @@ jobs:
     - name: Publish to GPR
       run: .github/scripts/publish-gem.sh --gem ${{ needs.gem.outputs.name }} --token "${{ secrets.GPR_TOKEN }}" --owner SwedbankPay --verbose
 
-    - name: Test gem
-      run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/fixture" --version ${{ needs.version.outputs.version }} --token "${{ secrets.GPR_TOKEN }}" --verbose
+    - name: Test gem (no theme)
+      run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/examples" --version ${{ needs.version.outputs.version }} --token "${{ secrets.GPR_TOKEN }}" --verbose
+
+    - name: Test gem (built-in theme)
+      run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/examples" --version ${{ needs.version.outputs.version }} --token "${{ secrets.GPR_TOKEN }}" --verbose --theme-name spacelab
+
+    - name: Test gem (custom theme)
+      run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/examples" --version ${{ needs.version.outputs.version }} --token "${{ secrets.GPR_TOKEN }}" --verbose --theme-name c2a3b0 --theme-directory "${{ github.workspace }}/spec/examples"
 
     - name: Upload Jekyll site
       uses: actions/upload-artifact@v2-preview
       if: always()
       with:
         name: site
-        path: ${{ github.workspace }}/spec/fixture/_site
+        path: ${{ github.workspace }}/spec/examples/_site
 
   publish-prod:
     needs: [version, gem]

data/README.md

@@ -6,6 +6,7 @@
 [![No PlantUML][no-plantuml-badge]][no-plantuml-workflow]
 [![Shell][shell-badge]][shell-workflow]
 [![Codecov][codecov-badge]][codecov]
+[![Codacy Badge][codacy-badge]][codacy]
 [![License][license-badge]][license]
 [![CLA assistant][cla-badge]][cla]
 [![Contributor Covenant][coc-badge]][coc]
@@ -180,6 +181,8 @@ agreement][cla].
 [clone]:                https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository
 [coc-badge]:            https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
 [coc]:                  ./CODE_OF_CONDUCT.md
+[codacy-badge]:         https://app.codacy.com/project/badge/Grade/de72385f4ca444c18819a3ce8a506638
+[codacy]:               https://www.codacy.com/gh/SwedbankPay/kramdown-plantuml/dashboard?utm_source=github.com&utm_medium=referral&utm_content=SwedbankPay/kramdown-plantuml&utm_campaign=Badge_Grade
 [codecov-badge]:        https://codecov.io/gh/SwedbankPay/kramdown-plantuml/branch/main/graph/badge.svg?token=U3QJLVG3HY
 [codecov]:              https://codecov.io/gh/SwedbankPay/kramdown-plantuml/
 [diagram-svg]:          ./spec/examples/diagram.svg

data/lib/kramdown-plantuml/bool_env.rb

@@ -9,8 +9,8 @@ module Kramdown
 
       def initialize(name)
         @name = name
-        @value = ENV.key?(name) ? ENV[name] : nil
-        @value = @value.to_s.downcase unless @value.nil?
+        value = ENV.fetch(name, nil)
+        @value = value.to_s.downcase unless value.nil?
       end
 
       def true?

data/lib/kramdown-plantuml/console_logger.rb

@@ -34,7 +34,7 @@ module Kramdown
         return false unless write_message?(level)
 
         pipe = pipe_for(level)
-        pipe.write("\n#{message}")
+        pipe.write("#{message}\n")
       end
 
       def write_message?(level_of_message)

data/lib/kramdown-plantuml/diagram.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'version'
+require_relative 'theme'
+require_relative 'plantuml_error'
+require_relative 'logger'
+require_relative 'executor'
+
+module Kramdown
+  module PlantUml
+    # Represents a PlantUML diagram that can be converted to SVG.
+    class Diagram
+      attr_reader :theme, :plantuml, :result
+
+      def initialize(plantuml, options = {})
+        @plantuml = plantuml
+        @theme = Theme.new(options || {})
+        @logger = Logger.init
+        @executor = Executor.new
+        @logger.warn 'PlantUML diagram is empty' if @plantuml.nil? || @plantuml.empty?
+      end
+
+      def convert_to_svg
+        return @svg unless @svg.nil?
+        return @plantuml if @plantuml.nil? || @plantuml.empty?
+
+        @plantuml = @theme.apply(@plantuml)
+        @plantuml = plantuml.strip
+        log(plantuml)
+        @result = @executor.execute(self)
+        @result.validate
+        @svg = wrap(@result.without_xml_prologue)
+        @svg
+      end
+
+      private
+
+      def wrap(svg)
+        theme_class = @theme.name ? "theme-#{@theme.name}" : ''
+        class_name = "plantuml #{theme_class}".strip
+
+        wrapper_element_start = "<div class=\"#{class_name}\">"
+        wrapper_element_end = '</div>'
+
+        "#{wrapper_element_start}#{svg}#{wrapper_element_end}"
+      end
+
+      def log(plantuml)
+        @logger.debug 'PlantUML converting diagram:'
+        @logger.debug_multiline plantuml
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/executor.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 
 require 'open3'
 require_relative '../which'
@@ -18,21 +18,19 @@ module Kramdown
         raise IOError, "'#{@plantuml_jar_file}' does not exist" unless File.exist? @plantuml_jar_file
       end
 
-      def execute(stdin)
-        cmd = "java -Djava.awt.headless=true -jar #{@plantuml_jar_file} -tsvg -failfast -pipe"
-        cmd << if @logger.debug?
-                 ' -verbose'
-               else
-                 ' -nometadata'
-               end
+      def execute(diagram)
+        raise ArgumentError, 'diagram cannot be nil' if diagram.nil?
+        raise ArgumentError, "diagram must be a #{Diagram}" unless diagram.is_a?(Diagram)
 
-        @logger.debug "PlantUML executing: #{cmd}"
+        cmd = "java -Djava.awt.headless=true -jar #{@plantuml_jar_file} -tsvg -failfast -pipe #{debug_args}"
 
-        stdout, stderr, status = Open3.capture3 cmd, stdin_data: stdin
+        @logger.debug "Executing '#{cmd}'."
 
-        @logger.debug "PlantUML exit code: #{status.exitstatus}"
+        stdout, stderr, status = Open3.capture3 cmd, stdin_data: diagram.plantuml
 
-        PlantUmlResult.new(stdout, stderr, status)
+        @logger.debug "PlantUML exit code '#{status.exitstatus}'."
+
+        PlantUmlResult.new(diagram, stdout, stderr, status.exitstatus)
       end
 
       private
@@ -43,6 +41,12 @@ module Kramdown
         first_jar = Dir[jar_glob].first
         File.expand_path first_jar unless first_jar.nil?
       end
+
+      def debug_args
+        return ' -verbose' if @logger.debug?
+
+        ' -nometadata'
+      end
     end
   end
 end

data/lib/kramdown-plantuml/jekyll_provider.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'English'
+require_relative 'logger'
+require_relative 'diagram'
+
+module Kramdown
+  module PlantUml
+    # Provides an instance of Jekyll if available.
+    module JekyllProvider
+      class << self
+        def jekyll
+          return @jekyll if defined? @jekyll
+
+          @jekyll = load_jekyll
+        end
+
+        def install
+          return @installed = false if jekyll.nil?
+
+          logger.debug 'Jekyll detected, hooking into :site:post_render'
+
+          Jekyll::Hooks.register :site, :post_render do |site|
+            logger.debug ':site:post_render triggered.'
+
+            site.pages.each do |page|
+              page.output = replace_needles(page.output)
+            end
+          end
+
+          @installed = true
+        end
+
+        def installed?
+          @installed
+        end
+
+        def needle(plantuml, options)
+          plantuml_options = !options.nil? && options.key?(:plantuml) ? options[:plantuml] : nil
+          hash = { 'plantuml' => plantuml, 'options' => plantuml_options }
+
+          <<~NEEDLE
+            <!--#kramdown-plantuml.start#-->
+            #{hash.to_json}
+            <!--#kramdown-plantuml.end#-->
+          NEEDLE
+        end
+
+        private
+
+        def replace_needles(html)
+          html.gsub(/<!--#kramdown-plantuml\.start#-->(?<json>.*?)<!--#kramdown-plantuml\.end#-->/m) do
+            json = $LAST_MATCH_INFO[:json]
+            hash = JSON.parse(json)
+            plantuml = hash['plantuml']
+            options = hash['options']
+            diagram = ::Kramdown::PlantUml::Diagram.new(plantuml, options)
+            return diagram.convert_to_svg
+          end
+        end
+
+        def load_jekyll
+          require 'jekyll'
+          ::Jekyll
+        rescue LoadError
+          nil
+        end
+
+        def logger
+          @logger ||= ::Kramdown::PlantUml::Logger.init
+        end
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/logger.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require_relative 'console_logger'
+require_relative 'jekyll_provider'
 
 module Kramdown
   module PlantUml
-    # Provides theming support for PlantUML
+    # Logs stuff
     class Logger
       def initialize(logger)
         raise ArgumentError, 'logger cannot be nil' if logger.nil?
@@ -17,37 +18,42 @@ module Kramdown
       end
 
       def debug(message)
-        @logger.debug(message)
+        write :debug, message
+      end
+
+      def debug_multiline(multiline_string)
+        return if multiline_string.nil? || multiline_string.empty?
+
+        lines = multiline_string.lines
+        lines.each do |line|
+          write :debug, line.rstrip
+        end
       end
 
       def info(message)
-        @logger.info(message)
+        write :info, message
       end
 
       def warn(message)
-        @logger.warn(message)
+        write :warn, message
       end
 
       def error(message)
-        @logger.error(message)
+        write :error, message
       end
 
       def debug?
         self.class.level == :debug
       end
 
+      def level
+        @level ||= level_from_logger || self.class.env
+      end
+
       class << self
         def init
-          inner = nil
-
-          begin
-            require 'jekyll'
-            inner = Jekyll.logger
-          rescue LoadError
-            inner = ConsoleLogger.new(level)
-          end
-
-          Logger.new(inner)
+          inner = JekyllProvider.jekyll ? JekyllProvider.jekyll.logger : nil || ConsoleLogger.new(level)
+          Logger.new inner
         end
 
         def level
@@ -63,6 +69,18 @@ module Kramdown
           :warn
         end
       end
+
+      private
+
+      def write(level, message)
+        @logger.public_send(level, " kramdown-plantuml: #{message}")
+      end
+
+      def level_from_logger
+        return @logger.level if @logger.respond_to? :level
+
+        nil
+      end
     end
   end
 end

data/lib/kramdown-plantuml/plantuml_error.rb

@@ -1,32 +1,69 @@
 # frozen_string_literal: true
 
+require_relative 'plantuml_result'
+
 module Kramdown
   module PlantUml
     # PlantUML Error
     class PlantUmlError < StandardError
-      def initialize(plantuml, stderr, exitcode)
+      def initialize(result)
+        raise ArgumentError, 'result cannot be nil' if result.nil?
+        raise ArgumentError, "result must be a #{PlantUmlResult}" unless result.is_a?(PlantUmlResult)
+
+        super create_message(result)
+      end
+
+      private
+
+      def create_message(result)
+        header = header(result).gsub("\n", ' ').strip
+        plantuml = plantuml(result)
+        result = result(result)
         message = <<~MESSAGE
-          Conversion of the following PlantUML diagram failed:
+          #{header}
 
           #{plantuml}
 
-          The error received from PlantUML was:
-
-          Exit code: #{exitcode}
-          #{stderr}
+          #{result}
         MESSAGE
 
-        super message
+        message.strip
       end
 
-      def self.should_raise?(exitcode, stderr)
-        return false if exitcode.zero?
+      def header(result)
+        if theme_not_found?(result) && !result.diagram.nil? && !result.diagram.theme.nil?
+          return <<~HEADER
+            Conversion of the following PlantUML result failed because the
+            theme '#{result.diagram.theme.name}' can't be found in the directory
+            '#{result.diagram.theme.directory}':
+          HEADER
+        end
+
+        'Conversion of the following PlantUML result failed:'
+      end
+
+      def theme_not_found?(result)
+        !result.nil? \
+        && !result.stderr.nil? \
+        && result.stderr.include?('NullPointerException') \
+        && result.stderr.include?('getTheme')
+      end
+
+      def plantuml(result)
+        return nil if result.nil? || result.diagram.nil?
+
+        result.diagram.plantuml
+      end
+
+      def result(result)
+        return nil if result.nil?
+
+        <<~RESULT
+          The error received from PlantUML was:
 
-        !stderr.nil? && !stderr.empty? && \
-          # If stderr is not empty, but contains the string 'CoreText note:',
-          # the error is caused by a bug in Java, and should be ignored.
-          # Circumvents https://bugs.openjdk.java.net/browse/JDK-8244621
-          !stderr.include?('CoreText note:')
+          Exit code: #{result.exitcode}
+          #{result.stderr}
+        RESULT
       end
     end
   end

data/lib/kramdown-plantuml/plantuml_result.rb

@@ -2,17 +2,24 @@
 
 require_relative 'logger'
 require_relative 'plantuml_error'
+require_relative 'diagram'
 
 module Kramdown
   module PlantUml
     # Executes the PlantUML Java application.
     class PlantUmlResult
-      attr_reader :stdout, :stderr, :exitcode
+      attr_reader :diagram, :stdout, :stderr, :exitcode
 
-      def initialize(stdout, stderr, status)
+      def initialize(diagram, stdout, stderr, exitcode)
+        raise ArgumentError, 'diagram cannot be nil' if diagram.nil?
+        raise ArgumentError, "diagram must be a #{Diagram}" unless diagram.is_a?(Diagram)
+        raise ArgumentError, 'exitcode cannot be nil' if exitcode.nil?
+        raise ArgumentError, "exitcode must be a #{Integer}" unless exitcode.is_a?(Integer)
+
+        @diagram = diagram
         @stdout = stdout
         @stderr = stderr
-        @exitcode = status.exitstatus
+        @exitcode = exitcode
         @logger = Logger.init
       end
 
@@ -37,12 +44,22 @@ module Kramdown
         @stdout
       end
 
-      def validate(plantuml)
-        raise PlantUmlError.new(plantuml, @stderr, @exitcode) if PlantUmlError.should_raise?(@exitcode, @stderr)
+      def valid?
+        return true if @exitcode.zero? || @stderr.nil? || @stderr.empty?
+
+        # If stderr is not empty, but contains the string 'CoreText note:',
+        # the error is caused by a bug in Java, and should be ignored.
+        # Circumvents https://bugs.openjdk.java.net/browse/JDK-8244621
+        @stderr.include?('CoreText note:')
+      end
+
+      def validate
+        raise PlantUmlError, self unless valid?
 
         return if @stderr.nil? || @stderr.empty?
 
-        @logger.debug("PlantUML log:\n#{@stderr}")
+        @logger.debug 'PlantUML log:'
+        @logger.debug_multiline @stderr
       end
     end
   end

data/lib/kramdown-plantuml/theme.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: false
+
+require_relative 'logger'
+
+module Kramdown
+  module PlantUml
+    # Provides theming support for PlantUML
+    class Theme
+      attr_reader :name, :directory
+
+      def initialize(options = {})
+        @logger = Logger.init
+        @name, @directory = theme_options(options)
+      end
+
+      def apply(plantuml)
+        if plantuml.nil? || !plantuml.is_a?(String) || plantuml.empty?
+          @logger.debug 'Empty diagram or not a String.'
+          return plantuml
+        end
+
+        if @name.nil? || @name.empty?
+          @logger.debug 'No theme to apply.'
+          return plantuml
+        end
+
+        theme(plantuml)
+      end
+
+      private
+
+      def theme_options(options)
+        options = symbolize_keys(options)
+
+        @logger.debug "Options: #{options}"
+
+        return nil if options.nil? || !options.key?(:theme)
+
+        theme = options[:theme] || {}
+        name = theme.key?(:name) ? theme[:name] : nil
+        directory = theme.key?(:directory) ? theme[:directory] : nil
+
+        [name, directory]
+      end
+
+      def symbolize_keys(options)
+        return options if options.nil?
+
+        array = options.map do |key, value|
+          value = value.is_a?(Hash) ? symbolize_keys(value) : value
+          [key.to_sym, value]
+        end
+
+        array.to_h
+      end
+
+      def theme(plantuml)
+        startuml = '@startuml'
+        startuml_index = plantuml.index(startuml) + startuml.length
+
+        return plantuml if startuml_index.nil?
+
+        theme_string = "\n!theme #{@name}"
+        theme_string << " from #{@directory}" unless @directory.nil?
+
+        @logger.debug "Applying #{theme_string.strip}"
+
+        /@startuml.*/.match(plantuml) do |match|
+          return plantuml.insert match.end(0), theme_string
+        end
+
+        plantuml
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/version.rb

@@ -2,6 +2,6 @@
 
 module Kramdown
   module PlantUml
-    VERSION = '1.1.1'
+    VERSION = '1.1.5'
   end
 end

data/lib/kramdown-plantuml.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'kramdown-plantuml/version'
-require_relative 'kramdown-plantuml/converter'
 require_relative 'kramdown_html'
+require_relative 'kramdown-plantuml/jekyll_provider'
+
+::Kramdown::PlantUml::JekyllProvider.install

data/lib/kramdown_html.rb

@@ -2,9 +2,10 @@
 
 require 'kramdown'
 require 'kramdown-parser-gfm'
-require_relative 'kramdown-plantuml/converter'
 require_relative 'kramdown-plantuml/logger'
 require_relative 'kramdown-plantuml/plantuml_error'
+require_relative 'kramdown-plantuml/diagram'
+require_relative 'kramdown-plantuml/jekyll_provider'
 
 module Kramdown
   module Converter
@@ -14,13 +15,31 @@ module Kramdown
       alias super_convert_codeblock convert_codeblock
 
       def convert_codeblock(element, indent)
-        return super_convert_codeblock(element, indent) if element.attr['class'] != 'language-plantuml'
+        return super_convert_codeblock(element, indent) unless plantuml?(element)
 
-        plantuml = element.value
+        jekyll = ::Kramdown::PlantUml::JekyllProvider
+
+        # If Jekyll is successfully loaded, we'll wait with converting the
+        # PlantUML diagram to SVG since a theme may be configured that needs to
+        # be copied to the assets directory before the PlantUML conversion can
+        # be performed. We therefore place a needle in the haystack that we will
+        # convert in the :site:pre_render hook.
+        return jekyll.needle(element.value, @options) if jekyll.installed?
+
+        convert_plantuml(element.value)
+      end
+
+      private
+
+      def plantuml?(element)
+        element.attr['class'] == 'language-plantuml'
+      end
+
+      def convert_plantuml(plantuml)
         plantuml_options = @options.key?(:plantuml) ? @options[:plantuml] : {}
-        converter = ::Kramdown::PlantUml::Converter.new(plantuml_options || {})
 
-        converter.convert_plantuml_to_svg(plantuml)
+        diagram = ::Kramdown::PlantUml::Diagram.new(plantuml, plantuml_options)
+        diagram.convert_to_svg
       end
     end
   end

data/pom.xml

@@ -10,7 +10,7 @@
         <dependency>
             <groupId>net.sourceforge.plantuml</groupId>
             <artifactId>plantuml</artifactId>
-            <version>1.2021.9</version>
+            <version>1.2021.10</version>
         </dependency>
     </dependencies>
 </project>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.5
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-31 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -166,18 +166,18 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/net/sourceforge/plantuml/plantuml/1.2021.8/plantuml-1.2021.8.jar
+- bin/net/sourceforge/plantuml/plantuml/1.2021.10/plantuml-1.2021.10.jar
 - kramdown-plantuml.gemspec
 - lib/kramdown-plantuml.rb
 - lib/kramdown-plantuml/bool_env.rb
 - lib/kramdown-plantuml/console_logger.rb
-- lib/kramdown-plantuml/converter.rb
+- lib/kramdown-plantuml/diagram.rb
 - lib/kramdown-plantuml/executor.rb
-- lib/kramdown-plantuml/hash.rb
+- lib/kramdown-plantuml/jekyll_provider.rb
 - lib/kramdown-plantuml/logger.rb
 - lib/kramdown-plantuml/plantuml_error.rb
 - lib/kramdown-plantuml/plantuml_result.rb
-- lib/kramdown-plantuml/themer.rb
+- lib/kramdown-plantuml/theme.rb
 - lib/kramdown-plantuml/version.rb
 - lib/kramdown_html.rb
 - lib/which.rb

data/lib/kramdown-plantuml/converter.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'version'
-require_relative 'themer'
-require_relative 'plantuml_error'
-require_relative 'logger'
-require_relative 'executor'
-
-module Kramdown
-  module PlantUml
-    # Converts PlantUML markup to SVG
-    class Converter
-      def initialize(options = {})
-        @themer = Themer.new(options)
-        @logger = Logger.init
-        @executor = Executor.new
-      end
-
-      def convert_plantuml_to_svg(plantuml)
-        plantuml = @themer.apply_theme(plantuml)
-        plantuml = plantuml.strip
-        @logger.debug "PlantUML converting diagram:\n#{plantuml}"
-        result = @executor.execute(plantuml)
-        result.validate(plantuml)
-        svg = result.without_xml_prologue
-        wrap(svg)
-      end
-
-      private
-
-      def wrap(svg)
-        theme_class = @themer.theme_name ? "theme-#{@themer.theme_name}" : ''
-        class_name = "plantuml #{theme_class}".strip
-
-        wrapper_element_start = "<div class=\"#{class_name}\">"
-        wrapper_element_end = '</div>'
-
-        "#{wrapper_element_start}#{svg}#{wrapper_element_end}"
-      end
-    end
-  end
-end

data/lib/kramdown-plantuml/hash.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-# Ruby's Hash class.
-class ::Hash
-  # Via https://stackoverflow.com/a/25835016/2257038
-  def symbolize_keys
-    h = map do |k, v|
-      v_sym = v.instance_of?(Hash) ? v.symbolize_keys : v
-      [k.to_sym, v_sym]
-    end
-
-    h.to_h
-  end
-end

data/lib/kramdown-plantuml/themer.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: false
-
-require_relative 'hash'
-require_relative 'logger'
-
-module Kramdown
-  module PlantUml
-    # Provides theming support for PlantUML
-    class Themer
-      attr_reader :theme_name, :theme_directory
-
-      def initialize(options = {})
-        options = options.symbolize_keys
-        @logger = Logger.init
-        @logger.debug(options)
-        @theme_name, @theme_directory = theme_options(options)
-      end
-
-      def apply_theme(plantuml)
-        return plantuml if plantuml.nil? || plantuml.empty? || @theme_name.nil? || @theme_name.empty?
-
-        startuml = '@startuml'
-        startuml_index = plantuml.index(startuml) + startuml.length
-
-        return plantuml if startuml_index.nil?
-
-        /@startuml.*/.match(plantuml) do |match|
-          theme_string = "\n!theme #{@theme_name}"
-          theme_string << " from #{@theme_directory}" unless @theme_directory.nil?
-
-          return plantuml.insert match.end(0), theme_string
-        end
-
-        plantuml
-      end
-
-      private
-
-      def theme_options(options)
-        return nil unless options.key?(:theme)
-
-        theme = options[:theme] || {}
-        theme_name = theme.key?(:name) ? theme[:name] : nil
-        theme_directory = theme.key?(:directory) ? theme[:directory] : nil
-
-        [theme_name, theme_directory]
-      end
-    end
-  end
-end