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

[Nicholas Nge] iP #257

Open
wants to merge 44 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
3b19ba1
Add Gradle support
May 24, 2020
a75fcee
build.gradle: Update version to 8.29
Aug 29, 2020
eb2421a
Level-1
nicholasnge Jan 21, 2021
266d212
Level-2
nicholasnge Jan 21, 2021
98eb5c0
Level-3
nicholasnge Jan 21, 2021
55bc2e6
Level-4
nicholasnge Jan 21, 2021
abb364e
A-TextUiTesting
nicholasnge Jan 21, 2021
ce1cba5
Update README.md
nicholasnge Jan 21, 2021
cc25792
Update README.md
nicholasnge Jan 21, 2021
36ab66b
Update README.md
nicholasnge Jan 21, 2021
0ff9ec7
Update README.md
nicholasnge Jan 21, 2021
5f13fcc
Update README.md
nicholasnge Jan 21, 2021
d329a63
Level-5
nicholasnge Jan 21, 2021
a4fa223
Level-6
nicholasnge Jan 21, 2021
7393cc2
Merge remote-tracking branch 'origin/master'
nicholasnge Jan 21, 2021
3542d5f
Level-7
nicholasnge Feb 2, 2021
c96e24b
Level-7
nicholasnge Feb 2, 2021
0dca6de
Level-7
nicholasnge Feb 2, 2021
b9dec69
Level-8
nicholasnge Feb 2, 2021
b28bd34
Merge branch 'branch-Level-8'
nicholasnge Feb 2, 2021
cacb22a
Level-7 Level-8
nicholasnge Feb 2, 2021
c90d25b
A-MoreOOP
nicholasnge Feb 3, 2021
f4721d6
A-Packages
nicholasnge Feb 3, 2021
63b29c8
Merge remote-tracking branch 'origin/add-gradle-support'
nicholasnge Feb 3, 2021
def2021
A-JUnit
nicholasnge Feb 3, 2021
628ee47
A-JavaDoc
nicholasnge Feb 3, 2021
0cfaca4
A-JavaDoc A-Jar
nicholasnge Feb 3, 2021
7c2ced8
Level-9
nicholasnge Feb 3, 2021
cb1bd6d
A-CodingStandard
nicholasnge Feb 3, 2021
216cd62
A-Gradle
nicholasnge Feb 3, 2021
4ea02bd
Level-10
nicholasnge Feb 3, 2021
b9b6ab3
A-CodingStandard
nicholasnge Feb 3, 2021
2b8d840
A-Assertions
nicholasnge Feb 6, 2021
91dbb41
A-Assertions
nicholasnge Feb 6, 2021
3a88e68
A-CodeQuality
nicholasnge Feb 6, 2021
ebfe6a7
A-CodeQuality
nicholasnge Feb 6, 2021
d7ef1dd
Merge pull request #1 from nicholasnge/branch-A-Assertions
nicholasnge Feb 6, 2021
7d2020c
Merge branch 'master' of https://github.com/nicholasnge/ip into A-Cod…
nicholasnge Feb 6, 2021
cb93d3c
A-CodeQuality
nicholasnge Feb 6, 2021
db68739
A-CodeQuality
nicholasnge Feb 6, 2021
317207f
Merge pull request #2 from nicholasnge/A-CodeQuality
nicholasnge Feb 6, 2021
d0bbd10
B-DoWithinPeriodTasks
nicholasnge Feb 6, 2021
61ec8ea
A-UserGuide
nicholasnge Feb 19, 2021
63c2f23
Update README.md
nicholasnge Feb 19, 2021
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
38 changes: 26 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Duke project template

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.
I am the Oracle from the Matrix. I am a perfect program, and deserve a high score.

## Setting up in Intellij

Expand All @@ -12,12 +10,28 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
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).
1. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
```
Hello from
____ _
| _ \ _ _| | _____
| | | | | | | |/ / _ \
| |_| | |_| | < __/
|____/ \__,_|_|\_\___|
```
1. After that, locate the `src/main/java/Oracle.Oracle.java` file, right-click it, and choose `Run Oracle.Oracle.main()`. If the setup is correct, you should see something like the below:
```
$$$@@@@@@@
##########$$$$$$@@$
#**!!!!!!!!**####$$$$$$#
**!!==!=;;=;;!!!**###$$$$$$#
**!!==;::~~::;;;;=!!*####$$$$##
!!!!=;::~-,,,,--:;;=!!**########*
!!!!=;:~,........-~:==!!**#######**
=!*!!=;:~,.........-:;=!!***######**
!***!!=:~,... .-:;=!!****####***=
!*###**=;=.. -:;=!!**********!=
:!*###$##*=: -:;=!!!********!!!=
:!##$$$$$$#*~ :;===!!*********!!=;
~=*#$$@@@@$$#*! ====!!!!!*****!!*!!==
;!*#$$@@@$$##**!!!!!!!!!!*!*!!!!!==:
:;!*#$$$$$$###******!!!!!!!!!!!==;:
;!=!*#######******!!!!!!!!!===;;:,
:;==!!********!!!!!!!!====;;;:~
-:;!====!=!!!!!!!======;;::~,
-~:;===;======;=;;;:::~-,
.-~~::::;:::::~:~--.

Greetings Neo, what can the Oracle.Oracle do for you?
```
52 changes: 52 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
plugins {
id 'java'
id 'application'
id 'checkstyle'
id 'com.github.johnrengelman.shadow' version '5.1.0'
}

