jekyll-kroki 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50b7f01538196d5f83bb7d6a53c39ec6f4ea3e341081805564e1bafe3e3aa380
-  data.tar.gz: fad323a88f082cc7bfddb35078246569d1b58e9ffa5a391f1344f4b9f55b5304
+  metadata.gz: 39c2c3f9463c5788864d00c4ed80e9aa826a1aa1d1380dbff2be92407958f0e5
+  data.tar.gz: 38340a5a1deaa705a0b7cde596e5eb007da3d84526b2641e9cad6e9f38e86809
 SHA512:
-  metadata.gz: fcba83e90f609bddd69e368f1089a0a0fc399647cc8801eee6a021e2c2fd9eb80abdc66805e811d41b26fd3738d595b561a1ae883d0037d6d8ea5e1e5aba383e
-  data.tar.gz: 1a425cdfcfc65488e0f8014a3dcefd7486943ad4d91a71d9e28915b4fe84fef357826614a642acb93d91401b8822d270c2dea20547c14a11c9fb81a648943f5b
+  metadata.gz: dbedea8bbf380c047c91cee38bc7fade0c9a6a0e3aa8735b7a18e3361219cb796fb3b89b17583db402f0b03bf083f13892d53a7677cc904d12f6be6990bfee98
+  data.tar.gz: 6c3cf11ca513c6b16331547bcd69003b77dd62c3a09b46c52e440684a5001f8c47318962037faa3a0bce5cf1e99c2dfe4a2f5f4e00f4bc0eb893ef0fb174efa6

data/.rubocop.yml

@@ -5,7 +5,7 @@ plugins:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 Gemspec/DevelopmentDependencies:
   EnforcedStyle: gemspec
@@ -23,4 +23,4 @@ Layout/LineLength:
 Metrics/ClassLength:
   Max: 120
 Metrics/MethodLength:
-  Max: 14
+  Max: 16

data/README.md

@@ -49,15 +49,25 @@ The server-side nature of Kroki means that you don't have to deal with installin
 Kroki is available either as a free service or self-hosted using Docker. Organisations that frequently build large Jekyll sites with many diagrams or want maximum control over their data have the option of running their own Kroki instance to provide consistency and use compute resources efficiently.
 
 ### Configuration
-You can specify the URL of the Kroki instance to use in the Jekyll `_config.yml` file:
+You can specify the following parameters in the Jekyll `_config.yml` file:
+
+| Parameter | Default value | Description |
+| --------- | ------------- | ----------- |
+| `url` | `https://kroki.io` | The URL of the Kroki instance to use |
+| `http_retries` | `3` | The number of HTTP retries |
+| `http_timeout` | `15` | The HTTP timeout value in seconds |
+| `max_concurrent_docs` | `8` | The maximum number of Jekyll documents to render concurrently |
+
+For example:
 
 ```yaml
 kroki:
   url: "https://my-kroki.server"
+  http_retries: 3
+  http_timeout: 15
+  max_concurrent_docs: 8
 ```
 
-This is useful if you want to run a Kroki instance locally or your organisation maintains its own private Kroki server. The public Kroki instance https://kroki.io is used by default.
-
 ### Security
 Embedding diagrams as SVGs directly within HTML files can be dangerous. You should only use a Kroki instance that you trust (or run your own!). For additional security, you can configure a [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) using custom Webrick headers in the Jekyll `_config.yml` file:
 

data/jekyll-kroki.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
                       languages into images using Kroki"
   spec.homepage = "https://github.com/felixvanoost/jekyll-kroki"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

data/lib/jekyll/kroki/version.rb

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

data/lib/jekyll/kroki.rb

@@ -15,27 +15,30 @@ require "zlib"
 module Jekyll
   # 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
-                             graphviz mermaid nomnoml nwdiag packetdiag pikchr plantuml rackdiag seqdiag structurizr
-                             svgbob symbolator tikz umlet vega vegalite wavedrom wireviz].freeze
+    DEFAULT_KROKI_URL = "https://kroki.io"
+    DEFAULT_HTTP_RETRIES = 3
+    DEFAULT_HTTP_TIMEOUT = 15
+    DEFAULT_MAX_CONCURRENT_DOCS = 8
     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
+    HTTP_RETRY_INTERVAL = 0.1
+    SUPPORTED_LANGUAGES = %w[actdiag blockdiag bpmn bytefield c4plantuml d2 dbml diagramsnet ditaa erd excalidraw
+                             graphviz mermaid nomnoml nwdiag packetdiag pikchr plantuml rackdiag seqdiag structurizr
+                             svgbob symbolator tikz umlet vega vegalite wavedrom wireviz].freeze
 
     class << self
       # Renders and embeds all diagram descriptions in the given Jekyll site using Kroki.
       #
       # @param [Jekyll::Site] The Jekyll site to embed diagrams in.
       def embed_site(site)
