[CS2113-W11-3] Travel Diary #52

LeThiHongMinh · 2025-03-04T15:01:23Z

Travel Diary is a desktop app for managing trips and travel memories, for use via a Command Line Interface (CLI). Travel Diary helps you log and organize trips, photos, and experiences more efficiently than traditional travel journaling apps.

okkhoy

The code that is present here is quite good.
however,
1/ much of the codebase needs javadoc comments
2/ i didn't see too many exception handling scenarios, or assert statements (and any logging statements).
please pay attention to these as they are used for grading

okkhoy · 2025-03-30T15:52:39Z

src/main/java/album/Album.java

+import java.util.ArrayList;
+import java.util.List;
+
+public class Album {


non-trivial methods need javadoc comments. (applied to all such classes in this codebase, please propagate the comment)

okkhoy · 2025-03-30T15:53:38Z

src/main/java/command/ExitCommand.java

+import trip.TripManager;
+import ui.Ui;
+
+// TODO: need to find out how to close photo after bye


remove such "note-to-self" comments.
you can use these kind of review comments for the purpose

okkhoy · 2025-03-30T15:54:07Z

src/main/java/command/SelectTripCommand.java

+//package command;
+//
+//import exception.TravelDiaryException;
+//import trip.TripManager;
+//import ui.Ui;
+//
+//public class SelectTripCommand extends Command {
+//    private int index;
+//
+//    public SelectTripCommand(int index) {
+//        this.index = index;
+//    }
+//
+//    @Override
+//    public void execute(TripManager tripManager, Ui ui, int fsmValue) throws TravelDiaryException {
+//        ui.showToUser("Alvida! Till we meet next time :)");
+//    }
+//}


don't retain commented code - in this case, you may as well remove the file totally

okkhoy · 2025-03-30T15:54:46Z

src/main/java/parser/Parser.java

+        case "bye":
+        case "list":
+        case "close":
+        case "menu":


fallthrough comments necessary

okkhoy · 2025-03-30T15:55:16Z

src/main/java/parser/Parser.java

+        map.put("name", tagsMap.get("n#"));
+        map.put("description", tagsMap.get("d#"));
+        map.put("location", tagsMap.get("l#"));
+        if (map.get("name") == null || map.get("description") == null || map.get("location") == null) {


some parts of the code (like this one) can use some blank lines to give well-readable vertical spacing

okkhoy · 2025-03-30T15:56:01Z

src/main/java/parser/Parser.java

+            if (part.startsWith(tag)) {
+                if (!seenTags.add(tag)) {
+                    throw new TravelDiaryException("Duplicate tag provided for " + tag);
+                }
+                String value = part.substring(tag.length()).trim();
+                if (value.isEmpty()) {
+                    throw new TravelDiaryException("Empty value provided for tag " + tag);
+                }
+                return new AbstractMap.SimpleEntry<>(tag, value);
+            }
+        }


consider extracting out some parts under a guard clause and eliminate arrow-head code

okkhoy · 2025-03-30T15:56:50Z

src/main/java/storage/Storage.java

+        try (BufferedWriter writer = new BufferedWriter(new FileWriter(dataFile))) {
+            for (Trip trip : trips) {
+                writer.write(formatTripLine(trip));
+                writer.newLine();
+
+                if (trip.album != null) {
+                    writer.write("A | " + encodeString(trip.name));
+                    writer.newLine();
+                    System.out.println("Saving album for trip: " + trip.name);  // Log album saving
+
+                    if (trip.album.photos != null) {
+                        for (Photo photo : trip.album.photos) {
+                            writer.write(formatPhotoLine(photo));
+                            writer.newLine();
+                            System.out.println("Saving photo: " + photo.getPhotoName());  // Log each photo saving
+                        }
+                    }
+                }
+            }


looks a lot like arrowhead code

okkhoy · 2025-03-30T15:57:28Z

src/main/java/storage/Storage.java

+                        decodeString(parts[1]),   // file path
+                        decodeString(parts[2]),   // photo name
+                        decodeString(parts[3]),   // caption


why not use meaningful variable names rather than use comments to indicate what each part is?

okkhoy · 2025-03-30T15:58:28Z

src/main/java/trip/TripManager.java

+            tripsDetails.append("\t").append(i + 1).append(") ")
+                    .append(trips.get(i).toString());


would using a loop be good in this case, instead of a sequence of appends?

okkhoy · 2025-03-30T15:59:08Z

src/test/java/parser/ParserTest.java

+    //    @Test
+    //    public void AddPhotoParsingTest() {
+    //        String simulatedInput = "add_photo f#./data/photos/sample1.jpg n#Osaka photo c#Friends l#Osaka street\n";
+    //        System.setIn(new ByteArrayInputStream(simulatedInput.getBytes()));
+    //
+    //        Map<String, String> parsedCommand = assertDoesNotThrow(Parser::getCommandDetails);
+    //
+    //        // Verify the parsed result
+    //        assertEquals("add_photo", parsedCommand.get("command"));
+    //        assertEquals("./data/photos/sample1.jpg", parsedCommand.get("filepath"));
+    //        assertEquals("Osaka photo", parsedCommand.get("photoname"));
+    //        assertEquals("Friends", parsedCommand.get("caption"));
+    //        assertEquals("Osaka street", parsedCommand.get("location"));
+    //    }
+    //
+    //    @Test
+    //    public void SelectParsingTest() {
+    //        String simulatedInput = "select 1";
+    //        System.setIn(new ByteArrayInputStream(simulatedInput.getBytes()));
+    //
+    //        Map<String, String> parsedCommand = assertDoesNotThrow(Parser::getCommandDetails);
+    //
+    //        // Verify the parsed result
+    //        assertEquals("select", parsedCommand.get("command"));
+    //        assertEquals("1", parsedCommand.get("index"));
+    //    }
+    //
+    //    @Test
+    //    public void DeleteParsingTest() {
+    //        String simulatedInput = "delete 10";
+    //        System.setIn(new ByteArrayInputStream(simulatedInput.getBytes()));
+    //
+    //        Map<String, String> parsedCommand = assertDoesNotThrow(Parser::getCommandDetails);
+    //
+    //        // Verify the parsed result
+    //        assertEquals("delete", parsedCommand.get("command"));
+    //        assertEquals("10", parsedCommand.get("index"));
+    //    }
+    //
+    //    @Test
+    //    public void ListParsingTest() {
+    //        String simulatedInput = "list";
+    //        System.setIn(new ByteArrayInputStream(simulatedInput.getBytes()));
+    //
+    //        Map<String, String> parsedCommand = assertDoesNotThrow(Parser::getCommandDetails);
+    //
+    //        // Verify the parsed result
+    //        assertEquals("list", parsedCommand.get("command"));
+    //    }
+}


commented out code should be removed.

Metadata extractor

…+ fix ui trip list

RESOLVED conflict for DG # Conflicts: # build.gradle

Add Location class

Ashley dg draft2

Dg it

Remove trip location and added period tracker

Roycecodes

Overall nice DG
Found some UML diagram flaws

Roycecodes · 2025-04-03T03:28:51Z

docs/DeveloperGuide.md

+##### Saving Data
+The saving process converts in-memory objects into a text representation and writes them to a file. The `saveTasks` method handles this process.
+
+![Sequence diagram for saving data](StorageSaveTrip.png)


Good work clear diagram shown
I think it would be nice to have activtion boxes
:)

