jekyll-kroki 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '048aeae4ac84f1263d620e1e0a6c434c9186a767132bac28a1c45b211e03be2b'
-  data.tar.gz: 05c14efd136bc6e21c77a9ae5ceaa1d81d32bff50538bc00f31aef804dad4165
+  metadata.gz: 50b7f01538196d5f83bb7d6a53c39ec6f4ea3e341081805564e1bafe3e3aa380
+  data.tar.gz: fad323a88f082cc7bfddb35078246569d1b58e9ffa5a391f1344f4b9f55b5304
 SHA512:
-  metadata.gz: f0e1a7c0a6886a0ca621617b4bcab1e7fe4871ccaec9c0d7d78f123b5027145c5ba51428f898e00f7d2671051194d31be9510db954f9a0392d118d3f80f75d93
-  data.tar.gz: be573dafbf9f2ed85eab43057845d4cf577f9df5ed6029184400845e51d6301cff14e04d0fbcfb6bf782e457a9cbf0ec67f14c12aaed51e0e464f1935a23d924
+  metadata.gz: fcba83e90f609bddd69e368f1089a0a0fc399647cc8801eee6a021e2c2fd9eb80abdc66805e811d41b26fd3738d595b561a1ae883d0037d6d8ea5e1e5aba383e
+  data.tar.gz: 1a425cdfcfc65488e0f8014a3dcefd7486943ad4d91a71d9e28915b4fe84fef357826614a642acb93d91401b8822d270c2dea20547c14a11c9fb81a648943f5b

data/.devcontainer/devcontainer.json

