Lab_6

survey

utils/table-generator/convert.py

@@ -0,0 +1,305 @@
+#!/bin/python3
+
+import sys
+import os
+
+# magic values
+NO   = 0
+AUTO = 1
+YES  = 2
+
+def convert_generic_v1(data):
+    split_raw_lines = [i.strip().split("|") for i in data.split("\n") if i]
+    
+    return generate_table(split_raw_lines)
+
+def convert_usecase_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(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):
+    table_lines = raw_table_data
+    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)
+
+    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__":
+    # parse args
+    files = []
+
+    write_to_file = AUTO
+    write_to_stdout = AUTO
+    usecase_formatting = AUTO
+    verbose = AUTO
+    process_table_files = AUTO
+    convert_to_activity_diagram = AUTO
+    file_output_path = None
+
+    # 1 pass (argument harvest)
+    for n, i in enumerate(sys.argv[1:]):
+        if i.startswith("-"):
+            # записувати таблицю в файл
+            if i in ["-f", "--file"]:
+                write_to_file = YES
+            elif i in ["-nf", "--no-file"]:
+                write_to_file = NO
+
+            # виводити таблицю у стандартний вивід
+            elif i in ["-o", "--stdout"]:
+                write_to_stdout = YES
+            elif i in ["-no", "--no-stdout"]:
+                write_to_stdout = NO
+
+            # форматувати таблицю як use-case
+            elif i in ["-u", "--usecase", "--use-case"]:
+                usecase_formatting = YES
+            elif i in ["-nu", "--no-usecase", "--no-use-case"]:
+                usecase_formatting = NO
+
+            # виводити на екран додаткову інформацію
+            elif i in ["-v", "--verbose"]:
+                verbose = YES
+            elif i in ["-nv", "--no-verbose"]:
+                verbose = NO
+
+            # дозволити обробку файлів .table
+            elif i in ["-t", "--process-table"]:
+                process_table_files = YES
+            elif i in ["-nt", "--no-process-table"]:
+                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"]:
+                file_output_path = sys.argv[n+2]
+                sys.argv.remove(sys.argv[n+2])
+
+    # 2 pass (filename harvest)
+    for i in sys.argv[1:]:
+        if not i.startswith("-"):
+            if i.endswith(".table") and process_table_files <= AUTO:
+                print(f"[Warning]: Excluding {i} to prevent processing of an already processed file (pass --process-table to override this behaviour)")
+            else:
+                files.append(i)
+
+    if len(files) < 1:
+        print("You need to pass at least one file as CLI argument", file=sys.stderr)
+        print("Exiting...", file=sys.stderr)
+        exit(1)
+
+    if len(files) == 1:
+        name = files[0]
+        data = open(name, encoding = "utf-8").read()
+
+        if usecase_formatting == YES:
+            if verbose == YES:
+                print(f"Force-formatting {name} as a use-case\n")
+            formatted_table_data = convert_usecase_v1(name.rsplit(".", 1)[0], data)
+        elif (name.endswith(".usecase") or name.endswith(".uc")) and usecase_formatting >= AUTO:
+            if verbose == YES:
+                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)
+        else:
+            formatted_table_data = convert_generic_v1(data)
+
+        if write_to_stdout >= AUTO:
+            print(formatted_table_data)
+        
+        if write_to_file > AUTO:
+            if file_output_path:
+                open(os.path.join(file_output_path, os.path.basename(name)) \
+                        + ".table", 'w', encoding = "utf-8") \
+                        .write(formatted_table_data+"\n")
+            else:
+                open(name + ".table", 'w', encoding = "utf-8").write(formatted_table_data+"\n")
+
+        exit(0)
+
+    for no, name in enumerate(files):
+        print(f"Converting {no+1:02d}/{len(files)}: {name}")
+
+        data = open(name, encoding = "utf-8").read()
+
+        if usecase_formatting == YES:
+            if verbose >= AUTO:
+                print(f"Force-formatting {name} as a use-case")
+            formatted_table_data = convert_usecase_v1(name.rsplit(".", 1)[0], data)
+        elif (name.endswith(".usecase") or name.endswith(".uc")) and usecase_formatting >= AUTO:
+            if verbose >= AUTO:
+                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)
+        else:
+            formatted_table_data = convert_generic_v1(data)
+
+        if write_to_stdout > AUTO:
+            print(formatted_table_data)
+        
+        if write_to_file >= AUTO:
+            if file_output_path:
+                open(os.path.join(file_output_path, os.path.basename(name)) \
+                        + ".table", 'w', encoding = "utf-8") \
+                        .write(formatted_table_data+"\n")
+            else:
+                open(name + ".table", 'w', encoding = "utf-8").write(formatted_table_data+"\n")

