kramdown-plantuml 1.0.1 → 1.1.2

data/Rakefile

@@ -1,10 +1,40 @@
+# frozen_string_literal: true
+
 require 'rake'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-    t.pattern = Dir.glob('spec/**/*_spec.rb')
-    t.rspec_opts = '--format documentation --tag ~no_plantuml --tag ~no_java'
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation --tag ~no_plantuml --tag ~no_java --tag ~debug'
+end
+
+namespace :maven do
+  task :install do
+    require 'fileutils'
+
+    system 'mvn install'
+    bin_dir = File.join __dir__, 'bin'
+    target_file = File.join bin_dir, 'plantuml.jar'
+    repo_dir = File.expand_path '~/.m2/repository'
+    jar_glob = File.join repo_dir, '/**/plantuml*.jar'
+    first_jar = Dir[jar_glob].first
+    jar_file = File.expand_path first_jar
+
+    FileUtils.mkdir_p bin_dir
+    FileUtils.move(jar_file, target_file)
+  end
+end
+
+namespace :codecov do
+  desc 'Uploads the latest SimpleCov result set to codecov.io'
+  task :upload do
+    require 'simplecov'
+    require 'codecov'
+
+    formatter = SimpleCov::Formatter::Codecov.new
+    formatter.format(SimpleCov::ResultMerger.merged_result)
+  end
 end
 
-task :default => :spec
+task default: :spec

data/kramdown-plantuml.gemspec

@@ -1,33 +1,48 @@
+# frozen_string_literal: true
+
 require_relative 'lib/which'
 require_relative 'lib/kramdown-plantuml/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "kramdown-plantuml"
+  spec.name          = 'kramdown-plantuml'
   spec.version       = Kramdown::PlantUml::VERSION
-  spec.authors       = ["Asbjørn Ulsberg"]
-  spec.email         = ["asbjorn@ulsberg.no"]
+  spec.authors       = ['Swedbank Pay']
+  spec.email         = ['opensource@swedbankpay.com']
 
-  spec.summary       = "Short summary"
-  spec.homepage      = "https://github.com/SwedbankPay/kramdown-plantuml"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  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.5.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/SwedbankPay/kramdown-plantuml"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/SwedbankPay/kramdown-plantuml'
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    if Which::which('git')
-      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into Git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    if Which.which('git')
+      files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+      # Explicitly add plantuml.jar to the list of files as it is not committed to Git.
+      files.append(Dir['bin/**/plantuml*.jar'].first)
     else
       puts "Git not found, no files added to #{spec.name}."
     end
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  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", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  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.rb

@@ -1,7 +1,5 @@
-require 'kramdown-plantuml/version'
-require 'kramdown-plantuml/converter'
-require 'kramdown_html'
+# frozen_string_literal: true
 
-module Kramdown::PlantUml
-    class Error < StandardError; end
-end
+require_relative 'kramdown-plantuml/version'
+require_relative 'kramdown-plantuml/converter'
+require_relative 'kramdown_html'

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/converter.rb

@@ -1,34 +1,52 @@
-require 'which'
-require 'open3'
-require_relative 'version'
+# frozen_string_literal: true
 
-module Kramdown::PlantUml
-  class Converter
-    def initialize
-      dir = File.dirname __dir__
-      bin = File.join dir, "../bin"
-      bin = File.expand_path bin
-      @plant_uml_jar_file = File.join bin, "plantuml.1.2020.5.jar"
+require_relative 'version'
+require_relative 'themer'
+require_relative 'plantuml_error'
+require_relative 'logger'
+require_relative 'executor'
 
-      if not File.exists? @plant_uml_jar_file
-        raise IOError.new("'#{@plant_uml_jar_file}' does not exist")
+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
 
-      unless Which::which("java")
-        raise IOError.new("Java can not be found")
+      def convert_plantuml_to_svg(plantuml)
+        if plantuml.nil? || plantuml.empty?
+          @logger.warn 'kramdown-plantuml: PlantUML diagram is empty'
+          return plantuml
+        end
+
+        plantuml = @themer.apply_theme(plantuml)
+        plantuml = plantuml.strip
+        log(plantuml)
+        result = @executor.execute(plantuml)
+        result.validate(plantuml)
+        svg = result.without_xml_prologue
+        wrap(svg)
       end
-    end
 
-    def convert_plantuml_to_svg(content)
-      cmd = "java -jar #{@plant_uml_jar_file} -tsvg -pipe"
+      private
+
+      def wrap(svg)
+        theme_class = @themer.theme_name ? "theme-#{@themer.theme_name}" : ''
+        class_name = "plantuml #{theme_class}".strip
 
-      stdout, stderr, status = Open3.capture3(cmd, :stdin_data => content)
+        wrapper_element_start = "<div class=\"#{class_name}\">"
+        wrapper_element_end = '</div>'
 
-      unless stderr.empty?
-        raise stderr
+        "#{wrapper_element_start}#{svg}#{wrapper_element_end}"
       end
 
-      return stdout
+      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,48 @@
+# frozen_string_literal: false
+
+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(stdin)
+        cmd = "java -Djava.awt.headless=true -jar #{@plantuml_jar_file} -tsvg -failfast -pipe"
+        cmd << if @logger.debug?
+                 ' -verbose'
+               else
+                 ' -nometadata'
+               end
+
+        @logger.debug "kramdown-plantuml: Executing '#{cmd}'."
+
+        stdout, stderr, status = Open3.capture3 cmd, stdin_data: stdin
+
+        @logger.debug "kramdown-plantuml: PlantUML exit code '#{status.exitstatus}'."
+
+        PlantUmlResult.new(stdout, stderr, status)
+      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
+    end
+  end
+end

data/lib/kramdown-plantuml/hash.rb

@@ -0,0 +1,14 @@
+# 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/logger.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative 'console_logger'
+
+module Kramdown
+  module PlantUml
+    # Provides theming support for PlantUML
+    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, string)
+        return if string.nil? || string.empty?
+
+        lines = 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
+
+      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
+    end
+  end
+end

data/lib/kramdown-plantuml/plantuml_error.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Kramdown
+  module PlantUml
+    # PlantUML Error
+    class PlantUmlError < StandardError
+      def initialize(plantuml, stderr, exitcode)
+        message = <<~MESSAGE
+          Conversion of the following PlantUML diagram failed:
+
+          #{plantuml}
+
+          The error received from PlantUML was:
+
+          Exit code: #{exitcode}
+          #{stderr}
+        MESSAGE
+
+        super message
+      end
+
+      def self.should_raise?(exitcode, stderr)
+        return false 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
+    end
+  end
+end