kramdown-plantuml 1.1.5 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3968b5c182c334e7dbe020e7cd02309f6349fedeab4c6011b63178aa570b5c7f
-  data.tar.gz: 804e7e4c062c10f1f1c7578c338a8b19ec70a23031081a129f90dc44fa087926
+  metadata.gz: 4ffc24d5b020aac9204946744f85793d0ae07da2fe95a27b9301f104aee78c13
+  data.tar.gz: 83ae8392c10526f3382d327497fee2b85c297f9eb7599798f1e789f947084800
 SHA512:
-  metadata.gz: ad3f371c0c4608c8d613ba9ec73414f6eea92c8eccf9a087fe7ccc487403b4742afc68c63574937aaf8ea30c9f90aaf56b7e5636764647b442137e7a683cbecd
-  data.tar.gz: c437216460a278794c2caeb20c151c5c2a98cce5d5a72e2a4d1b1fb077cc970ceb50fbb0fb3d832b92a7991d35b36776e019a295cbe9884ff928fee073dd9938
+  metadata.gz: 38a1e20a6a08fc178d25737ff9443fecfd8f48bbbc10f1b69eda8fd929f472a05f39150ad91d17cbaf94285757c156101510c16346aecee06f7a712e74c9908b
+  data.tar.gz: 9d6d3192043170c20829ab97fc5513bc392d5eb8af92eb8017042d6ebbd19000730427a5b8c3ac3809095d4a8ec74945424fe854c0d1667ecce1340b3e88b78a

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

