jekyll_remote_plantuml_plugin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 967fc61058c4df183be6629dda3ec094fc315e902fc28b20174136537abe495a
+  data.tar.gz: 8dea1992278c76251aa93fae9bf98d86ca7c0988bab2bd907e4cce8d1208c2e3
+SHA512:
+  metadata.gz: 85bcc911939780f5c058f1a27571bf9f169cf6c33722c483670f80eb2c50789fad22f5beec5775dad04be24f557aef74930e84d4729a93577215b14e8c901383
+  data.tar.gz: f1c2e0808ecb7a53d60031231cf57f36541f9b65e45d2de1da361093e0822bfef7b276f4b4c717212918ddd373ebf97569f517b66f3e60b97bbd883f11984b30

data/lib/jekyll_remote_plantuml_plugin.rb

@@ -0,0 +1,5 @@
+require_relative "jekyll_remote_plantuml_plugin/utils"
+require_relative "jekyll_remote_plantuml_plugin/jekyll_remote_plantuml_plugin"
+require_relative "jekyll_remote_plantuml_plugin/version"
+
+Liquid::Template.register_tag("plantuml", JekyllRemotePlantUMLPlugin::Block)

data/lib/jekyll_remote_plantuml_plugin/jekyll_remote_plantuml_plugin.rb

@@ -0,0 +1,145 @@
+require "liquid"
+require "digest"
+
+module JekyllRemotePlantUMLPlugin
+  class Block < Liquid::Block
+    include Utils::Common
+    include Utils::PlantUML
+    include Utils::Encode
+
+    FORMATS = %w[png svg].freeze
+    CONFIG_OPTIONS = %i[
+      provider
+      format
+      save_images_locally cache_dir
+      div_class div_style
+      img_class img_style img_id img_width img_height img_alt
+    ].freeze
+    TAG_OPTIONS = CONFIG_OPTIONS.dup.tap do |h|
+      %i[provider save_images_locally cache_dir].each do |k|
+        h.delete(k)
+      end
+    end.freeze
+    DEFAULT_CONFIG_OPTIONS = {
+      provider: "http://www.plantuml.com/plantuml",
+      format: "svg",
+      save_images_locally: false,
+      cache_dir: "plantuml",
+      div_class: "plantuml",
+      img_class: "plantuml"
+    }.freeze
+
+    PARAMS_SYNTAX = /
+        ([\w-]+)\s*=\s*
+        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w.-]+))
+      /x.freeze
+
+    def initialize(tag_name, markup, _)
+      super
+      @markup = markup.strip
+    end
+
+    def render(context)
+      content = super(context).strip
+      options = tag_options(context)
+
+      check_format(options[:format])
+
+      url = generate_url(options[:provider], encode(content), options[:format])
+      img_src_attr = options[:save_images_locally] ? img_local_src(context, content, url, options) : url
+      prepare_html(img_src_attr, options)
+    end
+
+    private
+
+    def tag_options(context)
+      tag_options = parse_params(context)
+
+      # delete unsupported options
+      tag_options.each { |key, _| tag_options.delete(key) unless TAG_OPTIONS.include?(key) }
+
+      # merge with config options
+      configuration_options.merge(tag_options)
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def parse_params(context)
+      {}.tap do |params|
+        @markup.scan(PARAMS_SYNTAX) do |key, d_quoted, s_quoted, variable|
+          params[key] = if d_quoted
+                          d_quoted.include?('\\"') ? d_quoted.gsub('\\"', '"') : d_quoted
+                        elsif s_quoted
+                          s_quoted.include?("\\'") ? s_quoted.gsub("\\'", "'") : s_quoted
+                        elsif variable
+                          context[variable]
+                        end
+        end
+      end.transform_keys(&:to_sym)
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def configuration_options
+      @configuration_options ||= Jekyll.configuration({})["plantuml"].transform_keys(&:to_sym).tap do |conf|
+        # delete unsupported options
+        conf.each { |key, _| conf.delete(key) unless CONFIG_OPTIONS.include?(key) }
+
+        # set defaults
+        DEFAULT_CONFIG_OPTIONS.each { |key, value| conf[key] = value if conf[key].nil? }
+      end
+    end
+
+    def img_local_src(context, content, url, options)
+      # prepare source image path
+      site = context.registers[:site]
+      image_basename = "#{Digest::SHA1.hexdigest encode(content)}.#{options[:format]}"
+      source_image_path = File.join(site.source, options[:cache_dir], image_basename)
+
+      unless File.exist?(source_image_path)
+        begin
+          download_image(url, source_image_path)
+        rescue StandardError => e
+          raise <<~TEXT
+            The download of the PlantUml diagram image failed: #{e}
+    
+            === CONTENT START
+            #{content}
+            === CONTENT END
+
+            URL: #{url}
+          TEXT
+        end
+
+        # make the image available in the destination directory
+        site.static_files << Jekyll::StaticFile.new(site, site.source, options[:cache_dir], image_basename)
+      end
+
+      "/#{join_paths(site.baseurl, options[:cache_dir], image_basename)}"
+    end
+
+    def check_format(format)
+      raise "Invalid PlantUML diagram format \"#{format}\"" unless FORMATS.include?(format)
+    end
+
+    def prepare_html(img_src_attr, options)
+      div_tag = ""
+      div_tag += "<div#{prepare_optional_attrs_content("div_", options)}>"
+      img_tag = "<img src=\"#{img_src_attr}\"#{prepare_optional_attrs_content("img_", options)} />"
+      div_tag += "\n  #{img_tag}\n"
+      "#{div_tag}</div>"
+    end
+
+    def prepare_optional_attrs_content(prefix, options)
+      result = ""
+      TAG_OPTIONS.each do |key|
+        next if !key.to_s.start_with?(prefix) || options[key].nil? || options[key].empty?
+
+        attribute_name = key.to_s.reverse.chomp(prefix.reverse).reverse
+        attribute_value = options[key]
+
+        result += " #{attribute_name}=\"#{attribute_value}\""
+      end
+
+      result
+    end
+  end
+end

