jekyll-kroki 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22cd7bfae1fa5a37266559c800563db4352a1f7323a65ce15a8058ddae6a7e55
-  data.tar.gz: d76013092f50d163ab83efde344705ec02e8252043d5cd90eadd68903aec472e
+  metadata.gz: 0f353846f7017642be1207c60d318604e0f9c0ee211aee558efe6dc7f4bfbff4
+  data.tar.gz: d65f5ac400887790313a64244d528169238df4820d5828eccc5adf94d06efb46
 SHA512:
-  metadata.gz: eeeeb8d251bcdbaa85429189d11c5ab3aae798b34a28fc4b7742fb195e5ba50af9d450f33dc14db629dc901b5a4e632da77d48abb599ed97b16ae2aa80cd5fee
-  data.tar.gz: 1d2bf0763f3551576b8e1d0f47b4aa8d62f14b01fe25698bd7ad1d043f4dad1a0c723f7ec607db4cae11bb4c4183be4018ae62b56a7803e8622ad83ac57aa12d
+  metadata.gz: 2c0a8a1ad9834f230721440ec19ba2bc9d847ee7f4509e99ddc780a108ffe8fd8d3ccf45182242c88eb088445a92de5dc3a9ebc754466b56b928bb485d65755b
+  data.tar.gz: 8131425affe90d14a5df9f61cf9806b66311f90a5827284e2b191c057c503031b69f58c1bd655ff367695ef59ff2df156439792067b461b0be3446638d892767

data/.devcontainer/devcontainer.json

@@ -0,0 +1,4 @@
+{
+	"name": "Ruby",
+	"image": "mcr.microsoft.com/devcontainers/ruby:3.0-bullseye"
+}

data/.rubocop.yml

@@ -12,4 +12,4 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 120
 Metrics/MethodLength:
-  Max: 12
+  Max: 14

data/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "editor.formatOnSave": true,
+    "editor.rulers": [
+        120
+    ],
+    "rubyLsp.formatter": "rubocop"
+}

data/README.md

