kramdown-plantuml 1.1.7 → 1.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 178996116d7a833c324db54da1b3c367fe13c1d55fabc47026df12bec25b6f9d
-  data.tar.gz: d5dc3e4824ab5095b42b33e4b01cc6cb38735fe0bb220472f02e8014f069261b
+  metadata.gz: '0307159bac1bde4c2f9d21a19fde7e2c3a474df622f5a0fd54d368d71e7c6884'
+  data.tar.gz: 440a8b11f5398ffc6f73ebf67c9d1eb5e5c91e3fc63fb9a15455033bf413a882
 SHA512:
-  metadata.gz: 5dd2e36fc7b66a4a8948ba801d75107c04fedbbb612fe525cabac758de15e3908368999d8779126a082dfcef70f990194c3abf0bace90eea019b182e3d26626c
-  data.tar.gz: 166be327fab188558c365c5284739d57ed7b851ce953e616b98d7f9002a20f89ab6af7527134a148eefdf547c4465adfe469d597eb8919af26a51cf3615e2b57
+  metadata.gz: d9a7db962e92eebd1729c3e043d6a6ba0fca49c8365d7eecdacd5120737eda1d0af58c423bdf8cdd7d6101e3421a19c778f9a3fee22148d9948b46f8f0a2d542
+  data.tar.gz: 5fe6ae9a8ffb8941825da89f0bf7f28229631292615938fcd9edd507553148a1feaab272c48fac9509dedffebd70e0cec8a3a6209a5d2ddb74323f575c606b01

data/kramdown-plantuml.gemspec

@@ -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/jekyll_provider.rb

@@ -2,7 +2,7 @@
 
 require 'json'
 require 'English'
-require 'rexml/document'
+require 'htmlentities'
 require_relative 'log_wrapper'
 require_relative 'diagram'
 
@@ -11,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
 
@@ -20,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
 
@@ -56,33 +50,67 @@ module Kramdown
 
         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]
             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 = ::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 needle: #{e.inspect}"
+            logger.error 'Error while replacing Jekyll needle.'
+            logger.error e.to_s
+            logger.debug_multiline json
           end
         end
 
-        def replace_needle(json)
-          hash = JSON.parse(json)
+        def decode_and_convert(hash, options)
           encoded_plantuml = hash['plantuml']
-          plantuml = decode_html_entities(encoded_plantuml)
-          options = ::Kramdown::PlantUml::Options.new({ plantuml: hash['options'] })
+          plantuml = HTMLEntities.new.decode encoded_plantuml
           diagram = ::Kramdown::PlantUml::Diagram.new(plantuml, options)
           diagram.convert_to_svg
         end
 
-        def decode_html_entities(encoded_plantuml)
-          doc = REXML::Document.new "<plantuml>#{encoded_plantuml}</plantuml>"
-          doc.root.text
-        end
-
         def load_jekyll
           require 'jekyll'
           ::Jekyll

data/lib/kramdown-plantuml/options.rb

@@ -10,7 +10,7 @@ module Kramdown
 
       def initialize(options_hash = {})
         @logger = LogWrapper.init
-        @options = massage(options_hash)
+        @options = massage(options_hash) || {}
         @raise_errors = extract_raise_errors(@options)
         extract_theme_options(@options)
       end
@@ -44,9 +44,9 @@ module Kramdown
       end
 
       def extract_theme_options(options)
-        return if options.empty? || !options.key?(:theme)
+        return if options.nil? || options.empty? || !options.key?(:theme)
 
-        theme = options[:theme] || {}
+        theme = options[:theme]
 
         unless theme.is_a?(Hash)
           @logger.warn ":theme is not a Hash: #{theme}"
@@ -58,12 +58,10 @@ module Kramdown
       end
 
       def extract_raise_errors(options)
-        if options.key?(:raise_errors)
-          raise_errors = options[:raise_errors]
-          return boolean(raise_errors, true)
-        end
+        return true if options.nil? || options.empty? || !options.key?(:raise_errors)
 
-        true
+        raise_errors = options[:raise_errors]
+        boolean(raise_errors, true)
       end
 
       def massage(options_hash)

data/lib/kramdown-plantuml/theme.rb

@@ -2,6 +2,7 @@
 
 require_relative 'options'
 require_relative 'log_wrapper'
+require_relative 'jekyll_provider'
 
 module Kramdown
   module PlantUml
@@ -13,9 +14,10 @@ module Kramdown
         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 = options.theme_directory
+        @directory = resolve options.theme_directory
       end
 
       def apply(plantuml)
@@ -34,6 +36,28 @@ module Kramdown
 
       private
 
+      def resolve(directory)
+        jekyll = JekyllProvider
+
+        return directory if directory.nil? || directory.empty? || !jekyll.installed?
+
+        directory = File.absolute_path(directory, jekyll.site_destination_dir)
+
+        log_or_raise "The theme directory '#{directory}' cannot be found" unless Dir.exist?(directory)
+
+        theme_path = File.join(directory, "puml-theme-#{@name}.puml")
+
+        log_or_raise "The theme '#{theme_path}' cannot be found" unless File.exist?(theme_path)
+
+        directory
+      end
+
+      def log_or_raise(message)
+        raise IOError, message if @raise_errors
+
+        logger.warn message
+      end
+
       def theme(plantuml)
         startuml = '@startuml'
         startuml_index = plantuml.index(startuml) + startuml.length

data/lib/kramdown-plantuml/version.rb

@@ -2,6 +2,6 @@
 
 module Kramdown
   module PlantUml
-    VERSION = '1.1.7'
+    VERSION = '1.1.11'
   end
 end

data/lib/kramdown_html.rb

@@ -28,7 +28,7 @@ module Kramdown
         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
@@ -37,10 +37,14 @@ module Kramdown
         element.attr['class'] == 'language-plantuml'
       end
 
-      def convert_plantuml(plantuml)
-        options = ::Kramdown::PlantUml::Options.new(@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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.11
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-11-04 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