Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alex Setyawan iP #476

Open
wants to merge 53 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
55f9f9f
docs/README.md: Tweak document template
Jan 7, 2024
f837ddb
Add Gradle support
May 24, 2020
a6f7324
Bump gradle and lib version
Eclipse-Dominator Aug 5, 2023
fbeec99
started level 0
alex-setyawan Jan 27, 2024
95ae554
added level 1
alex-setyawan Jan 27, 2024
dcaa40e
added level 2
alex-setyawan Jan 27, 2024
8282fc9
added level 3
alex-setyawan Jan 27, 2024
23725d6
added level 4
alex-setyawan Jan 27, 2024
0c94cc6
added text UI testing
alex-setyawan Jan 31, 2024
d9be119
added level 5
alex-setyawan Jan 31, 2024
40c2f1c
added level 6
alex-setyawan Jan 31, 2024
b8a17cf
add JavaDocs to Task.java
alex-setyawan Feb 9, 2024
ecd3039
Add JavaDocs to TodoTask.java
alex-setyawan Feb 9, 2024
81fa62e
Clean up code, add more abstractions and JavaDocs
alex-setyawan Feb 11, 2024
bc932d1
Add factory methods for DeadlineTask.java and EventTask.java
alex-setyawan Feb 12, 2024
8e740c8
Add Level 7
alex-setyawan Feb 12, 2024
c70d672
Remove JavaDocs from master branch
alex-setyawan Feb 12, 2024
6081c95
Deconflicted TodoTask.java
alex-setyawan Feb 12, 2024
f88ac1b
Add various changes
alex-setyawan Feb 12, 2024
1aab432
Add Level-8
alex-setyawan Feb 13, 2024
8f524c4
Add JavaDocs to Task.java
alex-setyawan Feb 13, 2024
150effc
Merge branch 'branch-Level-8'
alex-setyawan Feb 13, 2024
e8807b5
Add Parser, Storage, TaskList and Ui classes
alex-setyawan Feb 13, 2024
e787551
Add A-MoreOOP
alex-setyawan Feb 14, 2024
5d7d33e
Merge branch 'branch-A-MoreOOP'
alex-setyawan Feb 14, 2024
c555db6
Add A-Packages
alex-setyawan Feb 14, 2024
d8c5937
Change runtest.bat
alex-setyawan Feb 14, 2024
ac056d1
Change filepaths to include packages
alex-setyawan Feb 14, 2024
2e2cad8
Merge branch 'add-gradle-support'
alex-setyawan Feb 14, 2024
5c97137
Add A-JUnit
alex-setyawan Feb 21, 2024
918454b
Merge branch 'branch-A-JUnit'
alex-setyawan Feb 21, 2024
345dd2c
Add A-Jar
alex-setyawan Feb 21, 2024
8509e36
Add some JavaDocs for A-JavaDoc
alex-setyawan Feb 21, 2024
f8cef40
Merge branch 'branch-A-JavaDoc'
alex-setyawan Feb 21, 2024
ee52925
Add A-CodingStandard
alex-setyawan Feb 21, 2024
bac18eb
Merge branch 'branch-A-CodingStandard'
alex-setyawan Feb 21, 2024
f06896e
Add Level-9
alex-setyawan Feb 21, 2024
900fc2f
Merge branch 'branch-Level-9'
alex-setyawan Feb 21, 2024
566c52f
Fix bug in TaskList.java
alex-setyawan Feb 21, 2024
7016d82
Add first attempt of Level-10
alex-setyawan Feb 25, 2024
d29dc09
Add second attempt of Level-10
alex-setyawan Feb 26, 2024
3b5168f
Merge branch 'branch-Level-10'
alex-setyawan Feb 26, 2024
8abb368
Add A-Assertions
alex-setyawan Feb 26, 2024
bde67b9
Add A-CodeQuality
alex-setyawan Feb 26, 2024
ac84b3b
Merge pull request #2 from alex-setyawan/branch-A-Assertions
alex-setyawan Feb 26, 2024
c4d739c
Merge branch 'master' of https://github.com/alex-setyawan/ip into bra…
alex-setyawan Feb 26, 2024
c82256c
Add some JavaDocs
alex-setyawan Feb 26, 2024
66cec4a
Merge branch 'branch-A-CodeQuality'
alex-setyawan Feb 26, 2024
12919e9
Add C-Help extension
alex-setyawan Feb 26, 2024
aba319d
Merge branch 'branch-BCD-Extension'
alex-setyawan Feb 26, 2024
05dd207
Add A-UserGuide
alex-setyawan Feb 26, 2024
edc80be
Add more JavaDocs
alex-setyawan Feb 26, 2024
4eb286f
Change mainClass in build.gradle
alex-setyawan Feb 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,8 @@ src/main/resources/docs/
*.iml
bin/