data/lib/jekyll_remote_plantuml_plugin/utils.rb

@@ -0,0 +1,93 @@
+require "open-uri"
+require "zlib"
+
+module JekyllRemotePlantUMLPlugin
+  module Utils
+    module Common
+      def download_image(url, dest_path)
+        dest_dir = File.dirname(dest_path)
+        FileUtils.mkdir_p(dest_dir) unless File.directory?(dest_dir)
+
+        uri = URI.parse(url)
+        uri.open do |f|
+          File.open(dest_path, "wb") do |file|
+            file << f.read
+          end
+        end
+      end
+    end
+
+    module Encode
+      def encode(content)
+        encoded = content.force_encoding("utf-8")
+        encoded = Zlib::Deflate.new(nil, -Zlib::MAX_WBITS).deflate(encoded, Zlib::FINISH)
+        encode64(encoded)
+      end
+
+      def encode64(content)
+        length = content.length
+        ind = 0
+        out = ""
+
+        while ind < length
+          i1 = ind + 1 < length ? content[ind + 1].ord : 0
+          i2 = ind + 2 < length ? content[ind + 2].ord : 0
+          out += append3bytes(content[ind].ord, i1, i2)
+          ind += 3
+        end
+
+        out
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def append3bytes(bit1, bit2, bit3)
+        c1 = bit1 >> 2
+        c2 = ((bit1 & 0x3) << 4) | (bit2 >> 4)
+        c3 = ((bit2 & 0xF) << 2) | (bit3 >> 6)
+        c4 = bit3 & 0x3F
+        encode6bit(c1 & 0x3F).chr +
+          encode6bit(c2 & 0x3F).chr +
+          encode6bit(c3 & 0x3F).chr +
+          encode6bit(c4 & 0x3F).chr
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      # rubocop:disable Naming/MethodParameterName
+      def encode6bit(b)
+        return (48 + b).chr if b < 10
+
+        b -= 10
+        return (65 + b).chr if b < 26
+
+        b -= 26
+        return (97 + b).chr if b < 26
+
+        b -= 26
+        return "-" if b.zero?
+
+        b == 1 ? "_" : "?"
+      end
+      # rubocop:enable Naming/MethodParameterName
+    end
+
+    module PlantUML
+      def generate_url(provider, encoded_content, format)
+        join_paths(provider, format, encoded_content).to_s
+      end
+
+      def join_paths(*paths, separator: "/")
+        paths = paths.compact.reject(&:empty?)
+        last = paths.length - 1
+        paths.each_with_index.map do |path, index|
+          expand_path(path, index, last, separator)
+        end.join
+      end
+
+      def expand_path(path, current, last, separator)
+        path = path[1..] if path.start_with?(separator) && current.zero?
+        path = [path, separator] unless path.end_with?(separator) || current == last
+        path
+      end
+    end
+  end
+end

data/lib/jekyll_remote_plantuml_plugin/version.rb

@@ -0,0 +1,3 @@
+module JekyllRemotePlantUMLPlugin
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_remote_plantuml_plugin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Igrychev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- alexey.igrychev@flant.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll_remote_plantuml_plugin.rb
+- lib/jekyll_remote_plantuml_plugin/jekyll_remote_plantuml_plugin.rb
+- lib/jekyll_remote_plantuml_plugin/utils.rb
+- lib/jekyll_remote_plantuml_plugin/version.rb
+homepage: https://github.com/flant/jekyll_remote_plantuml_plugin
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/flant/jekyll_remote_plantuml_plugin
+  source_code_uri: https://github.com/flant/jekyll_remote_plantuml_plugin
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin that allows including local/remote PlantUML diagrams into your
+  pages, works only with an external PlantUML server (http://www.plantuml.com/plantuml
+  by default) — PlantUML jar installed locally not required.
+test_files: []