@@ -1,5 +1,8 @@
+![Main Workflow](https://github.com/felixvanoost/jekyll-kroki/actions/workflows/main.yml/badge.svg) 
+[![Gem Version](https://badge.fury.io/rb/jekyll-kroki.svg)](https://badge.fury.io/rb/jekyll-kroki)
+
 # jekyll-kroki
-A Jekyll plugin to convert diagram descriptions into images using Kroki
+A [Jekyll](https://jekyllrb.com/) plugin to convert diagram descriptions into images using [Kroki](https://kroki.io/).
 
 ## Installation
 
@@ -13,9 +16,9 @@ end
 
 ## Usage
 
-[Kroki](https://github.com/yuzutech/kroki) supports over 20 popular diagram languages spanning several dozen diagram types. The [examples](https://kroki.io/examples.html) page provides a taste of what's possible.
+Kroki supports over 25 popular diagram scripting languages, including Blockdiag, D2, GraphViz, Mermaid, and PlantUML. The [examples](https://kroki.io/examples.html) page and complete list of [supported diagram languages](https://kroki.io/#support) provide a taste of what's possible.
 
-In Markdown, simply write your diagram description inside a fenced code block with the language specified:
+In Markdown, simply write your diagram descriptions inside a fenced code block with the language specified:
 
 ````
 ```plantuml
@@ -27,13 +30,13 @@ Kroki --> Jekyll: Rendered diagram in SVG format
 ```
 ````
 
-When Jekyll builds your site, the `jekyll-kroki` plugin will encode the diagram, send it to the Kroki server for rendering, then replace the diagram description in the generated HTML with the rendered diagram in SVG format:
+When Jekyll builds your site, the `jekyll-kroki` plugin will encode the diagrams, send them to the Kroki server for rendering, then replace the diagram descriptions in the generated HTML with the rendered images in SVG format:
 
 ![sample-diagram](https://github.com/felixvanoost/jekyll-kroki/assets/10233016/244d2ec4-b09b-4a5f-8164-3851574c3dd2)
 
-The site remains truly static as the SVG is directly embedded in the HTML files that Jekyll serves. 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 truly static as the images are directly embedded in the HTML files that Jekyll serves. 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.
 
-`jekyll-kroki` uses the same Markdown fenced code syntax as the [GitLab Kroki integration](https://docs.gitlab.com/ee/administration/integration/kroki.html), allowing diagram descriptions in Markdown files to be displayed seamlessly in both the GitLab UI and on GitLab Pages sites generated using Jekyll.
+`jekyll-kroki` uses the same Markdown fenced code syntax as the [GitLab Kroki integration](https://docs.gitlab.com/ee/administration/integration/kroki.html), allowing diagram descriptions in Markdown files to be displayed seamlessly as images in both the GitLab UI and on GitLab Pages sites generated using Jekyll.
 
 ### Configuration
 
@@ -44,7 +47,7 @@ kroki:
   url: "https://my-kroki.server"
 ```
 
-This is useful if you want to run a Kroki instance locally or your organisation maintains its own private Kroki server. `jekyll-kroki` will use the public Kroki instance https://kroki.io by default if a URL is not specified.
+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
 

data/jekyll-kroki.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Felix van Oost"]
 
   spec.summary = "A Jekyll plugin to convert diagram descriptions into images using Kroki"
-  spec.description = "Replaces diagram descriptions written in any Kroki-supported language in HTML files generated by
-                      Jekyll with their visual representation in SVG format."
+  spec.description = "A Jekyll plugin to convert diagram descriptions written in over 25 popular diagram scripting
+                      languages into images using Kroki"
   spec.homepage = "https://github.com/felixvanoost/jekyll-kroki"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
 
   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"]
 

data/lib/jekyll/kroki/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   class Kroki
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

data/lib/jekyll/kroki.rb

@@ -5,6 +5,7 @@ require_relative "kroki/version"
 require "base64"
 require "faraday"
 require "faraday/retry"
+require "httpx/adapters/faraday"
 require "jekyll"
 require "nokogiri"
 require "zlib"
@@ -24,27 +25,29 @@ module Jekyll
         kroki_url = kroki_url(site.config)
         puts "[jekyll-kroki] Rendering diagrams using Kroki instance at '#{kroki_url}'"
 
-        # Set up a Faraday connection
         connection = setup_connection(kroki_url)
+        supported_languages = get_supported_languages(connection)
 
-        # Parse the page, render and embed the diagrams, then convert it back into HTML
         site.pages.each do |page|
           next unless embeddable?(page)
 
+          # Parse the page, render and embed the diagrams, then convert it back into HTML
           parsed_page = Nokogiri::HTML(page.output)
-          embed_page(connection, parsed_page)
+          embed_page(connection, supported_languages, parsed_page)
           page.output = parsed_page.to_html
         end
+      rescue StandardError => e
+        exit(e)
       end
 
       # Renders all diagram descriptions in any Kroki-supported language and embeds them in an HTML document.
       #
       # @param [Faraday::Connection] The Faraday connection to use
+      # @param [Array] The supported diagram languages
       # @param [Nokogiri::HTML4::Document] The parsed HTML document
-      def embed_page(connection, parsed_doc)
-        # Iterate through every diagram description in each of the supported languages
-        get_supported_languages(connection).each do |language|
-          parsed_doc.css("code[class~='language-#{language}']").each do |diagram_desc|
+      def embed_page(connection, supported_languages, parsed_page)
+        supported_languages.each do |language|
+          parsed_page.css("code[class~='language-#{language}']").each do |diagram_desc|
             # Replace the diagram description with the SVG representation rendered by Kroki
             diagram_desc.replace(render_diagram(connection, diagram_desc, language))
           end
@@ -102,12 +105,13 @@ module Jekyll
       # @param [Faraday::Connection] The Faraday connection to use
       # @return [Array] The supported diagram languages
       def get_supported_languages(connection)
-        begin
-          response = connection.get("health")
-        rescue Faraday::Error => e
-          raise e.response[:body]
-        end
-        response.body["version"].keys
+        response = connection.get("health")
+        supported_languages = response.body["version"]&.keys
+        raise "'#{connection.url_prefix}' does not point to a valid Kroki instance" if supported_languages.nil?
+
+        supported_languages
+      rescue Faraday::Error => e
+        raise e
       end
 
       # Sets up a new Faraday connection.
@@ -118,7 +122,8 @@ module Jekyll
         retry_options = { max: HTTP_MAX_RETRIES, interval: 0.1, interval_randomness: 0.5, backoff_factor: 2,
                           exceptions: [Faraday::RequestTimeoutError, Faraday::ServerError] }
 
-        Faraday.new(url: kroki_url) do |builder|
+        Faraday.new(url: kroki_url, request: { timeout: 5 }) do |builder|
+          builder.adapter :httpx, persistent: true
           builder.request :retry, retry_options
           builder.response :json, content_type: /\bjson$/
           builder.response :raise_error
@@ -147,6 +152,23 @@ module Jekyll
       def embeddable?(doc)
         doc.output_ext == ".html" && (doc.is_a?(Jekyll::Page) || doc.write?)
       end
+
+      # 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 [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.
+      #
+      # Source: https://www.mslinn.com/ruby/2200-crash-exit.html
+      def exit(error, caller_index = 1)
+        raise error
+      rescue StandardError => e
+        file, line_number, caller = e.backtrace[caller_index].split(":")
+        caller = caller.tr("`", "'")
+        warn %([jekyll-kroki] "#{error.message}" #{caller} on line #{line_number} of #{file}).red
+        exec "echo ''"
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-kroki
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Felix van Oost
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2023-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: httpx
+  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: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -109,14 +123,16 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.21'
 description: |-
-  Replaces diagram descriptions written in any Kroki-supported language in HTML files generated by
-                        Jekyll with their visual representation in SVG format.
+  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: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".rubocop.yml"
+- ".vscode/settings.json"
 - LICENSE
 - README.md
 - Rakefile
@@ -144,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to convert diagram descriptions into images using Kroki