kramdown-plantuml 1.1.8 → 1.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f873d08b8ab86ebe4ea964c30ad59a43a75c28d042d6627af1694d1ff262cbfd
-  data.tar.gz: cca59110bbdac25b41dc4c7ef41f9df0f84b17aa4a6da662feab19a73ca61724
+  metadata.gz: '09e8c86eb711f1566f32fce47684f204a1daaef68fd53c7d9837dea2af47eedc'
+  data.tar.gz: 5393660894a40a510b0d709dc5d6c8bfa738a7584c1f59c5f549526827fd99ef
 SHA512:
-  metadata.gz: bbe10bc2e73c25b0a2bd09651e9bd73b2aeb612fa26f0470df0e9f0477c8f8f69f3c69d428b136826264e975068dc073724fcf4ab5e10b93e59585001983ada8
-  data.tar.gz: b74471596aadcf0bde3bf7878864918fb5bd6297172f69b5f9d30c214f84c1f67dfe2c11b7b6e1dc78bfb85c817c0a2c4a26e5bb9c420c519d490b5567b29fe8
+  metadata.gz: f74720e634e10a0688ee87bc8c85277e07865583f85e87e86b87747e1aec03362ab98a7c85d92a14d399ad06eb6525b12647757809128af77f3d35d782e6bbba
+  data.tar.gz: 013a677b39a48aa8e401fb1d6dfd5340e66e01f564b2188a17fe5437201df7324ed0f4fd37704c137594867513c614ac33f7c8ce26948988225a11f8cd75da23

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

@@ -167,6 +167,7 @@ test_gem() {
 
     file="${workdir}/_site/index.html"
 
+    file_contains "${file}" "This is a fixture"
     file_contains "${file}" "class=\"${class}\""
     file_contains "${file}" "<svg"
     file_contains "${file}" "<ellipse"

data/lib/kramdown-plantuml/jekyll_page_processor.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'htmlentities'
+require 'json'
+require_relative 'log_wrapper'
+
+module Kramdown
+  module PlantUml
+    # Processes Jekyll pages.
+    class JekyllPageProcessor
+      PROCESSED_KEY = :kramdown_plantuml_processed
+
+      def initialize(page)
+        raise ArgumentError, 'page cannot be nil' if page.nil?
+
+        puts page.class
+
+        @page = page
+      end
+
+      def process(site_destination_directory)
+        @page.output = do_process
+        @page.data[PROCESSED_KEY] = true
+        @page.write(site_destination_directory)
+      end
+
+      def should_process?
+        return false unless @page.output_ext == '.html'
+
+        if !@page.data.nil? && @page.data.key?(PROCESSED_KEY) && @page.data[PROCESSED_KEY]
+          logger.debug "Skipping #{@page.path} because it has already been processed."
+          return false
+        end
+
+        true
+      end
+
+      class << self
+        def needle(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.nil? || options.raise_errors?
+
+          logger.error 'Error while placing needle.'
+          logger.error e.to_s
+          logger.debug_multiline plantuml
+        end
+
+        def logger
+          @logger ||= ::Kramdown::PlantUml::LogWrapper.init
+        end
+      end
+
+      private
+
+      def do_process
+        logger.debug "Replacing Jekyll needles 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 ? $LAST_MATCH_INFO[:json] : nil
+          replace_needle(json) unless json.nil?
+        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 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 logger
+        @logger ||= ::Kramdown::PlantUml::LogWrapper.init
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/jekyll_provider.rb

@@ -1,16 +1,15 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'English'
-require 'htmlentities'
 require_relative 'log_wrapper'
-require_relative 'diagram'
+require_relative 'jekyll_page_processor'
 
 module Kramdown
   module PlantUml
     # 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 +19,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
 
@@ -38,54 +29,39 @@ module Kramdown
         end
 
         def needle(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
+          JekyllPageProcessor.needle(plantuml, options)
         end
 
         private
 
-        def replace_needles(html)
-          return html if html.nil? || html.empty? || !html.is_a?(String)
+        def find_site_destination_dir
+          if jekyll.sites.nil? || jekyll.sites.empty?
+            logger.debug 'Jekyll detected, hooking into :site:post_write.'
+            return nil
+          end
 
-          html.gsub(/<!--#kramdown-plantuml\.start#-->(?<json>.*?)<!--#kramdown-plantuml\.end#-->/m) do
-            json = $LAST_MATCH_INFO[:json]
-            return replace_needle(json)
+          @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|
+            site_post_write(site)
           end
         end
 
-        def replace_needle(json)
-          hash = JSON.parse(json)
-          options_hash = hash['options']
-          options = ::Kramdown::PlantUml::Options.new({ plantuml: options_hash })
+        def site_post_write(site)
+          logger.debug 'Jekyll:site:post_write triggered.'
+          @site_destination_dir ||= site.dest
 
-          begin
-            decode_and_convert(hash, options)
-          rescue StandardError => e
-            raise e if options.raise_errors?
+          site.pages.each do |page|
+            processor = JekyllPageProcessor.new(page)
 
-            logger.error 'Error while replacing needle.'
-            logger.error e.to_s
-            logger.debug_multiline json
-          end
-        end
+            next unless processor.should_process?
 
-        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
+            processor.process(site.dest)
+          end
         end
 
         def load_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.8'
+    VERSION = '1.1.12'
   end
 end

data/lib/kramdown_html.rb

@@ -43,6 +43,7 @@ module Kramdown
       rescue StandardError => e
         raise e if options.raise_errors?
 
+        logger = ::Kramdown::PlantUml::LogWrapper.init
         logger.error "Error while replacing needle: #{e.inspect}"
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.12
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -187,6 +187,7 @@ files:
 - lib/kramdown-plantuml/console_logger.rb
 - lib/kramdown-plantuml/diagram.rb
 - lib/kramdown-plantuml/executor.rb
+- lib/kramdown-plantuml/jekyll_page_processor.rb
 - lib/kramdown-plantuml/jekyll_provider.rb
 - lib/kramdown-plantuml/log_wrapper.rb
 - lib/kramdown-plantuml/options.rb