Skip to content

[Thomas Cherian] iP #274

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

Open
wants to merge 28 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
d839859
Add Gradle support
May 24, 2020
f793428
Level-1
tomascherian Jan 20, 2022
a2a56a0
Add Task.java
tomascherian Jan 23, 2022
cd380db
Remove Duke
tomascherian Jan 23, 2022
137a3e6
Update Pac and Task.
tomascherian Jan 24, 2022
850f362
Add Event ToDo and Deadline. Update Keyword and Pac.
tomascherian Jan 25, 2022
3f1737f
Add Expected.txt and Input.txt
tomascherian Jan 26, 2022
b0d9915
Handle Exceptions in Pac.java. Add PacException.java
tomascherian Jan 26, 2022
57b362b
Add delete to Pac.java
tomascherian Jan 26, 2022
566e815
Update Pac.java
tomascherian Mar 1, 2022
ee770fd
Update Pac.java
tomascherian Mar 1, 2022
c30f64c
Update Pac.java, Deadline.java, Event.java
tomascherian Mar 1, 2022
f3ca7bb
Merge branch 'branch-Level-8'
tomascherian Mar 1, 2022
2b56999
Merge branch 'branch-Level-7'
tomascherian Mar 1, 2022
22bf473
Refactor code to make it more OOP
tomascherian Mar 19, 2022
d95d9ba
Divide classes to packages
tomascherian Mar 19, 2022
5b61b13
Modify Mark and Unmark
tomascherian Mar 20, 2022
dc3a89e
Modify Task to run tests
tomascherian Mar 20, 2022
d71f0d8
Add JUnit tests
tomascherian Mar 20, 2022
0e3967d
Create jar file
tomascherian Mar 20, 2022
7b3dca2
Add find feature
tomascherian Mar 20, 2022
77c95e0
Merge remote-tracking branch 'origin/add-gradle-support'
tomascherian Mar 20, 2022
abb74db
Update build.gradle
tomascherian Mar 20, 2022
f15a3db
Add GUI
tomascherian Mar 20, 2022
91c7ff3
Add Snooze/Reschedule feature
tomascherian Mar 20, 2022
9458bc3
Update User Guide.
tomascherian Mar 21, 2022
065efba
Add JavaDoc comments
tomascherian Mar 21, 2022
0224d85
Add UI.png
tomascherian Mar 21, 2022
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ bin/

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

repositories {
mavenCentral()
}

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

String javaFxVersion = '11'

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 {
mainClassName = "pac.Launcher"
}

shadowJar {
archiveBaseName = "pac"
archiveClassifier = null
}

checkstyle {
toolVersion = '8.29'
}

run{
standardInput = System.in
}
76 changes: 61 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,75 @@
# User Guide
___

## Features
## Features

### Feature-ABC
**Notes about the command format:**<br>
* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
e.g. In `todo TASK_DESCRIPTION`, `TASK_DESCRIPTION` is a parameter which can be used as `todo buy groceries`.

Description of the feature.
* Parameters cannot be in any order.<br>
e.g. `reschedule 1 /r 2022-10-25` is accepted but `reschedule /r 2022-10-25 1` is invaild command format.</pre>

### Feature-XYZ
* Extraneous parameters for commands that do not take in parameters will be ignored.<br>
e.g. `list XYZ` will be interpreted as `list`.

___
### Add a ToDo task : `todo`

Description of the feature.
Adds a ToDo task to the list with the given task description.<br>
**Format:** `todo TASK_DESCRIPTION`<br>
**e.g.** `todo buy groceries`
___
### Add an Event task : `event`

## Usage
Adds an Event task to the list with the given task description and date.<br>
**Format:** `event TASK_DESCRIPTION /at DATE`<br>
**e.g.** `event attend meeting /at 2022-02-15`

### `Keyword` - Describe action
* `DATE`should be in the format **YYYY-MM-DD** e.g. 2022-02-15
___
### Add a Deadline task : `deadline`

Describe the action and its outcome.
Adds an Deadline task to the list with the given task description and date.<br>
**Format:** `deadline TASK_DESCRIPTION /by DATE`<br>
**e.g.** `deadline submit project report /by 2022-02-15`

Example of usage:
* `DATE`should be in the format **YYYY-MM-DD** e.g. 2022-02-15
___
### Display all the tasks : `list`

`keyword (optional arguments)`
Displays all the tasks in the tasks list.<br>
**Format:** `list`<br>
**e.g.** `list`
___
### Mark a task as done : `mark`
Marks the task with the given task index as done.<br>
**Format:** `mark TASK_INDEX`<br>
**e.g.** `mark 2`
___
### Mark a task as not done : `unmark`
Marks the task with the given task index as not done.<br>
**Format:** `unmark TASK_INDEX`<br>
**e.g.** `unmark 2`
___
### Delete a task : `delete`
Deletes the task with the given task index.<br>
**Format:** `delete TASK_INDEX`<br>
**e.g.** `delete 2`
___
### Reschedule a task : `reschedule`
Reschedule the date of a `event` task or a `deadline` task with the given task index and date.<br>
**Format** `reschedule TASK_INDEX /r DATE`<br>
**e.g.** `reschedule 2 /r 2022-02-18`

Expected outcome:
* `reschedule` cannot be called for a `todo` task
* `DATE`should be in the format **YYYY-MM-DD** e.g. 2022-02-15
___
### Search the list of tasks : `find`

Finds all the tasks containing the given keyword.<br>
**Format:** `find KEYWORD`<br>
**e.g.** `find XYZ`
___

Description of the outcome.

```
expected output
```
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.
5 changes: 5 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.2-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
183 changes: 183 additions & 0 deletions gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
#!/usr/bin/env sh

#
# Copyright 2015 the original author or 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 UN*X
##
##############################################################################

# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null

APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`

# 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"'

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

warn () {
echo "$*"
}

die () {
echo
echo "$*"
echo
exit 1
}

# 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
;;
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"
which java >/dev/null 2>&1 || 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

# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi

# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi

# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`

# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option

if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=`expr $i + 1`
done
case $i in
0) set -- ;;
1) set -- "$args0" ;;
2) set -- "$args0" "$args1" ;;
3) set -- "$args0" "$args1" "$args2" ;;
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi

# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=`save "$@"`

# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"

exec "$JAVACMD" "$@"
Loading