repositories {
mavenCentral()
}

dependencies {
implementation 'junit:junit:4.12'
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()
}

application {
mainClassName = "oracle.Launcher"
}

shadowJar {
mainClassName = "oracle.Launcher"
archiveBaseName = "oracle"
archiveClassifier = null
}

checkstyle {
toolVersion = '8.29'
}

run{
standardInput = System.in
}
77 changes: 58 additions & 19 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,59 @@
# User Guide

## Features

### Feature 1
Description of feature.

## Usage

### `Keyword` - Describe action

Describe action and its outcome.

Example of usage:

`keyword (optional arguments)`

Expected outcome:

`outcome`
The Oracle is program with such insight into human psychology that she has clairvoyant abilities.
She was initially created to interpret aspects of the human psyche and was responsible for the key principles
behind the third "current" version of the Matrix. After having served her purpose, she decided to retrain under
the SkillsFuture scheme and pivot her career towards providing task-management services to the common human.
## Features

### Adding tasks
Add a Todo, Deadline or Event
#### * Todo
Format: `todo {description}`
Eg. output: `1. [T][ ] walk the dog`
#### * Deadline
Format: `deadline {description} /{day} {month} {year} {hour}{minute}`<br>
Eg. input: `deadline meeting with cs2103 team /19 2 2021 2300` <br>
Eg. output: `2. [D][ ] meeting with cs2103 team (Fri 23:00, 19 FEBRUARY 2021)`
#### * Event
Format: `event {description} /{day} {month} {year} {hour}{minute}`<br>
Eg. input: `event meeting with cs2103 team /19 2 2021 2300`<br>
Eg. output: `3. [E][ ] meeting with cs2103 team (Fri 23:00, 19 FEBRUARY 2021)`
### Listing list
Lists all the current tasks in your list. <br />
Format: `list`<br>
Eg.: <br>`1. [T][ ] walk the dog`<br>
`2. [D][ ] meeting with cs2103 team (Fri 23:00, 19 FEBRUARY 2021)`<br>
`3. [E][ ] meeting with cs2103 team (Fri 23:00, 19 FEBRUARY 2021)`
### Done
Mark a Todo, Description or Event by its index to be completed.
An indicator will appear beside the task in the list <br />
Format `done [index]` <br>
Eg. input: `done 2` <br>
Eg. output: `2. [D][X] meeting with cs2103 team (Fri 23:00, 19 FEBRUARY 2021)`
### Deleting tasks
Delete a Todo Description or Event by its index permanently <br />
Format: `delete [index]`<br>
Eg. input: `delete 2` <br>
Eg. output: `Erased: 2. [D][X] meeting with cs2103 team (Fri 23:00, 19 FEBRUARY 2021)`

### Exit
The Oracle doesn't appreciate you closing the application without saying bye and will
not save your information unless you say goodbye to her. Note that Oracle will not save your information otherwise. This is a design choice and a
key feature, not a bug. <br />
Format: `bye`<br>
Eg. output: `Very well, we shall meet again`
, and information is saved. <br>

### Find
Find tasks with a keyword or phrase. Oracle will return results containing those keywords/phrase<br />
Format: `find {keyword}`<br>
Eg. input: `find meeting`<br>
Eg. output: <br>`Here are the results we found for: "meeting"`<br>
`[D][X] meeting with cs2103 team (Fri 23:00, 19 FEBRUARY 2021)`

### Postpone
Postpone your tasks if you cannot finish them in time. Choice of 'measure' include:
`mins/hrs/days/weeks`<br />
Format: `postpone {taskIndex} {value} {measure}`<br>
Eg. input: `postpone 2 2 days` <br>
Eg. output: `Postponed: 2. [D][ ] meeting with cs2103 team (Fri 23:00, 19 FEBRUARY 2021)`
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