utils/table-generator/list-exceptions.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+grep -E '\|\ [0-9]{3}\.[0-9]{3}' use-cases/*.uc \
+    | cut -d '|' -f 2 \
+    | sort | uniq -c

utils/table-generator/update-activities.py

@@ -0,0 +1,8 @@
+#!/usr/bin/python3
+
+import updater
+
+target_folder = "activities"
+converter_args = "-a -nv"
+
+updater.process(target_folder, converter_args)

utils/table-generator/update-activities.sh

@@ -0,0 +1,13 @@
+#!/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

utils/table-generator/update-tables.py

@@ -0,0 +1,8 @@
+#!/usr/bin/python3
+
+import updater
+
+target_folder = "tables"
+converter_args = "-nv"
+
+updater.process(target_folder, converter_args)

utils/table-generator/update-tables.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+mkdir -p tables/
+./convert.py use-cases/* -nv -d tables/
+
+if [ -f tables.md ]; then
+    rm tables.md
+fi
+
+for i in tables/*; do
+    cat $i >> tables.md
+    echo "" >> tables.md
+done

utils/table-generator/updater.py

@@ -0,0 +1,26 @@
+#!/usr/bin/python3
+
+import shutil
+import sys
+import os
+
+PYTHON_INTERPRETER = sys.executable
+
+def process(target_folder, converter_args):
+    if os.path.exists(target_folder):
+        shutil.rmtree(target_folder)
+
+    os.mkdir(target_folder)
+    os.system(f"{PYTHON_INTERPRETER} convert.py use-cases/* {converter_args} -d {target_folder}/")
+
+    result_file = open(f"{target_folder}.md", "w")
+
+    try:
+        for i in os.listdir(target_folder):
+            with open(os.path.abspath(f"{target_folder}/{i}")) as f:
+                result_file.write(f.read())
+                result_file.write("\n")
+    except Exception as e:
+        print(f"File {target_folder}/{i} has raised exception {e}")
+
+    result_file.close()

utils/table-generator/use-cases/account.create.uc

@@ -0,0 +1,10 @@
+Назва | Створити обліковий запис
+Учасники | Користувач, система
+Передумови | Відсутні
+Результат | Обліковий запис користувача
+Виключні ситуації | 001.001 Користувач ввів заборонені символи в поле псевдоніму
+                  | 001.002 Ідентичний псевдонім вже існує
+Основний сценарій | 1. Користувач вводить бажаний псевдонім у поле вводу псевдоніму
+                  | 2. Користувач вводить пароль у поле вводу паролю
+                  | 3. Користувач натискає на кнопку створення облікового запису
+                  | 4. Система створює обліковий запис користувача (можливі 001.001, 001.002)

utils/table-generator/use-cases/account.delete.uc

@@ -0,0 +1,9 @@
+Назва | Видалити обліковий запис
+Учасники | Користувач, система
+Передумови | Користувач ідентифікований в системі
+Результат | Відсутність облікового запису користувача
+Виключні ситуації | 001.005 Користувач не ідентифікований
+Основний сценарій | 1. Користувач натискає на кнопку видалення облікового запису
+                  | 2. Система виводить кнопку-запит на підтвердження видалення облікового запису
+                  | 3. Користувач натискає на кнопку підтвердження видалення облікового запису
+                  | 4. Система видаляє обліковий запис (можлива 001.005)

utils/table-generator/use-cases/account.modify.uc

@@ -0,0 +1,10 @@
+Назва | Змінити властивості облікового запису
+Учасники | Користувач, система
+Передумови | Користувач ідентифікований в системі
+Результат | Зміна властивостей облікового запису
+Виключні ситуації | 001.005 Користувач не ідентифікований
+Основний сценарій | 1. Користувач натискає на кнопку редагування облікового запису
+                  | 2. Система виводить інтерфейс для редагування облікового запису (можлива 001.005)
+                  | 3. Користувач вказує бажані зміни властивостей облікового запису
+                  | 4. Користувач натискає на кнопку внесення змін до властивостей облікового запису
+                  | 5. Система змінює властивості облікового запису

utils/table-generator/use-cases/survey.link.create.uc

@@ -0,0 +1,12 @@
+Назва | Додати посилання на опитування
+Учасники | Користувач, система
+Передумови | Користувач авторизований у системі
+Результат | Нове посилання на опитування
+Виключні ситуації | 001.005 Користувач не ідентифікований
+                  | 001.006 Запитане опитування не існує
+                  | 001.008 Користувач не є власником опитування
+Основний сценарій | 1. Користувач натискає кнопку створення посилання на опитування
+                  | 2. Система виводить налаштування для нового посилання (можливі 001.005, 001.006, 001.008)
+                  | 3. Користувач вводить налаштування для нового посилання
+                  | 4. Користувач натискає на кнопку створення посилання
+                  | 5. Система створює нове посилання

utils/table-generator/use-cases/survey.link.delete.uc

@@ -0,0 +1,12 @@
+Назва | Видалити посилання на опитування
+Учасники | Користувач, система
+Передумови | Користувач авторизований у системі
+Результат | Видалення посилання на опитування
+Виключні ситуації | 001.005 Користувач не ідентифікований
+                  | 001.006 Запитане опитування не існує
+                  | 001.008 Користувач не є власником опитування
+                  | 001.009 Запитане посилання на існує
+Основний сценарій | 1. Користувач натискає кнопку видалення посилання
+                  | 2. Система виводить кнопку підтвердження видалення посилання
+                  | 3. Користувач натискає на кнопку підтвердження видалення посилання
+                  | 4. Система видаляє посилання (можливі 001.005, 001.006, 001.008, 001.009)

utils/table-generator/use-cases/survey.link.modify.uc

@@ -0,0 +1,13 @@
+Назва | Змінити властивості посилання на опитування
+Учасники | Користувач, система
+Передумови | Користувач авторизований у системі
+Результат | Зміна властивостей посилання на опитування
+Виключні ситуації | 001.005 Користувач не ідентифікований
+                  | 001.006 Запитане опитування не існує
+                  | 001.008 Користувач не є власником опитування
+                  | 001.009 Запитане посилання на існує
+Основний сценарій | 1. Користувач натискає кнопку редагування властивостей посилання
+                  | 2. Система виводить налаштування для обраного посилання (можливі 001.005, 001.006, 001.008, 001.009)
+                  | 3. Користувач вводить юажані зміни властивостей посилання
+                  | 4. Користувач натискає на кнопку збереження властиностей посилання
+                  | 5. Система змінює властивості посилання

utils/table-generator/use-cases/user.create_survey.uc

@@ -0,0 +1,12 @@
+Назва | Створити опитування
+Учасники | Користувач, система
+Передумови | Користувач ідентифікований в системі
+Результат | Створене опитування
+Виключні ситуації | 001.005 Користувач не ідентифікований
+                  | 001.007 Користувач ввів неприпустимі символи в назві опитування
+Основний сценарій | 1. Користувач переходить на сторінку створення опитування (можлива 001.005)
+                  | 2. Система виводить інтерфейс створення опитування
+                  | 3. Користувач задає інформацію про запитання та тип опитування
+                  | 4. Користувач натискає кнопку збереження опитування
+                  | 5. Система створює опитування (можлива 001.007)
+                  | 6. Система виводить посилання на проходження опитування

utils/table-generator/use-cases/user.delete_survey.uc

@@ -0,0 +1,11 @@
+Назва | Видалити опитування
+Учасники | Користувач, система
+Передумови | Користувач ідентифікований в системі, користувач є власником опитування
+Результат | Відсутність опитування
+Виключні ситуації | 001.005 Користувач не ідентифікований
+                  | 001.006 Запитане опитування не існує
+                  | 001.008 Користувач не є власником опитування
+Основний сценарій | 1. Користувач натискає на кнопку видалення опитування
+                  | 2. Система виводить запит на підтвердження видалення опитування
+                  | 3. Користувач натискає на кнопку підтвердження видалення опитування
+                  | 4. Система видаляє опитування (можливі 001.005, 001.006, 001.008)

utils/table-generator/use-cases/user.get_survey_result.uc

@@ -0,0 +1,9 @@
+Назва | Переглянути відповіді на опитування
+Учасники | Користувач, система
+Передумови | Користувач ідентифікований в системі, користувач є власником опитування
+Результат | Інформація про відповіді на опитування
+Виключні ситуації | 001.005 Користувач не ідентифікований
+                  | 001.006 Запитане опитування не існує
+                  | 001.008 Користувач не є власником опитування
+Основний сценарій | 1. Користувач натискає на кнопку перегляду відповідей на опитування
+                  | 2. Система виводить інформацію про відповіді на опитування (можливі 001.005, 001.006, 001.008)

utils/table-generator/use-cases/user.login.uc

@@ -0,0 +1,12 @@
+Назва | Пройти ідентифікацію в системі
+Учасники | Користувач, система
+Передумови | Користувач має обліковий запис
+Результат | Користувач ідентифікований в системі
+Виключні ситуації | 001.001 Користувач ввів заборонені символи в поле псевдоніму
+                  | 001.003 Користувач ввів псевдонім, якого не існує в системі
+                  | 001.004 Користувач ввів неправильний пароль до облікового запису
+Основний сценарій | 1. Користувач вводить псевдонім у поле вводу псевдоніму
+                  | 2. Користувач вводить пароль у поле вводу паролю
+                  | 3. Користувач натискає кнопку ідентифікації
+                  | 4. Система ідентифікує користувача (можливі 001.001, 001.003, 001.004)
+

utils/table-generator/use-cases/user.logout.uc

@@ -0,0 +1,7 @@
+Назва | Скинути дані про ідентифікацію в системі
+Учасники | Користувач, система
+Передумови | Користувач ідентифікований в системі
+Результат | Користувач не ідентифікований в системі
+Виключні ситуації | 001.005 Користувач не ідентифікований
+Основний сценарій | 1. Користувач натискає на кнопку виходу з облікового запису
+                  | 2. Система скидає інформацію про ідентифікацію користувача (можлива 001.005)

utils/table-generator/use-cases/user.modify_survey.uc

@@ -0,0 +1,12 @@
+Назва | Редагувати опитування
+Учасники | Користувач, система
+Передумови | Користувач ідентифікований в системі, користувач є власником опитування
+Результат | Змінене опитування
+Виключні ситуації | 001.005 Користувач не ідентифікований
+                  | 001.006 Запитане опитування не існує
+                  | 001.008 Користувач не є власником опитування
+Основний сценарій | 1. Користувач переходить на сторінку редагування опитування
+                  | 2. Система виводить інтерфейс редагування опитування (можливі 001.005, 001.006, 001.008)
+                  | 3. Користувач задає інформацію про зміни в опитуванні
+                  | 4. Користувач натискає кнопку збереження змін в опитуванні
+                  | 5. Система змінює опитування

utils/table-generator/use-cases/user.stat_survey.uc

@@ -0,0 +1,9 @@
+Назва | Переглянути властивості опитування
+Учасники | Користувач, система
+Передумови | Користувач ідентифікований в системі, користувач є власником опитування
+Результат | Інформація про властивості опитування
+Виключні ситуації | 001.005 Користувач не ідентифікований
+                  | 001.006 Запитане опитування не існує
+                  | 001.008 Користувач не є власником опитування
+Основний сценарій | 1. Користувач натискає на кнопку перегляду інформації про опитування
+                  | 2. Система виводить інформацію про опитування (можливі 001.005, 001.006, 001.008)

utils/table-generator/use-cases/user.take_anon_survey.uc

@@ -0,0 +1,11 @@
+Назва | Пройти анонімне опитування
+Учасники | Користувач, система
+Передумови | Відсутні
+Результат | Запис відповідей на опитування
+Виключні ситуації | 001.006 Запитане опитування не існує
+Основний сценарій | 1. Користувач переходить на сторінку проходження опитування
+                  | 2. Система виводить перелік запитань опитування (можлива 001.006)
+                  | 3. Користувач вводить відповіді на запитання
+                  | 4. Користувач натискає кнопку надсилання відповідей
+                  | 5. Система записує відповіді на опитування (можлива 001.006)
+                  | 6. Система виводить прощальне повідомлення

utils/table-generator/use-cases/user.take_named_survey.uc

@@ -0,0 +1,12 @@
+Назва | Пройти поіменне опитування
+Учасники | Користувач, система
+Передумови | Користувач ідентифікований в системі
+Результат | Запис відповідей на опитування та відомості про користувача
+Виключні ситуації | 001.005 Користувач не ідентифікований
+                  | 001.006 Запитане опитування не існує
+Основний сценарій | 1. Користувач переходить на сторінку проходження опитування
+                  | 2. Система виводить перелік запитань опитування (можливі 001.005, 001.006)
+                  | 3. Користувач вводить відповіді на запитання
+                  | 4. Користувач натискає кнопку надсилання відповідей
+                  | 5. Система записує відповіді на опитування та відомості про користувача (можлива 001.006)
+                  | 6. Система виводить прощальне повідомлення