-        kroki_url = kroki_url(site.config)
-        connection = setup_connection(kroki_url)
+        kroki_url = get_kroki_url(site.config)
+        http_retries = get_http_retries(site.config)
+        http_timeout = get_http_timeout(site.config)
+        connection = setup_connection(kroki_url, http_retries, http_timeout)
 
-        rendered_diag = embed_docs_in_site(site, connection)
+        max_concurrent_docs = get_max_concurrent_docs(site.config)
+        rendered_diag = embed_docs_in_site(site, connection, max_concurrent_docs)
         unless rendered_diag.zero?
           puts "[jekyll-kroki] Rendered #{rendered_diag} diagrams using Kroki instance at '#{kroki_url}'"
         end
@@ -44,21 +47,22 @@ module Jekyll
       end
 
       # 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.
+      # are rendered concurrently up to the limit defined by DEFAULT_MAX_CONCURRENT_DOCS.
       #
       # @param [Jekyll::Site] The Jekyll site to embed diagrams in.
       # @param [Faraday::Connection] The Faraday connection to use.
+      # @param [Integer] The maximum number of documents to render concurrently.
       # @return [Integer] The number of successfully rendered diagrams.
-      def embed_docs_in_site(site, connection)
+      def embed_docs_in_site(site, connection, max_concurrent_docs)
         rendered_diag = 0
-        semaphore = Async::Semaphore.new(MAX_CONCURRENT_DOCS)
+        semaphore = Async::Semaphore.new(max_concurrent_docs)
 
         Async do |task|
-          tasks = (site.pages + site.documents).map do |doc|
+          tasks = (site.pages + site.documents).filter_map do |doc|
             next unless embeddable?(doc)
 
             async_embed_single_doc(task, semaphore, connection, doc)
-          end.compact
+          end
 
           rendered_diag = tasks.sum(&:wait)
         end
@@ -154,14 +158,16 @@ module Jekyll
       # Sets up a new Faraday connection.
       #
       # @param [URI::HTTP] The URL of the Kroki instance.
+      # @param [Integer] The number of retries.
+      # @param [Integer] The timeout value in seconds.
       # @return [Faraday::Connection] The Faraday connection.
-      def setup_connection(kroki_url)
-        retry_options = { max: HTTP_MAX_RETRIES, interval: HTTP_RETRY_INTERVAL_SECONDS,
+      def setup_connection(kroki_url, retries, timeout)
+        retry_options = { max: retries, interval: HTTP_RETRY_INTERVAL,
                           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: HTTP_TIMEOUT_SECONDS }) do |builder|
+        Faraday.new(url: kroki_url, request: { timeout: timeout }) do |builder|
           builder.adapter :httpx, persistent: true
           builder.request :retry, retry_options
           builder.response :json, content_type: /\bjson$/
@@ -173,17 +179,38 @@ module Jekyll
       #
       # @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)
-        else
-          url = KROKI_DEFAULT_URL
-        end
+      def get_kroki_url(config)
+        url = config.fetch("kroki", {}).fetch("url", DEFAULT_KROKI_URL)
+        raise TypeError, "'url' is not a valid HTTP URL" unless URI.parse(url).is_a?(URI::HTTP)
+
         URI(url)
       end
 
-      # Determines whether a document may contain embeddable diagram descriptions - it is in HTML format and is either
+      # Gets the number of HTTP retries.
+      #
+      # @param The Jekyll site configuration.
+      # @return [Integer] The number of HTTP retries.
+      def get_http_retries(config)
+        config.fetch("kroki", {}).fetch("http_retries", DEFAULT_HTTP_RETRIES)
+      end
+
+      # Gets the HTTP timeout value.
+      #
+      # @param The Jekyll site configuration.
+      # @return [Integer] The HTTP timeout value in seconds.
+      def get_http_timeout(config)
+        config.fetch("kroki", {}).fetch("http_timeout", DEFAULT_HTTP_TIMEOUT)
+      end
+
+      # Gets the maximum number of documents to render concurrently.
+      #
+      # @param The Jekyll site configuration.
+      # @return [Integer] The maximum number of documents to render concurrently.
+      def get_max_concurrent_docs(config)
+        config.fetch("kroki", {}).fetch("max_concurrent_docs", DEFAULT_MAX_CONCURRENT_DOCS)
+      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 embeddability.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-kroki
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Felix van Oost
@@ -207,7 +207,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="