Skip to content

Commit 564f5c5

Browse files
jocelyn-sohjocelyn-soh
committed
Merge branch 'master' of https://github.com/AY2324S2-CS2103T-W10-4/tp into fix-bugs
2 parents 20d9b8f + edadb2f commit 564f5c5

File tree

53 files changed

+1363
-214
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1363
-214
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-W10-4/tp/actions)
22

3-
![Ui](docs/images/UpdatedUI.png)
3+
![Ui](docs/images/Ui.png)
44

55
# TutorsContactsPro
66

@@ -11,6 +11,6 @@
1111
* It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
1212
* It comes with a **reasonable level of user and developer documentation**.
1313
* It is named `TutorsContactsPro` (`TCP` for short) which means it is a pro-version app for tutors to manage their students
14-
* For the detailed documentation of this project, see the **[Address Book Product Website](https://ay2324s2-cs2103t-w10-4.github.io/tp/index.html)**.
14+
* For the detailed documentation of this project, see the **[TutorsContactsPro Product Website](https://ay2324s2-cs2103t-w10-4.github.io/tp/index.html)**.
1515
* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
1616
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

‎docs/DeveloperGuide.md‎

Lines changed: 708 additions & 82 deletions
Large diffs are not rendered by default.

‎docs/UserGuide.md‎

Lines changed: 119 additions & 91 deletions
Large diffs are not rendered by default.

‎docs/diagrams/AddGroupActivityDiagram.puml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
@startuml
2+
start
3+
:User executes addgroup command;
4+
5+
'Since the beta syntax does not support placing the condition outside the
6+
'diamond we place it as the true branch instead.
7+
8+
if () then ([GROUP_NAME provided is invalid])
9+
:Show invalid group name as error message;
10+
11+
else ([else])
12+
if () then ([Group name already exists in TutorsContactsPro])
13+
: Show duplicate group error message;
14+
else([else])
15+
: Add group to the group list;
16+
: Displays new group tab in the GUI;
17+
endif
18+
19+
endif
20+
stop
21+
@enduml

‎docs/diagrams/AddGroupSequenceDiagram.puml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
@startuml
2+
!include style.puml
3+
4+
box Logic LOGIC_COLOR_T1
5+
participant ":LogicManager" as LogicManager LOGIC_COLOR
6+
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
7+
participant ":AddGroupCommandParser" as AddGroupCommandParser LOGIC_COLOR
8+
participant "a:AddGroupCommand" as AddGroupCommand LOGIC_COLOR
9+
participant ":CommandResult" as CommandResult LOGIC_COLOR
10+
end box
11+
12+
box Model MODEL_COLOR_T1
13+
participant ":Model" as Model MODEL_COLOR
14+
end box
15+
16+
[-> LogicManager : execute("addgroup g/LAB10")
17+
activate LogicManager
18+
19+
LogicManager -> AddressBookParser : parseCommand("addgroup g/LAB10")
20+
activate AddressBookParser
21+
22+
create AddGroupCommandParser
23+
AddressBookParser -> AddGroupCommandParser
24+
activate AddGroupCommandParser
25+
26+
AddGroupCommandParser --> AddressBookParser
27+
deactivate AddGroupCommandParser
28+
29+
AddressBookParser -> AddGroupCommandParser : parse("g/LAB10")
30+
activate AddGroupCommandParser
31+
32+
create AddGroupCommand
33+
AddGroupCommandParser -> AddGroupCommand
34+
activate AddGroupCommand
35+
36+
AddGroupCommand --> AddGroupCommandParser : a
37+
deactivate AddGroupCommand
38+
39+
AddGroupCommandParser --> AddressBookParser : a
40+
deactivate AddGroupCommandParser
41+
42+
'Hidden arrow to position the destroy marker below the end of the activation bar.
43+
AddGroupCommandParser -[hidden]-> AddressBookParser
44+
destroy AddGroupCommandParser
45+
46+
AddressBookParser --> LogicManager : a
47+
deactivate AddressBookParser
48+
49+
LogicManager -> AddGroupCommand : execute()
50+
activate AddGroupCommand
51+
52+
AddGroupCommand -> Model : hasGroup(LAB10)
53+
activate Model
54+
55+
Model --> AddGroupCommand
56+
deactivate Model
57+
58+
AddGroupCommand -> Model : addGroup(LAB10)
59+
activate Model
60+
61+
Model --> AddGroupCommand
62+
deactivate Model
63+
64+
create CommandResult
65+
AddGroupCommand -> CommandResult
66+
activate CommandResult
67+
68+
CommandResult --> AddGroupCommand : result
69+
deactivate CommandResult
70+
71+
AddGroupCommand --> LogicManager : result
72+
deactivate AddGroupCommand
73+
74+
[<--LogicManager
75+
deactivate LogicManager
76+
@enduml

‎docs/diagrams/DeleteActivityDiagram.puml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
@startuml
22
start
3-
:Student TA executes add command;
3+
:User executes delete command;
44

5-
if () then ([command is in invalid format])
5+
if () then ([No INDEX provided])
66
:Show invalid command format as error message;
77

88
else ([else])
9-
if () then ([Student already exists in TutorsContactsPro])
10-
: Show duplicate group error message;
9+
if () then ([INDEX provided is invalid])
10+
:Show invalid command format as error message;
1111
else([else])
12-
: Add student to the contact list;
13-
: Displays student list in the GUI;
12+
: Deletes the specific student from the contact list;
13+
: Displays updated student list in the GUI;
1414
endif
1515

1616
endif

‎docs/diagrams/DeleteGroupActivityDiagram.puml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
@startuml
2+
start
3+
:User executes deletegroup command;
4+
5+
if () then ([GROUP_NAME provided in invalid])
6+
:Show invalid group name as error message;
7+
8+
else ([else])
9+
if () then ([Group name does not exist in TutorsContactsPro])
10+
: Show non-existent group error message;
11+
else([else])
12+
: Delete group from the group list;
13+
: Removes the group tab in the GUI;
14+
endif
15+
16+
endif
17+
stop
18+
@enduml

‎docs/diagrams/DeleteGroupSequenceDiagram.puml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
@startuml
2+
!include style.puml
3+
4+
box Logic LOGIC_COLOR_T1
5+
participant ":LogicManager" as LogicManager LOGIC_COLOR
6+
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
7+
participant ":DeleteGroupCommandParser" as DeleteGroupCommandParser LOGIC_COLOR
8+
participant "d:DeleteGroupCommand" as DeleteGroupCommand LOGIC_COLOR
9+
participant ":CommandResult" as CommandResult LOGIC_COLOR
10+
end box
11+
12+
box Model MODEL_COLOR_T1
13+
participant ":Model" as Model MODEL_COLOR
14+
end box
15+
16+
[-> LogicManager : execute("deletegroup g/TUT05")
17+
activate LogicManager
18+
19+
LogicManager -> AddressBookParser : parseCommand("deletegroup g/TUT05")
20+
activate AddressBookParser
21+
22+
create DeleteGroupCommandParser
23+
AddressBookParser -> DeleteGroupCommandParser
24+
activate DeleteGroupCommandParser
25+
26+
DeleteGroupCommandParser --> AddressBookParser
27+
deactivate DeleteGroupCommandParser
28+
29+
AddressBookParser -> DeleteGroupCommandParser : parse("g/TUT05")
30+
activate DeleteGroupCommandParser
31+
32+
create DeleteGroupCommand
33+
DeleteGroupCommandParser -> DeleteGroupCommand
34+
activate DeleteGroupCommand
35+
36+
DeleteGroupCommand --> DeleteGroupCommandParser : d
37+
deactivate DeleteGroupCommand
38+
39+
DeleteGroupCommandParser --> AddressBookParser : d
40+
deactivate DeleteGroupCommandParser
41+
42+
DeleteGroupCommandParser -[hidden]-> AddressBookParser
43+
destroy DeleteGroupCommandParser
44+
45+
AddressBookParser --> LogicManager : d
46+
deactivate AddressBookParser
47+
48+
LogicManager -> DeleteGroupCommand : execute()
49+
activate DeleteGroupCommand
50+
51+
DeleteGroupCommand -> Model : getFilteredGroupList()
52+
activate Model
53+
54+
Model --> DeleteGroupCommand
55+
deactivate Model
56+
57+
DeleteGroupCommand -> Model : deleteGroup(example)
58+
activate Model
59+
60+
Model --> DeleteGroupCommand
61+
deactivate Model
62+
63+
create CommandResult
64+
DeleteGroupCommand -> CommandResult
65+
activate CommandResult
66+
67+
CommandResult --> DeleteGroupCommand : result
68+
deactivate CommandResult
69+
70+
DeleteGroupCommand --> LogicManager : result
71+
deactivate DeleteGroupCommand
72+
73+
[<--LogicManager
74+
deactivate LogicManager
75+
@enduml

‎docs/diagrams/DeleteSequenceDiagram.puml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ deactivate DeleteCommand
3939

4040
DeleteCommandParser --> AddressBookParser : d
4141
deactivate DeleteCommandParser
42-
'Hidden arrow to position the destroy marker below the end of the activation bar.
42+
4343
DeleteCommandParser -[hidden]-> AddressBookParser
4444
destroy DeleteCommandParser
4545

‎docs/diagrams/EditGroupActivityDiagram.puml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
@startuml
2+
start
3+
:User executes editgroup command;
4+
5+
6+
if () then ([invalid command format])
7+
:Show invalid group name as error message;
8+
9+
else ([else])
10+
if () then ([Group name does not exist in TutorsContactsPro])
11+
: Show non-existent group error message;
12+
else ([else])
13+
if () then ([TELEGRAM_LINK provided is invalid])
14+
: Shows invalid telegram invite link as error message;
15+
else([else])
16+
: Edits group by adding or editing the telegram invite link assigned to that group;
17+
endif
18+
endif
19+
endif
20+
stop
21+
@enduml

0 commit comments

Comments
 (0)