kramdown-plantuml 1.0.1 → 1.1.2

data/lib/kramdown-plantuml/plantuml_result.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'logger'
+require_relative 'plantuml_error'
+
+module Kramdown
+  module PlantUml
+    # Executes the PlantUML Java application.
+    class PlantUmlResult
+      attr_reader :stdout, :stderr, :exitcode
+
+      def initialize(stdout, stderr, status)
+        @stdout = stdout
+        @stderr = stderr
+        @exitcode = status.exitstatus
+        @logger = Logger.init
+      end
+
+      def without_xml_prologue
+        return @stdout if @stdout.nil? || @stdout.empty?
+
+        xml_prologue_start = '<?xml'
+        xml_prologue_end = '?>'
+
+        start_index = @stdout.index(xml_prologue_start)
+
+        return @stdout if start_index.nil?
+
+        end_index = @stdout.index(xml_prologue_end, xml_prologue_start.length)
+
+        return @stdout if end_index.nil?
+
+        end_index += xml_prologue_end.length
+
+        @stdout.slice! start_index, end_index
+
+        @stdout
+      end
+
+      def validate(plantuml)
+        raise PlantUmlError.new(plantuml, @stderr, @exitcode) if PlantUmlError.should_raise?(@exitcode, @stderr)
+
+        return if @stderr.nil? || @stderr.empty?
+
+        @logger.debug 'kramdown-plantuml: PlantUML log:'
+        @logger.debug_with_prefix 'kramdown-plantuml: ', @stderr
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/themer.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: false
+
+require_relative 'hash'
+require_relative 'logger'
+
+module Kramdown
+  module PlantUml
+    # Provides theming support for PlantUML
+    class Themer
+      attr_reader :theme_name, :theme_directory
+
+      def initialize(options = {})
+        options = options.symbolize_keys unless options.nil?
+        @logger = Logger.init
+        @logger.debug "kramdown-plantuml: Options: #{options}"
+        @theme_name, @theme_directory = theme_options(options)
+      end
+
+      def apply_theme(plantuml)
+        if plantuml.nil? || plantuml.empty?
+          @logger.debug 'kramdown-plantuml: Empty diagram.'
+          return plantuml
+        end
+
+        if @theme_name.nil? || @theme_name.empty?
+          @logger.debug 'kramdown-plantuml: No theme to apply.'
+          return plantuml
+        end
+
+        theme(plantuml)
+      end
+
+      private
+
+      def theme_options(options)
+        return nil if options.nil? || !options.key?(:theme)
+
+        theme = options[:theme] || {}
+        theme_name = theme.key?(:name) ? theme[:name] : nil
+        theme_directory = theme.key?(:directory) ? theme[:directory] : nil
+
+        [theme_name, theme_directory]
+      end
+
+      def theme(plantuml)
+        startuml = '@startuml'
+        startuml_index = plantuml.index(startuml) + startuml.length
+
+        return plantuml if startuml_index.nil?
+
+        theme_string = "\n!theme #{@theme_name}"
+        theme_string << " from #{@theme_directory}" unless @theme_directory.nil?
+
+        @logger.debug "kramdown-plantuml: Applying #{theme_string}"
+
+        /@startuml.*/.match(plantuml) do |match|
+          return plantuml.insert match.end(0), theme_string
+        end
+
+        plantuml
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/version.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Kramdown
   module PlantUml
-    @version = ENV['GEM_VERSION'] || '0.0.1-INVALID'
-    VERSION = @version
+    VERSION = '1.1.2'
   end
 end

data/lib/kramdown_html.rb

@@ -1,15 +1,27 @@
+# frozen_string_literal: true
+
 require 'kramdown'
-require "kramdown-plantuml/converter"
+require 'kramdown-parser-gfm'
+require_relative 'kramdown-plantuml/converter'
+require_relative 'kramdown-plantuml/logger'
+require_relative 'kramdown-plantuml/plantuml_error'
+
+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
 
-class Kramdown::Converter::Html
-    alias_method :super_convert_codeblock, :convert_codeblock
+      def convert_codeblock(element, indent)
+        return super_convert_codeblock(element, indent) if element.attr['class'] != 'language-plantuml'
 
-    def convert_codeblock(element, indent)
-        if element.attr["class"] != "language-plantuml"
-            return super_convert_codeblock(element, indent)
-        end
+        plantuml = element.value
+        plantuml_options = @options.key?(:plantuml) ? @options[:plantuml] : {}
+        converter = ::Kramdown::PlantUml::Converter.new(plantuml_options || {})
 
-        converter = Kramdown::PlantUml::Converter.new
-        return converter.convert_plantuml_to_svg(element.value)
+        converter.convert_plantuml_to_svg(plantuml)
+      end
     end
+  end
 end

data/lib/which.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# Wraps the `which` Unix utility
 class Which
   def self.which(cmd)
     exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']

data/pom.xml

@@ -0,0 +1,16 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+                        http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.swedbankpay</groupId>
+    <artifactId>kramdown-plantuml</artifactId>
+    <version>INVALID</version>
+    <name>Kramdown::PlantUml</name>
+    <dependencies>
+        <dependency>
+            <groupId>net.sourceforge.plantuml</groupId>
+            <artifactId>plantuml</artifactId>
+            <version>1.2021.9</version>
+        </dependency>
+    </dependencies>
+</project>

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.2
 platform: ruby
 authors:
-- Asbjørn Ulsberg
+- Swedbank Pay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: open3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,32 +80,108 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description: 
 email:
-- asbjorn@ulsberg.no
+- opensource@swedbankpay.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/codecov.yml"
+- ".github/dependabot.yml"
+- ".github/mergify.yml"
+- ".github/scripts/amend.sh"
+- ".github/scripts/build-gem.sh"
+- ".github/scripts/inspect-gem.sh"
+- ".github/scripts/publish-gem.sh"
+- ".github/scripts/test-gem.sh"
+- ".github/scripts/variables.sh"
+- ".github/workflows/amend.yml"
 - ".github/workflows/no-java.yml"
 - ".github/workflows/no-plantuml.yml"
 - ".github/workflows/ruby.yml"
+- ".github/workflows/shell.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- GitVersion.yml
 - LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/plantuml.1.2020.5.jar
-- bin/setup
+- bin/net/sourceforge/plantuml/plantuml/1.2021.8/plantuml-1.2021.8.jar
 - kramdown-plantuml.gemspec
 - lib/kramdown-plantuml.rb
+- lib/kramdown-plantuml/bool_env.rb
+- lib/kramdown-plantuml/console_logger.rb
 - lib/kramdown-plantuml/converter.rb
+- lib/kramdown-plantuml/executor.rb
+- lib/kramdown-plantuml/hash.rb
+- lib/kramdown-plantuml/logger.rb
+- lib/kramdown-plantuml/plantuml_error.rb
+- lib/kramdown-plantuml/plantuml_result.rb
+- lib/kramdown-plantuml/themer.rb
 - lib/kramdown-plantuml/version.rb
 - lib/kramdown_html.rb
 - lib/which.rb
+- pom.xml
 homepage: https://github.com/SwedbankPay/kramdown-plantuml
 licenses:
 - MIT
@@ -78,15 +196,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Short summary
+summary: kramdown-plantuml allows you to use PlantUML syntax within fenced code blocks
+  with Kramdown (Jekyll's default Markdown parser).
 test_files: []

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "kramdown-plantuml"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here