Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: nus-oss/AB3-J17
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v0.3.0
Choose a base ref
...
head repository: nus-oss/AB3-J17
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref
  • 12 commits
  • 38 files changed
  • 9 contributors

Commits on Jul 11, 2024

  1. Migrate to Java 17

    Let's migrate to Java 17 so as not to fall too far behind
    the latest LTS version (currently, 21).
    
    Contributoring authors:
    @baskargopinath, @bennyLCK, @billyhoce, @gongg21, @hjungwoo01,
    @jedkohjk, @jyue487, @itstrueitstrueitsrealitsreal, @brein62,
    @aureliony, @ljy0422, @macareonie, @ryanozx, @Carlintyj,
    @teoks0199, @drustanyjt
    damithc committed Jul 11, 2024
    Copy the full SHA
    fe805d8 View commit details

Commits on Jul 20, 2024

  1. DG: Fix typo addressbook.commons -> address.commons

    Carlintyj authored and damithc committed Jul 20, 2024
    Copy the full SHA
    a736a75 View commit details

Commits on Jul 23, 2024

  1. MainApp.java: Fix typo Address Book -> AddressBook

    When launching AB3 from terminal using java -jar, the start
    of logging says 'Starting AddressBook' while the end says
    'Stopping Address Book'.
    
    Let's fix this inconsistency by changing it to 'Stopping 
    AddressBook' in MainApp.java.
    baskargopinath authored Jul 23, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    934f740 View commit details

Commits on Jul 26, 2024

  1. AboutUs.md: Change http -> https

    hjungwoo01 authored and damithc committed Jul 26, 2024
    Copy the full SHA
    87a1319 View commit details

