[CS2113-W10-3] BuffBuddy #20

TVageesan · 2024-09-22T06:31:13Z

BuffBuddy aims to help people achieve their fitness goals by tracking their activities, calories, and water intake. It also provides helpful suggestions and information to provide a all-in-one fitness solution app, with a CLI interface to make accessing said information as quick as possible.

joshuan98

There are many instances of magic strings and inconsistent formatting. Please consider taking a look and resolve these.

joshuan98 · 2024-10-19T11:57:57Z

src/main/java/programme/Programme.java

+
+    public Day deleteDay(int index){
+        if (dayList.size() < index){
+            System.out.println("invalid index");


You can consider using constant field for error messages instead of a magic string

joshuan98 · 2024-10-19T12:02:44Z

src/main/java/core/Storage.java

+    private JsonObject createJSON(ProgrammeList programmeList, History history) {
+        JsonObject jsonObject = new JsonObject();
+        jsonObject.add("programmeList", programmeList.toJson());
+        jsonObject.add("history", history.toJson());
+        return jsonObject;
+    }


Storage seems to handle both file updates and json parsing. You can consider splitting this into a different file.

joshuan98 · 2024-10-19T12:03:29Z

src/main/java/core/Storage.java

+
+    private JsonObject load() {
+        try (FileReader reader = new FileReader(path)){
+            JsonElement elememt = JsonParser.parseReader(reader);


Do remember to check for spelling mistakes

joshuan98 · 2024-10-19T12:06:22Z

src/main/java/BuffBuddy.java

+import parser.Parser;
+import programme.ProgrammeList;
+
+public class BuffBuddy {


This class seems to be handling multiple functions. You can consider splitting it into different files.

joshuan98 · 2024-10-19T12:06:41Z

src/main/java/command/programme/CreateCommand.java

+public class CreateCommand extends Command {
+    public static final String COMMAND_WORD = "create";
+    private final String name;
+    private final ArrayList<Day> contents;


Perhaps this naming can be improved.

joshuan98 · 2024-10-19T12:07:27Z

src/main/java/parser/Parser.java

+
+import static parser.ParserUtils.parseIndex;
+
+public class Parser {


Do remember to add relevant code comments

joshuan98 · 2024-10-19T12:08:12Z

src/main/java/parser/Parser.java

+        case LogCommand.COMMAND_WORD -> prepareLogCommand(argumentString);
+        case HistoryCommand.COMMAND_WORD -> new HistoryCommand();
+        case ExitCommand.COMMAND_WORD -> new ExitCommand();
+        default -> new InvalidCommand();


I think you should standardise how you write your switch statements.

joshuan98 · 2024-10-19T12:08:44Z

src/main/java/parser/Parser.java

+            switch (flag){
+            case "/p":
+                progIndex = parseIndex(value);
+                break;
+            case "/d":
+                dayIndex = parseIndex(value);
+                break;
+            case "/t":
+                date = parseDate(value);
+                break;
+            default:
+                throw new IllegalArgumentException("Flag command not recognized: " + flag);


This may be considered as nesting by some. You can consider refactoring this.

joshuan98 · 2024-10-19T12:09:34Z

src/test/java/command/CommandTest.java

+    public void assertCommand() {
+        assertTrue(true);
+    }


Not too sure about the purpose of this test.

shaunngoh · 2024-10-30T04:32:13Z

docs/DeveloperGuide.md

-## Design & implementation
+### DailyRecord component
+API: `DailyRecord.java`
+![Diagram for DailyRecord Component](./images/DailyRecord_API_UML.jpg)


You could omit methods that are not directly relevant. Such as the toString() method in the DailyRecord UML diagram

Navigability is missing from Day, MealList and Water class

shaunngoh · 2024-10-30T04:37:04Z

docs/DeveloperGuide.md

+
+### Sequence Diagram
+
+![Sequence Diagram for WeeklySummary feature](./images/History%20WeeklySummary%20UML%20Sequence%20Diagram.png)


Maybe you could keep the application used to create the UML diagrams consistent?

shaunngoh · 2024-10-30T04:52:16Z

docs/DeveloperGuide.md

+
+#### Sequence Diagram for "Add Meal" Command
+
+![Add Meal Sequence Diagram](images/AddMeal_Sequence_diagram.png)


The add meal sequence diagram is missing an activation bar in MealList

ehz0ah

Overall pretty decent, just a few nits to fix. I am also wondering if the diagram is hand-drawn (on PlantUML or not). If it is, maybe you can use a standardized way to draw them

ehz0ah · 2024-10-30T04:22:32Z

docs/DeveloperGuide.md

-## Design & implementation
+### DailyRecord component
+API: `DailyRecord.java`
+![Diagram for DailyRecord Component](./images/DailyRecord_API_UML.jpg)


Functions/Methods parameter could include variable name followed by its type for better readability.

Suggested change

![Diagram for DailyRecord Component](./images/DailyRecord_API_UML.jpg)

+ logDay(newDay : Day)

ehz0ah · 2024-10-30T04:23:29Z

docs/DeveloperGuide.md


-## Design & implementation
+### DailyRecord component
+API: `DailyRecord.java`


Clear separation of association and dependencies!

ehz0ah · 2024-10-30T04:38:01Z

docs/DeveloperGuide.md

+objects, restoring the user's previous session.
+
+The following sequence diagram shows how a load operation for ProgrammeList goes through the Storage component:
+![Sequence Diagram for Load operation](./images/LoadProgrammeList_Seq_Dia.jpg)


ehz0ah · 2024-10-30T04:49:04Z

docs/DeveloperGuide.md

+![Sequence Diagram for Load operation](./images/LoadProgrammeList_Seq_Dia.jpg)
+
+The following sequence diagram shows how a save operation goes through the Storage component:
+![Sequence Diagram for Save operation](./images/Save_Seq-Dia.jpg)


For both addition of programmeListJsonObject and historyJsonObject using the add() function, you could be more specific and mention it as the arguments of the function.

Suggested change

![Sequence Diagram for Save operation](./images/Save_Seq-Dia.jpg)

add("programmeList", programmeListToJson(programmeList))

Since the add method depends on the Json object, you should consider adding it.
Since the add function depends on the Json object

ehz0ah · 2024-10-30T04:52:16Z

docs/DeveloperGuide.md

+
+### Sequence Diagram
+
+![Sequence Diagram for WeeklySummary feature](./images/History%20WeeklySummary%20UML%20Sequence%20Diagram.png)


I think you can be more consistent in your overall DG functions call in terms of how you represent your method's arguments. Some methods are shown where the arguments are represented by their type while some other methods are represented by the actual arguments.

ehz0ah · 2024-10-30T04:57:58Z

docs/DeveloperGuide.md

+
+Step 2. The user executes `programme edit /p 1 /d 1 /x 1` to delete the first exercise in the first day of the first programme. The programme first retrieves the given day with `ProgrammeList#getDay()`.
+
+![](images/editCommandStepTwo.png)


This seems slightly too nested to understand 😵

Yvorm · 2024-10-30T05:34:30Z

docs/DeveloperGuide.md

+### Save/Load Feature
+
+The save/load mechanism is handled by three main components: `Storage`, `FileManager`, and `DateSerializer`. `FileManager` manages file interactions, including reading from and writing to JSON data files, while `Storage` handles the conversion between JSON objects and `ProgrammeList`/`History` objects. The `DateSerializer` is used for converting `LocalDate` to/from JSON format.
+
+#### FileManager implements the following key operations:
+- **`FileManager#load()`**: Reads the data file into a `JsonObject`.
+- **`FileManager#save(JsonObject data)`**: Writes the `JsonObject` containing all data back into the file.
+- **`FileManager#createDirIfNotExist()`** and **`FileManager#createFileIfNotExist()`**: Ensure that the necessary directory and file exist before saving.
+
+#### Storage converts JSON data into Java objects:
+- **`Storage#loadProgrammeList()`**: Converts the `ProgrammeList` JSON data into a `ProgrammeList` object using `programmeListFromJson()`.
+- **`Storage#loadHistory()`**: Converts the `History` JSON data into a `History` object using `historyFromJson()`.
+- **`Storage#saveData()`**: Converts `ProgrammeList` and `History` into JSON using `createJSON()`, and passes it to `FileManager#save()`.
+
+#### DateSerializer is responsible for:
+- **`DateSerializer#serialize()`**: Converts `LocalDate` into `JsonElement`.
+- **`DateSerializer#deserialize()`**: Converts `JsonElement` back into `LocalDate`.
+
+These operations are exposed in the `Model` interface, allowing seamless saving and loading of `ProgrammeList` and `History` data.


Save/Lead implementation overview is accurate and concise. LGTM!

Yvorm · 2024-10-30T05:40:10Z

docs/DeveloperGuide.md

+![Add Meal Step 1](images/AddMeal_Step_one_diagram.png)
+
+**Step 2**: The command retrieves the `DailyRecord` for the specified date from the `History` using `History#getRecordByDate()`. If no record exists, a new one is created.
+
+![Add Meal Step 2](images/AddMeal_Step_two_diagram.png)
+
+**Step 3**: The `AddMealCommand` adds the meal to the `MealList` of the `DailyRecord`. If the meallist already exists, it updates the existing meallist instead.
+
+![Add Meal Step 3](images/AddMeal_Step_three_diagram.png)
+
+**Step 4**: The newly added `Meal` object is returned to the `AddMealCommand` to display as part of the `CommandResult`.
+
+![Add Meal Step 4](images/AddMeal_Step_four_diagram.png)


Should these diagrams be using non-orthogonal lines?

Yvorm · 2024-10-30T05:51:05Z

docs/DeveloperGuide.md

-## Design & implementation
+### DailyRecord component
+API: `DailyRecord.java`
+![Diagram for DailyRecord Component](./images/DailyRecord_API_UML.jpg)


You may want to digitise or clarify the names of some of your operations, they are a bit difficult to read at points.

Great work! Maybe can use consistent formatting for all diagrams so that readability can be improved and the DG can look more unified overall.

Yvorm · 2024-10-30T05:56:33Z

docs/DeveloperGuide.md

+
+### Sequence Diagram
+
+![Sequence Diagram for WeeklySummary feature](./images/History%20WeeklySummary%20UML%20Sequence%20Diagram.png)


You may want to rewrite / clarify the names used in this diagram, they are a bit difficult to understand. Also nitpicky - but the lines in this diagram (activation bars) are not straight.

Yvorm · 2024-10-30T06:00:00Z

docs/DeveloperGuide.md

+The following sequence diagram shows how a load operation for ProgrammeList goes through the Storage component:
+![Sequence Diagram for Load operation](./images/LoadProgrammeList_Seq_Dia.jpg)
+
+The following sequence diagram shows how a save operation goes through the Storage component:


You may want to rewrite operation names, they are unclear and very difficult to understand currently.

wx-03 · 2024-10-30T06:26:57Z

docs/DeveloperGuide.md

+![Sequence Diagram for Load operation](./images/LoadProgrammeList_Seq_Dia.jpg)
+
+The following sequence diagram shows how a save operation goes through the Storage component:
+![Sequence Diagram for Save operation](./images/Save_Seq-Dia.jpg)


Perhaps you could standardize the software used to generate the sequence diagrams rather than having only some hand-drawn

wx-03 · 2024-10-30T06:33:53Z

docs/DeveloperGuide.md

+
+#### Sequence Diagram for "Add Meal" Command
+
+![Add Meal Sequence Diagram](images/AddMeal_Sequence_diagram.png)


It is unclear what the hexadecimal values in the sequence diagram represent

wx-03 · 2024-10-30T06:37:58Z

docs/DeveloperGuide.md

+
+**Step 4**: The newly added `Meal` object is returned to the `AddMealCommand` to display as part of the `CommandResult`.
+
+![Add Meal Step 4](images/AddMeal_Step_four_diagram.png)


These diagrams are confusing and hard to understand

wx-03 · 2024-10-30T06:40:50Z

docs/DeveloperGuide.md

+
+The overall design that enables this functionality is described generically by the following sequence diagram.
+
+![Edit Command generic sequence](images/editCommand.png)


Arrows representing method returns should be dashed arrows.

Metanyu

Very detailed guide overall, maybe some changes are needed so that the guide looks more professional and unified. Great work!

Metanyu · 2024-10-31T15:12:38Z

docs/DeveloperGuide.md

-## Design & implementation
+### DailyRecord component
+API: `DailyRecord.java`
+![Diagram for DailyRecord Component](./images/DailyRecord_API_UML.jpg)


Great work! Maybe can use consistent formatting for all diagrams so that readability can be improved and the DG can look more unified overall.

Metanyu · 2024-10-31T15:18:53Z

docs/DeveloperGuide.md

+  day, and removing items such as meals or water entries. Each modification is logged for traceability.
+- **Calculates key daily statistics:** `DailyRecord` is capable of calculating the total calories burned from the recorded `Day` and the
+  calories gained from the `MealList`. It can also sum the total water intake for the day.
+- **Provides a comprehensive summary:** The class’s `toString()` method generates a detailed summary of the day’s activities, including


I like the clear description of functionality for this component!

Metanyu · 2024-10-31T15:37:22Z

docs/DeveloperGuide.md

+
+### Sequence Diagram
+
+![Sequence Diagram for WeeklySummary feature](./images/History%20WeeklySummary%20UML%20Sequence%20Diagram.png)


Very easy to understand description and sequence diagram! Maybe more consistent formatting and more contrast coloring (the black activation bar against black background is hard to see)

Metanyu · 2024-10-31T15:40:57Z

docs/DeveloperGuide.md

+
+The overall design that enables this functionality is described generically by the following sequence diagram.
+
+![Edit Command generic sequence](images/editCommand.png)


Potential diagram bug: Is the activation bar for Model class too long ?

Metanyu · 2024-10-31T15:44:25Z

docs/DeveloperGuide.md

+
+The overall design that enables this functionality is described generically by the following sequence diagram.
+
+![Edit Command generic sequence](images/editCommand.png)


Another potential bug: activation bar for Parser never ended?

Metanyu · 2024-10-31T15:46:36Z

docs/DeveloperGuide.md

+This flow allows users to easily create structured workout routines, customizing their fitness journey directly within BuffBuddy.
+
+The overall design that enables this functionality is described generically by the following sequence diagram.
+![](images/createCommand.jpeg)


Maybe can use digital tools for this diagram because it's hard to clearly make out the details in this.

Adjust history commands

…into DG

Update DG

Update ProgCommandFactory to ProgrammeCommandFactory

Finish documentation

Edit PPP

…into v2.0_BugFix

Edited programme exceptions

update PPP

Merge with master

Update authorship

Editing PPP

PPP

Shortened PPP

made changes to exceptions

Finish BuffBuddy

joshuan98 reviewed Oct 19, 2024

View reviewed changes

shaunngoh reviewed Oct 30, 2024

View reviewed changes

ehz0ah reviewed Oct 30, 2024

View reviewed changes

Yvorm reviewed Oct 30, 2024

View reviewed changes

wx-03 reviewed Oct 30, 2024

View reviewed changes

Metanyu reviewed Oct 31, 2024

View reviewed changes

Bev-low and others added 24 commits November 7, 2024 11:03

Upload loadProgrammeListSeqenceDiagram image

a51ba86

Upload Save Sequence Diagram

65118b5

Change ReadMe File

1c8c97a

Adjust history commands

ef35c27

Merge branch 'master' into Adjust-History-Commands

9945772

Fix checkstyle error

3caf340

Update UG

0d163c4

Remove test

1f8455c

Remove title to standarise

c1ae5ac

Add programme Compoennt and descriptions

6fc0059

Add programme Compoennt diagram

7bd3ede

Add Date Seralizer in diagram

d412197

Add Save Seq Dia

6f3a5a3

Move Private methods to the top for DailyRecord

898f3cc

Minor fixes

34cf6b4

Merge pull request #229 from TVageesan/Adjust-History-Commands

8e86548

Adjust history commands

Merge branch 'master' of https://github.com/AY2425S1-CS2113-W10-3/tp …

69b3deb

…into DG

Add Date Serializer description

a201fbb

Added a toStringPB for PB printing for nicer looking strings

f814ab1

Make printing pb nicer

c7d0a97

Fix printing of History PB commands and updated UG accordingly

8bdd01c

Add JavaDoc to toStringPb

0b48724

Added PPP changes

4a7efeb

Merge pull request #230 from Bev-low/DG

5d1ddd5

Update DG

nirala-ts and others added 30 commits November 12, 2024 13:06

Add link to PPP

4bf740f

Merge pull request #310 from nirala-ts/master

7b2d09f

Update ProgCommandFactory to ProgrammeCommandFactory

Merge pull request #311 from TVageesan/master

ebbfc6b

Finish documentation

Edited programme exceptions

28621c8

Edit PPP

fa3eaf4

update PPP

f1cb94c

Shortened PPP

d37d9d8

Update tvageesan.md

a3e357d

Merge pull request #313 from nirala-ts/master

ccb34bf

Edit PPP

Merge branch 'master' of https://github.com/AY2425S1-CS2113-W10-3/tp …

01d9250

…into v2.0_BugFix

Merge pull request #312 from Atulteja/master

2dc572f

Edited programme exceptions

Update Log feature authorship

0780db9

Merge pull request #314 from Bev-low/v2.0_BugFix

7bbdc39

update PPP

Merge branch 'master' of https://github.com/AY2425S1-CS2113-W10-3/tp

4bc00d4

Merge with master

Shortened PPP

ba9f46a

Merge pull request #315 from nirala-ts/master

d81a2fb

Update authorship

Merge pull request #316 from Atulteja/master

c3ccd36

Editing PPP

Add Link

d5f8893

Merge pull request #317 from Bev-low/v2.0_BugFix

2b4e1be

PPP

Update DeveloperGuide.md

db6759a

Shortened PPP

778847a

Merge pull request #318 from Atulteja/master

7b812c5

Shortened PPP

Update BuffBuddy.java

d1da3f5

made changes to exceptions

4931ffd

made changes to exceptions

b76319a

Merge pull request #319 from Atulteja/master

56d1602

made changes to exceptions

Finish BuffBuddy

b0ad264

Solve checkstyle bug

b770f5b

Merge pull request #320 from TVageesan/master

004ca15

Finish BuffBuddy

Update UserGuide.md

ec1b69d


		import static parser.ParserUtils.parseIndex;

		public class Parser {


		### Sequence Diagram

		![Sequence Diagram for WeeklySummary feature](./images/History%20WeeklySummary%20UML%20Sequence%20Diagram.png)


		#### Sequence Diagram for "Add Meal" Command

		![Add Meal Sequence Diagram](images/AddMeal_Sequence_diagram.png)

	![Diagram for DailyRecord Component](./images/DailyRecord_API_UML.jpg)
	+ logDay(newDay : Day)

	![Sequence Diagram for Save operation](./images/Save_Seq-Dia.jpg)
	add("programmeList", programmeListToJson(programmeList))


		Step 2. The user executes `programme edit /p 1 /d 1 /x 1` to delete the first exercise in the first day of the first programme. The programme first retrieves the given day with `ProgrammeList#getDay()`.

		![](images/editCommandStepTwo.png)


		Step 4: The newly added `Meal` object is returned to the `AddMealCommand` to display as part of the `CommandResult`.

		![Add Meal Step 4](images/AddMeal_Step_four_diagram.png)


		The overall design that enables this functionality is described generically by the following sequence diagram.

		![Edit Command generic sequence](images/editCommand.png)

[CS2113-W10-3] BuffBuddy #20

Are you sure you want to change the base?

[CS2113-W10-3] BuffBuddy #20

Conversation

TVageesan commented Sep 22, 2024

joshuan98 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

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

ehz0ah 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

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

Metanyu 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