CSC207-2022F-UofT / course-project-collegecook

course-project-collegecook created by GitHub Classroom
2 stars 1 forks source link

Recipe improvement #115

Closed Brenden-Yiping-Wang closed 1 year ago

Brenden-Yiping-Wang commented 1 year ago

Improve in functionality

Change the ViewRecipeUI so that the result of searching recipe will depends on the user input every time, rather than the first time input. All the functions work now, user can both create a recipe and view a recipe

Add more testing

Add testing for the Recipe, RecipeList, RecipeInteractor, RecipeController and RecipeReadWriter. The testing coverage is 100% for methods in these classes. There are several lines not covered in the RecipeReadWriter, because there is no need and no way to test the ClassNotFoundException (The file name is private and final)

Add JavaDoc

Every method in the Recipe package has JavaDoc now, including the description for parameter and return type.

Fix problems

Fix all the problems according to the warning in the IntelliJ, so that unnecessary methods and imports are deleted. Besides, I change all the method name to follow the Java naming convention, for example, get_recipe is changed to getRecipe

Refactor to follow the clean architecture

The ViewRecipeUI was using the method in the Entity layer, which is not allowed. I refactor the code so that the UI only use methods in the controller.