Andrew

.github/workflows/workflow.yml

@@ -0,0 +1,45 @@
+on: push
+name: Build, Test and Upload JAR
+jobs:
+  checks:
+    name: Run Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+
+    - name: Mount bazel cache
+      uses: actions/cache@v1
+      with:
+        path: "/home/runner/.cache/bazel"
+        key: bazel
+
+    - name: Install bazelisk
+      run: |
+        curl -LO "https://github.com/bazelbuild/bazelisk/releases/download/v1.1.0/bazelisk-linux-amd64"
+        mkdir -p "${GITHUB_WORKSPACE}/bin/"
+        mv bazelisk-linux-amd64 "${GITHUB_WORKSPACE}/bin/bazel"
+        chmod +x "${GITHUB_WORKSPACE}/bin/bazel"
+
+    - name: Run Unit Tests
+      run: |
+        "${GITHUB_WORKSPACE}/bin/bazel" test //...
+
+    - name: Run UI and Serialization Tests
+      working-directory: ./text-ui-test
+      run: |
+        chmod +x runtest.sh
+        ./runtest.sh
+
+    - name: Build JAR File
+      run: |
+        "${GITHUB_WORKSPACE}/bin/bazel" build //:TerminalDuke_deploy.jar
+
+    - name: "Move file to non-symlink directory (a workaround for some bug See: https://github.com/actions/upload-artifact/issues/92)"
+      run: |
+       mv ${{ github.workspace }}/bazel-bin/TerminalDuke_deploy.jar ${{ github.workspace }}/TerminalDuke_deploy.jar
+
+    - name: Upload JAR File
+      uses: actions/upload-artifact@v2
+      with:
+        name: TerminalDuke_deploy.jar
+        path: ${{ github.workspace }}/TerminalDuke_deploy.jar

.gitignore

@@ -14,4 +14,12 @@ src/main/resources/docs/
 bin/
 
 /text-ui-test/ACTUAL.txt
+/text-ui-test/tasks.json
 text-ui-test/EXPECTED-UNIX.TXT
+
+# Ignore all bazel-* symlinks. There is no full list since this can change
+# based on the name of the directory bazel is cloned into.
+/bazel-*
+
+# for pre-commit git-hooks
+/.cache/*

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/maltzj/google-style-precommit-hook
+    rev: b7e9e7fcba4a5aea463e72fe9964c14877bd8130
+    hooks:
+      - id: google-style-java

.pre-commit-hooks.yaml

@@ -0,0 +1,8 @@
+# Pre-commit hook to run google-format-java right before commiting
+# Source: https://github.com/maltzj/google-style-precommit-hook
+- id: google-style-java
+  name: Google Java Code Style for Java
+  description: Formats code in Google's Java codestyle.
+  entry: ./tools/format-code.sh
+  language: script
+  files: \.java$ # We don't technically need this, as the script will filter for us, but this will allow the hook to be skipped if no Java is changed.

BUILD

@@ -0,0 +1,54 @@
+load("@rules_java//java:defs.bzl", "java_binary", "java_test")
+
+java_binary(
+    name = "TerminalDuke", # Production Build.
+    srcs = glob([
+        "src/main/java/com/lockarhythm/**/*.java",
+    ]),
+    deps = [
+        "@maven//:org_apache_commons_commons_lang3",
+        "@maven//:com_google_code_gson_gson",
+        "@maven//:org_ocpsoft_prettytime_prettytime_nlp",
+    ],
+)
+
+java_binary(
+    name = "TerminalDukeQA", # QA Build. has assertions enabled.
+    main_class = "com.lockarhythm.application.TerminalDuke",
+    srcs = glob([
+        "src/main/java/com/lockarhythm/**/*.java",
+    ]),
+    deps = [
+        "@maven//:org_apache_commons_commons_lang3",
+        "@maven//:com_google_code_gson_gson",
+        "@maven//:org_ocpsoft_prettytime_prettytime_nlp",
+    ],
+    jvm_flags = [
+        "-enableassertions",
+    ],
+)
+
+[
+  java_test(
+      name = class_name,
+      size = "small",
+      srcs = glob([
+          "src/test/java/com/lockarhythm/**/*.java",
+          "src/main/java/com/lockarhythm/**/*.java",
+      ]),
+    deps = [
+        "@maven//:org_apache_commons_commons_lang3",
+        "@maven//:com_google_code_gson_gson",
+        "@maven//:org_ocpsoft_prettytime_prettytime_nlp",
+        ]
+  )
+  for class_name in [
+      "TestTerminalDuke",
+      "TestEchoResponder",
+      "TestExitResponder",
+      "TestListResponder",
+      "TestMarkAsDoneResponder",
+      "TestTodoTask",
+      "TestTaskList",
+  ]
+]

