Compare commits
No commits in common. "9b538c7d8e5b66bcb6509428c5240fc5ecb9e351" and "688e2a7984d69d0a8f46fa727ebf9621d047ec3b" have entirely different histories.
9b538c7d8e
...
688e2a7984
|
|
@ -106,5 +106,3 @@ dist
|
||||||
# utils/table-generator generated files
|
# utils/table-generator generated files
|
||||||
utils/table-generator/tables/
|
utils/table-generator/tables/
|
||||||
utils/table-generator/tables.md
|
utils/table-generator/tables.md
|
||||||
utils/table-generator/activities/
|
|
||||||
utils/table-generator/activities.md
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,11 @@
|
||||||
# Проєктування бази даних
|
# Проєктування системи
|
||||||
|
|
||||||
## BE модель
|
|
||||||
|
Вбудовування зображень діаграм здійснюється з використанням сервісу [plantuml.com](https://plantuml.com/).
|
||||||
|
|
||||||
|
В markdown-файлі використовується опис діаграми
|
||||||
|
|
||||||
|
```md
|
||||||
|
|
||||||
<center style="
|
<center style="
|
||||||
border-radius:4px;
|
border-radius:4px;
|
||||||
|
|
@ -11,38 +16,67 @@
|
||||||
|
|
||||||
@startuml
|
@startuml
|
||||||
|
|
||||||
entity Account
|
participant Client
|
||||||
entity Account.username <<TEXT>>
|
|
||||||
entity Account.password <<TEXT>>
|
|
||||||
|
|
||||||
entity Survey
|
participant SR as "Service Registry"
|
||||||
entity Survey.name <<TEXT>>
|
|
||||||
entity Survey.duration <<TEXT>>
|
|
||||||
entity Survey.isPaused <<BOOLEAN>>
|
|
||||||
entity Survey.isNamed <<BOOLEAN>>
|
|
||||||
|
|
||||||
entity Question
|
participant Service
|
||||||
entity Question.text <<TEXT>>
|
|
||||||
|
|
||||||
entity Responce
|
Service -> SR : register
|
||||||
entity Responce.value <<TEXT>>
|
SR -> SR
|
||||||
|
SR --> Service
|
||||||
|
...
|
||||||
|
|
||||||
Account.username --* Account
|
SR -> Service: heartbeat
|
||||||
Account.password --* Account
|
SR <-- Service: health
|
||||||
|
...
|
||||||
|
|
||||||
Survey.name --* Survey
|
Client -> SR: find
|
||||||
Survey.duration --* Survey
|
Client <-- SR: service endpoint
|
||||||
Survey.isPaused --* Survey
|
Client -> Service: request
|
||||||
Survey.isNamed --* Survey
|
Client <-- Service: response
|
||||||
|
|
||||||
Responce.value -u-* Responce
|
|
||||||
|
|
||||||
Question.text -u-* Question
|
|
||||||
|
|
||||||
Account "1,1" -- "0,*" Survey
|
@enduml
|
||||||
Survey "1,1" -- "0,*" Question
|
|
||||||
Question "1,1" -r- "0,*" Responce
|
</center>
|
||||||
Account "0,1" -r- "0,*" Responce
|
```
|
||||||
|
|
||||||
|
яка буде відображена наступним чином
|
||||||
|
|
||||||
|
<center style="
|
||||||
|
border-radius:4px;
|
||||||
|
border: 1px solid #cfd7e6;
|
||||||
|
box-shadow: 0 1px 3px 0 rgba(89,105,129,.05), 0 1px 1px 0 rgba(0,0,0,.025);
|
||||||
|
padding: 1em;"
|
||||||
|
>
|
||||||
|
|
||||||
|
@startuml
|
||||||
|
|
||||||
|
@startuml
|
||||||
|
|
||||||
|
participant Client
|
||||||
|
|
||||||
|
participant SR as "Service Registry"
|
||||||
|
|
||||||
|
participant Service
|
||||||
|
|
||||||
|
Service -> SR : register
|
||||||
|
SR -> SR
|
||||||
|
SR --> Service
|
||||||
|
...
|
||||||
|
|
||||||
|
SR -> Service: heartbeat
|
||||||
|
SR <-- Service: health
|
||||||
|
...
|
||||||
|
|
||||||
|
Client -> SR: find
|
||||||
|
Client <-- SR: service endpoint
|
||||||
|
Client -> Service: request
|
||||||
|
Client <-- Service: response
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@enduml
|
@enduml
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -34,27 +34,6 @@ def convert_usecase_v1(filename, data):
|
||||||
|
|
||||||
return generate_table(merged_lines)
|
return generate_table(merged_lines)
|
||||||
|
|
||||||
def convert_activity_v1(filename, data):
|
|
||||||
split_raw_lines_from_file = [i.split(" | ") for i in data.split("\n") if i]
|
|
||||||
|
|
||||||
if '/' in filename:
|
|
||||||
use_case_name = filename.rsplit("/", 1)[1].upper()
|
|
||||||
elif '\\' in filename:
|
|
||||||
use_case_name = filename.rsplit("\\", 1)[1].upper()
|
|
||||||
else:
|
|
||||||
use_case_name = filename.upper()
|
|
||||||
|
|
||||||
split_raw_lines = [["ID", use_case_name]] + split_raw_lines_from_file
|
|
||||||
|
|
||||||
merged_lines = []
|
|
||||||
for i in split_raw_lines:
|
|
||||||
if i[0].replace(" ", "") == "":
|
|
||||||
merged_lines[-1][1] += "<br>" + i[1]
|
|
||||||
else:
|
|
||||||
merged_lines.append(i)
|
|
||||||
|
|
||||||
return generate_table_with_activity_diagram(merged_lines)
|
|
||||||
|
|
||||||
def generate_table(raw_table_data):
|
def generate_table(raw_table_data):
|
||||||
table_lines = raw_table_data
|
table_lines = raw_table_data
|
||||||
transposed_table = list(zip(*table_lines))
|
transposed_table = list(zip(*table_lines))
|
||||||
|
|
@ -81,101 +60,15 @@ def generate_table(raw_table_data):
|
||||||
|
|
||||||
return "\n".join(formatted_table_lines)
|
return "\n".join(formatted_table_lines)
|
||||||
|
|
||||||
def convert_line_to_activity_diagram(line):
|
|
||||||
split_line = line[1].split("<br>")
|
|
||||||
|
|
||||||
result = "@startuml\n %PLACEHOLDER%\nstop\n@enduml"
|
|
||||||
|
|
||||||
last_swimline_name = ""
|
|
||||||
initiator_name = ""
|
|
||||||
|
|
||||||
for i in split_line:
|
|
||||||
clear_line = i.lstrip("1234567890. ")
|
|
||||||
swimline_label, combined_action = clear_line.split(" ", 1)
|
|
||||||
|
|
||||||
action_and_exceptions = combined_action.split(" (")
|
|
||||||
|
|
||||||
if len(action_and_exceptions) > 1:
|
|
||||||
action = action_and_exceptions[0].strip().capitalize()
|
|
||||||
exceptions = action_and_exceptions[1].strip(") ").capitalize()
|
|
||||||
else:
|
|
||||||
action = action_and_exceptions[0].strip().capitalize()
|
|
||||||
exceptions = ""
|
|
||||||
|
|
||||||
# запам'ятовуємо назву користувача системи
|
|
||||||
# (він завжди починає взаємодію, а, отже,
|
|
||||||
# перша дія завжди належить йому)
|
|
||||||
if not initiator_name:
|
|
||||||
initiator_name = swimline_label
|
|
||||||
|
|
||||||
# змінюємо swinline, якщо керування перейшло до іншого актора
|
|
||||||
if last_swimline_name != swimline_label:
|
|
||||||
result = result.replace("%PLACEHOLDER%", f"|{swimline_label}|\n %PLACEHOLDER%")
|
|
||||||
|
|
||||||
# якщо це перша дія, то вказуємо start
|
|
||||||
if not last_swimline_name:
|
|
||||||
result = result.replace("%PLACEHOLDER%", f"start\n %PLACEHOLDER%")
|
|
||||||
|
|
||||||
# зберігаємо нове ім'я актора
|
|
||||||
last_swimline_name = swimline_label
|
|
||||||
|
|
||||||
# прописуємо поточну дію актора
|
|
||||||
result = result.replace("%PLACEHOLDER%", f": {action};\n %PLACEHOLDER%")
|
|
||||||
|
|
||||||
# якщо є виключні ситуації, додаємо інформацію про них
|
|
||||||
if exceptions:
|
|
||||||
result = result.replace("%PLACEHOLDER%", f"note right #lightpink\n <b>{exceptions}</b>\n end note\n %PLACEHOLDER%")
|
|
||||||
|
|
||||||
# впенюємося, що взаємодія закінчується на swinline користувача
|
|
||||||
if last_swimline_name != initiator_name:
|
|
||||||
result = result.replace("%PLACEHOLDER%", f"|{initiator_name}|\n %PLACEHOLDER%")
|
|
||||||
|
|
||||||
# видаляємо мітку %PLACEHOLDER%
|
|
||||||
result = result.replace("%PLACEHOLDER%\n", "")
|
|
||||||
return result
|
|
||||||
|
|
||||||
|
|
||||||
def generate_table_with_activity_diagram(raw_table_data):
|
|
||||||
table_lines = raw_table_data[:-1]
|
|
||||||
activity_line = raw_table_data[-1]
|
|
||||||
|
|
||||||
transposed_table = list(zip(*table_lines))
|
|
||||||
|
|
||||||
field_sizes = [max([max([len(k)+2 for k in j.split("\n")]) for j in i]) for i in transposed_table]
|
|
||||||
|
|
||||||
formatted_table_lines = []
|
|
||||||
|
|
||||||
l = "|"
|
|
||||||
for i, field in enumerate(table_lines[0]):
|
|
||||||
l += field.center(field_sizes[i])
|
|
||||||
l += "|"
|
|
||||||
|
|
||||||
formatted_table_lines.append(l)
|
|
||||||
formatted_table_lines.append(f"|{'|'.join([':'+'-'*(i-2)+':' for i in field_sizes])}|")
|
|
||||||
|
|
||||||
for line in table_lines[1:]:
|
|
||||||
l = "|"
|
|
||||||
for i, field in enumerate(line):
|
|
||||||
l += field.center(field_sizes[i])
|
|
||||||
l += "|"
|
|
||||||
|
|
||||||
formatted_table_lines.append(l)
|
|
||||||
|
|
||||||
activity_diagram = convert_line_to_activity_diagram(activity_line)
|
|
||||||
|
|
||||||
return "\n".join(formatted_table_lines) + "\n" + activity_diagram
|
|
||||||
|
|
||||||
|
|
||||||
if __name__=="__main__":
|
if __name__=="__main__":
|
||||||
# parse args
|
# parse args
|
||||||
files = []
|
files = []
|
||||||
|
|
||||||
write_to_file = AUTO
|
write_to_file = AUTO
|
||||||
write_to_stdout = AUTO
|
write_to_stdout = AUTO
|
||||||
usecase_formatting = AUTO
|
usecase_formatting = AUTO
|
||||||
verbose = AUTO
|
verbose = AUTO
|
||||||
process_table_files = AUTO
|
process_table_files = AUTO
|
||||||
convert_to_activity_diagram = AUTO
|
|
||||||
file_output_path = None
|
file_output_path = None
|
||||||
|
|
||||||
# 1 pass (argument harvest)
|
# 1 pass (argument harvest)
|
||||||
|
|
@ -211,12 +104,6 @@ if __name__=="__main__":
|
||||||
elif i in ["-nt", "--no-process-table"]:
|
elif i in ["-nt", "--no-process-table"]:
|
||||||
process_table_files = NO
|
process_table_files = NO
|
||||||
|
|
||||||
# перетворює останню клітинку таблиці в діаграму активностей
|
|
||||||
if i in ["-a", "--convert-to-activity-diagram"]:
|
|
||||||
convert_to_activity_diagram = YES
|
|
||||||
elif i in ["-na", "--no-convert-to-activity-diagram"]:
|
|
||||||
convert_to_activity_diagram = NO
|
|
||||||
|
|
||||||
# задає папку, в яку необхідно зберігати конвертовані таблиці
|
# задає папку, в яку необхідно зберігати конвертовані таблиці
|
||||||
elif i in ["-d", "--destination"]:
|
elif i in ["-d", "--destination"]:
|
||||||
file_output_path = sys.argv[n+2]
|
file_output_path = sys.argv[n+2]
|
||||||
|
|
@ -246,13 +133,6 @@ if __name__=="__main__":
|
||||||
elif (name.endswith(".usecase") or name.endswith(".uc")) and usecase_formatting >= AUTO:
|
elif (name.endswith(".usecase") or name.endswith(".uc")) and usecase_formatting >= AUTO:
|
||||||
if verbose == YES:
|
if verbose == YES:
|
||||||
print(f"Auto-detected use-case in file {name}\n")
|
print(f"Auto-detected use-case in file {name}\n")
|
||||||
|
|
||||||
if convert_to_activity_diagram == YES:
|
|
||||||
if verbose == YES:
|
|
||||||
print(f"Converting file {name} to activity diagram\n")
|
|
||||||
|
|
||||||
formatted_table_data = convert_activity_v1(name.rsplit(".", 1)[0], data)
|
|
||||||
else:
|
|
||||||
formatted_table_data = convert_usecase_v1(name.rsplit(".", 1)[0], data)
|
formatted_table_data = convert_usecase_v1(name.rsplit(".", 1)[0], data)
|
||||||
else:
|
else:
|
||||||
formatted_table_data = convert_generic_v1(data)
|
formatted_table_data = convert_generic_v1(data)
|
||||||
|
|
@ -282,13 +162,6 @@ if __name__=="__main__":
|
||||||
elif (name.endswith(".usecase") or name.endswith(".uc")) and usecase_formatting >= AUTO:
|
elif (name.endswith(".usecase") or name.endswith(".uc")) and usecase_formatting >= AUTO:
|
||||||
if verbose >= AUTO:
|
if verbose >= AUTO:
|
||||||
print(f"Auto-detected use-case in file {name}")
|
print(f"Auto-detected use-case in file {name}")
|
||||||
|
|
||||||
if convert_to_activity_diagram == YES:
|
|
||||||
if verbose == YES:
|
|
||||||
print(f"Converting file {name} to activity diagram\n")
|
|
||||||
|
|
||||||
formatted_table_data = convert_activity_v1(name.rsplit(".", 1)[0], data)
|
|
||||||
else:
|
|
||||||
formatted_table_data = convert_usecase_v1(name.rsplit(".", 1)[0], data)
|
formatted_table_data = convert_usecase_v1(name.rsplit(".", 1)[0], data)
|
||||||
else:
|
else:
|
||||||
formatted_table_data = convert_generic_v1(data)
|
formatted_table_data = convert_generic_v1(data)
|
||||||
|
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
#!/bin/sh
|
|
||||||
|
|
||||||
mkdir -p activities/
|
|
||||||
./convert.py use-cases/* -a -nv -d activities/
|
|
||||||
|
|
||||||
if [ -f activities.md ]; then
|
|
||||||
rm activities.md
|
|
||||||
fi
|
|
||||||
|
|
||||||
for i in activities/*; do
|
|
||||||
cat $i >> activities.md
|
|
||||||
echo "" >> activities.md
|
|
||||||
done
|
|
||||||
Reference in New Issue