Branch DG usecases #327

raydenlim · 2023-11-13T19:26:09Z

No description provided.

codecov · 2023-11-13T19:28:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6f53b7d) 81.35% compared to head (5563b4b) 81.35%.
Report is 11 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##             master     #327   +/-   ##
=========================================
  Coverage     81.35%   81.35%           
  Complexity     1483     1483           
=========================================
  Files           190      190           
  Lines          4709     4709           
  Branches        513      513           
=========================================
  Hits           3831     3831           
  Misses          723      723           
  Partials        155      155

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Originalidk

Other than a small nit, LGTM!

Originalidk · 2023-11-13T19:46:05Z

docs/DeveloperGuide.md

@@ -688,7 +682,7 @@ Below is the sequence diagram outlining the execution of `EditGradeCommand`.


 Step 1:
-The `LogicManager` invokes `ViewAssignmentsCommand::execute`, which in turn calls `Model::getFilteredPersonList` and `List<Person>::get` to get the specified Student.
+The `LogicManager` invokes `EditGradeCommand::execute`, which in turn calls `Model::getFilteredPersonList` and `List<Person>::get` to get the specified Student.


Good catch!

Originalidk · 2023-11-13T19:48:07Z

docs/DeveloperGuide.md

+
+  * 3g1. F.A.K.E.J.A.R.V.I.S. shows an error message.
+
+    Use case resumes at step 2.


 *{More to be added}*


Just a nit, but think we could remove this already

ok, will delete that :)

# Conflicts: # docs/DeveloperGuide.md

ldinghan

Some nits to fix before we can merge this

ldinghan · 2023-11-13T21:55:34Z

docs/DeveloperGuide.md

@@ -173,7 +173,8 @@ Below is a class diagram describing the implementation of `Session` and its resp

 **Alternative 1 (current choice):** The `CreateSession` feature takes in arguments of varying number of student names.
 - Pros:This choice offers a high degree of flexibility when it comes to adding students to a session. You can add any number of students when creating a session, which is essential for accommodating different class sizes and situations.
-  **Alternative 2:** An alternative design could involve creating two separate constructor methods within the `CreateSession` class. One constructor would be responsible for adding a student to an existing `SessionStudents`, and the other would take an entire `SessionStudents` object as an argument.
+


Should now be StudentSet after refactoring by wesley

ldinghan · 2023-11-13T21:55:56Z

docs/DeveloperGuide.md

@@ -173,7 +173,8 @@ Below is a class diagram describing the implementation of `Session` and its resp

 **Alternative 1 (current choice):** The `CreateSession` feature takes in arguments of varying number of student names.
 - Pros:This choice offers a high degree of flexibility when it comes to adding students to a session. You can add any number of students when creating a session, which is essential for accommodating different class sizes and situations.
-  **Alternative 2:** An alternative design could involve creating two separate constructor methods within the `CreateSession` class. One constructor would be responsible for adding a student to an existing `SessionStudents`, and the other would take an entire `SessionStudents` object as an argument.
+
+**Alternative 2:** An alternative design could involve creating two separate constructor methods within the `CreateSession` class. One constructor would be responsible for adding a student to an existing `SessionStudents`, and the other would take an entire `SessionStudents` object as an argument.


Change to StudentSet

ldinghan · 2023-11-13T21:56:51Z

docs/DeveloperGuide.md

+  * Pros:
+    * Decoupling: Details of interactions between the models are abstracted away.
+  * Cons:
+    * Overkill: For a small project like F.A.K.E.J.A.R.V.I.S. this approach may be over-engineered.


Might want to remove this part or rephrase a bit to make it look more professional

ldinghan · 2023-11-13T21:57:12Z

docs/DeveloperGuide.md

+
+  * Cons:
+    * Resource Intensive: Any edits to the Score(s) of a Graded Test will create new `Person` instances, this may be resource-intensive when done in large-scale.
+    * Limited Extensibility: 


Missing con

ldinghan · 2023-11-13T21:57:25Z

docs/DeveloperGuide.md

+    * Reduce redundancy: Avoids creating new instance for every change to an Object.
+  * Cons: 
+    * Mutable Objects: Causes the `Person` object to no longer be immutable, giving rise to potential bugs or complications during the integration process.
+    * Testing/Maintenance Challenges: Requires extra attention when making test cases, to prevent unintended side effects.


remove comma

ldinghan · 2023-11-13T21:58:53Z

docs/DeveloperGuide.md

@@ -1284,7 +1354,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
    Use case ends.


