tp

Lukas Ethan Wachtel (LWachtel1) Project Portfolio Page

Project: ByteCeps

BYTE-CEPS is a CLI-based tool for setting and tracking fitness goals. The user interacts with the tool using commands entered via the CLI interface. With BYTE-CEPS, they can compile a list of exercises, build custom workouts, assign workouts to a weekly schedule and log details of each exercise completed in each performed workout.

Summary of Contributions: LWachtel1 RepoSense

New Features

• Help menu: Shows the user how to correctly format each possible BYTE-CEPS command.
  • What it does: Upon initial program execution, a guidance message detailing the commands to access the help menu is displayed. A user can enter 1 of these commands to view 3 different lists, each one with numbered items describing the functionalities associated with a category tracked by BYTE-CEPS. They can then see a given functionality’s specific command formatting by entering the previous command along with the number from its help menu list position as a parameter.
  • Credits: I wrote the initial HelpMenuManager class & added Javadocs, and joshualeejunyi & pqienso refined my code. I then added functionality to view the access guidance message whenever the user enters help alone.
• Editing an exercise: Allows user to change name of an already created exercise.

Enhancements to Existing Features

• validators package & its accompanying classes: Ensures our classes within the processing package follow the single responsibility principle (SRP).
  • What it does: Each Validator-type class parses the inputs provided for the methods in its corresponding Manager class, checking input validity according to conditional statements and throwing exceptions if invalid.
  • Justification: This abstracts the input parsing & validation process out of the Manager-type classes, thus ensuring they have a single responsibility, which is user command execution.
  • Credits: I wrote the initial validators package. Each class method within a Validator-type class was public and corresponded to a Manager method by which it was called to parse & validate input, before the Manager method executed its task. pqienso significantly improved said package by changing each Validator-type class to have only one public method, which is called from the Validator-type class execute() method. This public Validator method calls another private method that validates input for the specific private Manager method that execute() has called to execute the user’s command.
• Testing Storage methods: 75% of methods within Storage are covered.
  • Credits: I wrote all test methods within the StorageTest class and the helper methods for file handling. joshualeejunyi wrote setup(), setUpStreams()and restoreStreams(), which are integral to the functioning of the test methods.
• Testing ExerciseManager method for editing an exercise:
  • Credits: I wrote all test methods for editing an exercise. However, other tests written by my teammates acted as helpful guidance.
• Testing HelpMenuManager and HelpValidator methods: 87% of methods within HelpMenuManager and 100% within HelpValidator are covered.
  • Credits: I wrote all test methods. I reused and adapted joshualeejunyi’s setup(), setUpStreams()and restoreStreams() methods.
• Bug fixes:
  • Issue #114: Implemented a fix for a logging bug where a user was unable to log two of the same exercise on the same day; I did this by overriding the existing equals() method used by ExerciseLog, which was the bug’s cause.
  • Issue #69: Use of the HashSet class was causing incorrect ordering in exercise & workout lists, so I implemented a fix by using the LinkedHashSet class instead.
  • Issue #47: Implemented fixes for unhandled exceptions for week (now called program).

Documentation

• UG: Added all documentation for the help menu and related commands.
• DG:
  • Entire help menu section, including descriptions and sequence diagrams
  • Added to v4vern’s manual testing section regarding the help menu.

Community (Contributions to the Team and Beyond):

• Review my teammates’ PRs
• Reported an above-average number of bugs during the PE dry run, 8 bugs, for the team working on MediTracker. See proof here.

Contributions to DG: Extracts

help command sequence diagram:

help /FLAG command sequence diagram:

help /FLAG PARAMETER command sequence diagram: