kramdown-plantuml 1.0.5 → 1.1.4

data/kramdown-plantuml.gemspec

@@ -9,10 +9,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Swedbank Pay']
   spec.email         = ['opensource@swedbankpay.com']
 
-  spec.summary       = "kramdown-plantuml allows you to use PlantUML syntax within fenced code blocks with Kramdown (Jekyll's default Markdown parser)"
+  spec.summary       = <<~SUMMARY
+    kramdown-plantuml allows you to use PlantUML syntax within fenced code
+    blocks with Kramdown (Jekyll's default Markdown parser).
+  SUMMARY
   spec.homepage      = 'https://github.com/SwedbankPay/kramdown-plantuml'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/SwedbankPay/kramdown-plantuml'
@@ -33,9 +36,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'kramdown', '~> 2.3'
+  spec.add_dependency 'kramdown-parser-gfm', '~> 1.1'
   spec.add_dependency 'open3', '~> 0.1'
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rubocop', '~> 0.92'
+  spec.add_development_dependency 'rspec-its', '~> 1.3'
+  spec.add_development_dependency 'rubocop', '~> 1.12'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.4'
 end

data/lib/kramdown-plantuml/bool_env.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Kramdown
+  module PlantUml
+    # Converts envrionment variables to boolean values
+    class BoolEnv
+      TRUTHY_VALUES = %w[t true yes y 1].freeze
+      FALSEY_VALUES = %w[f false n no 0].freeze
+
+      def initialize(name)
+        @name = name
+        value = ENV.fetch(name, nil)
+        @value = value.to_s.downcase unless value.nil?
+      end
+
+      def true?
+        return true if TRUTHY_VALUES.include?(@value)
+        return false if FALSEY_VALUES.include?(@value) || @value.nil? || value.empty?
+
+        raise "The value '#{@value}' of '#{@name}' can't be converted to a boolean"
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/console_logger.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'bool_env'
+
+module Kramdown
+  module PlantUml
+    # Logs to $stdout and $stderr
+    class ConsoleLogger
+      LOG_LEVELS = %i[debug info warn error].freeze
+
+      def initialize(level)
+        @configured_log_level = level
+      end
+
+      def debug(message)
+        write(:debug, message)
+      end
+
+      def info(message)
+        write(:info, message)
+      end
+
+      def warn(message)
+        write(:warn, message)
+      end
+
+      def error(message)
+        write(:error, message)
+      end
+
+      private
+
+      def write(level, message)
+        return false unless write_message?(level)
+
+        pipe = pipe_for(level)
+        pipe.write("#{message}\n")
+      end
+
+      def write_message?(level_of_message)
+        LOG_LEVELS.index(@configured_log_level) <= LOG_LEVELS.index(level_of_message)
+      end
+
+      def pipe_for(level)
+        case level
+        when :debug, :info
+          $stdout
+        when :warn, :error
+          $stderr
+        else
+          raise ArgumentError, "Unknown log level '#{level}'."
+        end
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/diagram.rb

@@ -0,0 +1,57 @@
+# 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
+      end
+
+      def convert_to_svg
+        return @svg unless @svg.nil?
+
+        if @plantuml.nil? || @plantuml.empty?
+          @logger.warn ' kramdown-plantuml: PlantUML diagram is empty'
+          return @plantuml
+        end
+
+        @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 ' kramdown-plantuml: PlantUML converting diagram:'
+        @logger.debug_with_prefix ' kramdown-plantuml: ', plantuml
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/executor.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'open3'
+require_relative '../which'
+require_relative 'logger'
+require_relative 'plantuml_result'
+
+module Kramdown
+  module PlantUml
+    # Executes the PlantUML Java application.
+    class Executor
+      def initialize
+        @logger = Logger.init
+        @plantuml_jar_file = find_plantuml_jar_file
+
+        raise IOError, 'Java can not be found' unless Which.which('java')
+        raise IOError, "No 'plantuml.jar' file could be found" if @plantuml_jar_file.nil?
+        raise IOError, "'#{@plantuml_jar_file}' does not exist" unless File.exist? @plantuml_jar_file
+      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: diagram.plantuml
+
+        @logger.debug " kramdown-plantuml: PlantUML exit code '#{status.exitstatus}'."
+
+        PlantUmlResult.new(diagram, stdout, stderr, status.exitstatus)
+      end
+
+      private
+
+      def find_plantuml_jar_file
+        dir = File.dirname __dir__
+        jar_glob = File.join dir, '../bin/**/plantuml*.jar'
+        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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require_relative 'console_logger'
+
+module Kramdown
+  module PlantUml
+    # Logs stuff
+    class Logger
+      def initialize(logger)
+        raise ArgumentError, 'logger cannot be nil' if logger.nil?
+        raise ArgumentError, 'logger must respond to #debug' unless logger.respond_to? :debug
+        raise ArgumentError, 'logger must respond to #info' unless logger.respond_to? :info
+        raise ArgumentError, 'logger must respond to #warn' unless logger.respond_to? :warn
+        raise ArgumentError, 'logger must respond to #error' unless logger.respond_to? :error
+
+        @logger = logger
+      end
+
+      def debug(message)
+        @logger.debug message
+      end
+
+      def debug_with_prefix(prefix, multiline_string)
+        return if multiline_string.nil? || multiline_string.empty?
+
+        lines = multiline_string.lines
+        lines.each do |line|
+          @logger.debug "#{prefix}#{line.rstrip}"
+        end
+      end
+
+      def info(message)
+        @logger.info message
+      end
+
+      def warn(message)
+        @logger.warn message
+      end
+
+      def error(message)
+        @logger.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
+        end
+
+        def level
+          @level ||= level_from_env
+        end
+
+        private
+
+        def level_from_env
+          return :debug if BoolEnv.new('DEBUG').true?
+          return :debug if BoolEnv.new('VERBOSE').true?
+
+          :warn
+        end
+      end
+
+      private
+
+      def level_from_logger
+        return @logger.level if @logger.respond_to? :level
+
+        nil
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/plantuml_error.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative 'plantuml_result'
+
+module Kramdown
+  module PlantUml
+    # PlantUML Error
+    class PlantUmlError < StandardError
+      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
+          #{header}
+
+          #{plantuml}
+
+          #{result}
+        MESSAGE
+
+        message.strip
+      end
+
+      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:
+
+          Exit code: #{result.exitcode}
+          #{result.stderr}
+        RESULT
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/plantuml_result.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative 'logger'
+require_relative 'plantuml_error'
+require_relative 'diagram'
+
+module Kramdown
+  module PlantUml
+    # Executes the PlantUML Java application.
+    class PlantUmlResult
+      attr_reader :diagram, :stdout, :stderr, :exitcode
+
+      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 = exitcode
+        @logger = Logger.init
+      end
+
+      def without_xml_prologue
+        return @stdout if @stdout.nil? || @stdout.empty?
+
+        xml_prologue_start = '<?xml'
+        xml_prologue_end = '?>'
+
+        start_index = @stdout.index(xml_prologue_start)
+
+        return @stdout if start_index.nil?
+
+        end_index = @stdout.index(xml_prologue_end, xml_prologue_start.length)
+
+        return @stdout if end_index.nil?
+
+        end_index += xml_prologue_end.length
+
+        @stdout.slice! start_index, end_index
+
+        @stdout
+      end
+
+      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 ' kramdown-plantuml: PlantUML log:'
+        @logger.debug_with_prefix ' kramdown-plantuml: ', @stderr
+      end
+    end
+  end
+end