Roycecodes · 2025-04-03T03:30:18Z

docs/DeveloperGuide.md

+##### Saving Data
+The saving process converts in-memory objects into a text representation and writes them to a file. The `saveTasks` method handles this process.
+
+![Sequence diagram for saving data](StorageSaveTrip.png)


Nice work
think if you add colons to class name it will be good

Roycecodes · 2025-04-03T03:30:56Z

docs/DeveloperGuide.md

+##### Saving Data
+The saving process converts in-memory objects into a text representation and writes them to a file. The `saveTasks` method handles this process.
+
+![Sequence diagram for saving data](StorageSaveTrip.png)


think it will be nice to include constructor boxes as well

Roycecodes · 2025-04-03T03:31:41Z

docs/DeveloperGuide.md

+These specialized exceptions provide detailed information about what went wrong and where, making debugging easier.
+
+### PhotoPrinter
+![PhotoPrinter](https://raw.githubusercontent.com/AY2425S2-CS2113-W11-3/tp/16bbdd2e8a63af5e7aecbf1fc662e6bd7f0c7c35/photo_printerdraft.png)


I think there shouldnt be a C logo next to class name
nice diagram btw

Roycecodes · 2025-04-03T03:32:27Z

docs/DeveloperGuide.md

+These specialized exceptions provide detailed information about what went wrong and where, making debugging easier.
+
+### PhotoPrinter
+![PhotoPrinter](https://raw.githubusercontent.com/AY2425S2-CS2113-W11-3/tp/16bbdd2e8a63af5e7aecbf1fc662e6bd7f0c7c35/photo_printerdraft.png)


i think it is the standard to have + - to indicate public/private instead of boxes and squares
nice work.

update aboutus

Add colon to sequence diagram

Uml format bryan

Added PPP

Add coments

make changes to ppp - remove community involvement

Guide update

Uml format bryan

Finished PPP

UML update

Final PPP.

okkhoy reviewed Mar 30, 2025

View reviewed changes

LeThiHongMinh and others added 28 commits April 1, 2025 19:48

Merge pull request #53 from Gavalion/metadata_extractor

7417b97

Metadata extractor

photoprinter class diagram for DG draft

16bbdd2

Developer guide draft for PhotoPrinter class.

6f4818b

Add developer guide (storage) + add help function + add storage test …

a7922c9

…+ fix ui trip list

fix checkstyle

3c1ded2

Merge pull request #54 from LeThiHongMinh/storage-ui

8ca06e1

Add Location class

cc155ba

fix checkstyle

34c867d

Merge branch 'master' of https://github.com/AY2425S2-CS2113-W11-3/tp

0164fe4

RESOLVED conflict for DG # Conflicts: # build.gradle

Merge pull request #55 from LeThiHongMinh/storage-ui

c53eee3

Add Location class

Merge branch 'master' of https://github.com/AY2425S2-CS2113-W11-3/tp

8016e14

DG draft for PhotoPrinter

16faa3f

Merge branch 'master' of https://github.com/ashleyang2001/tp

4ac01f0

dg draft 2

7b01918

remove checking on bat and sh file, do check with junits only

6613e28

remove checks on runtest.bat and sh file

90da86e

Merge pull request #58 from ashleyang2001/Ashley-DG-Draft2

5ed6dcf

Ashley dg draft2

Updated glossary section of DG.

8ccc02c

Added travel_diary.txt to .gitignore.

54b317d

Merge pull request #60 from ojassurana/DG-IT

7c28b0d

Dg it

Remove location argument from trip

324c941

added periodtracker method in trip to track

646ea5f

fix gradle.

fc6e7c7

Merge pull request #64 from Gavalion/remove_trip_location

6d04833

Remove trip location and added period tracker

Merge branch 'master' of https://github.com/AY2425S2-CS2113-W11-3/tp

22f5848

Removed support for #l tag on Parser.java.

84ba07a

Added 1000cities data.

5f2d1e1

Makes location extractor work offline now.

85dbce3

Roycecodes reviewed Apr 3, 2025

View reviewed changes

gavalion5 and others added 30 commits April 8, 2025 12:53

Merge branch 'master' into aboutus

5f7d205

Merge pull request #154 from Gavalion/aboutus

c7a976b

update aboutus

Add colon to sequence diagram

40a7747

Move the sequence diagram

c5ff974

Merge pull request #157 from LeThiHongMinh/junit_test

1121998

Add colon to sequence diagram

Merge branch 'master' into UML_format_bryan

5e7282e

Added PPP

a9d300d

Merge pull request #158 from Gavalion/UML_format_bryan

4263e57

Uml format bryan

Merge pull request #159 from ashleyang2001/Ashley-PPP-Final

04f37d8

Added PPP

Add coments

d625813

make changes to ppp - remove community involvement

1b329e8

Merge pull request #160 from ashleyang2001/Comments

e4206af

Add coments

Merge pull request #161 from LeThiHongMinh/junit_test

c81d315

make changes to ppp - remove community involvement

update ug

ef735ed

print pdf for ppp

a036fa9

Merge branch 'master' of https://github.com/AY2425S2-CS2113-W11-3/tp

cab47b5

update UG to mention how to upload photo from phone

0e8e03d

Modified guide

4d092e5

Merge branch 'master' into UML_format_bryan

cde1078

Merge pull request #163 from ashleyang2001/Guide-update

a19c313

Guide update

Merge pull request #164 from Gavalion/UML_format_bryan

a9322d2

Uml format bryan

fix uml picture

988572d

Finished PPP

35b33c9

Merge pull request #165 from ojassurana/PPP-Final

f1c602f

Finished PPP

uml

e7b0945

Merge branch 'master' of https://github.com/AY2425S2-CS2113-W11-3/tp

914dc5e

Merge pull request #166 from Gavalion/master

ef6abe6

UML update

Final PPP.

1baaf7f

Merge pull request #168 from ojassurana/OneLastPPP

890b296

Final PPP.

Update DeveloperGuide.md

30dd413

		tripsDetails.append("\t").append(i + 1).append(") ")
		.append(trips.get(i).toString());

[CS2113-W11-3] Travel Diary #52

Are you sure you want to change the base?

[CS2113-W11-3] Travel Diary #52

Uh oh!

Conversation

LeThiHongMinh commented Mar 4, 2025

Uh oh!

okkhoy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Roycecodes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants