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.

Sign up for GitHub

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

Jump to bottom

Structurizr diagram options #13

Merged
merged 8 commits into from
Jan 5, 2023
Merged

Structurizr diagram options #13

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3a4aabb
add structurizr type
Jun 10, 2022
6458ff4
allow diagram options
Jun 10, 2022
ad8625f
readme update
Jun 10, 2022
4cbb282
sorted types
Jun 10, 2022
bbd669e
use os env as default if set for server url
Jun 20, 2022
5688521
fix trailing spaces and os env name
Sep 14, 2022
1b452fd
Merge branch 'main' into structurizr-diagram-options
pgrund Oct 28, 2022
f0d1fbf
Merge branch 'main' into structurizr-diagram-options
b-bittner Jan 5, 2023
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
20 changes: 12 additions & 8 deletions kroki/client.py
View file
Open in desktop
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
10 changes: 6 additions & 4 deletions kroki/plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,19 +85,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