fsgmhoward / cs2113t-pe

Hi there! 👋

Welcome to my GitHub profile! I'm Howard Liu, currently a full-time student pursuing a Master's Degree in Information Security.

• 🔭 I'm actively seeking a full-time position with an earliest start date in Jan 2025! I'm open to any computing-related opportunities, with roles in security engineering or software development being my preferences.
• 👨‍💻 Recently, I'm doing some self-study on OSCP certification (OffSec Certified Professional).
• 📫 You can reach me via email, available on my GitHub profile.
• 💬 I'm proficient in English, Mandarin, and Cantonese, so feel free to communicate with me in your preferred language! I also had a minor in Japanese, but most of that knowledge has been returned to my lecturer 🤣.
• 📚 I also maintain my personal blog, which you can find 👉 here (in Chinese).

Some Technologies Used in Projects and Internships

While my GitHub profile provides an overview, it may not cover everything. If you have any questions or simply want to chat, don't hesitate to contact me. I make an effort to respond to emails whenever I'm awake.

cs2113t-pe's Issues

Incomplete/Missing "Instructions for Manual Testing" section for DG

According to the text book, this section should contain some input and output for the tester to test the program, which should cover all user-testable functionalities. This is also what I should use for this PE.

However, for your team's DG, this section contains merely one instruction for testing the parser, using the test cases provided in the source file.

Given the instructions in for this PE, I have no access to the code on Github so there is no way for me to follow this instruction to test the parser. I also think this deviates from the original meaning from the textbook as using code (JUnit test cases) to test should be considered as automated testing.

Missing Feature "View all facility categories"

In the user story section of your user guide, this is listed as "must-have" and I also agree that it is an essential feature of the application. However, this is no where to be found from your application as well as UG.

I understand that the three types are clearly stated in the UG. However, considering the case that not all users will bring the UG and flip through it every time using the program, it is essential to have a help command like this.

P.S. This is what you mentioned in the DG:

As a user, I can view the list of categories of facilities in the school.
So that user will know the type of facilities provided in the school and be able to use the program
accordingly.

Inappropriate behaviour in handling the search of nearest facilities

The facility itself should not be included into the search result, when the target facility type is the same as the original one.

For example, not like this:

What else would you like to do?
findFacility<library1><library><1>
library1@N1-02-02

nor this:

findFacility<canteen1><canteen><3>
canteen1@N4-01-01  <---------------------------------------
canteen4@N5-04-02
canteen3@N5-04-01

The rationale for this is, when we try to search a facility of the same type, it is usually because the original one is not accessible (e.g. library being full or canteen temporary closed) and we want to find a nearest one. Printing out the same building does not solve the user's needs at all.

Inconsistency in command format

There are total 5 commands listed in the UG, namely:

listAllLocations<facility_type>
search facilityType/id
search in building_name
findFacility<facility><facility_type><top k>
bye

I would say this is very confusing for the users. Some commands use capitalised character while some use space to separate words. More over, arguments are supplied to listAllLocations and findFacility using arrow brackets <> while the others use empty space to split.

It would be better if all of them are standardized into one format. For example, search in become:

searchIn<building_name>

Inconsistency in facility type

For listAllLocations, LTs are typed as lecture theater.

However, for search and findFacility, it is typed as lectureTheater without the space in between.

Adding/removing the space in either cases will render the command fail. There should be one consistent spelling for lecture theater.

Weird index for "search in"

I understand that the index may be the index for the facility in its category. However, it does not make any sense to print it out here as it is expected to be the index of the item this list.

Screenshot:

^ For example, instead of

1 (canteen1) is located at  (5.5, 6.6, N4-01-01)
2 (canteen2) is located at  (1.0, 1.0, N3-02-02)
1 (lectureTheater1) is located at  (25.5, 26.6, NS3-05-43)

Printing this would be more appropriate and intuitive:

1 (canteen1) is located at  (5.5, 6.6, N4-01-01)
2 (canteen2) is located at  (1.0, 1.0, N3-02-02)
3 (lectureTheater1) is located at  (25.5, 26.6, NS3-05-43)

Missing Introduction Section for DG

For the DG, the introduction section is missing. Your DG starts directly from the "design and implementation" section.

There should at least be some brief introduction on what is this application, and how to use the DG. These things provide background information for developers who are interested to collaborate with you on your application.

Wrong "Sequence diagram for findNearest"

For the above diagram, there are a few problems.

1. The first arrow should use solid line instead of dotted line
2. The return dotted line is missing from findNearest to Map, and from Facility to findNearest
3. Activation bar should only start after the incoming arrow, and terminate immediately after the return arrow. I have circled out instances which this is violated
4. Return of control to the user at the end of Map is also missing.

In consistency in error output for "search"

When a wrong index is entered, there are two different behaviours for the error output depends on the facility name.

For canteen, Aiyoh where got this canteen one is printed.

For the other two, Aiyoh where got "[index entered]" this lecture theater one is printed.

Screenshot:

The error message should be standardized.

Functional Requirement does not match with User Stories in DG

The last functional requirement and user stories does not match.

View the location of a specific library in school

As a user, I can view the list of all canteens in the school. To know where a library is if a user knows its ID.

I think there is a typo here. Moreover, why do I have to view a list of all canteens if I know the ID?

Wrong error message output for "findFacility" when large k is entered

What else would you like to do?
findFacility<library1><Canteen><1>
canteen1@N4-01-01
What else would you like to do?
findFacility<library1><Canteen><20>
Unable to find top20! There are only 4 Canteen available
What else would you like to do?
findFacility<library1><Canteen><2000000000000000000>
please try again! remember to input location name, the facility name that you want to look for and the number of nearest facilities you are searching for
For example:findFacility<library1><Canteen><2>

When a large k like 2000000000000000000 is entered, it just prints out a generic error message instead of stating the k is larger than the number of available facilities, like what it did for 20.

Wrong "Sequence Diagram for loading facility data"

I would assume that you want to represent the constructor here:

The correct notion should be like this instead:

Moreover, is there a missing arrow going back here?

Since the "control" has not been transferred back to the user and the activation bar has not terminate, I would assume that the execution is still at the :FileManager, so the user should not have a action pointing.

Command output not explained in UG/DG

Taking this example:

search in NorthSpine
Here are the facilities in "NorthSpine":
1 (canteen1) is located at  (5.5, 6.6, N4-01-01)
2 (canteen2) is located at  (1.0, 1.0, N3-02-02)
1 (lectureTheater1) is located at  (25.5, 26.6, NS3-05-43)

For the numbers following located at, it is not explained in either UG or even DG. I would assume that this is some kind of coordinates used for calculation of nearest facilities but it does not make much sense for the users.