ay2223s2-cs2103t-t15-4 / tp

CLIpboard

• This is a team project for Software Engineering (SE) students from CS2103T-T15-4.
  
• CLIpboard is a desktop application made for professors or teaching assistants who have a need to manage a significant number of students from different classes.
  Example usages:
  • as a storage to store particulars of students
• For the detailed documentation of this project, see the CLIpboard's Website.
• This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.

tp's Issues

As a TA, I want to view personal information for a particular student

... so that I can easily locate particulars for a single student

Change json files names that reference 'AddressBook' to 'Roster'

Consequently, would also affect test cases.
e.g. From tfifteenfour.clipboard.storage.JsonSerializableRosterTest

Add command should restrict additions of duplicate StudentID

Currently restricts based on duplicate names.

As a TA, delete all student data from a class

... so that I don’t have to delete them one by one

As a TA, I want to be able to undo my commands

... so that I can recover my data when I did some mistake (i.e. Used clear accidentally)

Browse previous commands by up and down arrow keys

so that user does not have to type in previous commands.

As a TA, I want to have a list of emails of students from the same class

... I can contact my students easily.

As a TA, I want to list out all students in my class

... so that I can retrieve a list with all of my students’ names and their particulars

As a TA, I want to be able to filter students taking a particular module only

...so that I can check against the app when I am having live lessons with the class without distractions of other students from other classes

As a TA, I want to be able to filter my students based on data such as results or name

... so I can easily find and compare data.

As s TA, I want to be able to see photos of the student

... so that I can remember their names better and refer to the correct student during class

Update the Developer Guide

As per: Week 7 #5

As a TA, I want to be able to have a centralised platform to store student information

... I can easily access and update their particulars.

Add Skeletal PPP (Yi Xin)

As per: Week 7 #4

Add Skeletal PPP (Kelvin)

As per: Week 7 #4

Add Skeletal PPP (Afiq)

As per: Week 7 #4

Update the User Guide

As per: Week 7 #3

Sample data size should be more representative of a class/cohort size

For performance testing.

Possible performance related issues (can add to this list):

1. Significant overhead might be incurred for maintaining previous states for "undo" command

Week 6 #5 Tutorial 1 : tracing code (Isabel)

Following the Tutorial under Week 6 #5 Tutorial 1 for Tracing the execution path here.

Going through the tutorial

1. Setting Breakpoint:

2. Debugger tool status after running app and entering edit 1 n/Alice Yeoh:

3. Debugger at the switch statement:

4. Checking the contents of editPersonDescriptor in EditCommandParser#parse():

5. EditCommand#execute() method creates a CommandResult object and returns it:

6. Choosing the methods to step into, highlighted in pink:

7. Sending feedback to user (shown up top pane of app):

---

Conclusion cases to try out:

1. redit 1 n/Alice Yu: AddressBookParser#parseCommand() throws a ParseException for invalid redit command.
2. edit 0 n/Alice Yu: EditCommandParser#parse() throws a ParseException for invalid index.
3. edit 1 n/Alex Yeoh: No exceptions as expected.
4. edit 1: EditCommandParser#parse() throws a ParseException as no field is updated.
5. edit 1 n/アリス ユー: ParserUtil#parseName() throws a ParseException caught in `MainWindow#executeCommand'.
6. edit 1 t/one t/two t/three t/one: No exceptions as expected as ParserUtil#parseTags() uses a Set to filter the additional one tag out in EditCommand#parseTagsForEdit().

---

Components to modify to perform following enhancements:

1. Make command words case-insensitive: Convert commandWord in AddressBookParser#parseCommand() to lower case before running through the switch statements.
2. Allow delete to remove more than one index at a time: Can allow varargs, or change the implementation of ParserUtil#parseIndex() to handle more than just a oneBasedIndex. Below is a short code of what could be done instead, excluding the actual implementations of the overloaded method.

   public static Index parseIndex(String oneBasedIndex) throws ParseException {
      // If there is possibly more than one index
       if (oneBasedIndex.trim().contains(" ")) {
              return parseIndex(oneBasedIndex.trim().split(" ");
       }
       ...
   }

4. Save the address book in the CSV format instead: In storage, add in appropriate files corresponding to the Json classes to be replaced with Csv. We also have to change the addressBookFilePath to the following (json to csv):

private Path addressBookFilePath = Paths.get("data" , "addressbook.csv");

6. Add a new command: Generally, just add a new class inheriting from logic.commands.Command , and update the AddressBookParser#parseCommand to include the new command in the switch case.
7. Add a new field to Person: Add the new field into model.person, and add it as a field under the Person class. Update methods accordingly to include the new field.
8. Add a new entity to the address book: I assume this new entity is still a person. In that case we can make Person an abstract class and have new entities such as Student or Teacher inheriting from it. New fields can be added into the corresponding new entities.

General Testing Issues

(Add on to this checklist)

• Add testing for view command
• Add testing for remark command
• Update testing for add command
• Update testing for edit command
• Update testing for EditCommandParser
• Add testing for 'upload' command
• #53

Smoke-Tests:

Update these when our product is finalized.

• Runnable on Windows (as of commit: 14f0194)
• Runnable on MacOS (as of commit: 14f0194)
• Runnable on Linux (as of commit: 14f0194)

As a TA, I want to be able to copy a student’s email

...so that I can send an email to them

Make window of displaying error message resizable

Currently, the window displaying error message resizable is fixed-size and it's troublesome for user to scroll around and read the message.

Let's make that part resizable so that it will enlarge as the app window expands.

As a TA, I want to be able to sort students by their particulars (e.g. Name / student id)

... OR to have them sorted in the first place, so that I can have a list of students in a sorted order

Help command should show more information

Instead of just redirecting to UG, would be better if it lists out the available commands

General Documentation Issues

This list is not exhaustive, please add on to it if you encounter any additional issues

Requirements as per Week 7:
DG
UG

Link to CLIpboard Guides

Would be better to categorise these according to the respective document they would affect. But no time for now :-)

