kramdown-plantuml 1.3.0 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc1234f77cba369797da8b8efd79b0a1913e65cd07f14ab26189c0acb2fa4900
-  data.tar.gz: 445fea556a2c3f248a3158e3f8fd9383624a1aceefb1e03e549e48ce87a6a4de
+  metadata.gz: 1b755b8fc90e54aada29c40ce3b4391858d2b978487a82a9965bef5da8084b08
+  data.tar.gz: 0afb90a2bc66c705f7efb6e5c48d26c3e7e3ab83f1fd4ba2300090121b844958
 SHA512:
-  metadata.gz: 62dea36dfd6f811cb0861db862a938ae6e10f4d36fa1783ef33ec2338355710cfe8c718fcaf246cc73974d652729ea99560220997ef12c44174a8b6b1adbab1b
-  data.tar.gz: b9b72275e8eec577c9a249802191f8e9a457b1dfdb4e83328e2e4a942f43077ab39c08fbff2790af23f7c1c3c6d451250bfab7effa7b47455d994472bea1c439
+  metadata.gz: fc479376cac81326afd561679f65d84ae110a762cf85ecd6936713f7dcaf019dbb7031890ea038dd4874955ffcdf7ca71fdca3ad30756d7526579cde89385d87
+  data.tar.gz: 605bcc56726601a048cc69599c0b8a72f6845cb1145af7549d35cb832b3aff515aae6dbf560294145509897b86ca698fde5848d21f34cc9230360a0f01517b9a

data/.github/mergify.yml

@@ -9,10 +9,15 @@ pull_request_rules:
   - name: Automatic merge on approval
     conditions:
       - author~=^dependabot(|-preview)\[bot\]$
+      - '#commits-behind=0' # Only merge up to date pull requests
+      - check-success=test
+      - check-success=version
+      - check-success=plantuml
+      - check-success=gem
+      - check-success=shellcheck
+      - check-success=license/cla
     actions:
       merge:
-        method: merge
-        strict: smart
 
   - name: Thank contributor
     conditions:

data/.github/workflows/amend.yml

@@ -9,7 +9,7 @@ jobs:
     if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/amend')
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           persist-credentials: false
       - name: amend

data/.github/workflows/no-java.yml

@@ -13,7 +13,7 @@ jobs:
       image: ruby:2.7.2
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Bundle install
       run: bundle install --jobs 4 --retry 3

data/.github/workflows/no-plantuml.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Set up Ruby 2.7
       uses: ruby/setup-ruby@v1

data/.github/workflows/ruby.yml

@@ -10,18 +10,18 @@ jobs:
       version: ${{ steps.variables.outputs.version }}
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 0
 
     - name: Setup GitVersion
-      uses: gittools/actions/gitversion/setup@v0.9.11
+      uses: gittools/actions/gitversion/setup@v0.9.13
       with:
         versionSpec: '5.x.x'
 
     - name: Execute GitVersion
       id: gitversion
-      uses: gittools/actions/gitversion/execute@v0.9.11
+      uses: gittools/actions/gitversion/execute@v0.9.13
 
     - name: Create variables
       id: variables
@@ -34,16 +34,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Setup Java
-      uses: actions/setup-java@v2
+      uses: actions/setup-java@v3
       with:
         distribution: adopt
         java-version: 14
 
     - name: Cache Maven dependencies
-      uses: actions/cache@v2.1.6
+      uses: actions/cache@v3
       with:
         path: ~/.m2/repository
         key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -56,7 +56,7 @@ jobs:
       run: mvn install
 
     - name: Upload plantuml.jar artifact
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: plantuml.jar
         path: ~/.m2/repository/**/plantuml*.jar
@@ -69,9 +69,9 @@ jobs:
       name: ${{ steps.gem.outputs.name }}
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - uses: actions/download-artifact@v2
+    - uses: actions/download-artifact@v3
       with:
         name: plantuml.jar
         path: bin/
@@ -97,7 +97,7 @@ jobs:
       run: bundle exec rspec --format documentation --tag debug
 
     - name: Upload code coverage (debug)
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: rspec-debug-coverage
         path: ./coverage
