Merge pull request 'Лаб №4: додавання ER-моделі' (#40) from shmuliar into master

Reviewed-on: #40

docs/design/README.md

@@ -1,11 +1,6 @@
-# Проєктування системи
+# Проєктування бази даних
 
-
+## BE модель
-Вбудовування зображень діаграм здійснюється з використанням сервісу [plantuml.com](https://plantuml.com/). 
-
-В markdown-файлі використовується опис діаграми
-
-```md
 
 <center style="
     border-radius:4px;
@@ -16,34 +11,58 @@
 
 @startuml
 
-participant Client
+entity Account <<ENTITY>>
+entity Account.username <<TEXT>>
+entity Account.password <<TEXT>>
 
-participant SR as "Service Registry"
+entity Survey <<ENTITY>>
+entity Survey.name <<TEXT>>
+entity Survey.duration <<TEXT>>
+entity Survey.isPaused <<BOOLEAN>>
+entity Survey.isNamed <<BOOLEAN>>
 
-participant Service
+entity Question <<ENTITY>>
+entity Question.text <<TEXT>>
 
-Service -> SR : register
+entity Responce <<ENTITY>>
-SR -> SR
+entity Responce.value <<TEXT>>
-SR --> Service
-...
 
-SR -> Service: heartbeat
+entity Link <<ENTITY>>
-SR <-- Service: health
+entity Link.usageLimit <<INT>>
-...
+entity Link.responceLimit <<INT>>
+entity Link.uses <<INT>>
+entity Link.responces <<INT>>
+entity Link.path <<TEXT>>
 
-Client -> SR: find
+Account.username --* Account
-Client <-- SR: service endpoint
+Account.password --* Account
-Client -> Service: request
-Client <-- Service: response
 
+Survey.name --* Survey
+Survey.duration --* Survey
+Survey.isPaused --* Survey
+Survey.isNamed --* Survey
 
+Link.usageLimit -u-* Link
+Link.responceLimit -u-* Link
+Link.uses --* Link
+Link.responces --* Link
+Link.path -u-* Link
+
+Responce.value -u-* Responce
+
+Question.text -u-* Question
+
+Account "1,1" -- "0,*" Survey
+Survey "1,1" -- "0,*" Question
+Question "1,1" -r- "0,*" Responce
+Account "0,1" -r- "0,*" Responce
+Link "0,*" -- "1,1" Survey
 
 @enduml
 
 </center>
-```
 
-яка буде відображена наступним чином
+## ER-модель
 
 <center style="
     border-radius:4px;
@@ -54,33 +73,45 @@ Client <-- Service: response
 
 @startuml
 
-    @startuml
+entity Account <<ENTITY>> {
+    id:INT
+    username:CHAR(64)
+    password:CHAR(256)
+}
 
-participant Client
+entity Responce <<ENTITY>> {
+    id:INT
+    value:CHAR(16384)
+}
 
-participant SR as "Service Registry"
+entity Question <<ENTITY>> {
+    id:INT
+    text:CHAR(256)
+}
 
-participant Service
+entity Survey <<ENTITY>> {
-
+    id:INT
-Service -> SR : register
+    name:CHAR(256)
-SR -> SR
+    duration:CHAR(256)
-SR --> Service
+    isPaused:BOOLEAN
-...
+    isNamed:BOOLEAN
-
+}
-SR -> Service: heartbeat
-SR <-- Service: health
-...
-
-Client -> SR: find
-Client <-- SR: service endpoint
-Client -> Service: request
-Client <-- Service: response
 
+entity Link <<ENTITY>> {
+    id:INT
+    uses:INT
+    responces:INT
+    usageLimit:INT
+    responceLimit:INT
+    path:CHAR(32)
+}
 
+Responce "0,*" --> "1,1" Question
+Question "0,*" --> "1,1" Survey
+Survey "0,*" --> "1,1" Account
+Link "0,*" --> "1,1" Survey
+Responce "0,*" --> "0,1" Account
 
 @enduml
 
 </center>
-
-
-

docs/requirements/stakeholders-needs.md

@@ -93,6 +93,33 @@
 | Виключні ситуації |                                                                                                                                                             001.005 Користувач не ідентифікований                                                                                                                                                              |
 | Основний сценарій | 1. Користувач натискає на кнопку редагування облікового запису<br>2. Система виводить інтерфейс для редагування облікового запису (можлива 001.005)<br>3. Користувач вказує бажані зміни властивостей облікового запису<br>4. Користувач натискає на кнопку внесення змін до властивостей облікового запису<br>5. Система змінює властивості облікового запису |
 
+|         ID        |                                                                                                                                                  SURVEY.LINK.CREATE                                                                                                                                                  |
+|:-----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                                                                                                                            Додати посилання на опитування                                                                                                                                            |
+|      Учасники     |                                                                                                                                                 Користувач, система                                                                                                                                                  |
+|     Передумови    |                                                                                                                                          Користувач авторизований у системі                                                                                                                                          |
+|     Результат     |                                                                                                                                             Нове посилання на опитування                                                                                                                                             |
+| Виключні ситуації |                                                                                            001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування                                                                                             |
+| Основний сценарій | 1. Користувач натискає кнопку створення посилання на опитування<br>2. Система виводить налаштування для нового посилання (можливі 001.005, 001.006, 001.008)<br>3. Користувач вводить налаштування для нового посилання<br>4. Користувач натискає на кнопку створення посилання<br>5. Система створює нове посилання |
+
+|         ID        |                                                                                                                          SURVEY.LINK.DELETE                                                                                                                          |
+|:-----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                                                                                                   Видалити посилання на опитування                                                                                                                   |
+|      Учасники     |                                                                                                                         Користувач, система                                                                                                                          |
+|     Передумови    |                                                                                                                  Користувач авторизований у системі                                                                                                                  |
+|     Результат     |                                                                                                                  Видалення посилання на опитування                                                                                                                   |
+| Виключні ситуації |                                                 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування<br>001.009 Запитане посилання на існує                                                 |
+| Основний сценарій | 1. Користувач натискає кнопку видалення посилання<br>2. Система виводить кнопку підтвердження видалення посилання<br>3. Користувач натискає на кнопку підтвердження видалення посилання<br>4. Система видаляє посилання (можливі 001.005, 001.006, 001.008, 001.009) |
+
+|         ID        |                                                                                                                                                                   SURVEY.LINK.MODIFY                                                                                                                                                                   |
+|:-----------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                                                                                                                                      Змінити властивості посилання на опитування                                                                                                                                                       |
+|      Учасники     |                                                                                                                                                                  Користувач, система                                                                                                                                                                   |
+|     Передумови    |                                                                                                                                                           Користувач авторизований у системі                                                                                                                                                           |
+|     Результат     |                                                                                                                                                       Зміна властивостей посилання на опитування                                                                                                                                                       |
+| Виключні ситуації |                                                                                          001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування<br>001.009 Запитане посилання на існує                                                                                          |
+| Основний сценарій | 1. Користувач натискає кнопку редагування властивостей посилання<br>2. Система виводить налаштування для обраного посилання (можливі 001.005, 001.006, 001.008, 001.009)<br>3. Користувач вводить юажані зміни властивостей посилання<br>4. Користувач натискає на кнопку збереження властиностей посилання<br>5. Система змінює властивості посилання |
+
 |         ID        |                                                                                                                                                                            USER.CREATE_SURVEY                                                                                                                                                                            |
 |:-----------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
 |       Назва       |                                                                                                                                                                           Створити опитування                                                                                                                                                                            |
@@ -210,6 +237,9 @@ Cистема розділяє користувачів на дві катего
 - створити опитування
 - відредагувати своє опитування
 - видалити своє опитування
+- створити посилання на своє опитування
+- редагувати властивості посилання на своє опитування
+- видалити посилання на своє опитування
 - призупинити своє опитування
 - продовжити своє опитування
 - переглянути властивості свого опитування

docs/use-cases/README.md

@@ -17,6 +17,9 @@
     (<b>ACCOUNT.CREATE</b>\nСтворити обліковий запис) as CreateAccount
     (<b>ACCOUNT.DELETE</b>\nВидалити обліковий запис) as DeleteAccount
     (<b>ACCOUNT.MODIFY</b>\nЗмінити властивості облікового запису) as ModifyAccount
+    (<b>SURVEY.LINK.CREATE</b>\nСтворити посилання на опитування) as CreateLink
+    (<b>SURVEY.LINK.DELETE</b>\nВидалити посилання на опитування) as DeleteLink
+    (<b>SURVEY.LINK.MODIFY</b>\nЗмінити властивості посилання на опитування) as ModifyLink
     (<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
@@ -33,6 +36,9 @@
 
     AuthorisedUser -r-> ModifyAccount
     AuthorisedUser -u-> DeleteAccount
+    AuthorisedUser -r-> CreateLink
+    AuthorisedUser -l-> DeleteLink
+    AuthorisedUser -u-> ModifyLink
     AuthorisedUser -u-> LogOut
     AuthorisedUser --> CreateSurvey
     AuthorisedUser -u-> DeleteSurvey
@@ -80,9 +86,15 @@
     (<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
+    (<b>SURVEY.LINK.CREATE</b>\nСтворити посилання на опитування) as CreateLink
+    (<b>SURVEY.LINK.DELETE</b>\nВидалити посилання на опитування) as DeleteLink
+    (<b>SURVEY.LINK.MODIFY</b>\nЗмінити властивості посилання на опитування) as ModifyLink
 
     AuthorisedUser -r-> ModifyAccount
     AuthorisedUser -u-> DeleteAccount
+    AuthorisedUser -r-> CreateLink
+    AuthorisedUser -l-> DeleteLink
+    AuthorisedUser -u-> ModifyLink
     AuthorisedUser -u-> LogOut
     AuthorisedUser -d-> CreateSurvey
     AuthorisedUser -u-> DeleteSurvey
@@ -221,6 +233,80 @@
     stop
 @enduml
 
+|         ID        |                                                       SURVEY.LINK.CREATE                                                      |
+|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                                 Додати посилання на опитування                                                |
+|      Учасники     |                                                      Користувач, система                                                      |
+|     Передумови    |                                               Користувач авторизований у системі                                              |
+|     Результат     |                                                  Нове посилання на опитування                                                 |
+| Виключні ситуації | 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        |                                                                          SURVEY.LINK.DELETE                                                                          |
+|:-----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                                                   Видалити посилання на опитування                                                                   |
+|      Учасники     |                                                                         Користувач, система                                                                          |
+|     Передумови    |                                                                  Користувач авторизований у системі                                                                  |
+|     Результат     |                                                                  Видалення посилання на опитування                                                                   |
+| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування<br>001.009 Запитане посилання на існує |
+@startuml
+    |Користувач|
+    start
+    : Натискає кнопку видалення посилання;
+    |Система|
+    : Виводить кнопку підтвердження видалення посилання;
+    |Користувач|
+    : Натискає на кнопку підтвердження видалення посилання;
+    |Система|
+    : Видаляє посилання;
+    note right #lightpink
+        <b>Можливі 001.005, 001.006, 001.008, 001.009</b>
+    end note
+    |Користувач|
+    stop
+@enduml
+
+|         ID        |                                                                          SURVEY.LINK.MODIFY                                                                          |
+|:-----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+|       Назва       |                                                             Змінити властивості посилання на опитування                                                              |
+|      Учасники     |                                                                         Користувач, система                                                                          |
+|     Передумови    |                                                                  Користувач авторизований у системі                                                                  |
+|     Результат     |                                                              Зміна властивостей посилання на опитування                                                              |
+| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування<br>001.009 Запитане посилання на існує |
+@startuml
+    |Користувач|
+    start
+    : Натискає кнопку редагування властивостей посилання;
+    |Система|
+    : Виводить налаштування для обраного посилання;
+    note right #lightpink
+        <b>Можливі 001.005, 001.006, 001.008, 001.009</b>
+    end note
+    |Користувач|
+    : Вводить юажані зміни властивостей посилання;
+    : Натискає на кнопку збереження властиностей посилання;
+    |Система|
+    : Змінює властивості посилання;
+    |Користувач|
+    stop
+@enduml
+
 |         ID        |                                            USER.CREATE_SURVEY                                            |
 |:-----------------:|:--------------------------------------------------------------------------------------------------------:|
 |       Назва       |                                           Створити опитування                                            |

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. Система змінює властивості посилання