---

Bugs

Landing Page

• Missing link to UG in header
  Original:

Current:

---

User Guide

• Update docs for newly added/changed commands

1. List of available commands
2. add command format changed.
3. view command keyword does not match UG (show). Either change the UG or change the code
4. Missing upload command

• README, Landing Page & UG: UI mockup does not match actual UI

---

Developer Guide

• Still references AB3.
• Landing Page: references AB3 instead of CLIpboard

• AboutUs: Contact information uses filler email

- [x] DG.Glossary: Student information does not match our implementation

---

Improvements (can be pushed to next iteration instead)

• Landing Page: Header title does not match our product name (is this intended?)

• Proof-read UG for v1.2
• Proof-read DG for v1.2
• Apply concepts from CS2101 (Crucial for grading)

As a TA, I want to be able to leave a note under a student's profile

so that I can keep track of additional information of students easily

Add testing for SortCommand

Pending remodel

Add Skeletal PPP (Isabel)

As per: Week 7 #4

Case-sensitivity in commands

Commands like find and module shouldn't be case-sensitive.

Add testing for UndoCommand

#90 implementation has been completed, but lacking testing class & methods.

On hold until more features have been merged

Add upload functionality for student photos

enhancement for user story #45

CLIpboard creates numerous files that clutters its own directory

• Find out what these files are for, what creates them, and compile them in a folder instead.
• Consequently, this will likely affect other portions of the code:
• E.g. UI pulls preferences.json from a specified file path, this has to be changed.

As a TA, I want to be able to edit a students' attendance

.. so that I can mark students are not absent if they are late

Command field font color against background color is difficult to read

Redesign UI to fit our product

• change grey theme to light brown
• redesigne some of the icons
• change application title to CLIpboard

If a valid file path to a folder is specified, the folder is added without any contents

Need to either recognise a folder as an invalid path, or allow mass uploading PNGs from within the folder

As a TA, I want to be able to add grades for exams / assignments (tasks)

... so that I can keep track of a student's result easily

As a TA, I want to be able to edit students' information easily

... so that I can update the new information easily for viewing

As a TA, I want to be able to mark a students attendance

... so that I can track who is present for a class

As a TA, I want to be able to add tasks under sessions for each student

... so that I can keep track of a student's tasks easily

Show StudentId in StudentListPanel

For cases where there are multiple students with same exact names, they are indistinguishable in the UI unless "view" is called.

Refactor AB3 code to suit CLIpboard

Currently, variable and class names in AB3 such as 'Person' class are not applicable to CLIpboard.

Let's change these names to better suit CLIpboard.

Possible renaming changes:
'Address book' -> 'Student Roster'
'address' field in Person -> 'studentId'

Remaining tasks (non-exhaustive):

• Rename json files used in testing (see #53)
• Most variable names have been changed, but some might have been missed. Keep a lookout.

Add a placeholder image for student's photo

Creates a new ImageView object in StudentCard to display student's photo

Add Skeletal PPP (Pearl)

As per: Week 7 #4

As a TA, I want to be able to record the attendance for each student

... so that I am able use to keep track of who is present in each class

As a TA, I want to add new students with their particulars

.. so that I can create a new profile for a student.

---

Basic adding functionality has already been implemented in AB3.
Below are what is to be refactored or added for CLIpboard.

• Extend Module from Tag
• Add PREFIX_MODULE = m/ prefix and update AddCommandParser to use PREFIX_MODULE (must have at least one) before PREFIX_TAG (zero or more).
• Update AddCommand instructions for MESSAGE_USAGE to have m/ beforet/
• At least one module has to be added (in AddCommandParser)
• Allow adding of notes together with adding of student command (Tentative after #21 is merged)

Eg. add n/John Doe p/98765432 e/[email protected] sid/A1234567X m/CS2103T n/Discussing Topic A on 3 Mar 2023

Note that some aspects of EditCommand have been changed due to overlaps of the functionality of modules.

RemarkCommandParser uses raw types

Display the command in red font if there is an error

Just as it was implemented in AB3

Add separate view pane for viewed student

Current GUI would display viewed student in the same student list tab.
Let's change GUI such that viewed student would be displayed in a separate pane.

As a TA, I want to remove students from my class

... so that I can update my class list if anyone needs to be removed