diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000000000000000000000000000000000..097f9f98d9eec50af4ab357b4913aa9bf5a12b0e --- /dev/null +++ b/.gitattributes @@ -0,0 +1,9 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..cd7dfe49c94e2437c193fdfa915c8078f127d273 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +# Ignore Gradle build output directory +build/ +out/ +*.class +# Ignore Gradle project-specific cache directory +.gradle +.DS_Store +www/public \ No newline at end of file diff --git a/Architecture.txt b/Architecture.txt new file mode 100644 index 0000000000000000000000000000000000000000..54961ad0e0fecc36ebfefb6f801f9199229567e5 --- /dev/null +++ b/Architecture.txt @@ -0,0 +1,21 @@ +Project Tracking and Team collaboration: + - Gitlab: https://git.uwaterloo.ca/sw4wang/cs346 + +Main Programming Language: + - Kotlin + +GUI: + - JavaFX + - Local data storage: JSON Format + +Cloud/web Services: + - Spring boot + - Docker to containerize the service + - Microsoft Azure to host the service + - SQLite to store data remotely + +Unit Testing: + - JUnit + +Building the Application: + - Gradle \ No newline at end of file diff --git a/README.md b/README.md index f0265fb32b6fbedeca0f8e1bfd61ba4b583ba3b9..37ff6b87b6fffde29f1230fc1c452ff056c665bf 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,14 @@ -# CS346 +# CS 346 Markdown Project +# Team 215 +This repository is the Markdown Editor application for Team 215. This projects relates to building a note-taking application. +## Wiki +Landing page: https://git.uwaterloo.ca/sw4wang/cs346 +Meeting Minutes: // Link to meeting minutes file +Requirements: // Link to requirements.txt +Architecture: // Link to archtecture.txt -## Getting started +## Issues and Milestones +// To be filled in future sprints -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! - -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://git.uwaterloo.ca/sw4wang/cs346.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://git.uwaterloo.ca/sw4wang/cs346/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. diff --git a/Requirements.txt b/Requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..5067ec2de2203391a0b2a8bc3a47062889b04c6a --- /dev/null +++ b/Requirements.txt @@ -0,0 +1,35 @@ +# GUI Requirements + +This is a desktop application. + +- A top-level menu bar that lists major functions, and indicates the hotkeys for each feature (e.g. File, Edit, View menu and submenus). +- Hotkeys/keyboard shortcuts for major functionality. +- Window resizing, so that the user can resize and reposition the application. You should save the window size and position on exit, and restore that size and position when they relaunch it. +- Minimize/mazimize buttons function as expected. +- Undo-redo support for actions in the user interface. +- Cut-copy-paste text. + +- Support basic Markdown syntax, including headings, bold, italics, and so on. This includes syntax highlighting for these elements, and hotkeys to apply formatting (e.g. CMD-B to bold selected text). +- Users should be able to open an existing markdown file (extensions .md or .markdown), close the current file, save or save-as with appropriate dialogs. +- It should be possible to have multiple markdown files open simultaneously (in different windows or different tabs). +- You should support light and dark themes, and the user should be able to set their preference in a Settings dialog. These settings should persist across sections and files. +- Provide two view modes: raw markdown syntax (as above), or formatted text. +- Save application settings in the cloud so that they are preserved across sessions. + +# Service Requirements + +- Build a web service so user's data can be shared across multiple systems. +- A user should be able to launch multiple instances of the application, and have the instances load and use this remote data. +- Application should communicate with the web service using HTTP protocol. +- Data should be saved so that if the web service is stopped and restarted, the data will persist. + + +# Additional Feature Requirements + +- Add themes! Dark, Light, Solarized etc. +- Stylize the toolbars e.g. a fancy VS Code style, expanding toolbar. +- Support editing both in raw markdown or formatted text (similar to Typora, where you can mode-switch but edit in either mode). +- Save files in the cloud, instead of just settings. [ed. this would likely mean the ability to import files, browse, and delete from the cloud as well]. +- Open multiple files in tabs instead of windows. +- Export as HTML. +- Export as PDF. \ No newline at end of file diff --git a/app/build.gradle.kts b/app/build.gradle.kts new file mode 100644 index 0000000000000000000000000000000000000000..c319480dbbc0e008255d4abffa7382a96615af08 --- /dev/null +++ b/app/build.gradle.kts @@ -0,0 +1,17 @@ +/* + * This file was generated by the Gradle 'init' task. + */ + +plugins { + id("cs.kotlin-application-conventions") +} + +dependencies { + implementation("org.apache.commons:commons-text") + implementation(project(":utilities")) +} + +application { + // Define the main class for the application. + mainClass.set("cs.app.AppKt") +} diff --git a/app/src/main/kotlin/cs/app/App.kt b/app/src/main/kotlin/cs/app/App.kt new file mode 100644 index 0000000000000000000000000000000000000000..a55e3ccf6fe84a54ec22a87573541e25b2c747d4 --- /dev/null +++ b/app/src/main/kotlin/cs/app/App.kt @@ -0,0 +1,14 @@ +/* + * This Kotlin source file was generated by the Gradle 'init' task. + */ +package cs.app + +import cs.utilities.StringUtils + +import org.apache.commons.text.WordUtils + +fun main() { + val tokens = StringUtils.split(MessageUtils.getMessage()) + val result = StringUtils.join(tokens) + println(WordUtils.capitalize(result)) +} diff --git a/app/src/main/kotlin/cs/app/MessageUtils.kt b/app/src/main/kotlin/cs/app/MessageUtils.kt new file mode 100644 index 0000000000000000000000000000000000000000..33bcee54ba6b1e9a3c79375f421cfe6e9c3e4d5f --- /dev/null +++ b/app/src/main/kotlin/cs/app/MessageUtils.kt @@ -0,0 +1,10 @@ +/* + * This Kotlin source file was generated by the Gradle 'init' task. + */ +package cs.app + +class MessageUtils { + companion object { + fun getMessage(): String = "Hello World!" + } +} diff --git a/app/src/test/kotlin/cs/app/MessageUtilsTest.kt b/app/src/test/kotlin/cs/app/MessageUtilsTest.kt new file mode 100644 index 0000000000000000000000000000000000000000..f496554eec9b51cb76097f7bd481494c756a635f --- /dev/null +++ b/app/src/test/kotlin/cs/app/MessageUtilsTest.kt @@ -0,0 +1,14 @@ +/* + * This Kotlin source file was generated by the Gradle "init" task. + */ +package cs.app + +import org.junit.jupiter.api.Test + +import org.junit.jupiter.api.Assertions.assertEquals + +class MessageUtilsTest { + @Test fun testGetMessage() { + assertEquals("Hello World!", MessageUtils.getMessage()) + } +} diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts new file mode 100644 index 0000000000000000000000000000000000000000..2bd0ce450fd4d42b348579605adb07b46f90bafd --- /dev/null +++ b/buildSrc/build.gradle.kts @@ -0,0 +1,17 @@ +/* + * This file was generated by the Gradle 'init' task. + */ + +plugins { + // Support convention plugins written in Kotlin. Convention plugins are build scripts in 'src/main' that automatically become available as plugins in the main build. + `kotlin-dsl` +} + +repositories { + // Use the plugin portal to apply community plugins in convention plugins. + gradlePluginPortal() +} + +dependencies { + implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:1.7.10") +} diff --git a/buildSrc/settings.gradle.kts b/buildSrc/settings.gradle.kts new file mode 100644 index 0000000000000000000000000000000000000000..3f3e665c500049b74aaa067f20edc7b961a7ecb9 --- /dev/null +++ b/buildSrc/settings.gradle.kts @@ -0,0 +1,7 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * This settings file is used to specify which projects to include in your build-logic build. + */ + +rootProject.name = "buildSrc" diff --git a/buildSrc/src/main/kotlin/cs.kotlin-application-conventions.gradle.kts b/buildSrc/src/main/kotlin/cs.kotlin-application-conventions.gradle.kts new file mode 100644 index 0000000000000000000000000000000000000000..bd74f5449e62759fd6ccfd41d492f0446bedcf9d --- /dev/null +++ b/buildSrc/src/main/kotlin/cs.kotlin-application-conventions.gradle.kts @@ -0,0 +1,11 @@ +/* + * This file was generated by the Gradle 'init' task. + */ + +plugins { + // Apply the common convention plugin for shared build configuration between library and application projects. + id("cs.kotlin-common-conventions") + + // Apply the application plugin to add support for building a CLI application in Java. + application +} diff --git a/buildSrc/src/main/kotlin/cs.kotlin-common-conventions.gradle.kts b/buildSrc/src/main/kotlin/cs.kotlin-common-conventions.gradle.kts new file mode 100644 index 0000000000000000000000000000000000000000..f743af2e416f337ee40af32ba469bf07e65f7628 --- /dev/null +++ b/buildSrc/src/main/kotlin/cs.kotlin-common-conventions.gradle.kts @@ -0,0 +1,28 @@ +/* + * This file was generated by the Gradle 'init' task. + */ + +plugins { + // Apply the org.jetbrains.kotlin.jvm Plugin to add support for Kotlin. + id("org.jetbrains.kotlin.jvm") +} + +repositories { + // Use Maven Central for resolving dependencies. + mavenCentral() +} + +dependencies { + constraints { + // Define dependency versions as constraints + implementation("org.apache.commons:commons-text:1.9") + } + + // Use JUnit Jupiter for testing. + testImplementation("org.junit.jupiter:junit-jupiter:5.9.1") +} + +tasks.named<Test>("test") { + // Use JUnit Platform for unit tests. + useJUnitPlatform() +} diff --git a/buildSrc/src/main/kotlin/cs.kotlin-library-conventions.gradle.kts b/buildSrc/src/main/kotlin/cs.kotlin-library-conventions.gradle.kts new file mode 100644 index 0000000000000000000000000000000000000000..c913611d19d1145d46afe8dbd3dfae0f5a4b0d6e --- /dev/null +++ b/buildSrc/src/main/kotlin/cs.kotlin-library-conventions.gradle.kts @@ -0,0 +1,11 @@ +/* + * This file was generated by the Gradle 'init' task. + */ + +plugins { + // Apply the common convention plugin for shared build configuration between library and application projects. + id("cs.kotlin-common-conventions") + + // Apply the java-library plugin for API and implementation separation. + `java-library` +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000000000000000000000000000000000..943f0cbfa754578e88a3dae77fce6e3dea56edbf Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000000000000000000000000000000000..f398c33c4b08dabb3f1275e57706c2de4effb50c --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +networkTimeout=10000 +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000000000000000000000000000000000000..65dcd68d65c82f2a5338fded4af852f9caf93b93 --- /dev/null +++ b/gradlew @@ -0,0 +1,244 @@ +#!/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 + +# 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 "$*" +} >&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 + 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" && ! "$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 + +# 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" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000000000000000000000000000000000000..93e3f59f135dd2dd498de4beb5c64338cc33beeb --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/list/build.gradle.kts b/list/build.gradle.kts new file mode 100644 index 0000000000000000000000000000000000000000..e63bd145d16b615f4d1686d3a17db8672640ba31 --- /dev/null +++ b/list/build.gradle.kts @@ -0,0 +1,7 @@ +/* + * This file was generated by the Gradle 'init' task. + */ + +plugins { + id("cs.kotlin-library-conventions") +} diff --git a/list/src/main/kotlin/cs/list/LinkedList.kt b/list/src/main/kotlin/cs/list/LinkedList.kt new file mode 100644 index 0000000000000000000000000000000000000000..55d0913c1c2599728224a52ff181e050d497f9eb --- /dev/null +++ b/list/src/main/kotlin/cs/list/LinkedList.kt @@ -0,0 +1,86 @@ +/* + * This Kotlin source file was generated by the Gradle 'init' task. + */ +package cs.list + +class LinkedList { + private var head: Node? = null + + fun add(element: String) { + val newNode = Node(element) + + val it = tail(head) + if (it == null) { + head = newNode + } else { + it.next = newNode + } + } + + private fun tail(head: Node?): Node? { + var it: Node? + + it = head + while (it?.next != null) { + it = it.next + } + + return it + } + + fun remove(element: String): Boolean { + var result = false + var previousIt: Node? = null + var it: Node? = head + while (!result && it != null) { + if (0 == element.compareTo(it.data)) { + result = true + unlink(previousIt, it) + break + } + previousIt = it + it = it.next + } + + return result + } + + private fun unlink(previousIt: Node?, currentIt: Node) { + if (currentIt == head) { + head = currentIt.next + } else { + previousIt?.next = currentIt.next + } + } + + fun size(): Int { + var size = 0 + + var it = head + while (it != null) { + ++size + it = it.next + } + + return size + } + + fun get(idx: Int): String { + var index = idx + var it = head + while (index > 0 && it != null) { + it = it.next + index-- + } + + if (it == null) { + throw IndexOutOfBoundsException("Index is out of range") + } + + return it.data + } + + private data class Node(val data: String) { + var next: Node? = null + } +} diff --git a/list/src/test/kotlin/cs/list/LinkedListTest.kt b/list/src/test/kotlin/cs/list/LinkedListTest.kt new file mode 100644 index 0000000000000000000000000000000000000000..e12e837f6576e88a1c6292eb9fed71f3b3d757ca --- /dev/null +++ b/list/src/test/kotlin/cs/list/LinkedListTest.kt @@ -0,0 +1,50 @@ +/* + * This Kotlin source file was generated by the Gradle "init" task. + */ +package cs.list + +import org.junit.jupiter.api.Test + +import org.junit.jupiter.api.Assertions.* + +class LinkedListTest { + @Test fun testConstructor() { + val list = LinkedList() + assertEquals(0, list.size()) + } + + @Test fun testAdd() { + val list = LinkedList() + + list.add("one") + assertEquals(1, list.size()) + assertEquals("one", list.get(0)) + + list.add("two") + assertEquals(2, list.size()) + assertEquals("two", list.get(1)) + } + + @Test fun testRemove() { + val list = LinkedList() + + list.add("one") + list.add("two") + assertTrue(list.remove("one")) + + assertEquals(1, list.size()) + assertEquals("two", list.get(0)) + + assertTrue(list.remove("two")) + assertEquals(0, list.size()) + } + + @Test fun testRemoveMissing() { + val list = LinkedList() + + list.add("one") + list.add("two") + assertFalse(list.remove("three")) + assertEquals(2, list.size()) + } +} diff --git a/meeting-minutes/Jan 31 - Project Review Meeting.pdf b/meeting-minutes/Jan 31 - Project Review Meeting.pdf new file mode 100644 index 0000000000000000000000000000000000000000..d4ee52b2b9ea23c4490db5db473ae4a8bebcf6e1 Binary files /dev/null and b/meeting-minutes/Jan 31 - Project Review Meeting.pdf differ diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000000000000000000000000000000000000..fc5826c48f523c68c2ff3341196e8694b8afd2ce --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,11 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * + * Detailed information about configuring a multi-project build in Gradle can be found + * in the user manual at https://docs.gradle.org/7.6/userguide/multi_project_builds.html + */ + +rootProject.name = "CS 346" +include("app", "list", "utilities") diff --git a/utilities/build.gradle.kts b/utilities/build.gradle.kts new file mode 100644 index 0000000000000000000000000000000000000000..82459d95874f2e8b45b5ba847476d9f6c704bcee --- /dev/null +++ b/utilities/build.gradle.kts @@ -0,0 +1,11 @@ +/* + * This file was generated by the Gradle 'init' task. + */ + +plugins { + id("cs.kotlin-library-conventions") +} + +dependencies { + api(project(":list")) +} diff --git a/utilities/src/main/kotlin/cs/utilities/JoinUtils.kt b/utilities/src/main/kotlin/cs/utilities/JoinUtils.kt new file mode 100644 index 0000000000000000000000000000000000000000..529f285b770670464613a0176a568afe7deee4ea --- /dev/null +++ b/utilities/src/main/kotlin/cs/utilities/JoinUtils.kt @@ -0,0 +1,22 @@ +/* + * This Kotlin source file was generated by the Gradle 'init' task. + */ +package cs.utilities + +import cs.list.LinkedList + +class JoinUtils { + companion object { + fun join(source: LinkedList): String { + val result = StringBuilder() + for (i in 0 until source.size()) { + if (result.isNotEmpty()) { + result.append(" ") + } + result.append(source.get(i)) + } + + return result.toString() + } + } +} diff --git a/utilities/src/main/kotlin/cs/utilities/SplitUtils.kt b/utilities/src/main/kotlin/cs/utilities/SplitUtils.kt new file mode 100644 index 0000000000000000000000000000000000000000..d8887800aafecb1c4334e3c00eddc1639218423c --- /dev/null +++ b/utilities/src/main/kotlin/cs/utilities/SplitUtils.kt @@ -0,0 +1,42 @@ +/* + * This Kotlin source file was generated by the Gradle 'init' task. + */ +package cs.utilities + +import cs.list.LinkedList + +class SplitUtils { + companion object { + fun split(source: String): LinkedList { + var lastFind = 0 + val result = LinkedList() + + var currentFind = source.indexOf(" ", lastFind) + while (currentFind != -1) { + var token = source.substring(lastFind) + if (currentFind != -1) { + token = token.substring(0, currentFind - lastFind) + } + + addIfValid(token, result) + lastFind = currentFind + 1 + currentFind = source.indexOf(" ", lastFind) + } + + val token = source.substring(lastFind) + addIfValid(token, result) + + return result + } + + private fun addIfValid(token: String, list: LinkedList) { + if (isTokenValid(token)) { + list.add(token) + } + } + + private fun isTokenValid(token: String): Boolean { + return token.isNotEmpty() + } + } +} diff --git a/utilities/src/main/kotlin/cs/utilities/StringUtils.kt b/utilities/src/main/kotlin/cs/utilities/StringUtils.kt new file mode 100644 index 0000000000000000000000000000000000000000..fc6e536cc498c243b16b6b5d272fcf2435d4b8dc --- /dev/null +++ b/utilities/src/main/kotlin/cs/utilities/StringUtils.kt @@ -0,0 +1,18 @@ +/* + * This Kotlin source file was generated by the Gradle 'init' task. + */ +package cs.utilities + +import cs.list.LinkedList + +class StringUtils { + companion object { + fun join(source: LinkedList): String { + return JoinUtils.join(source) + } + + fun split(source: String): LinkedList { + return SplitUtils.split(source) + } + } +}