table-generator: прибрав зайвий закоментований код з інструментів

Reviewed-on: hasslesstech/edu-dis-labs#36
Reviewed-by: Rhinemann <andreyfrog26@gmail.com>
Reviewed-by: IO-23 Andrii Bodnar <bodnarandrew123@gmail.com>

.gitignore

@@ -106,3 +106,5 @@ dist
 # utils/table-generator generated files
 utils/table-generator/tables/
 utils/table-generator/tables.md
+utils/table-generator/activities/
+utils/table-generator/activities.md

docs/.vuepress/config.js

@@ -36,6 +36,15 @@ module.exports = {
     {
       title: 'Розроблення вимог до системи',
         path:"/requirements/",
+        children: [
+            "/requirements/state-of-the-art",
+            "/requirements/stakeholders-needs"
+        ]
+    },
+
+    {
+      title: 'Розроблення вимог до функціональности системи',
+      path:"/use-cases/"
     },
 
     {
@@ -93,7 +102,7 @@ module.exports = {
     // editLinkText: 'Ви можете покращити цю сторінку'
 
   },
-  title: 'Назва проєкту',
+  title: 'Expertise',
   description: 'Лабораторні роботи з дисципліни "Розподілені інформаційні системи"',
   configureWebpack: {
     resolve: {

docs/use-cases/README.md

@@ -45,3 +45,374 @@
 @enduml
 
 </center>
+
+## Схеми використання для окремих діячів
+
+Схема використання для гостя:
+
+@startuml
+
+    :Гість: as Guest
+
+    (<b>ACCOUNT.CREATE</b>\nСтворити обліковий запис) as CreateAccount
+    (<b>USER.LOGIN</b>\nПройти ідентифікацію в системі) as LogIn
+    (<b>USER.TAKE_ANON_SURVEY</b>\nПройти анонімне опитування) as TakeAnonSurvey
+
+    Guest -u-> CreateAccount
+    Guest --> LogIn
+    Guest -r-> TakeAnonSurvey
+
+@enduml
+
+Схема використання для зареєстрованого користувача:
+
+@startuml
+
+    :Зареєстрований користувач: as AuthorisedUser
+
+    (<b>ACCOUNT.DELETE</b>\nВидалити обліковий запис) as DeleteAccount
+    (<b>ACCOUNT.MODIFY</b>\nЗмінити властивості облікового запису) as ModifyAccount
+    (<b>USER.CREATE_SURVEY</b>\nСтворити опитування) as CreateSurvey
+    (<b>USER.DELETE_SURVEY</b>\nВидалити опитування) as DeleteSurvey
+    (<b>USER.GET_SURVEY_RESULT</b>\nПереглянути відповіді на опитування) as GetSurveyResult
+    (<b>USER.LOGOUT</b>\nСкинути дані про ідентифікацію в системі) as LogOut
+    (<b>USER.MODIFY_SURVEY</b>\nРедагувати опитування) as ModifySurvey
+    (<b>USER.STAT_SURVEY</b>\nПереглянути властивості опитування) as StatSurvey
+    (<b>USER.TAKE_ANON_SURVEY</b>\nПройти анонімне опитування) as TakeAnonSurvey
+    (<b>USER.TAKE_NAMED_SURVEY</b>\nПройти поіменне опитування) as TakeNamedSurvey
+
+    AuthorisedUser -r-> ModifyAccount
+    AuthorisedUser -u-> DeleteAccount
+    AuthorisedUser -u-> LogOut
+    AuthorisedUser -d-> CreateSurvey
+    AuthorisedUser -u-> DeleteSurvey
+    AuthorisedUser --> StatSurvey
+    AuthorisedUser -d-> ModifySurvey
+    AuthorisedUser --> GetSurveyResult
+    AuthorisedUser -l-> TakeAnonSurvey
+    AuthorisedUser -d-> TakeNamedSurvey
+
+@enduml
+
+## Сценарії використання
+### Для гостя
+
+|         ID        |                                             ACCOUNT.CREATE                                             |
+|:-----------------:|:------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                        Створити обліковий запис                                        |
+|      Учасники     |                                          Користувач, система                                           |
+|     Передумови    |                                                Відсутні                                                |
+|     Результат     |                                      Обліковий запис користувача                                       |
+| Виключні ситуації | 001.001 Користувач ввів заборонені символи в поле псевдоніму<br>001.002 Ідентичний псевдонім вже існує |
+@startuml
+    |Користувач|
+    start
+    : Вводить бажаний псевдонім у поле вводу псевдоніму;
+    : Вводить пароль у поле вводу паролю;
+    : Натискає на кнопку створення облікового запису;
+    |Система|
+    : Створює обліковий запис користувача;
+    note right #lightpink
+        <b>Можливі 001.001, 001.002</b>
+    end note
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |                                                                                            USER.LOGIN                                                                                           |
+|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                                                                  Пройти ідентифікацію в системі                                                                                 |
+|      Учасники     |                                                                                       Користувач, система                                                                                       |
+|     Передумови    |                                                                                  Користувач має обліковий запис                                                                                 |
+|     Результат     |                                                                               Користувач ідентифікований в системі                                                                              |
+| Виключні ситуації | 001.001 Користувач ввів заборонені символи в поле псевдоніму<br>001.003 Користувач ввів псевдонім, якого не існує в системі<br>001.004 Користувач ввів неправильний пароль до облікового запису |
+@startuml
+    |Користувач|
+    start
+    : Вводить псевдонім у поле вводу псевдоніму;
+    : Вводить пароль у поле вводу паролю;
+    : Натискає кнопку ідентифікації;
+    |Система|
+    : Ідентифікує користувача;
+    note right #lightpink
+        <b>Можливі 001.001, 001.003, 001.004</b>
+    end note
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |        USER.TAKE_ANON_SURVEY         |
+|:-----------------:|:------------------------------------:|
+|       Назва       |      Пройти анонімне опитування      |
+|      Учасники     |         Користувач, система          |
+|     Передумови    |               Відсутні               |
+|     Результат     |    Запис відповідей на опитування    |
+| Виключні ситуації | 001.006 Запитане опитування не існує |
+@startuml
+    |Користувач|
+    start
+    : Переходить на сторінку проходження опитування;
+    |Система|
+    : Виводить перелік запитань опитування;
+    note right #lightpink
+        <b>Можлива 001.006</b>
+    end note
+    |Користувач|
+    : Вводить відповіді на запитання;
+    : Натискає кнопку надсилання відповідей;
+    |Система|
+    : Записує відповіді на опитування;
+    note right #lightpink
+        <b>Можлива 001.006</b>
+    end note
+    : Виводить прощальне повідомлення;
+    |Користувач|
+    stop
+@enduml
+
+### Для зареєстрованого користувача
+
+|         ID        |               ACCOUNT.DELETE              |
+|:-----------------:|:-----------------------------------------:|
+|       Назва       |          Видалити обліковий запис         |
+|      Учасники     |            Користувач, система            |
+|     Передумови    |    Користувач ідентифікований в системі   |
+|     Результат     | Відсутність облікового запису користувача |
+| Виключні ситуації |   001.005 Користувач не ідентифікований   |
+@startuml
+    |Користувач|
+    start
+    : Натискає на кнопку видалення облікового запису;
+    |Система|
+    : Виводить кнопку-запит на підтвердження видалення облікового запису;
+    |Користувач|
+    : Натискає на кнопку підтвердження видалення облікового запису;
+    |Система|
+    : Видаляє обліковий запис;
+    note right #lightpink
+        <b>Можлива 001.005</b>
+    end note
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |             ACCOUNT.MODIFY            |
+|:-----------------:|:-------------------------------------:|
+|       Назва       | Змінити властивості облікового запису |
+|      Учасники     |          Користувач, система          |
+|     Передумови    |  Користувач ідентифікований в системі |
+|     Результат     |  Зміна властивостей облікового запису |
+| Виключні ситуації | 001.005 Користувач не ідентифікований |
+@startuml
+    |Користувач|
+    start
+    : Натискає на кнопку редагування облікового запису;
+    |Система|
+    : Виводить інтерфейс для редагування облікового запису;
+    note right #lightpink
+        <b>Можлива 001.005</b>
+    end note
+    |Користувач|
+    : Вказує бажані зміни властивостей облікового запису;
+    : Натискає на кнопку внесення змін до властивостей облікового запису;
+    |Система|
+    : Змінює властивості облікового запису;
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |                                            USER.CREATE_SURVEY                                            |
+|:-----------------:|:--------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                           Створити опитування                                            |
+|      Учасники     |                                           Користувач, система                                            |
+|     Передумови    |                                   Користувач ідентифікований в системі                                   |
+|     Результат     |                                           Створене опитування                                            |
+| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.007 Користувач ввів неприпустимі символи в назві опитування |
+@startuml
+    |Користувач|
+    start
+    : Переходить на сторінку створення опитування;
+    note right #lightpink
+        <b>Можлива 001.005</b>
+    end note
+    |Система|
+    : Виводить інтерфейс створення опитування;
+    |Користувач|
+    : Задає інформацію про запитання та тип опитування;
+    : Натискає кнопку збереження опитування;
+    |Система|
+    : Створює опитування;
+    note right #lightpink
+        <b>Можлива 001.007</b>
+    end note
+    : Виводить посилання на проходження опитування;
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |                                                       USER.DELETE_SURVEY                                                      |
+|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                                      Видалити опитування                                                      |
+|      Учасники     |                                                      Користувач, система                                                      |
+|     Передумови    |                            Користувач ідентифікований в системі, користувач є власником опитування                            |
+|     Результат     |                                                     Відсутність опитування                                                    |
+| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування |
+@startuml
+    |Користувач|
+    start
+    : Натискає на кнопку видалення опитування;
+    |Система|
+    : Виводить запит на підтвердження видалення опитування;
+    |Користувач|
+    : Натискає на кнопку підтвердження видалення опитування;
+    |Система|
+    : Видаляє опитування;
+    note right #lightpink
+        <b>Можливі 001.005, 001.006, 001.008</b>
+    end note
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |                                                     USER.GET_SURVEY_RESULT                                                    |
+|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                              Переглянути відповіді на опитування                                              |
+|      Учасники     |                                                      Користувач, система                                                      |
+|     Передумови    |                            Користувач ідентифікований в системі, користувач є власником опитування                            |
+|     Результат     |                                             Інформація про відповіді на опитування                                            |
+| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування |
+@startuml
+    |Користувач|
+    start
+    : Натискає на кнопку перегляду відповідей на опитування;
+    |Система|
+    : Виводить інформацію про відповіді на опитування;
+    note right #lightpink
+        <b>Можливі 001.005, 001.006, 001.008</b>
+    end note
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |               USER.LOGOUT                |
+|:-----------------:|:----------------------------------------:|
+|       Назва       | Скинути дані про ідентифікацію в системі |
+|      Учасники     |           Користувач, система            |
+|     Передумови    |   Користувач ідентифікований в системі   |
+|     Результат     | Користувач не ідентифікований в системі  |
+| Виключні ситуації |  001.005 Користувач не ідентифікований   |
+@startuml
+    |Користувач|
+    start
+    : Натискає на кнопку виходу з облікового запису;
+    |Система|
+    : Скидає інформацію про ідентифікацію користувача;
+    note right #lightpink
+        <b>Можлива 001.005</b>
+    end note
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |                                                       USER.MODIFY_SURVEY                                                      |
+|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                                     Редагувати опитування                                                     |
+|      Учасники     |                                                      Користувач, система                                                      |
+|     Передумови    |                            Користувач ідентифікований в системі, користувач є власником опитування                            |
+|     Результат     |                                                       Змінене опитування                                                      |
+| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування |
+@startuml
+    |Користувач|
+    start
+    : Переходить на сторінку редагування опитування;
+    |Система|
+    : Виводить інтерфейс редагування опитування;
+    note right #lightpink
+        <b>Можливі 001.005, 001.006, 001.008</b>
+    end note
+    |Користувач|
+    : Задає інформацію про зміни в опитуванні;
+    : Натискає кнопку збереження змін в опитуванні;
+    |Система|
+    : Змінює опитування;
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |                                                        USER.STAT_SURVEY                                                       |
+|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                               Переглянути властивості опитування                                              |
+|      Учасники     |                                                      Користувач, система                                                      |
+|     Передумови    |                            Користувач ідентифікований в системі, користувач є власником опитування                            |
+|     Результат     |                                             Інформація про властивості опитування                                             |
+| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування |
+@startuml
+    |Користувач|
+    start
+    : Натискає на кнопку перегляду інформації про опитування;
+    |Система|
+    : Виводить інформацію про опитування;
+    note right #lightpink
+        <b>Можливі 001.005, 001.006, 001.008</b>
+    end note
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |        USER.TAKE_ANON_SURVEY         |
+|:-----------------:|:------------------------------------:|
+|       Назва       |      Пройти анонімне опитування      |
+|      Учасники     |         Користувач, система          |
+|     Передумови    |               Відсутні               |
+|     Результат     |    Запис відповідей на опитування    |
+| Виключні ситуації | 001.006 Запитане опитування не існує |
+@startuml
+    |Користувач|
+    start
+    : Переходить на сторінку проходження опитування;
+    |Система|
+    : Виводить перелік запитань опитування;
+    note right #lightpink
+        <b>Можлива 001.006</b>
+    end note
+    |Користувач|
+    : Вводить відповіді на запитання;
+    : Натискає кнопку надсилання відповідей;
+    |Система|
+    : Записує відповіді на опитування;
+    note right #lightpink
+        <b>Можлива 001.006</b>
+    end note
+    : Виводить прощальне повідомлення;
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |                             USER.TAKE_NAMED_SURVEY                            |
+|:-----------------:|:-----------------------------------------------------------------------------:|
+|       Назва       |                           Пройти поіменне опитування                          |
+|      Учасники     |                              Користувач, система                              |
+|     Передумови    |                      Користувач ідентифікований в системі                     |
+|     Результат     |          Запис відповідей на опитування та відомості про користувача          |
+| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує |
+@startuml
+    |Користувач|
+    start
+    : Переходить на сторінку проходження опитування;
+    |Система|
+    : Виводить перелік запитань опитування;
+    note right #lightpink
+        <b>Можливі 001.005, 001.006</b>
+    end note
+    |Користувач|
+    : Вводить відповіді на запитання;
+    : Натискає кнопку надсилання відповідей;
+    |Система|
+    : Записує відповіді на опитування та відомості про користувача;
+    note right #lightpink
+        <b>Можлива 001.006</b>
+    end note
+    : Виводить прощальне повідомлення;
+    |Користувач|
+    stop
+@enduml

utils/table-generator/convert.py

@@ -34,6 +34,27 @@ def convert_usecase_v1(filename, data):
 
     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))
@@ -60,15 +81,101 @@ def generate_table(raw_table_data):
 
     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)
@@ -104,6 +211,12 @@ if __name__=="__main__":
             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]
@@ -133,6 +246,13 @@ if __name__=="__main__":
         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)
@@ -162,6 +282,13 @@ if __name__=="__main__":
         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)

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/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()