Commits on Jul 30, 2024

  1. Revert TLS workaround after upgrading to JDK17

    The SSLProtocolException error when uploading test
    coverage information no longer occurs with JDK17,
    so the past workaround of disabling TLSv1.3 is no
    longer needed.
    
    Let's remove the workaround and re-enable TLSv1.3.
    aureliony authored and damithc committed Jul 30, 2024
    Copy the full SHA
    82598c1 View commit details
  2. UserGuide.md: Make JAR download step generic (#28)

    Currently, every time a new release is done, developers would have
    to update the file name to reflect the latest JAR file published. 
    This can be difficult to keep track of.
    
    Let's change the JAR download step (step 2) in the Quick Start
    section in the user guide to say "latest `.jar` file" instead of 
    "latest `addressbook.jar`".
    
    This serves to make the JAR download step generic, eliminating the
    need for developers to update the file name every time a new
    release is published.
    brein62 authored Jul 30, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    3da04ac View commit details
  3. UG: Add help window known issue

    The Help Window cannot be activated if the previous
    Help Window is still alive but minimized.
    
    Until there is a better solution, let's mention this problem
    in the 'Known issues' section of the UG.
    hjungwoo01 authored Jul 30, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    5af1c6d View commit details

Commits on Aug 4, 2024

  1. Remove AB3 tutorials

    As the tutorials have been moved to
    https://se-education.org/guides/tutorials/ab3.html,
    let's remove them from this codebase.
    teoks0199 authored Aug 4, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    885a5ab View commit details

Commits on Aug 8, 2024

  1. README.md: Fix typo in SE-EDU link

    Author: @jyue487
    jyue487 authored Aug 8, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    351d006 View commit details
  2. Update Gradle Wrapper Validation Action to v3

    The current version (v1) of Gradle Wrapper Validation Action
    is outdated and may stop working in the future.
    
    Let's update the workflow dependency, and
    use the format as recommended in
    https://github.com/gradle/wrapper-validation-action/blob/main/README.md.
    aureliony authored and damithc committed Aug 8, 2024
    Copy the full SHA
    6f00272 View commit details
  3. Update setup-java action to v4

    The current version (v1) of the setup-java action is outdated,
    and may stop working in the future. As newer versions of the action
    require the 'distribution' field, 'zulu' is specified, which is
    the default used in v1.
    
    Let's update the workflow dependency, and use the format as recommended
    in https://github.com/actions/setup-java/blob/main/README.md.
    aureliony authored and damithc committed Aug 8, 2024
    Copy the full SHA
    4209f9c View commit details
  4. Update Codecov Action to v4

    The current version (v3) of the codecov action had previously stopped
    working (nus-cs2103-AY2324S2/forum#729), and
    may stop working again in the future.
    
    Let's update the codecov action to the latest version (v4) to minimize
    the chance of it breaking, and use the format as recommended in
    https://github.com/codecov/codecov-action/blob/main/README.md.
    aureliony authored and damithc committed Aug 8, 2024
    Copy the full SHA
    93e00db View commit details
Showing with 19 additions and 833 deletions.
  1. +8 −7 .github/workflows/gradle.yml
  2. +1 −1 README.md
  3. +2 −2 build.gradle
  4. +1 −1 docs/AboutUs.md
  5. +2 −2 docs/DeveloperGuide.md
  6. +1 −1 docs/SettingUp.md
  7. +3 −2 docs/UserGuide.md
  8. BIN docs/images/add-remark/$Remark.png
  9. BIN docs/images/add-remark/ContextMenu.png
  10. BIN docs/images/add-remark/CreateTest.png
  11. BIN docs/images/add-remark/GradleRun.png
  12. BIN docs/images/add-remark/RemarkBound.png
  13. BIN docs/images/add-remark/RemarkCommandClass.png
  14. BIN docs/images/add-remark/RemarkCommandParserClass.png
  15. BIN docs/images/add-remark/RemarkComplete.png
  16. BIN docs/images/add-remark/RemarkFailureOutput.png
  17. BIN docs/images/add-remark/RemarkHello.png
  18. BIN docs/images/add-remark/RemarkNotImplemented.png
  19. BIN docs/images/remove/$address.png
  20. BIN docs/images/remove/SafeDeleteConflicts.png
  21. BIN docs/images/remove/UnsafeDelete.png
  22. BIN docs/images/remove/UnsafeDeleteOnField.png
  23. BIN docs/images/tracing/DebuggerStep1.png
  24. BIN docs/images/tracing/EditCommand.png
  25. BIN docs/images/tracing/FindUsages.png
  26. BIN docs/images/tracing/LeftGutter.png
  27. BIN docs/images/tracing/LogicSequenceDiagram.png
  28. BIN docs/images/tracing/ShowExecutionPoint.png
  29. BIN docs/images/tracing/StepInto.png
  30. BIN docs/images/tracing/StepOver.png
  31. BIN docs/images/tracing/StructureToolWindow.png
  32. BIN docs/images/tracing/Variables.png
  33. BIN docs/images/tracing/searchResultsForExecuteMethod.png
  34. +0 −399 docs/tutorials/AddRemark.md
  35. +0 −112 docs/tutorials/RemovingFields.md
  36. +0 −301 docs/tutorials/TracingCode.md
  37. +0 −4 gradle.properties
  38. +1 −1 src/main/java/seedu/address/MainApp.java
15 changes: 8 additions & 7 deletions .github/workflows/gradle.yml
Original file line number Diff line number Diff line change
@@ -27,19 +27,20 @@ jobs:
run: ./run-checks.sh

- name: Validate Gradle Wrapper
uses: gradle/wrapper-validation-action@v1
uses: gradle/actions/wrapper-validation@v3

- name: Setup JDK 11
uses: actions/setup-java@v1
- name: Setup JDK 17
uses: actions/setup-java@v4
with:
java-version: '11'
distribution: 'zulu'
java-version: '17'
java-package: jdk+fx

- name: Build and check with Gradle
run: ./gradlew check coverage

- name: Upload coverage reports to Codecov
if: runner.os == 'Linux'
uses: codecov/codecov-action@v3
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -11,4 +11,4 @@
* It comes with a **reasonable level of user and developer documentation**.
* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org/#contributing-to-se-edu) for more info.
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -8,8 +8,8 @@ plugins {

mainClassName = 'seedu.address.Main'

sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
sourceCompatibility = JavaVersion.VERSION_17
targetCompatibility = JavaVersion.VERSION_17

repositories {
mavenCentral()
2 changes: 1 addition & 1 deletion docs/AboutUs.md
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ layout: page
title: About Us
---

We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).

You can reach us at the email `seer[at]comp.nus.edu.sg`

4 changes: 2 additions & 2 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
@@ -147,7 +147,7 @@ The `Storage` component,

### Common classes

Classes used by multiple components are in the `seedu.addressbook.commons` package.
Classes used by multiple components are in the `seedu.address.commons` package.

--------------------------------------------------------------------------------------------------------------------

@@ -317,7 +317,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

### Non-Functional Requirements

1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
1. Should work on any _mainstream OS_ as long as it has Java `17` or above installed.
2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.

2 changes: 1 addition & 1 deletion docs/SettingUp.md
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@ Follow the steps in the following guide precisely. Things will not work out if y
First, **fork** this repo, and **clone** the fork into your computer.

If you plan to use Intellij IDEA (highly recommended):
1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to to ensure Intellij is configured to use **JDK 11**.
1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to ensure Intellij is configured to use **JDK 17**.
1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA.<br>
:exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project.
1. **Verify the setup**:
5 changes: 3 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
@@ -12,9 +12,9 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo

## Quick start

1. Ensure you have Java `11` or above installed in your Computer.
1. Ensure you have Java `17` or above installed in your Computer.

1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases).
1. Download the latest `.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases).

1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.

@@ -182,6 +182,7 @@ _Details coming soon ..._
## Known issues

1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.
2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.

--------------------------------------------------------------------------------------------------------------------

Binary file removed docs/images/add-remark/$Remark.png
Binary file not shown.
Binary file removed docs/images/add-remark/ContextMenu.png
Binary file not shown.
Binary file removed docs/images/add-remark/CreateTest.png
Binary file not shown.
Binary file removed docs/images/add-remark/GradleRun.png
Binary file not shown.
Binary file removed docs/images/add-remark/RemarkBound.png
Binary file not shown.
Binary file removed docs/images/add-remark/RemarkCommandClass.png
Binary file not shown.
Binary file removed docs/images/add-remark/RemarkCommandParserClass.png
Binary file not shown.
Binary file removed docs/images/add-remark/RemarkComplete.png
Binary file not shown.
Binary file removed docs/images/add-remark/RemarkFailureOutput.png
Binary file not shown.
Binary file removed docs/images/add-remark/RemarkHello.png
Binary file not shown.
Binary file removed docs/images/add-remark/RemarkNotImplemented.png
Binary file not shown.
Binary file removed docs/images/remove/$address.png
Binary file not shown.
Binary file removed docs/images/remove/SafeDeleteConflicts.png
Binary file not shown.
Binary file removed docs/images/remove/UnsafeDelete.png
Binary file not shown.
Binary file removed docs/images/remove/UnsafeDeleteOnField.png
Binary file not shown.
Binary file removed docs/images/tracing/DebuggerStep1.png
Binary file not shown.
Binary file removed docs/images/tracing/EditCommand.png
Binary file not shown.
Binary file removed docs/images/tracing/FindUsages.png
Binary file not shown.
Binary file removed docs/images/tracing/LeftGutter.png
Binary file not shown.
Binary file removed docs/images/tracing/LogicSequenceDiagram.png
Binary file not shown.
Binary file removed docs/images/tracing/ShowExecutionPoint.png
Binary file not shown.
Binary file removed docs/images/tracing/StepInto.png
Binary file not shown.
Binary file removed docs/images/tracing/StepOver.png
Binary file not shown.
Binary file removed docs/images/tracing/StructureToolWindow.png
Binary file not shown.
Binary file removed docs/images/tracing/Variables.png
Binary file not shown.
Diff not rendered.
399 changes: 0 additions & 399 deletions docs/tutorials/AddRemark.md

This file was deleted.

112 changes: 0 additions & 112 deletions docs/tutorials/RemovingFields.md

This file was deleted.

301 changes: 0 additions & 301 deletions docs/tutorials/TracingCode.md

This file was deleted.

4 changes: 0 additions & 4 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
org.gradle.parallel=false
org.gradle.jvmargs=-XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError -Xmx1024m -Dfile.encoding=utf-8

# TODO: This is a workaround for a JDK11 bug which causes test coverage upload to fail.
# Remove it when https://bugs.openjdk.java.net/browse/JDK-8221253 is fixed.
systemProp.jdk.tls.client.protocols="TLSv1,TLSv1.1,TLSv1.2"
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/MainApp.java
Original file line number Diff line number Diff line change
@@ -176,7 +176,7 @@ public void start(Stage primaryStage) {

@Override
public void stop() {
logger.info("============================ [ Stopping Address Book ] =============================");
logger.info("============================ [ Stopping AddressBook ] =============================");
try {
storage.saveUserPrefs(model.getUserPrefs());
} catch (IOException e) {