@@ -109,7 +109,7 @@ jobs:
       run: bundle exec rake
 
     - name: Upload code coverage
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: rspec-coverage
         path: ./coverage
@@ -125,7 +125,7 @@ jobs:
         git checkout HEAD -- Gemfile
 
     - name: Upload code coverage (Jekyll)
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: rspec-jekyll-coverage
         path: ./coverage
@@ -138,7 +138,7 @@ jobs:
       run: .github/scripts/build-gem.sh --ref ${{ github.ref }} --verbose
 
     - name: Upload gem
-      uses: actions/upload-artifact@v2-preview
+      uses: actions/upload-artifact@v3
       with:
         name: ${{ steps.gem.outputs.name }}
         path: ${{ steps.gem.outputs.name }}
@@ -150,7 +150,7 @@ jobs:
       run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/examples" --gemdir "${{ github.workspace }}" --verbose
 
     - name: Upload code coverage (gem)
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: gem-coverage
         path: ./coverage
@@ -166,15 +166,15 @@ jobs:
         (github.event_name != 'pull_request_target' && github.actor != 'dependabot[bot]')
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       if: ${{ github.event_name != 'pull_request_target' }}
 
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       if: ${{ github.event_name == 'pull_request_target' }}
       with:
         ref: ${{ github.event.pull_request.head.sha }}
 
-    - uses: actions/download-artifact@v2
+    - uses: actions/download-artifact@v3
       with:
         name: ${{ needs.gem.outputs.name }}
 
@@ -200,7 +200,7 @@ jobs:
       run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/examples" --version ${{ needs.version.outputs.version }} --token "${{ secrets.GPR_TOKEN }}" --verbose --theme-name c2a3b0 --theme-directory "${{ github.workspace }}/spec/examples"
 
     - name: Upload Jekyll site
-      uses: actions/upload-artifact@v2-preview
+      uses: actions/upload-artifact@v3
       if: always()
       with:
         name: site
@@ -212,9 +212,9 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/') # Only publish tagged commits
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - uses: actions/download-artifact@v2
+    - uses: actions/download-artifact@v3
       with:
         name: ${{ needs.gem.outputs.name }}
 

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Kramdown
+  module PlantUml
+    # Plugs into Kramdown::Converter::Html to provide conversion of PlantUML markup
+    # into beautiful SVG.
+    module ConverterExtension
+      def convert_codeblock(element, indent)
+        return super(element, indent) unless plantuml? element
+
+        convert_plantuml(element.value)
+      end
+
+      private
+
+      def plantuml?(element)
+        element.attr['class'] == 'language-plantuml'
+      end
+
+      def convert_plantuml(plantuml)
+        puml_opts = PlantUml::Options.new(@options)
+        diagram = PlantUml::PlantUmlDiagram.new(plantuml, puml_opts)
+        diagram.svg.to_s
+      rescue StandardError => e
+        raise e if puml_opts.nil? || puml_opts.raise_errors?
+
+        logger = PlantUml::LogWrapper.init
+        logger.error "Error while converting diagram: #{e.inspect}"
+      end
+    end
+  end
+end

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,52 +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_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.0'
+    VERSION = '1.3.3'
   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,46 +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'
+require_relative 'kramdown-plantuml/converter_extension'
 
-module Kramdown
-  module Converter
-    # Plugs into Kramdown::Converter::Html to provide conversion of PlantUML markup
-    # into beautiful SVG.
-    class Html
-      alias super_convert_codeblock convert_codeblock
-
-      def convert_codeblock(element, indent)
-        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)
-      end
-
-      private
-
-      def plantuml?(element)
-        element.attr['class'] == 'language-plantuml'
-      end
-
-      def convert_plantuml(plantuml, options)
-        diagram = ::Kramdown::PlantUml::PlantUmlDiagram.new(plantuml, options)
-        diagram.svg.to_s
-      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
-end
+Kramdown::Converter::Html.prepend Kramdown::PlantUml::ConverterExtension

data/pom.xml

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

metadata

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