kramdown-plantuml 1.1.9 → 1.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ffc24d5b020aac9204946744f85793d0ae07da2fe95a27b9301f104aee78c13
-  data.tar.gz: 83ae8392c10526f3382d327497fee2b85c297f9eb7599798f1e789f947084800
+  metadata.gz: af8b7df3676e0e2a57ebe8e4fc96f0e51388036d7910c9547bbd73f75b9ebde0
+  data.tar.gz: 1dc627d6d92fd81bd88a2ad7b9bc31f11a319117e734bff80d3e49651be07979
 SHA512:
-  metadata.gz: 38a1e20a6a08fc178d25737ff9443fecfd8f48bbbc10f1b69eda8fd929f472a05f39150ad91d17cbaf94285757c156101510c16346aecee06f7a712e74c9908b
-  data.tar.gz: 9d6d3192043170c20829ab97fc5513bc392d5eb8af92eb8017042d6ebbd19000730427a5b8c3ac3809095d4a8ec74945424fe854c0d1667ecce1340b3e88b78a
+  metadata.gz: 6e7fd6b35fe88507e326370e901b1cc02b7801e1b1a82d2510fa4f3cb41528a43e4465d4c44336ce05ae292a3bc4d1f11b3a382bc779e648c73aab70a33384ea
+  data.tar.gz: 919450a3b77827d699c2c071c161d7bb29cc7400e6bb108cc6f745e7e8980137174767e208d3cfae2c72ba9701fcc346415d2ee348817f79f4391e3d0ae39162

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,103 @@
+# 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?
+
+        @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,10 +1,7 @@
 # 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
@@ -32,20 +29,7 @@ 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
@@ -63,55 +47,23 @@ module Kramdown
 
         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
+            site_post_write(site)
           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)
+        def site_post_write(site)
+          logger.debug 'Jekyll:site:post_write triggered.'
+          @site_destination_dir ||= site.dest
 
-          html.gsub(/<!--#kramdown-plantuml\.start#-->(?<json>.*?)<!--#kramdown-plantuml\.end#-->/m) do
-            json = $LAST_MATCH_INFO[:json]
-            return replace_needle(json)
-          end
-        end
+          site.pages.each do |page|
+            processor = JekyllPageProcessor.new(page)
 
-        def replace_needle(json)
-          logger.debug 'Replacing Jekyll needle.'
+            next unless processor.should_process?
 
-          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
+            processor.process(site.dest)
           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

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.1.13
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-03 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