@@ -1,9 +1,10 @@
 {
 	"name": "Ruby",
-	"image": "mcr.microsoft.com/devcontainers/ruby:3.0-bullseye",
+	"image": "mcr.microsoft.com/devcontainers/ruby:3.4-bullseye",
 	"customizations": {
 		"vscode": {
 			"extensions": [
+				"GitHub.vscode-github-actions",
 				"streetsidesoftware.code-spell-checker"
 			]
 		}

data/.rubocop.yml

@@ -1,6 +1,15 @@
+plugins:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.6
 
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
@@ -11,5 +20,7 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+Metrics/ClassLength:
+  Max: 120
 Metrics/MethodLength:
-  Max: 14
+  Max: 14

data/README.md

@@ -32,7 +32,7 @@ When Jekyll builds your site, the `jekyll-kroki` plugin will encode the diagrams
 
 ![sample-diagram](https://github.com/felixvanoost/jekyll-kroki/assets/10233016/244d2ec4-b09b-4a5f-8164-3851574c3dd2)
 
-The site remains truly static as the images are directly embedded in the HTML files served by Jekyll. Jekyll only depends on the Kroki server (which can also be run locally) during the build stage, and all of the client-side processing that is normally used to render diagrams into images is eliminated.
+The site remains fully static as the images are directly embedded in the HTML files served by Jekyll. Jekyll only depends on the Kroki server - which can also be run locally - during the build stage, and all of the client-side processing that is normally used to render diagrams into images is eliminated.
 
 ### Advantages
 

data/jekyll-kroki.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   # Load the files that are versioned in Git into the RubyGem.
   spec.files = Dir.chdir(__dir__) do
@@ -28,13 +29,17 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "faraday", ["~> 2.7"]
-  spec.add_runtime_dependency "faraday-retry", ["~> 2.2"]
-  spec.add_runtime_dependency "httpx", ["~> 1.1"]
-  spec.add_runtime_dependency "jekyll", ["~> 4"]
-  spec.add_runtime_dependency "nokogiri", ["~> 1.15"]
+  spec.add_dependency "async", ["~> 2.25"]
+  spec.add_dependency "faraday", ["~> 2.7"]
+  spec.add_dependency "faraday-retry", ["~> 2.2"]
+  spec.add_dependency "httpx", ["~> 1.1"]
+  spec.add_dependency "jekyll", ["~> 4"]
+  spec.add_dependency "nokogiri", ["~> 1.15"]
 
   spec.add_development_dependency "minitest", ["~> 5.0"]
   spec.add_development_dependency "rake", ["~> 13.0"]
   spec.add_development_dependency "rubocop", ["~> 1.21"]
+  spec.add_development_dependency "rubocop-minitest", ["~> 0.38"]
+  spec.add_development_dependency "rubocop-performance", ["~> 1.25"]
+  spec.add_development_dependency "rubocop-rake", ["~> 0.7"]
 end

data/lib/jekyll/kroki/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   class Kroki
-    VERSION = "0.3.3"
+    VERSION = "0.4.0"
   end
 end

data/lib/jekyll/kroki.rb

@@ -2,6 +2,8 @@
 
 require_relative "kroki/version"
 
+require "async"
+require "async/semaphore"
 require "base64"
 require "faraday"
 require "faraday/retry"
@@ -11,7 +13,7 @@ require "nokogiri"
 require "zlib"
 
 module Jekyll
-  # Converts diagram descriptions into images using Kroki
+  # Converts diagram descriptions into images using Kroki.
   class Kroki
     KROKI_DEFAULT_URL = "https://kroki.io"
     SUPPORTED_LANGUAGES = %w[actdiag blockdiag bpmn bytefield c4plantuml d2 dbml diagramsnet ditaa erd excalidraw
@@ -19,24 +21,21 @@ module Jekyll
                              svgbob symbolator tikz umlet vega vegalite wavedrom wireviz].freeze
     EXPECTED_HTML_TAGS = %w[code div].freeze
     HTTP_MAX_RETRIES = 3
+    HTTP_RETRY_INTERVAL_BACKOFF_FACTOR = 2
+    HTTP_RETRY_INTERVAL_RANDOMNESS = 0.5
+    HTTP_RETRY_INTERVAL_SECONDS = 0.1
+    HTTP_TIMEOUT_SECONDS = 15
+    MAX_CONCURRENT_DOCS = 8
 
     class << self
-      # Renders and embeds all diagram descriptions in a Jekyll site using Kroki.
+      # Renders and embeds all diagram descriptions in the given Jekyll site using Kroki.
       #
-      # @param [Jekyll::Site] The Jekyll site to embed diagrams in
+      # @param [Jekyll::Site] The Jekyll site to embed diagrams in.
       def embed_site(site)
-        # Get the URL of the Kroki instance
         kroki_url = kroki_url(site.config)
         connection = setup_connection(kroki_url)
 
-        rendered_diag = 0
-        (site.pages + site.documents).each do |doc|
-          next unless embeddable?(doc)
-
-          # Render all supported diagram descriptions in the document
-          rendered_diag += embed_doc(connection, doc)
-        end
-
+        rendered_diag = embed_docs_in_site(site, connection)
         unless rendered_diag.zero?
           puts "[jekyll-kroki] Rendered #{rendered_diag} diagrams using Kroki instance at '#{kroki_url}'"
         end
@@ -44,37 +43,78 @@ module Jekyll
         exit(e)
       end
 
-      # Renders all supported diagram descriptions in a document and embeds them as inline SVGs in the HTML source.
+      # Renders the diagram descriptions in all Jekyll pages and documents in the given Jekyll site. Pages / documents
+      # are rendered concurrently up to the limit defined by MAX_CONCURRENT_DOCS.
       #
-      # @param [Faraday::Connection] The Faraday connection to use
-      # @param [Nokogiri::HTML4::Document] The parsed HTML document
-      # @param [Integer] The number of rendered diagrams
-      def embed_doc(connection, doc)
-        # Parse the HTML document
+      # @param [Jekyll::Site] The Jekyll site to embed diagrams in.
+      # @param [Faraday::Connection] The Faraday connection to use.
+      # @return [Integer] The number of successfully rendered diagrams.
+      def embed_docs_in_site(site, connection)
+        rendered_diag = 0
+        semaphore = Async::Semaphore.new(MAX_CONCURRENT_DOCS)
+
+        Async do |task|
+          tasks = (site.pages + site.documents).map do |doc|
+            next unless embeddable?(doc)
+
+            async_embed_single_doc(task, semaphore, connection, doc)
+          end.compact
+
+          rendered_diag = tasks.sum(&:wait)
+        end
+
+        rendered_diag
+      end
+
+      # Renders the supported diagram descriptions in a single document asynchronously, respecting the concurrency limit
+      # imposed by the provided semaphore.
+      #
+      # @param [Async::Task] The parent async task to spawn a child task from.
+      # @param [Async::Semaphore] A semaphore to limit concurrency.
+      # @param [Faraday::Connection] The Faraday connection to use.
+      # @param [Jekyll::Page, Jekyll::Document] The document to process.
+      # @return [Integer] The number of successfully rendered diagrams.
+      def async_embed_single_doc(task, semaphore, connection, doc)
+        task.async do
+          semaphore.async { embed_single_doc(connection, doc) }.wait
+        rescue StandardError => e
+          warn "[jekyll-kroki] Error rendering diagram: #{e.message}".red
+          0
+        end
+      end
+
+      # Renders the supported diagram descriptions in a single document and embeds them as inline SVGs in the HTML
+      # source.
+      #
+      # @param [Faraday::Connection] The Faraday connection to use.
+      # @param [Jekyll::Page, Jekyll::Document] The document to process.
+      # @return [Integer] The number of successfully rendered diagrams.
+      def embed_single_doc(connection, doc)
+        # Parse the HTML document.
         parsed_doc = Nokogiri::HTML(doc.output)
 
         rendered_diag = 0
         SUPPORTED_LANGUAGES.each do |language|
           EXPECTED_HTML_TAGS.each do |tag|
             parsed_doc.css("#{tag}[class~='language-#{language}']").each do |diagram_desc|
-              # Replace the diagram description with the SVG representation rendered by Kroki
+              # Replace the diagram description with the SVG representation rendered by Kroki.
               diagram_desc.replace(render_diagram(connection, diagram_desc, language))
               rendered_diag += 1
             end
           end
         end
 
-        # Convert the document back to HTML
+        # Convert the document back to HTML.
         doc.output = parsed_doc.to_html
         rendered_diag
       end
 
       # Renders a single diagram description using Kroki.
       #
-      # @param [Faraday::Connection] The Faraday connection to use
-      # @param [String] The diagram description
-      # @param [String] The language of the diagram description
-      # @return [String] The rendered diagram in SVG format
+      # @param [Faraday::Connection] The Faraday connection to use.
+      # @param [String] The diagram description.
+      # @param [String] The language of the diagram description.
+      # @return [String] The rendered diagram in SVG format.
       def render_diagram(connection, diagram_desc, language)
         begin
           response = connection.get("#{language}/svg/#{encode_diagram(diagram_desc.text)}")
@@ -94,8 +134,8 @@ module Jekyll
       # Sanitises a rendered diagram. Only <script> elements are removed, which is the most minimal / naive
       # implementation possible.
       #
-      # @param [String] The diagram to santise in SVG format
-      # @return [String] The sanitised diagram
+      # @param [String] The diagram to santise in SVG format.
+      # @return [String] The sanitised diagram.
       def sanitise_diagram(diagram_svg)
         parsed_svg = Nokogiri::XML(diagram_svg)
         parsed_svg.xpath('//*[name()="script"]').each(&:remove)
@@ -105,21 +145,23 @@ module Jekyll
       # Encodes the diagram into Kroki format using deflate + base64.
       # See https://docs.kroki.io/kroki/setup/encode-diagram/.
       #
-      # @param [String, #read] The diagram description to encode
-      # @return [String] The encoded diagram
+      # @param [String, #read] The diagram description to encode.
+      # @return [String] The encoded diagram.
       def encode_diagram(diagram_desc)
         Base64.urlsafe_encode64(Zlib.deflate(diagram_desc))
       end
 
       # Sets up a new Faraday connection.
       #
-      # @param [URI::HTTP] The URL of the Kroki instance
-      # @return [Faraday::Connection] The Faraday connection
+      # @param [URI::HTTP] The URL of the Kroki instance.
+      # @return [Faraday::Connection] The Faraday connection.
       def setup_connection(kroki_url)
-        retry_options = { max: HTTP_MAX_RETRIES, interval: 0.1, interval_randomness: 0.5, backoff_factor: 2,
+        retry_options = { max: HTTP_MAX_RETRIES, interval: HTTP_RETRY_INTERVAL_SECONDS,
+                          interval_randomness: HTTP_RETRY_INTERVAL_RANDOMNESS,
+                          backoff_factor: HTTP_RETRY_INTERVAL_BACKOFF_FACTOR,
                           exceptions: [Faraday::RequestTimeoutError, Faraday::ServerError] }
 
-        Faraday.new(url: kroki_url, request: { timeout: 5 }) do |builder|
+        Faraday.new(url: kroki_url, request: { timeout: HTTP_TIMEOUT_SECONDS }) do |builder|
           builder.adapter :httpx, persistent: true
           builder.request :retry, retry_options
           builder.response :json, content_type: /\bjson$/
@@ -129,23 +171,22 @@ module Jekyll
 
       # Gets the URL of the Kroki instance to use for rendering diagrams.
       #
-      # @param The Jekyll site configuration
-      # @return [URI::HTTP] The URL of the Kroki instance
+      # @param The Jekyll site configuration.
+      # @return [URI::HTTP] The URL of the Kroki instance.
       def kroki_url(config)
         if config.key?("kroki") && config["kroki"].key?("url")
           url = config["kroki"]["url"]
           raise TypeError, "'url' is not a valid HTTP URL" unless URI.parse(url).is_a?(URI::HTTP)
-
-          URI(url)
         else
-          URI(KROKI_DEFAULT_URL)
+          url = KROKI_DEFAULT_URL
         end
+        URI(url)
       end
 
       # Determines whether a document may contain embeddable diagram descriptions - it is in HTML format and is either
       # a Jekyll::Page or writeable Jekyll::Document.
       #
-      # @param [Jekyll::Page or Jekyll::Document] The document to check for embedability
+      # @param [Jekyll::Page or Jekyll::Document] The document to check for embeddability.
       def embeddable?(doc)
         doc.output_ext == ".html" && (doc.is_a?(Jekyll::Page) || doc.write?)
       end
@@ -153,7 +194,7 @@ module Jekyll
       # Exits the Jekyll process without returning a stack trace. This method does not return because the process is
       # abruptly terminated.
       #
-      # @param [StandardError] The error to display in the termination message
+      # @param [StandardError] The error to display in the termination message.
       # @param [int] The caller index to display in the termination message. The default index is 1, which means the
       #              calling method. To specify the calling method's caller, pass in 2.
       #
@@ -162,7 +203,7 @@ module Jekyll
         raise error
       rescue StandardError => e
         file, line_number, caller = e.backtrace[caller_index].split(":")
-        caller = caller.tr("`", "'")
+        caller = caller.tr("", "'")
         warn %([jekyll-kroki] "#{error.message}" #{caller} on line #{line_number} of #{file}).red
         exec "exit 1"
       end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-kroki
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Felix van Oost
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -122,10 +135,51 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: |-
   A Jekyll plugin to convert diagram descriptions written in over 25 popular diagram scripting
                         languages into images using Kroki
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -145,7 +199,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/felixvanoost/jekyll-kroki
   source_code_uri: https://github.com/felixvanoost/jekyll-kroki
-post_install_message: 
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A Jekyll plugin to convert diagram descriptions into images using Kroki
 test_files: []