Merge pull request #262 from AY2122S1-CS2103T-W13-2/jiahao/UGDG-update

Add PasswordCommand sequence diagram
AY2122S1-CS2103T-W13-2 · Nov 7, 2021 · 5a41aae · 5a41aae
2 parents 32f6acc + 72520ec
commit 5a41aae
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 3 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -469,10 +469,16 @@ The system first checks if the password is valid. This is due to the fact that t
 
 The user can change the password if they wish. The diagram below summarises the workflow.
 
-![Change password diagram](images/FlowChangePassword.png)
+![Change password activity diagram](images/FlowChangePassword.png)
 
 The `PasswordCommandParser` checks the format and the validity of the new password. Then, the `LogicManager` will check if the old password supplied is correct. If the old password is correct, the `Encryption` in `LogicManager` will be updated and the data file will be encrypted with the new `Encryption`. This enables the changing of password.
 
+The Sequence Diagram below illustrates the interactions within the Logic component for changing a password. Note that some parts are omitted for simplicity.
+
+![PasswordCommand diagram](images/PasswordCommandSequenceDiagram.png)
+
+The PasswordCommand is executed by a special `executePasswordCommand` method. Two `EncryptionManager` are created, each corresponds to one password. The one for the old password will be used to decrypt the data file. The one for the new password will be used to encrypt the decrypted data file. The decrypted data file is then removed. This completes the process of changing password.
+
 ### Find feature
 
 #### Implementation

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -644,7 +644,7 @@ The flags used in `password` are as follows:
 password
 ```
 
-Do note that the password needs to be between **8** and **32** characters (inclusive) long.
+Do note that the password needs to be between **8** and **32** (inclusive) ASCII characters.
 
 The prohibited characters are : `/`, `-`. Note that password cannot contain blank space.
 

diff --git a/docs/diagrams/PasswordCommandSequenceDiagram.puml b/docs/diagrams/PasswordCommandSequenceDiagram.puml
@@ -0,0 +1,52 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+end box
+
+box Encryption
+participant "temp:EncryptionManager" as EncryptionManager1 ENCRYPTION_COLOR
+participant "new:EncryptionManager" as EncryptionManager2 ENCRYPTION_COLOR
+end box
+
+participant "<color:#red>**<<class>>**\n<color:#black>FileUtil" as FileUtil
+
+[-> LogicManager : executePasswordCommand(...)
+activate LogicManager
+
+create EncryptionManager1
+LogicManager -> EncryptionManager1
+activate EncryptionManager1
+
+EncryptionManager1 --> LogicManager
+deactivate EncryptionManager1
+
+create EncryptionManager2
+LogicManager -> EncryptionManager2
+activate EncryptionManager2
+
+EncryptionManager2 --> LogicManager
+deactivate EncryptionManager2
+
+LogicManager -> EncryptionManager1  : decrypt()
+activate EncryptionManager1
+
+EncryptionManager1 --> LogicManager
+deactivate EncryptionManager1
+
+LogicManager -> EncryptionManager2 : encrypt()
+activate EncryptionManager2
+
+EncryptionManager2 --> LogicManager
+deactivate EncryptionManager2
+
+LogicManager -> FileUtil : deleteFile()
+activate FileUtil
+
+FileUtil --> LogicManager
+deactivate FileUtil
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/images/PasswordCommandSequenceDiagram.png b/docs/images/PasswordCommandSequenceDiagram.png
diff --git a/docs/team/zhou-jiahao-1998.md b/docs/team/zhou-jiahao-1998.md
@@ -14,7 +14,7 @@ Given below are my contributions to the project.
 * **New Feature**: Encryption integration
     * What it does: allows SPAM to read and write from the encrypted file.
     * Justification: This feature makes sure that the data file stays encrypted at all times.
-    * Credits: Pair programming with @huizhuansam.
+    * Credits: Pair programming with [@huizhuansam](https://github.com/huizhuansam).
 
 
 * **New Feature**: Password protection