README.md

@@ -1,24 +1,61 @@
-# Duke project template
+<img src="https://user-images.githubusercontent.com/88638946/130622078-e049680c-7895-4725-ace0-49869574887c.png" width="50%" align="right">
+
+# Duke
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 
-## Setting up in Intellij
-
-Prerequisites: JDK 11, update Intellij to the most recent version.
-
-1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first)
-1. Open the project into Intellij as follows:
-   1. Click `Open`.
-   1. Select the project directory, and click `OK`.
-   1. If there are any further prompts, accept the defaults.
-1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
-   In the same dialog, set the **Project language level** field to the `SDK default` option.
-3. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
-   ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+## Demo
+![output](https://user-images.githubusercontent.com/88638946/131530452-cbe5ab59-9e43-4c08-affe-f9fdf2c75427.gif)
+
+
+## Build
+Prerequisites: Have `bazel` installed.
+
+To build for local development on macOS:
+```bash
+# bazel makes a wrapper script around the jar file.
+bazel build //:TerminalDuke && ./bazel-bin/TerminalDuke
+
+# or simply
+bazel run //:TerminalDuke
+
+# Use bazelisk for M1 Macs (Apple Silicon)
+USE_BAZEL_VERSION=ac9353fab161efae4af72e73fbb657a762b3620d bazelisk run //:TerminalDuke
+
+# For QA build, for example, having assertions enabled, build TerminalDukeQA instead
+USE_BAZEL_VERSION=ac9353fab161efae4af72e73fbb657a762b3620d bazelisk run //:TerminalDukeQA
+```
+
+To build jar file for deployment purposes:
+```bash
+bazel build //:Duke_deploy.jar
+
+java -jar ./bazel-bin/Duke_deploy.jar
+```
+
+## Testing
+For unit tests:
+```bash
+bazel test --test_output=all //...
+```
+For terminal ui tests (`text-ui-test`):
+```bash
+cd text-ui-test
+./runtest.sh
+```
+
+## Code Formatting & Style
+Use [google-java-format](https://github.com/google/google-java-format):
+```bash
+google-java-format --replace **/*.java # executes recursively
+```
+
+## Pre-commit Git Hook (Tested on macOS)
+`pre-commit` is a python tool that helps to create git pre-commit hook handlers. For this project, it is used to enforce Google Java Style (via `google-java-format`) on new commits.
+
+To setup, ensure you have [`pre-commit`](https://pre-commit.com/#install) installed, then run:
+```bash
+pre-commit install
+```
+This only needs to be executed once, so that `pre-commit` can generate the script and write it to `.git/hooks/pre-commit`
+Thereafter, it should be executed right before every commit!

WORKSPACE

@@ -0,0 +1,27 @@
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+RULES_JVM_EXTERNAL_TAG = "4.0"
+RULES_JVM_EXTERNAL_SHA = "31701ad93dbfe544d597dbe62c9a1fdd76d81d8a9150c2bf1ecf928ecdf97169"
+
+http_archive(
+    name = "rules_jvm_external",
+    strip_prefix = "rules_jvm_external-%s" % RULES_JVM_EXTERNAL_TAG,
+    sha256 = RULES_JVM_EXTERNAL_SHA,
+    url = "https://github.com/bazelbuild/rules_jvm_external/archive/%s.zip" % RULES_JVM_EXTERNAL_TAG,
+)
+
+load("@rules_jvm_external//:defs.bzl", "maven_install")
+
+maven_install(
+    artifacts = [
+        #"com.google.guava:guava:21.0",
+        "org.apache.commons:commons-lang3:3.11",
+        "com.google.code.gson:gson:2.8.8",
+        "org.ocpsoft.prettytime:prettytime-nlp:5.0.2.Final"
+    ],
+    repositories = [
+        # Private repositories are supported through HTTP Basic auth
+        "https://maven.google.com",
+        "https://repo1.maven.org/maven2",
+    ],
+)