kramdown-plantuml 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51cbb0be0b06278afe3b3d1eb572190a9f7a04fc869454b023854d5d8012e596
-  data.tar.gz: 0e7cb4345aeab6972d3b0009b71ddc714f046f5b558ae1d37b334697af39575b
+  metadata.gz: beba25f229338deced9900f7a611c9040846e562c966de164e88dbb040acadde
+  data.tar.gz: 8c2aa7aa04a1a6e59a98032e1cc325544a2be7c3bc3cd407cbb3af09babe390c
 SHA512:
-  metadata.gz: c18e9c35a4fef278f506106c1365839e7f58b0b45c8b352912187cd324df373b342400e56f51b9c13278ab199fd5fb6101c63cd02aa25ce9efef07722d7c517a
-  data.tar.gz: d822db2c31c38db0f7ce0a5b92221ebf30a55be1f5d011141199d07d94a01b5ddba99a1ba127d13b88219f6135a384d90741315b6e00b88d0e72c20fa1220d2f
+  metadata.gz: fcdfa9c61a9b2c751aeae743edfb58d81c3602e1eb62f6b8993fd11b2372dd6ee271f77737f655967a093c03a90d0ebf3b4865c703b7a5ed2d7b806c5a4d19d5
+  data.tar.gz: d35a3daea2ab515d0fd788d8b2fb0575c4993e4f25ba3c7ebda02631b8ae8d397dc88917b3809cf732e9b9a5d16bbbfa52cdfa2095a682c68de8d6ed8fba3377

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

@@ -101,8 +101,6 @@ test_gem() {
 
     cd "${workdir}"
 
-    gem install bundler
-
     if [[ -n "${token}" ]]; then
         # A non-empty $token means we should install the Gem from GPR
         repository="https://rubygems.pkg.github.com/swedbankpay"

data/.github/workflows/ruby.yml

@@ -91,14 +91,20 @@ 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: Test with Rake
+      run: bundle exec rake
+
+    - name: Upload code coverage
+      uses: actions/upload-artifact@v2
+      with:
+        name: coverage
+        path: ./coverage
+
     - name: Codecov upload
       run: bundle exec rake codecov:upload || echo 'Codecov upload failed'
 

data/lib/kramdown-plantuml/{converter.rb → diagram.rb}

@@ -1,40 +1,45 @@
 # frozen_string_literal: true
 
 require_relative 'version'
-require_relative 'themer'
+require_relative 'theme'
 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)
+    # 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
       end
 
-      def convert_plantuml_to_svg(plantuml)
-        if plantuml.nil? || plantuml.empty?
+      def convert_to_svg
+        return @svg unless @svg.nil?
+
+        if @plantuml.nil? || @plantuml.empty?
           @logger.warn ' kramdown-plantuml: PlantUML diagram is empty'
-          return plantuml
+          return @plantuml
         end
 
-        plantuml = @themer.apply_theme(plantuml)
-        plantuml = plantuml.strip
+        @plantuml = @theme.apply(@plantuml)
+        @plantuml = plantuml.strip
         log(plantuml)
-        result = @executor.execute(plantuml)
-        result.validate(plantuml)
-        svg = result.without_xml_prologue
-        wrap(svg)
+        @result = @executor.execute(self)
+        @result.validate
+        @svg = wrap(@result.without_xml_prologue)
+        @svg
       end
 
       private
 
       def wrap(svg)
-        theme_class = @themer.theme_name ? "theme-#{@themer.theme_name}" : ''
+        theme_class = @theme.name ? "theme-#{@theme.name}" : ''
         class_name = "plantuml #{theme_class}".strip
 
         wrapper_element_start = "<div class=\"#{class_name}\">"

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)
+
+        cmd = "java -Djava.awt.headless=true -jar #{@plantuml_jar_file} -tsvg -failfast -pipe #{debug_args}"
 
         @logger.debug " kramdown-plantuml: Executing '#{cmd}'."
 
-        stdout, stderr, status = Open3.capture3 cmd, stdin_data: stdin
+        stdout, stderr, status = Open3.capture3 cmd, stdin_data: diagram.plantuml
 
         @logger.debug " kramdown-plantuml: PlantUML exit code '#{status.exitstatus}'."
 
-        PlantUmlResult.new(stdout, stderr, status)
+        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/logger.rb

@@ -20,10 +20,10 @@ module Kramdown
         @logger.debug message
       end
 
-      def debug_with_prefix(prefix, string)
-        return if string.nil? || string.empty?
+      def debug_with_prefix(prefix, multiline_string)
+        return if multiline_string.nil? || multiline_string.empty?
 
-        lines = string.lines
+        lines = multiline_string.lines
         lines.each do |line|
           @logger.debug "#{prefix}#{line.rstrip}"
         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,8 +44,17 @@ 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?
 

data/lib/kramdown-plantuml/{themer.rb → theme.rb}

@@ -5,21 +5,21 @@ require_relative 'logger'
 module Kramdown
   module PlantUml
     # Provides theming support for PlantUML
-    class Themer
-      attr_reader :theme_name, :theme_directory
+    class Theme
+      attr_reader :name, :directory
 
       def initialize(options = {})
         @logger = Logger.init
-        @theme_name, @theme_directory = theme_options(options)
+        @name, @directory = theme_options(options)
       end
 
-      def apply_theme(plantuml)
-        if plantuml.nil? || plantuml.empty?
-          @logger.debug ' kramdown-plantuml: Empty diagram.'
+      def apply(plantuml)
+        if plantuml.nil? || !plantuml.is_a?(String) || plantuml.empty?
+          @logger.debug ' kramdown-plantuml: Empty diagram or not a String.'
           return plantuml
         end
 
-        if @theme_name.nil? || @theme_name.empty?
+        if @name.nil? || @name.empty?
           @logger.debug ' kramdown-plantuml: No theme to apply.'
           return plantuml
         end
@@ -37,10 +37,10 @@ module Kramdown
         return nil if options.nil? || !options.key?(:theme)
 
         theme = options[:theme] || {}
-        theme_name = theme.key?(:name) ? theme[:name] : nil
-        theme_directory = theme.key?(:directory) ? theme[:directory] : nil
+        name = theme.key?(:name) ? theme[:name] : nil
+        directory = theme.key?(:directory) ? theme[:directory] : nil
 
-        [theme_name, theme_directory]
+        [name, directory]
       end
 
       def symbolize_keys(options)
@@ -60,8 +60,8 @@ module Kramdown
 
         return plantuml if startuml_index.nil?
 
-        theme_string = "\n!theme #{@theme_name}"
-        theme_string << " from #{@theme_directory}" unless @theme_directory.nil?
+        theme_string = "\n!theme #{@name}"
+        theme_string << " from #{@directory}" unless @directory.nil?
 
         @logger.debug " kramdown-plantuml: Applying #{theme_string.strip}"
 

data/lib/kramdown-plantuml/version.rb

@@ -2,6 +2,6 @@
 
 module Kramdown
   module PlantUml
-    VERSION = '1.1.3'
+    VERSION = '1.1.4'
   end
 end

data/lib/kramdown-plantuml.rb

@@ -1,5 +1,3 @@
 # frozen_string_literal: true
 
-require_relative 'kramdown-plantuml/version'
-require_relative 'kramdown-plantuml/converter'
 require_relative 'kramdown_html'

data/lib/kramdown_html.rb

@@ -2,9 +2,9 @@
 
 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'
 
 module Kramdown
   module Converter
@@ -18,9 +18,8 @@ module Kramdown
 
         plantuml = element.value
         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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -166,17 +166,17 @@ 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.9/plantuml-1.2021.9.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/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