@@ -165,7 +165,6 @@ test_gem() {
     bundle install
     bundle exec jekyll build "${jekyll_build_args[@]}"
 
-
     file="${workdir}/_site/index.html"
 
     file_contains "${file}" "class=\"${class}\""

data/.github/workflows/ruby.yml

@@ -94,7 +94,7 @@ jobs:
     - name: RSPec (debug)
       env:
         DEBUG: 1
-      run: bundle exec rspec --tag debug
+      run: bundle exec rspec --format documentation --tag debug
 
     - name: Upload code coverage (debug)
       uses: actions/upload-artifact@v2
@@ -117,6 +117,22 @@ jobs:
     - name: Codecov upload
       run: bundle exec rake codecov:upload || echo 'Codecov upload failed'
 
+    - name: RSPec (Jekyll)
+      run: |
+        echo "gem 'jekyll', require: false, group: :test" >> Gemfile
+        bundle install
+        bundle exec rspec --format documentation --tag jekyll
+        git checkout HEAD -- Gemfile
+
+    - name: Upload code coverage (Jekyll)
+      uses: actions/upload-artifact@v2
+      with:
+        name: rspec-jekyll-coverage
+        path: ./coverage
+
+    - name: Codecov upload (Jekyll)
+      run: bundle exec rake codecov:upload || echo 'Codecov upload failed'
+
     - name: Build gem
       id: gem
       run: .github/scripts/build-gem.sh --ref ${{ github.ref }} --verbose

data/README.md

@@ -130,6 +130,20 @@ kramdown:
       directory: path/to/themes
 ```
 
+### Errors
+
+By default, `kramdown-plantuml` will raise an error and crash if something goes
+wrong during processing. This can be circumvented by setting the `raise_errors`
+configuration key to `false`:
+
+```yaml
+kramdown:
+  plantuml:
+    raise_errors: false
+```
+
+The default value of `raise_errors` is `true`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on [GitHub][github]. This project is

data/Rakefile

@@ -6,7 +6,7 @@ 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 --tag ~debug'
+  t.rspec_opts = '--format documentation --tag ~no_plantuml --tag ~no_java --tag ~debug --tag ~jekyll'
 end
 
 namespace :maven do

data/kramdown-plantuml.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'lib/which'
+require_relative 'lib/kramdown-plantuml/which'
 require_relative 'lib/kramdown-plantuml/version'
 
 Gem::Specification.new do |spec|
@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'htmlentities', '~> 4'
   spec.add_dependency 'kramdown', '~> 2.3'
   spec.add_dependency 'kramdown-parser-gfm', '~> 1.1'
   spec.add_dependency 'open3', '~> 0.1'

data/lib/kramdown-plantuml/diagram.rb

@@ -2,8 +2,9 @@
 
 require_relative 'version'
 require_relative 'theme'
+require_relative 'options'
 require_relative 'plantuml_error'
-require_relative 'logger'
+require_relative 'log_wrapper'
 require_relative 'executor'
 
 module Kramdown
@@ -12,10 +13,14 @@ module Kramdown
     class Diagram
       attr_reader :theme, :plantuml, :result
 
-      def initialize(plantuml, options = {})
+      def initialize(plantuml, options)
+        raise ArgumentError, 'options cannot be nil' if options.nil?
+        raise ArgumentError, "options must be a '#{Options}'." unless options.is_a?(Options)
+
         @plantuml = plantuml
-        @theme = Theme.new(options || {})
-        @logger = Logger.init
+        @options = options
+        @theme = Theme.new(options)
+        @logger = LogWrapper.init
         @executor = Executor.new
         @logger.warn 'PlantUML diagram is empty' if @plantuml.nil? || @plantuml.empty?
       end
@@ -25,12 +30,14 @@ module Kramdown
         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
+      rescue StandardError => e
+        raise e if @options.raise_errors?
+
+        @logger.error e.to_s
       end
 
       private

data/lib/kramdown-plantuml/executor.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'open3'
-require_relative '../which'
-require_relative 'logger'
+require_relative 'which'
+require_relative 'log_wrapper'
 require_relative 'plantuml_result'
 
 module Kramdown
@@ -10,12 +10,18 @@ module Kramdown
     # Executes the PlantUML Java application.
     class Executor
       def initialize
-        @logger = Logger.init
+        @logger = LogWrapper.init
+
+        java_location = Which.which('java')
+
+        raise IOError, 'Java can not be found' if java_location.nil?
+
+        @logger.debug "Java found: #{java_location}"
         @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
+
+        @logger.debug "plantuml.jar found: #{@plantuml_jar_file}"
       end
 
       def execute(diagram)
@@ -37,9 +43,13 @@ module Kramdown
 
       def find_plantuml_jar_file
         dir = File.dirname __dir__
-        jar_glob = File.join dir, '../bin/**/plantuml*.jar'
+        bin_dir = File.expand_path File.join dir, '../bin'
+        jar_glob = File.join bin_dir, '/**/plantuml*.jar'
         first_jar = Dir[jar_glob].first
-        File.expand_path first_jar unless first_jar.nil?
+
+        raise IOError, "No 'plantuml.jar' file could be found within the '#{bin_dir}' directory." if first_jar.nil?
+
+        File.expand_path first_jar
       end
 
       def debug_args

data/lib/kramdown-plantuml/jekyll_provider.rb

@@ -2,7 +2,8 @@
 
 require 'json'
 require 'English'
-require_relative 'logger'
+require 'htmlentities'
+require_relative 'log_wrapper'
 require_relative 'diagram'
 
 module Kramdown
@@ -10,6 +11,8 @@ module Kramdown
     # Provides an instance of Jekyll if available.
     module JekyllProvider
       class << self
+        attr_reader :site_destination_dir
+
         def jekyll
           return @jekyll if defined? @jekyll
 
@@ -19,16 +22,8 @@ module Kramdown
         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
-
+          find_site_destination_dir
+          register_hook
           @installed = true
         end
 
@@ -37,29 +32,86 @@ module Kramdown
         end
 
         def needle(plantuml, options)
-          plantuml_options = !options.nil? && options.key?(:plantuml) ? options[:plantuml] : nil
-          hash = { 'plantuml' => plantuml, 'options' => plantuml_options }
+          hash = { 'plantuml' => plantuml, 'options' => options.to_h }
 
           <<~NEEDLE
             <!--#kramdown-plantuml.start#-->
             #{hash.to_json}
             <!--#kramdown-plantuml.end#-->
           NEEDLE
+        rescue StandardError => e
+          raise e if options.raise_errors?
+
+          puts e
+          logger.error 'Error while placing needle.'
+          logger.error e.to_s
+          logger.debug_multiline plantuml
         end
 
         private
 
-        def replace_needles(html)
+        def find_site_destination_dir
+          if jekyll.sites.nil? || jekyll.sites.empty?
+            logger.debug 'Jekyll detected, hooking into :site:post_write.'
+            return nil
+          end
+
+          @site_destination_dir = jekyll.sites.first.dest
+          logger.debug "Jekyll detected, hooking into :site:post_write of '#{@site_destination_dir}'."
+          @site_destination_dir
+        end
+
+        def register_hook
+          Jekyll::Hooks.register :site, :post_write do |site|
+            logger.debug ':site:post_write triggered.'
+
+            @site_destination_dir ||= site.dest
+
+            site.pages.each do |page|
+              page.output = replace_needles(page)
+              page.write(@site_destination_dir)
+            end
+          end
+        end
+
+        def replace_needles(page)
+          logger.debug "Replacing Jekyll needle in #{page.path}"
+
+          html = page.output
+          return html if html.nil? || html.empty? || !html.is_a?(String)
+
           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
+            return replace_needle(json)
+          end
+        end
+
+        def replace_needle(json)
+          logger.debug 'Replacing Jekyll needle.'
+
+          needle_hash = JSON.parse(json)
+          options_hash = needle_hash['options']
+          options_hash[:site_destination_dir] = @site_destination_dir
+          options = ::Kramdown::PlantUml::Options.new({ plantuml: options_hash })
+
+          begin
+            decode_and_convert(needle_hash, options)
+          rescue StandardError => e
+            raise e if options.raise_errors?
+
+            logger.error 'Error while replacing Jekyll needle.'
+            logger.error e.to_s
+            logger.debug_multiline json
           end
         end
 
+        def decode_and_convert(hash, options)
+          encoded_plantuml = hash['plantuml']
+          plantuml = HTMLEntities.new.decode encoded_plantuml
+          diagram = ::Kramdown::PlantUml::Diagram.new(plantuml, options)
+          diagram.convert_to_svg
+        end
+
         def load_jekyll
           require 'jekyll'
           ::Jekyll
@@ -68,7 +120,7 @@ module Kramdown
         end
 
         def logger
-          @logger ||= ::Kramdown::PlantUml::Logger.init
+          @logger ||= ::Kramdown::PlantUml::LogWrapper.init
         end
       end
     end

data/lib/kramdown-plantuml/{logger.rb → log_wrapper.rb}

@@ -6,7 +6,7 @@ require_relative 'jekyll_provider'
 module Kramdown
   module PlantUml
     # Logs stuff
-    class Logger
+    class LogWrapper
       def initialize(logger)
         raise ArgumentError, 'logger cannot be nil' if logger.nil?
         raise ArgumentError, 'logger must respond to #debug' unless logger.respond_to? :debug
@@ -52,8 +52,9 @@ module Kramdown
 
       class << self
         def init
-          inner = JekyllProvider.jekyll ? JekyllProvider.jekyll.logger : nil || ConsoleLogger.new(level)
-          Logger.new inner
+          inner = JekyllProvider.jekyll ? JekyllProvider.jekyll.logger : nil
+          inner ||= ConsoleLogger.new(level)
+          new inner
         end
 
         def level

data/lib/kramdown-plantuml/options.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative 'log_wrapper'
+
+module Kramdown
+  module PlantUml
+    # Options for PlantUML processing
+    class Options
+      attr_reader :theme_name, :theme_directory
+
+      def initialize(options_hash = {})
+        @logger = LogWrapper.init
+        @options = massage(options_hash)
+        @raise_errors = extract_raise_errors(@options)
+        extract_theme_options(@options)
+      end
+
+      def raise_errors?
+        @raise_errors
+      end
+
+      def to_h
+        @options
+      end
+
+      private
+
+      def boolean(value, default_value)
+        return value if [true, false].include? value
+        return default_value if value.nil?
+
+        s = value.to_s.strip
+        return true if %w[true yes 1].select { |v| v.casecmp(s).zero? }.any?
+        return false if %w[false no 0].select { |v| v.casecmp(s).zero? }.any?
+
+        default_value
+      end
+
+      def extract_plantuml_options(options_hash)
+        return options_hash[:plantuml] if options_hash.key?(:plantuml)
+        return options_hash['plantuml'] if options_hash.key?('plantuml')
+
+        {}
+      end
+
+      def extract_theme_options(options)
+        return if options.empty? || !options.key?(:theme)
+
+        theme = options[:theme] || {}
+
+        unless theme.is_a?(Hash)
+          @logger.warn ":theme is not a Hash: #{theme}"
+          return
+        end
+
+        @theme_name = theme.key?(:name) ? theme[:name] : nil
+        @theme_directory = theme.key?(:directory) ? theme[:directory] : nil
+      end
+
+      def extract_raise_errors(options)
+        if options.key?(:raise_errors)
+          raise_errors = options[:raise_errors]
+          return boolean(raise_errors, true)
+        end
+
+        true
+      end
+
+      def massage(options_hash)
+        if options_hash.nil? || !options_hash.is_a?(Hash) || options_hash.empty?
+          @logger.debug 'No options provided'
+          return {}
+        end
+
+        plantuml_options = extract_plantuml_options(options_hash)
+        symbolize_keys(plantuml_options)
+      end
+
+      def symbolize_keys(options)
+        return options if options.nil? || options.empty?
+
+        array = options.map do |key, value|
+          value = value.is_a?(Hash) ? symbolize_keys(value) : value
+          [key.to_sym, value]
+        end
+
+        array.to_h
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/plantuml_result.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'logger'
+require_relative 'log_wrapper'
 require_relative 'plantuml_error'
 require_relative 'diagram'
 
@@ -20,7 +20,7 @@ module Kramdown
         @stdout = stdout
         @stderr = stderr
         @exitcode = exitcode
-        @logger = Logger.init
+        @logger = LogWrapper.init
       end
 
       def without_xml_prologue

data/lib/kramdown-plantuml/theme.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: false
 
-require_relative 'logger'
+require_relative 'options'
+require_relative 'log_wrapper'
+require_relative 'jekyll_provider'
 
 module Kramdown
   module PlantUml
@@ -8,9 +10,14 @@ module Kramdown
     class Theme
       attr_reader :name, :directory
 
-      def initialize(options = {})
-        @logger = Logger.init
-        @name, @directory = theme_options(options)
+      def initialize(options)
+        raise ArgumentError, 'options cannot be nil' if options.nil?
+        raise ArgumentError, "options must be a '#{Options}'." unless options.is_a?(Options)
+
+        @raise_errors = options.raise_errors?
+        @logger = LogWrapper.init
+        @name = options.theme_name
+        @directory = resolve options.theme_directory
       end
 
       def apply(plantuml)
@@ -21,7 +28,7 @@ module Kramdown
 
         if @name.nil? || @name.empty?
           @logger.debug 'No theme to apply.'
-          return plantuml
+          return plantuml.strip
         end
 
         theme(plantuml)
@@ -29,29 +36,26 @@ module Kramdown
 
       private
 
-      def theme_options(options)
-        options = symbolize_keys(options)
+      def resolve(directory)
+        jekyll = JekyllProvider
 
-        @logger.debug "Options: #{options}"
+        return directory if directory.nil? || directory.empty? || !jekyll.installed?
 
-        return nil if options.nil? || !options.key?(:theme)
+        directory = File.absolute_path(directory, jekyll.site_destination_dir)
 
-        theme = options[:theme] || {}
-        name = theme.key?(:name) ? theme[:name] : nil
-        directory = theme.key?(:directory) ? theme[:directory] : nil
+        log_or_raise "The theme directory '#{directory}' cannot be found" unless Dir.exist?(directory)
 
-        [name, directory]
-      end
+        theme_path = File.join(directory, "puml-theme-#{@name}.puml")
 
-      def symbolize_keys(options)
-        return options if options.nil?
+        log_or_raise "The theme '#{theme_path}' cannot be found" unless File.exist?(theme_path)
 
-        array = options.map do |key, value|
-          value = value.is_a?(Hash) ? symbolize_keys(value) : value
-          [key.to_sym, value]
-        end
+        directory
+      end
+
+      def log_or_raise(message)
+        raise IOError, message if @raise_errors
 
-        array.to_h
+        logger.warn message
       end
 
       def theme(plantuml)
@@ -69,7 +73,7 @@ module Kramdown
           return plantuml.insert match.end(0), theme_string
         end
 
-        plantuml
+        plantuml.strip
       end
     end
   end

data/lib/kramdown-plantuml/version.rb

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

data/lib/{which.rb → kramdown-plantuml/which.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Wraps the `which` Unix utility
+# Mimics the `which` Unix utility
 class Which
   def self.which(cmd)
     exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
@@ -10,6 +10,7 @@ class Which
         return exe if File.executable?(exe) && !File.directory?(exe)
       end
     end
+
     nil
   end
 end

data/lib/kramdown_html.rb

@@ -2,8 +2,9 @@
 
 require 'kramdown'
 require 'kramdown-parser-gfm'
-require_relative 'kramdown-plantuml/logger'
+require_relative 'kramdown-plantuml/log_wrapper'
 require_relative 'kramdown-plantuml/plantuml_error'
+require_relative 'kramdown-plantuml/options'
 require_relative 'kramdown-plantuml/diagram'
 require_relative 'kramdown-plantuml/jekyll_provider'
 
@@ -24,9 +25,10 @@ module Kramdown
         # 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?
+        options = ::Kramdown::PlantUml::Options.new(@options)
+        return jekyll.needle(element.value, options) if jekyll.installed?
 
-        convert_plantuml(element.value)
+        convert_plantuml(element.value, options)
       end
 
       private
@@ -35,11 +37,14 @@ module Kramdown
         element.attr['class'] == 'language-plantuml'
       end
 
-      def convert_plantuml(plantuml)
-        plantuml_options = @options.key?(:plantuml) ? @options[:plantuml] : {}
-
-        diagram = ::Kramdown::PlantUml::Diagram.new(plantuml, plantuml_options)
+      def convert_plantuml(plantuml, options)
+        diagram = ::Kramdown::PlantUml::Diagram.new(plantuml, options)
         diagram.convert_to_svg
+      rescue StandardError => e
+        raise e if options.raise_errors?
+
+        logger = ::Kramdown::PlantUml::LogWrapper.init
+        logger.error "Error while replacing needle: #{e.inspect}"
       end
     end
   end

data/pom.xml

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.9
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +180,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/net/sourceforge/plantuml/plantuml/1.2021.10/plantuml-1.2021.10.jar
+- bin/net/sourceforge/plantuml/plantuml/1.2021.12/plantuml-1.2021.12.jar
 - kramdown-plantuml.gemspec
 - lib/kramdown-plantuml.rb
 - lib/kramdown-plantuml/bool_env.rb
@@ -174,13 +188,14 @@ files:
 - lib/kramdown-plantuml/diagram.rb
 - lib/kramdown-plantuml/executor.rb
 - lib/kramdown-plantuml/jekyll_provider.rb
-- lib/kramdown-plantuml/logger.rb
+- lib/kramdown-plantuml/log_wrapper.rb
+- lib/kramdown-plantuml/options.rb
 - lib/kramdown-plantuml/plantuml_error.rb
 - lib/kramdown-plantuml/plantuml_result.rb
 - lib/kramdown-plantuml/theme.rb
 - lib/kramdown-plantuml/version.rb
+- lib/kramdown-plantuml/which.rb
 - lib/kramdown_html.rb
-- lib/which.rb
 - pom.xml
 homepage: https://github.com/SwedbankPay/kramdown-plantuml
 licenses: