kramdown-plantuml 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2a7f9fc36a5af2bb28cc4aa5a6dcf7313e8fbf4efad763783cf165ff4ca0192
-  data.tar.gz: c6732b8d23e7edc5d89c4ca9bb4db9fbd5aeded25b76007bb2fa15a9c32ccdde
+  metadata.gz: 716bd98dfc84efc97e64f12e8c1f68c1ee7a982e1d1ea33eabdf0f74b4560c04
+  data.tar.gz: 56254a3d065d7c69f2744cca59d32974e37f3e773bceccc2c63ab8dc151a5ace
 SHA512:
-  metadata.gz: f9f0d06fbf084ea9b93ef189a6c6c1b43dbc9b73abdfe4f46963b396bdf0e2e5f3340f047f32e75af488072120f76f470febdd3ab91b6d3d87dbd4173213ecca
-  data.tar.gz: d9fd8d226b104f5ba77b6fd50e25add3c8261933a9841b0a454df231afa8d544583a2b584fbb5ac463e8c7526432cf2753f1fa9249d51c743c0a7890403099a5
+  metadata.gz: 4e19ff0d0e8b1b90f5a5e19595c95982c9e6c126b1b54b5238c0ee1ac81463aaf63350be0ea90c04844cbc7fca5c126cadd86fec50073ed9af0bf83b9800a706
+  data.tar.gz: c0dea81be5cd8bbf9c9541b4941cfd4c0ab05700a092a6b4672ec7adfe96f5e2212c22861dfcd0e86d1e90611b8bf2734da12d12b05853239ffa582b3b67bcc5

data/.github/workflows/ruby.yml

@@ -43,7 +43,7 @@ jobs:
         java-version: 14
 
     - name: Cache Maven dependencies
-      uses: actions/cache@v2.1.6
+      uses: actions/cache@v2.1.7
       with:
         path: ~/.m2/repository
         key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}

data/README.md

@@ -127,7 +127,7 @@ kramdown:
   plantuml:
     theme:
       name: my-custom-theme
-      directory: path/to/themes
+      directory: spec/examples
 ```
 
 ### Dimensions and Styling

data/lib/kramdown-plantuml/jekyll_provider.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'log_wrapper'
-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
+        attr_reader :site_source_dir
 
         def jekyll
           return @jekyll if defined? @jekyll
@@ -16,60 +15,17 @@ module Kramdown
           @jekyll = load_jekyll
         end
 
-        def install
-          return @installed = false if jekyll.nil?
-
-          find_site_destination_dir
-          register_hook
-          @installed = true
-        end
-
-        def installed?
-          @installed
-        end
-
-        def needle(plantuml, options)
-          JekyllPageProcessor.needle(plantuml, options)
-        end
-
         private
 
-        def find_site_destination_dir
+        def find_site_source_dir
           if jekyll.sites.nil? || jekyll.sites.empty?
-            logger.debug 'Jekyll detected, hooking into :site:post_write.'
+            logger.warn 'Jekyll detected, but no sites found.'
             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|
-            site_post_write(site)
-          end
-        end
-
-        def site_post_write(site)
-          logger.debug 'Jekyll:site:post_write triggered.'
-          @site_destination_dir ||= site.dest
-
-          site.pages.each do |page|
-            processor = JekyllPageProcessor.new(page)
-
-            next unless processor.should_process?
-
-            processor.process(site.dest)
-          end
-
-          site.posts.each do |post|
-            processor = JekyllPageProcessor.new(post)
-
-            next unless processor.should_process?
-
-            processor.process(site.dest)
-          end
+          @site_source_dir = jekyll.sites.first.source
+          logger.debug "Jekyll detected, using '#{@site_source_dir}' as base directory."
+          @site_source_dir
         end
 
         def load_jekyll

data/lib/kramdown-plantuml/plantuml_diagram.rb

@@ -18,7 +18,7 @@ module Kramdown
         raise ArgumentError, 'options cannot be nil' if options.nil?
         raise ArgumentError, "options must be a '#{Options}'." unless options.is_a?(Options)
 
-        @plantuml = plantuml
+        @plantuml = plantuml.strip unless plantuml.nil?
         @options = options
         @theme = Theme.new(options)
         @logger = LogWrapper.init

data/lib/kramdown-plantuml/theme.rb

@@ -35,9 +35,9 @@ module Kramdown
       def resolve(directory)
         jekyll = JekyllProvider
 
-        return directory if directory.nil? || directory.empty? || !jekyll.installed?
+        return directory if directory.nil? || directory.empty?
 
-        directory = File.absolute_path(directory, jekyll.site_destination_dir)
+        directory = File.absolute_path(directory, jekyll.site_source_dir)
 
         log_or_raise "The theme directory '#{directory}' cannot be found" unless Dir.exist?(directory)
 
@@ -51,7 +51,7 @@ module Kramdown
       def log_or_raise(message)
         raise IOError, message if @raise_errors
 
-        logger.warn message
+        @logger.warn message
       end
 
       def theme(plantuml)

data/lib/kramdown-plantuml/version.rb

@@ -2,6 +2,6 @@
 
 module Kramdown
   module PlantUml
-    VERSION = '1.3.1'
+    VERSION = '1.3.2'
   end
 end

data/lib/kramdown-plantuml.rb

@@ -1,6 +1,3 @@
 # frozen_string_literal: true
 
 require_relative 'kramdown_html'
-require_relative 'kramdown-plantuml/jekyll_provider'
-
-::Kramdown::PlantUml::JekyllProvider.install

data/lib/kramdown_html.rb

@@ -6,7 +6,6 @@ require_relative 'kramdown-plantuml/log_wrapper'
 require_relative 'kramdown-plantuml/plantuml_error'
 require_relative 'kramdown-plantuml/options'
 require_relative 'kramdown-plantuml/plantuml_diagram'
-require_relative 'kramdown-plantuml/jekyll_provider'
 
 module Kramdown
   module Converter
@@ -16,19 +15,9 @@ module Kramdown
       alias super_convert_codeblock convert_codeblock
 
       def convert_codeblock(element, indent)
-        return super_convert_codeblock(element, indent) unless plantuml?(element)
+        return super_convert_codeblock(element, indent) unless plantuml? element
 
-        jekyll = ::Kramdown::PlantUml::JekyllProvider
-
-        # If Jekyll is successfully loaded, we'll wait with converting the
-        # PlantUML diagram to SVG since a theme may be configured that needs to
-        # 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.
-        options = ::Kramdown::PlantUml::Options.new(@options)
-        return jekyll.needle(element.value, options) if jekyll.installed?
-
-        convert_plantuml(element.value, options)
+        convert_plantuml(element.value)
       end
 
       private
@@ -37,14 +26,15 @@ module Kramdown
         element.attr['class'] == 'language-plantuml'
       end
 
-      def convert_plantuml(plantuml, options)
-        diagram = ::Kramdown::PlantUml::PlantUmlDiagram.new(plantuml, options)
+      def convert_plantuml(plantuml)
+        puml_opts = ::Kramdown::PlantUml::Options.new(@options)
+        diagram = ::Kramdown::PlantUml::PlantUmlDiagram.new(plantuml, puml_opts)
         diagram.svg.to_s
       rescue StandardError => e
-        raise e if options.raise_errors?
+        raise e if puml_opts.nil? || puml_opts.raise_errors?
 
         logger = ::Kramdown::PlantUml::LogWrapper.init
-        logger.error "Error while replacing needle: #{e.inspect}"
+        logger.error "Error while converting diagram: #{e.inspect}"
       end
     end
   end

data/pom.xml

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -194,13 +194,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/net/sourceforge/plantuml/plantuml/1.2021.12/plantuml-1.2021.12.jar
+- bin/net/sourceforge/plantuml/plantuml/1.2021.16/plantuml-1.2021.16.jar
 - kramdown-plantuml.gemspec
 - lib/kramdown-plantuml.rb
 - lib/kramdown-plantuml/bool_env.rb
 - lib/kramdown-plantuml/console_logger.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/none_s.rb

data/lib/kramdown-plantuml/jekyll_page_processor.rb

@@ -1,103 +0,0 @@
-# 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::PlantUmlDiagram.new(plantuml, options)
-        diagram.svg
-      end
-
-      def logger
-        @logger ||= ::Kramdown::PlantUml::LogWrapper.init
-      end
-    end
-  end
-end