# file for saved task list
/list.txt

/text-ui-test/ACTUAL.TXT
text-ui-test/EXPECTED-UNIX.TXT
56 changes: 56 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
plugins {
id 'java'
id 'application'
id 'com.github.johnrengelman.shadow' version '7.1.2'
}

repositories {
mavenCentral()
}

dependencies {
testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'

String javaFxVersion = '17.0.7'

implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'win'
implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'mac'
implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'linux'
implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'win'
implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'mac'
implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'linux'
implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
}

test {
useJUnitPlatform()

testLogging {
events "passed", "skipped", "failed"

showExceptions true
exceptionFormat "full"
showCauses true
showStackTraces true
showStandardStreams = false
}
}

application {
mainClass.set("awex.Launcher")
}

shadowJar {
archiveBaseName = "awex"
archiveClassifier = null
}

run{
standardInput = System.in
}
59 changes: 45 additions & 14 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,60 @@
# User Guide
# AWEX User Guide

## Features
AWEX (A Wonderful Experience) provides you a simple, yet interactive experience while making your list of things to do, so you'll never feel alone on the path to peak productivity!

### Feature-ABC
![Screenshot of AWEX's first messages](Ui.png)

Description of the feature.
## Features

### Feature-XYZ
### Add Tasks

Description of the feature.
Input Format:

## Usage
`todo <task>`

### `Keyword` - Describe action
`deadline <task> /by <YYYY-MM-DD hh:mm>`

Describe the action and its outcome.
`event <task> /from <YYYY-MM-DD hh:mm> /to <YYYY-MM-DD hh:mm>`

Example of usage:
### Mark/Unmark Tasks

`keyword (optional arguments)`
Input Format:

Expected outcome:
`mark <task number>`

Description of the outcome.
`unmark <task number>`

### Find Tasks

Input Format:

`find <item>`

### List Tasks

Input Format: `list`

### Delete Tasks

Input Format:

`delete <task number>`

### User Manual

Input Format: `help`

Response:

```
expected output
Input type must be one of:
1. list
2. mark <task number>
3. unmark <task number>
4. todo <task>
5. deadline <task> /by <YYYY-MM-DD hh:mm>
6. event <task> /from <YYYY-MM-DD hh:mm> /to <YYYY-MM-DD hh:mm>
7. delete <task number>
8. find <item>\n"
Type 'bye' to exit.
```
Binary file added docs/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
7 changes: 7 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.2-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
248 changes: 248 additions & 0 deletions gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
#!/bin/sh

#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################

# Attempt to set APP_HOME

# Resolve links: $0 may be a link
app_path=$0

# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done

# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum

warn () {
echo "$*"
} >&2

die () {
echo
echo "$*"
echo
exit 1
} >&2

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar


# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
if ! command -v java >/dev/null 2>&1
then
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
fi

# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi

# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.

# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )

JAVACMD=$( cygpath --unix "$JAVACMD" )

# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi


# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.

set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"

# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi

# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#

eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'

exec "$JAVACMD" "$@"
Loading