-**Use case: Adding a student to a consultation**
+**Use case 15: Adding a student to a consultation**


Change to base form i.e. "Add a "

ldinghan · 2023-11-13T21:59:31Z

docs/DeveloperGuide.md

+
+* 3g. The given score is invalid.
+
+  * 3g1. F.A.K.E.J.A.R.V.I.S. shows an error message.


Not sure how 3f differs from 3g

ldinghan · 2023-11-13T22:01:07Z

docs/DeveloperGuide.md

+
+2. **Phone Number Validation**
+   * Current Implementation: Currently, any number that is longer than 3 digits are considered valid. It doesn't allow for special characters too.
+   * Enhancement: Introduce a validation mechanism for phone numbers to ensure that entered phone numbers adhere to a specified format. (e.g SG phone number starts with 8 or 9 and have)


starts with 8 or 9 and have.... incomplete sentence

ldinghan · 2023-11-13T22:02:14Z

docs/DeveloperGuide.md

+   * Enhancement: Implement the functionality to convert data to and from CSV files, enabling users to conveniently import/export data without manual editing.
+   * Reason: To enhance user convenience and data interchangeability, allowing for seamless integration with external applications that support CSV formats.
+   * Suggested Fixes:
+     * Have a `convertCsvToJson` and `convertJsonToCsv` method to convert the files accordingly.


I think instead of "convert", possibly just abstract out the conversion and just allow users to download either json or csv files?

ldinghan · 2023-11-13T22:04:23Z

docs/DeveloperGuide.md

+
+8. **Dynamic Session Number**
+   * Current Implementation: Session numbers are immutable. (e.g a Session 5 will remain as Session 5 even though Sessions 1-4 are deleted)
+   * Enhancement: Make the session number dynamic, updating automatically to reflect the current session number even after deleting previous sessions.


I think no. The idea behind having static session numbers is that it differs from the other features in a sense that each session is labelled a certain session number, rather than by indexing

ok, will remove this

raydenlim added 2 commits November 14, 2023 02:55

Update DG

e7f1ec8

Add use case and numberings

fba92ff

raydenlim added priority.High Must do severity.High A flaw that affects most users and causes major problems for users type.Documentation Documentation labels Nov 13, 2023

raydenlim added this to the v1.4 milestone Nov 13, 2023

raydenlim self-assigned this Nov 13, 2023

This was linked to issues Nov 13, 2023

DG: Add this in #310

Closed

DG: Number the use cases for clarity #321

Closed

DG: Reorder the sequence and activity diagram of gradedtest to command #322

Closed

DG: Add breaker for CreateSession #324

Closed

Merge branch 'UPDATEEEE' into branch-DG-usecases

81b0830

Originalidk approved these changes Nov 13, 2023

View reviewed changes

raydenlim added 8 commits November 14, 2023 04:23

Add test cases

e50cfee

Merge branch 'UPDATEEE' into branch-DG-usecases

2e9d0a5

# Conflicts: # docs/DeveloperGuide.md

Resolve merge conflicts

b648f4d

Update DG Add Ack

22dd0c7

Remove redundant parts in DG

2a2ec66

Update DG ack

5dcdb98

Update DG ack grammar

bf72208

Standardize testing language

5c2dea3

ldinghan reviewed Nov 13, 2023

View reviewed changes

Update DG

5563b4b

raydenlim merged commit ced73a7 into AY2324S1-CS2103T-T15-1:master Nov 13, 2023
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Branch DG usecases #327

Branch DG usecases #327

raydenlim commented Nov 13, 2023

codecov bot commented Nov 13, 2023 •

edited

Loading

Originalidk left a comment

Originalidk Nov 13, 2023

Originalidk Nov 13, 2023

raydenlim Nov 13, 2023

ldinghan left a comment

ldinghan Nov 13, 2023

ldinghan Nov 13, 2023

ldinghan Nov 13, 2023

ldinghan Nov 13, 2023

ldinghan Nov 13, 2023

ldinghan Nov 13, 2023

ldinghan Nov 13, 2023

ldinghan Nov 13, 2023

ldinghan Nov 13, 2023

ldinghan Nov 13, 2023

raydenlim Nov 13, 2023


		* 3g. The given score is invalid.

		* 3g1. F.A.K.E.J.A.R.V.I.S. shows an error message.

Branch DG usecases #327

Branch DG usecases #327

Conversation

raydenlim commented Nov 13, 2023

codecov bot commented Nov 13, 2023 • edited Loading

Codecov Report

Originalidk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ldinghan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 13, 2023 •

edited

Loading