All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Improvements based on SpotBugs and FindSecBugs scans:
- LogRecord.toString() changed to use platform-specific line separators.
- LogRecord.equals(Object): correctly handle null and other types.
- RecordList.equals(Object): correctly handle null and other types.
- Bin.contentsToString(): StringBuilder instead of iterated concat.
- SessionLog.moveCountToString(): StringBuilder instead of iterated concat.
- SessionLogFormatter: fixed potential resource leak.
- SessionLog: implemented readObject to properly initialize transient fields during deserialization.
- Set most classes to package access.
- Integrated SpotBugs into build process.
- Integrated FindSecBugs into build process.
- Refactored the following based on RefactorFirst scan:
- SessionLog class
- GUI-related test cases
- Non-GUI-related test cases
- Reformatted all sourcecode to Google Java Style.
- Migrated test cases to JUnit Jupiter 5.9
- Misc refactoring based on feedback from Sonatype Lift, including:
- Added explicit Charset when loading SessionLog template.
- Added explicit cast in narrowing compound assignment in initialization of item list.
- In SessionLog, replaced usage of Java's Date class, which is known to be buggy, with Instant.
- Removed single use constant with format string for SessionLog.
- Fixed empty catch blocks.
- Configured Spotify's fmt-maven-plugin to format to Google Java Style during builds.
- Configured the refactor-first-maven-plugin within a profile in the pom.xml.
- Adopted Google Java Style.
- Release is to force an update of the metadata on the archiving site Zenodo to include link to paper in Journal of Open Source Education. This release otherwise contains no new or changed functionality.
- Release is for paper in Journal of Open Source Education (JOSE), and also to start archiving in Zenodo for same purpose. This release otherwise contains no new or changed functionality.
- Modified CI/CD workflow to comment coverage percentages on PRs.
- A directory of example homework assignments that can be used or adapted by course instructors using the application in a class. The example assignments can also be used by self-directed learners.
- Session Logs
- Feature that logs most user interaction with the application, and generates an in-application view of the session log.
- The session log summarizes total time in the application, instances solved by the user correctly using their chosen heuristic, number of successful and unsuccessful solving actions taken in each of the application modes, as well as additional information that may be useful to instructors using the application within a course context.
- In addition to viewing the current session log, session logs can be saved to a file. The motivation is to ease instructor grading of assignments that use the application. For example, instructors can assign each student a different problem instance and have students save and submit the session log, which the instructor can then use for validation.
- The load session log feature loads a session log, validates it, and displays a human readable summary. The validation verifies that instances that are claimed solved using a particular heuristic were actually solved using that heuristic. That is, the session log doesn't include the solution, but rather it includes the actions taken to reach the solution, the problem instance number, and the chosen heuristic, and the application validates that the actions taken are those that the heuristic would have chosen. The validation also validates timestamp sequences, etc.
- Note to instructors: We don't guarantee that the session logs cannot be faked. However, the effort required to fake a session log that will fool the validation is significantly more than the effort needed to work through the exercises. Additionally, to successfully fake a session log, the student would still need the correct sequence of actions to solve the specified instance using the specified heuristic. Simply assign each student a different problem instance number (it is a value of type long), perhaps based on their student id number.
- Reorganized resources files (html content of dialogs, and images) to use a namespace (i.e., within a directory hierarchy based on package name).
- Updates to documentation.
- Code improvements to eliminate potentially errorprone code as identified in MuseDev's static analysis reports.
- Adopted SemVer versioning.
- First release to Maven Central Repository and to the GitHub Package Registry.
- Minor resource leak in unclosed Scanner.
First public release.
- Automated tutorial features.
- Self-guided tutorial on combinatorial optimization, the bin packing problem, and constructive heuristics for bin packing.
- Checks user's progress and provides feedback enabling user to test their knowledge of the various constructive heuristics covered by the tutorial.
- Help dialog box.
- Tutorial dialog box.
- Computation of lower bounds.
- Several heuristic modes that monitor user's interaction with bin packing instance and provides feedback on correctness of their usage of different constructive heuristics: first-fit, first-fit decreasing, best-fit, and best-fit decreasing.
- Significant refactoring of existing code.
- Generate instances by a seed for reproducibility.
- Ability to sort items by size.
- About dialog box.
- Improvements to interface.
- Interactively manipulate random instances of bin packing.
- Visualize random instances of bin packing.