kramdown-plantuml 1.1.12 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09e8c86eb711f1566f32fce47684f204a1daaef68fd53c7d9837dea2af47eedc'
-  data.tar.gz: 5393660894a40a510b0d709dc5d6c8bfa738a7584c1f59c5f549526827fd99ef
+  metadata.gz: a2a7f9fc36a5af2bb28cc4aa5a6dcf7313e8fbf4efad763783cf165ff4ca0192
+  data.tar.gz: c6732b8d23e7edc5d89c4ca9bb4db9fbd5aeded25b76007bb2fa15a9c32ccdde
 SHA512:
-  metadata.gz: f74720e634e10a0688ee87bc8c85277e07865583f85e87e86b87747e1aec03362ab98a7c85d92a14d399ad06eb6525b12647757809128af77f3d35d782e6bbba
-  data.tar.gz: 013a677b39a48aa8e401fb1d6dfd5340e66e01f564b2188a17fe5437201df7324ed0f4fd37704c137594867513c614ac33f7c8ce26948988225a11f8cd75da23
+  metadata.gz: f9f0d06fbf084ea9b93ef189a6c6c1b43dbc9b73abdfe4f46963b396bdf0e2e5f3340f047f32e75af488072120f76f470febdd3ab91b6d3d87dbd4173213ecca
+  data.tar.gz: d9fd8d226b104f5ba77b6fd50e25add3c8261933a9841b0a454df231afa8d544583a2b584fbb5ac463e8c7526432cf2753f1fa9249d51c743c0a7890403099a5

data/.github/workflows/ruby.yml

@@ -15,13 +15,13 @@ jobs:
         fetch-depth: 0
 
     - name: Setup GitVersion
-      uses: gittools/actions/gitversion/setup@v0.9.10
+      uses: gittools/actions/gitversion/setup@v0.9.11
       with:
         versionSpec: '5.x.x'
 
     - name: Execute GitVersion
       id: gitversion
-      uses: gittools/actions/gitversion/execute@v0.9.10
+      uses: gittools/actions/gitversion/execute@v0.9.11
 
     - name: Create variables
       id: variables

data/README.md

@@ -130,6 +130,37 @@ kramdown:
       directory: path/to/themes
 ```
 
+### Dimensions and Styling
+
+It's possible to customize the dimensions and scale of the diagram by providing
+the `width`, `height` and `scale` configuration keys. It's also possible to add
+arbitrary styling with the `style` key.
+
+`scale` is applied before the diagram is generated, while `width` and `height`
+are applied after, meaning they can be combined (to most likely detrimental
+results, but YOLO).
+
+```yaml
+kramdown:
+  plantuml:
+    width: 200px
+    height: 100px
+    scale: 2
+    style: "border: 1px solid black"
+```
+
+To remove the `width`, `height` and `style` attributes from the `<svg />`
+element, set the key's value to `none`. `scale` does not support a value of
+`none` as it does not need to be removed.
+
+```yaml
+kramdown:
+  plantuml:
+    width: none
+    height: none
+    style: none
+```
+
 ### Errors
 
 By default, `kramdown-plantuml` will raise an error and crash if something goes
@@ -199,7 +230,7 @@ agreement][cla].
 [codacy]:               https://www.codacy.com/gh/SwedbankPay/kramdown-plantuml/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=SwedbankPay/kramdown-plantuml&amp;utm_campaign=Badge_Grade
 [codecov-badge]:        https://codecov.io/gh/SwedbankPay/kramdown-plantuml/branch/main/graph/badge.svg?token=U3QJLVG3HY
 [codecov]:              https://codecov.io/gh/SwedbankPay/kramdown-plantuml/
-[diagram-svg]:          ./spec/examples/diagram.svg
+[diagram-svg]:          ./spec/examples/network-diagram.svg
 [fenced]:               https://www.markdownguide.org/extended-syntax/#syntax-highlighting
 [fork]:                 https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo
 [gem-badge]:            https://badge.fury.io/rb/kramdown-plantuml.svg

data/kramdown-plantuml.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec-html-matchers', '>= 0.9'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
   spec.add_development_dependency 'rubocop', '~> 1.12'
   spec.add_development_dependency 'rubocop-rake', '~> 0.6'

data/lib/kramdown-plantuml/executor.rb

@@ -26,7 +26,7 @@ module Kramdown
 
       def execute(diagram)
         raise ArgumentError, 'diagram cannot be nil' if diagram.nil?
-        raise ArgumentError, "diagram must be a #{Diagram}" unless diagram.is_a?(Diagram)
+        raise ArgumentError, "diagram must be a #{PlantUmlDiagram}" unless diagram.is_a?(PlantUmlDiagram)
 
         cmd = "java -Djava.awt.headless=true -jar #{@plantuml_jar_file} -tsvg -failfast -pipe #{debug_args}"
 

data/lib/kramdown-plantuml/jekyll_page_processor.rb

@@ -13,8 +13,6 @@ module Kramdown
       def initialize(page)
         raise ArgumentError, 'page cannot be nil' if page.nil?
 
-        puts page.class
-
         @page = page
       end
 
@@ -93,8 +91,8 @@ module Kramdown
       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
+        diagram = ::Kramdown::PlantUml::PlantUmlDiagram.new(plantuml, options)
+        diagram.svg
       end
 
       def logger

data/lib/kramdown-plantuml/jekyll_provider.rb

@@ -62,6 +62,14 @@ module Kramdown
 
             processor.process(site.dest)
           end
+
+          site.posts.each do |post|
+            processor = JekyllPageProcessor.new(post)
+
+            next unless processor.should_process?
+
+            processor.process(site.dest)
+          end
         end
 
         def load_jekyll

data/lib/kramdown-plantuml/none_s.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Ruby's Object class.
+class Object
+  # Performs a case insensitive, trimmed comparison of the Object and the
+  # String 'none' and Symbol :none. Returns true if the comparison is true,
+  # otherwise false.
+  #
+  # @return [Boolean] True if the Object is equal to 'none' or :none,
+  # otherwise false.
+  def none_s?
+    return false if nil?
+    return true if self == :none
+
+    to_s.strip.casecmp?('none')
+  end
+end

data/lib/kramdown-plantuml/options.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
+require_relative 'none_s'
 require_relative 'log_wrapper'
 
 module Kramdown
   module PlantUml
     # Options for PlantUML processing
     class Options
-      attr_reader :theme_name, :theme_directory
+      attr_reader :theme_name, :theme_directory, :width, :height, :style, :scale
 
       def initialize(options_hash = {})
         @logger = LogWrapper.init
         @options = massage(options_hash) || {}
         @raise_errors = extract_raise_errors(@options)
         extract_theme_options(@options)
+        extract_style_options(@options)
       end
 
       def raise_errors?
@@ -64,6 +66,24 @@ module Kramdown
         boolean(raise_errors, true)
       end
 
+      def extract_style_options(options)
+        return if options.nil? || options.empty?
+
+        set_instance_property(:width, options)
+        set_instance_property(:height, options)
+        set_instance_property(:style, options)
+        set_instance_property(:scale, options)
+      end
+
+      def set_instance_property(key, options)
+        return unless options.key? key
+
+        value = options[key]
+        value = :none if value.none_s?
+        prop_name = "@#{key}".to_sym
+        instance_variable_set(prop_name, value)
+      end
+
       def massage(options_hash)
         if options_hash.nil? || !options_hash.is_a?(Hash) || options_hash.empty?
           @logger.debug 'No options provided'

data/lib/kramdown-plantuml/{diagram.rb → plantuml_diagram.rb}

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
-require_relative 'version'
-require_relative 'theme'
+require_relative 'executor'
+require_relative 'log_wrapper'
 require_relative 'options'
 require_relative 'plantuml_error'
-require_relative 'log_wrapper'
-require_relative 'executor'
+require_relative 'svg_diagram'
+require_relative 'theme'
+require_relative 'version'
 
 module Kramdown
   module PlantUml
     # Represents a PlantUML diagram that can be converted to SVG.
-    class Diagram
-      attr_reader :theme, :plantuml, :result
+    class PlantUmlDiagram
+      attr_reader :theme, :plantuml, :result, :options
 
       def initialize(plantuml, options)
         raise ArgumentError, 'options cannot be nil' if options.nil?
@@ -25,15 +26,13 @@ module Kramdown
         @logger.warn 'PlantUML diagram is empty' if @plantuml.nil? || @plantuml.empty?
       end
 
-      def convert_to_svg
-        return @svg unless @svg.nil?
-        return @plantuml if @plantuml.nil? || @plantuml.empty?
+      def svg
+        return @svg_diagram unless @svg_diagram.nil?
 
         @plantuml = @theme.apply(@plantuml)
-        log(plantuml)
+        log(@plantuml)
         @result = @executor.execute(self)
-        @result.validate
-        @svg = wrap(@result.without_xml_prologue)
+        @svg_diagram = SvgDiagram.new(@result)
       rescue StandardError => e
         raise e if @options.raise_errors?
 
@@ -42,16 +41,6 @@ module Kramdown
 
       private
 
-      def wrap(svg)
-        theme_class = @theme.name ? "theme-#{@theme.name}" : ''
-        class_name = "plantuml #{theme_class}".strip
-
-        wrapper_element_start = "<div class=\"#{class_name}\">"
-        wrapper_element_end = '</div>'
-
-        "#{wrapper_element_start}#{svg}#{wrapper_element_end}"
-      end
-
       def log(plantuml)
         @logger.debug 'PlantUML converting diagram:'
         @logger.debug_multiline plantuml

data/lib/kramdown-plantuml/plantuml_error.rb

@@ -31,11 +31,11 @@ module Kramdown
       end
 
       def header(result)
-        if theme_not_found?(result) && !result.diagram.nil? && !result.diagram.theme.nil?
+        if theme_not_found?(result) && !result.plantuml_diagram.nil? && !result.plantuml_diagram.theme.nil?
           return <<~HEADER
             Conversion of the following PlantUML result failed because the
-            theme '#{result.diagram.theme.name}' can't be found in the directory
-            '#{result.diagram.theme.directory}':
+            theme '#{result.plantuml_diagram.theme.name}' can't be found in the directory
+            '#{result.plantuml_diagram.theme.directory}':
           HEADER
         end
 
@@ -50,9 +50,9 @@ module Kramdown
       end
 
       def plantuml(result)
-        return nil if result.nil? || result.diagram.nil?
+        return nil if result.nil? || result.plantuml_diagram.nil?
 
-        result.diagram.plantuml
+        result.plantuml_diagram.plantuml
       end
 
       def result(result)

data/lib/kramdown-plantuml/plantuml_result.rb

@@ -2,46 +2,29 @@
 
 require_relative 'log_wrapper'
 require_relative 'plantuml_error'
-require_relative 'diagram'
+require_relative 'svg_diagram'
 
 module Kramdown
   module PlantUml
     # Executes the PlantUML Java application.
     class PlantUmlResult
-      attr_reader :diagram, :stdout, :stderr, :exitcode
+      attr_reader :plantuml_diagram, :stdout, :stderr, :exitcode
 
-      def initialize(diagram, stdout, stderr, exitcode)
-        raise ArgumentError, 'diagram cannot be nil' if diagram.nil?
-        raise ArgumentError, "diagram must be a #{Diagram}" unless diagram.is_a?(Diagram)
+      def initialize(plantuml_diagram, stdout, stderr, exitcode)
+        raise ArgumentError, 'diagram cannot be nil' if plantuml_diagram.nil?
+        raise ArgumentError, "diagram must be a #{PlantUmlDiagram}" unless plantuml_diagram.is_a?(PlantUmlDiagram)
         raise ArgumentError, 'exitcode cannot be nil' if exitcode.nil?
         raise ArgumentError, "exitcode must be a #{Integer}" unless exitcode.is_a?(Integer)
 
-        @diagram = diagram
+        @plantuml_diagram = plantuml_diagram
         @stdout = stdout
         @stderr = stderr
         @exitcode = exitcode
         @logger = LogWrapper.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
+      def svg_diagram
+        @plantuml_diagram.svg
       end
 
       def valid?
@@ -53,7 +36,7 @@ module Kramdown
         @stderr.include?('CoreText note:')
       end
 
-      def validate
+      def validate!
         raise PlantUmlError, self unless valid?
 
         return if @stderr.nil? || @stderr.empty?

data/lib/kramdown-plantuml/style_builder.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'none_s'
+
+module Kramdown
+  module PlantUml
+    # Builds a CSS style string from a hash of style properties.
+    class StyleBuilder
+      def initialize
+        @hash = {}
+      end
+
+      def []=(key, value)
+        return if key.nil?
+
+        case key
+        when :width, :height
+          if none(value)
+            @hash.delete(key)
+          else
+            @hash[key] = value
+          end
+        else
+          self.style = value
+        end
+      end
+
+      def to_s
+        @hash.sort_by { |key, _| key }.map { |key, value| "#{key}:#{value}" }.join(';')
+      end
+
+      private
+
+      def none(value)
+        return true if value.nil?
+
+        value_s = value.to_s.strip
+
+        return true if value_s.empty? || value.none_s?
+
+        false
+      end
+
+      def style=(style)
+        return if style.nil? || style.strip.empty?
+
+        style.split(';').each do |pair|
+          key, value = pair.split(':')
+          key = key.strip.to_sym
+          value = value.strip
+          @hash[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/svg_diagram.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'rexml/document'
+require_relative 'none_s'
+require_relative 'style_builder'
+require_relative 'plantuml_diagram'
+
+module Kramdown
+  module PlantUml
+    # A diagram in SVG format.
+    class SvgDiagram
+      def initialize(plantuml_result)
+        raise ArgumentError, 'plantuml_result cannot be nil' if plantuml_result.nil?
+        raise ArgumentError, "plantuml_result must be a #{PlantUmlResult}" unless plantuml_result.is_a?(PlantUmlResult)
+
+        plantuml_result.validate!
+        svg = plantuml_result.stdout
+        @doc = REXML::Document.new svg
+        @source = plantuml_result.plantuml_diagram
+        @style_builder = StyleBuilder.new
+        transfer_options(plantuml_result)
+      end
+
+      def to_s
+        return '' if @doc.root.nil?
+
+        wrapper_doc = REXML::Document.new
+        wrapper_doc.context[:attribute_quote] = :quote
+        wrapper_element = REXML::Element.new('div').tap do |div|
+          div.add_attribute 'class', wrapper_class_name
+          div.add_element @doc.root
+        end
+
+        wrapper_doc.add_element wrapper_element
+        wrapper_doc.to_s
+      end
+
+      def width
+        get_xml_attribute_value(:width)
+      end
+
+      def height
+        get_xml_attribute_value(:height)
+      end
+
+      def style
+        get_xml_attribute_value(:style)
+      end
+
+      private
+
+      def wrapper_class_name
+        theme_class = @source.theme.name ? "theme-#{@source.theme.name}" : ''
+        "plantuml #{theme_class}".strip
+      end
+
+      def get_xml_attribute_value(attribute_name)
+        return nil if @doc.root.nil?
+
+        name = attribute_name.to_s
+        value = @doc.root.attributes[name]
+        value.nil? || value.none_s? ? :none : value
+      end
+
+      def manipulate_xml_attribute(attribute_name, value)
+        if value.none_s?
+          remove_xml_attribute(attribute_name)
+        elsif !value.nil? && value.is_a?(String) && !value.strip.empty?
+          set_xml_attribute(attribute_name, value)
+        end
+
+        update_style unless attribute_name == :style || style == :none
+      end
+
+      def remove_xml_attribute(attribute_name)
+        @doc.root.attributes.get_attribute(attribute_name.to_s).remove
+      end
+
+      def set_xml_attribute(attribute_name, value)
+        name = attribute_name.to_s
+        @doc.root.attributes[name] = value
+        @style_builder[attribute_name] = value
+      end
+
+      def update_style
+        style = @style_builder.to_s
+        set_xml_attribute(:style, style)
+      end
+
+      def transfer_options(plantuml_result)
+        return if (options = options(plantuml_result)).nil?
+
+        %i[style width height].each do |attribute|
+          options.public_send(attribute).tap do |option_value|
+            next if option_value.nil?
+
+            option_value = option_value.to_s.strip
+
+            next if option_value.empty?
+
+            manipulate_xml_attribute(attribute, option_value)
+          end
+        end
+      end
+
+      def options(plantuml_result)
+        return nil if @doc.root.nil? \
+          || plantuml_result.nil? \
+          || plantuml_result.plantuml_diagram.nil?
+
+        plantuml_result.plantuml_diagram.options
+      end
+    end
+  end
+end

data/lib/kramdown-plantuml/theme.rb

@@ -8,7 +8,7 @@ module Kramdown
   module PlantUml
     # Provides theming support for PlantUML
     class Theme
-      attr_reader :name, :directory
+      attr_reader :name, :directory, :scale
 
       def initialize(options)
         raise ArgumentError, 'options cannot be nil' if options.nil?
@@ -17,6 +17,7 @@ module Kramdown
         @raise_errors = options.raise_errors?
         @logger = LogWrapper.init
         @name = options.theme_name
+        @scale = options.scale
         @directory = resolve options.theme_directory
       end
 
@@ -26,11 +27,6 @@ module Kramdown
           return plantuml
         end
 
-        if @name.nil? || @name.empty?
-          @logger.debug 'No theme to apply.'
-          return plantuml.strip
-        end
-
         theme(plantuml)
       end
 
@@ -59,13 +55,12 @@ module Kramdown
       end
 
       def theme(plantuml)
-        startuml = '@startuml'
-        startuml_index = plantuml.index(startuml) + startuml.length
+        theme_string = build_theme_string
 
-        return plantuml if startuml_index.nil?
-
-        theme_string = "\n!theme #{@name}"
-        theme_string << " from #{@directory}" unless @directory.nil?
+        if theme_string.empty?
+          @logger.debug 'No theme to apply.'
+          return plantuml
+        end
 
         @logger.debug "Applying #{theme_string.strip}"
 
@@ -75,6 +70,18 @@ module Kramdown
 
         plantuml.strip
       end
+
+      def build_theme_string
+        theme_string = ''
+
+        unless @name.nil? || @name.empty?
+          theme_string << "\n!theme #{@name}"
+          theme_string << " from #{@directory}" unless @directory.nil?
+        end
+
+        theme_string << "\nscale #{@scale}" unless @scale.nil?
+        theme_string
+      end
     end
   end
 end

data/lib/kramdown-plantuml/version.rb

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

data/lib/kramdown_html.rb

@@ -5,7 +5,7 @@ require 'kramdown-parser-gfm'
 require_relative 'kramdown-plantuml/log_wrapper'
 require_relative 'kramdown-plantuml/plantuml_error'
 require_relative 'kramdown-plantuml/options'
-require_relative 'kramdown-plantuml/diagram'
+require_relative 'kramdown-plantuml/plantuml_diagram'
 require_relative 'kramdown-plantuml/jekyll_provider'
 
 module Kramdown
@@ -38,8 +38,8 @@ module Kramdown
       end
 
       def convert_plantuml(plantuml, options)
-        diagram = ::Kramdown::PlantUml::Diagram.new(plantuml, options)
-        diagram.convert_to_svg
+        diagram = ::Kramdown::PlantUml::PlantUmlDiagram.new(plantuml, options)
+        diagram.svg.to_s
       rescue StandardError => e
         raise e if options.raise_errors?
 

data/pom.xml

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.1.12
+  version: 1.3.1
 platform: ruby
 authors:
 - Swedbank Pay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -185,14 +199,17 @@ files:
 - lib/kramdown-plantuml.rb
 - lib/kramdown-plantuml/bool_env.rb
 - 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/none_s.rb
 - lib/kramdown-plantuml/options.rb
+- lib/kramdown-plantuml/plantuml_diagram.rb
 - lib/kramdown-plantuml/plantuml_error.rb
 - lib/kramdown-plantuml/plantuml_result.rb
+- lib/kramdown-plantuml/style_builder.rb
+- lib/kramdown-plantuml/svg_diagram.rb
 - lib/kramdown-plantuml/theme.rb
 - lib/kramdown-plantuml/version.rb
 - lib/kramdown-plantuml/which.rb