Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Structurizr diagram options #13

Merged
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@ plugins:

Use code-fences with a tag of kroki-`<Module>` to replace the code with the wanted diagram.

[Diagram options](https://docs.kroki.io/kroki/setup/diagram-options/) can be set as well.

Example for BlockDiag:

````markdown
```kroki-blockdiag
```kroki-blockdiag no-transparency=false
blockdiag {
blockdiag -> generates -> "block-diagrams";
blockdiag -> is -> "very easy!";
Expand Down
20 changes: 12 additions & 8 deletions kroki/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,31 +25,34 @@ def __init__(self, server_url, http_method):
def _kroki_uri(self, kroki_type):
return f'{self.server_url}/{kroki_type}/svg'

def _get_url(self, kroki_type, kroki_diagram_data):
def _get_url(self, kroki_type, kroki_diagram_data, kroki_diagram_options={}):
kroki_data_param = \
base64.urlsafe_b64encode(
zlib.compress(str.encode(kroki_diagram_data), 9)).decode()


kroki_query_param = \
"&".join([ f'{k}={v}' for k, v in kroki_diagram_options.items()]) if len(kroki_diagram_options)>0 else ''
if len(kroki_data_param) >= 4096:
debug(f'Length of encoded diagram is {len(kroki_data_param)}. '
'Kroki may not be able to read the data completely!')

kroki_uri = self._kroki_uri(kroki_type)
return f'{kroki_uri}/{kroki_data_param}'
error(f'{kroki_uri}/{kroki_data_param}?{kroki_query_param}')
return f'{kroki_uri}/{kroki_data_param}?{kroki_query_param}'

def get_url(self, kroki_type, kroki_diagram_data):
def get_url(self, kroki_type, kroki_diagram_data,kroki_diagram_options={}):
debug(f'get_url: {kroki_type}')

if self.http_method != 'GET':
error(f'HTTP method is {self.http_method}. Config error!')
return None

return self._get_url(kroki_type, kroki_diagram_data)
return self._get_url(kroki_type, kroki_diagram_data, kroki_diagram_options)

def get_image_data(self, kroki_type, kroki_diagram_data):
def get_image_data(self, kroki_type, kroki_diagram_data, kroki_diagram_options={}):
try:
if self.http_method == 'GET':
url = self._get_url(kroki_type, kroki_diagram_data)
url = self._get_url(kroki_type, kroki_diagram_data, kroki_diagram_options)

debug(f'get_image_data [GET {url[:50]}..]')
r = requests.get(url)
Expand All @@ -59,7 +62,8 @@ def get_image_data(self, kroki_type, kroki_diagram_data):
debug(f'get_image_data [POST {url}]')

r = requests.post(url, json={
"diagram_source": kroki_diagram_data
"diagram_source": kroki_diagram_data,
"diagram_options": kroki_diagram_options
})

debug(f'get_image_data [Response: {r}]')
Expand Down
9 changes: 5 additions & 4 deletions kroki/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ class KrokiDiagramTypes():
"erd",
"graphviz",
"nomnoml",
"pikchr",
"plantuml",
"c4plantuml",
"structurizr",
"svgbob",
"umlet",
"vega",
"vegalite",
"wavedrom",
"pikchr",
"umlet",
"wavedrom"
)

kroki_blockdiag = (
Expand Down Expand Up @@ -50,4 +51,4 @@ def __init__(self, blockdiag_enabled, bpmn_enabled, excalidraw_enabled, mermaid_

def get_block_regex(self, fence_prefix):
diagram_types_re = "|".join(self.diagram_types)
return rf'(?:```{fence_prefix})({diagram_types_re})\n(.*?)(?:```)'
return rf'(?:```{fence_prefix})({diagram_types_re})((?:\s?[a-zA-Z0-9\-_]+=[a-zA-Z0-9\-_]+)*)\n(.*?)(?:```)'
pgrund marked this conversation as resolved.
Show resolved Hide resolved
13 changes: 8 additions & 5 deletions kroki/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from mkdocs.plugins import log
from pathlib import Path
from os.path import relpath
import os

from .config import KrokiDiagramTypes
from .client import KrokiClient
Expand All @@ -21,7 +22,7 @@

class KrokiPlugin(BasePlugin):
config_scheme = (
('ServerURL', config.config_options.Type(str, default='https://kroki.io')),
('ServerURL', config.config_options.Type(str, default=os.getenv('KROKI_SERVER','https://kroki.io'))),
b-bittner marked this conversation as resolved.
Show resolved Hide resolved
('EnableBlockDiag', config.config_options.Type(bool, default=True)),
('Enablebpmn', config.config_options.Type(bool, default=True)),
('EnableExcalidraw', config.config_options.Type(bool, default=True)),
Expand Down Expand Up @@ -85,19 +86,21 @@ def _save_kroki_image_and_get_url(self, file_name, image_data, files):

return f'/{get_url}'

def _replace_kroki_block(self, match_obj, files, page):
def _replace_kroki_block(self, match_obj, files, page):
b-bittner marked this conversation as resolved.
Show resolved Hide resolved
kroki_type = match_obj.group(1).lower()
kroki_data = match_obj.group(2)
kroki_options = match_obj.group(2)
kroki_data = match_obj.group(3)

kroki_diagram_options=dict(x.split('=') for x in kroki_options.strip().split(' ')) if kroki_options else {}
get_url = None
if self.config["DownloadImages"]:
image_data = self.kroki_client.get_image_data(kroki_type, kroki_data)
image_data = self.kroki_client.get_image_data(kroki_type, kroki_data, kroki_diagram_options)

if image_data:
file_name = self._kroki_filename(kroki_data, page)
get_url = self._save_kroki_image_and_get_url(file_name, image_data, files)
else:
get_url = self.kroki_client.get_url(kroki_type, kroki_data)
get_url = self.kroki_client.get_url(kroki_type, kroki_data, kroki_diagram_options)

if get_url is not None:
return f'![Kroki]({get_url})'
Expand Down