diff --git a/.gitignore b/.gitignore index 4d0d2aa..dc6d945 100644 --- a/.gitignore +++ b/.gitignore @@ -66,3 +66,9 @@ fastlane/Preview.html fastlane/screenshots fastlane/test_output fastlane/readme.md + +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build diff --git a/README.md b/README.md index e4989f0..ed1b383 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,6 @@ Ένα απλό πρότυπο οργάνωσης του κώδικα και της τεχνικής τεκμηρίωσης για τις εξαμηνιαίες εργασίες του μαθήματος Τεχνολογία Λογισμικού ([INF138](https://eclass.aueb.gr/courses/INF138/)) του Τμήματος Πληροφορικής Οικονομικού Πανεπιστημίου Αθηνών. -Η τρέχουσα έκδοση περιλαμβάνει την [προδιαγραφή των απαιτήσεων λογισμικού](requirements/software-requirements.md) με προσαρμογή του `IEEE Std 830-1998` για την ενσωμάτωση απαιτήσεων σε μορφή περιπτώσεων χρήσης. Για περισσότερες λεπτομέρειες μπορείτε να ανατρέξετε στο βιβλίο [Μ Γιακουμάκης, Ν. Διαμαντίδης, Τεχνολογία Λογισμικού, Σταμούλης, 2009](https://www.softeng.gr). +Η τρέχουσα έκδοση περιλαμβάνει την [προδιαγραφή των απαιτήσεων λογισμικού](docs/markdown/software-requirements.md) με προσαρμογή του `IEEE Std 830-1998` για την ενσωμάτωση απαιτήσεων σε μορφή περιπτώσεων χρήσης. Για περισσότερες λεπτομέρειες μπορείτε να ανατρέξετε στο βιβλίο [Μ Γιακουμάκης, Ν. Διαμαντίδης, Τεχνολογία Λογισμικού, Σταμούλης, 2009](https://www.softeng.gr). diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..047efb2 --- /dev/null +++ b/build.gradle @@ -0,0 +1,29 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * This generated file contains a sample Java application project to get you started. + * For more details take a look at the 'Building Java & JVM projects' chapter in the Gradle + * User Manual available at https://docs.gradle.org/6.8.3/userguide/building_java_projects.html + */ + +plugins { + id "com.github.dkorotych.gradle-maven-exec" version "2.2.1" +} + +repositories { + // Use JCenter for resolving dependencies. + jcenter() +} + + +task umlet(type: MavenExec) { + def docsDir = file("./docs") + workingDir docsDir + goals 'umlet:convert' + + define([ + 'umlet.targetDir': 'markdown/uml', + ]) + quiet false +} + diff --git a/src/site/markdown/software-requirements.md b/docs/markdown/software-requirements.md similarity index 96% rename from src/site/markdown/software-requirements.md rename to docs/markdown/software-requirements.md index e99beed..06ead89 100644 --- a/src/site/markdown/software-requirements.md +++ b/docs/markdown/software-requirements.md @@ -26,7 +26,7 @@ ## Επισκόπηση μοντέλου περιπτώσεων χρήσης -![Διάγραμμα περιπτώσεων χρήσης](diagrams/use-case-diagram.png) +![Διάγραμμα περιπτώσεων χρήσης](uml/requirements/use-case-diagram.png) \[*Εισάγουμε το διάγραμμα περιπτώσεων χρήσης. Βλέπε σχήμα 3-19 του παραδείγματος 3-11 στη σελίδα 168 του βιβλίου.* @@ -129,7 +129,7 @@ \[*Εισάγουμε ένα διάγραμμα κλάσεων με την αρχική έκδοση των κλάσεων λογισμικού. Βλέπε σχήμα 4-104 του παραδείγματος 4-14 στη σελίδα 258 του βιβλίου*\] -![Κλάσεις Ανάλυσης](diagrams/analysis-classes.png) +![Κλάσεις Ανάλυσης](uml/requirements/analysis-classes.png) Κλάσεις ανάλυσης που έχουν προκύψει από την ανάλυση των περιπτώσεων χρήσης *Διαχείριση Λογαριασμού* και *Διαχείριση Στοιχείων Πελάτη*. @@ -141,11 +141,11 @@ #### Άνοιγμα νέου λογαριασμού -![Διάγραμμα ακολουθίας - Άνοιγμα Λογαριασμού](diagrams/sequence-create-account.png) +![Διάγραμμα ακολουθίας - Άνοιγμα Λογαριασμού](uml/requirements/sequence-create-account.png) #### Ανάληψη μετρητών από ταμείο -![Διάγραμμα ακολουθίας - Ανάληψη μετρητών](diagrams/sequence-make-withdrawal.png) +![Διάγραμμα ακολουθίας - Ανάληψη μετρητών](uml/requirements/sequence-make-withdrawal.png) ## Άλλα μοντέλα ------------ diff --git a/src/site/markdown/uc1-cashier-transactions.md b/docs/markdown/uc1-cashier-transactions.md similarity index 100% rename from src/site/markdown/uc1-cashier-transactions.md rename to docs/markdown/uc1-cashier-transactions.md diff --git a/src/site/markdown/uc2-account-management.md b/docs/markdown/uc2-account-management.md similarity index 97% rename from src/site/markdown/uc2-account-management.md rename to docs/markdown/uc2-account-management.md index 5400aeb..4ae55ea 100644 --- a/src/site/markdown/uc2-account-management.md +++ b/docs/markdown/uc2-account-management.md @@ -39,7 +39,7 @@ ## Διαγράμματα ### Διάγραμμα δραστηριότητας - Άνοιγμα νέου λογαριασμού -![Διάγραμμα δραστηριότητας - Άνοιγμα Λογαριασμού](diagrams/activity-create-account.png) +![Διάγραμμα δραστηριότητας - Άνοιγμα Λογαριασμού](uml/requirements/activity-create-account.png) diff --git a/src/site/markdown/uc3-client-management.md b/docs/markdown/uc3-client-management.md similarity index 100% rename from src/site/markdown/uc3-client-management.md rename to docs/markdown/uc3-client-management.md diff --git a/src/site/markdown/uc4-debit-card-management.md b/docs/markdown/uc4-debit-card-management.md similarity index 100% rename from src/site/markdown/uc4-debit-card-management.md rename to docs/markdown/uc4-debit-card-management.md diff --git a/docs/markdown/uml/requirements/activity-create-account.png b/docs/markdown/uml/requirements/activity-create-account.png new file mode 100644 index 0000000..228acb0 Binary files /dev/null and b/docs/markdown/uml/requirements/activity-create-account.png differ diff --git a/docs/markdown/uml/requirements/analysis-classes.png b/docs/markdown/uml/requirements/analysis-classes.png new file mode 100644 index 0000000..e141607 Binary files /dev/null and b/docs/markdown/uml/requirements/analysis-classes.png differ diff --git a/docs/markdown/uml/requirements/sequence-create-account.png b/docs/markdown/uml/requirements/sequence-create-account.png new file mode 100644 index 0000000..0c94f0e Binary files /dev/null and b/docs/markdown/uml/requirements/sequence-create-account.png differ diff --git a/docs/markdown/uml/requirements/sequence-make-withdrawal.png b/docs/markdown/uml/requirements/sequence-make-withdrawal.png new file mode 100644 index 0000000..e58c965 Binary files /dev/null and b/docs/markdown/uml/requirements/sequence-make-withdrawal.png differ diff --git a/docs/markdown/uml/requirements/use-case-diagram.png b/docs/markdown/uml/requirements/use-case-diagram.png new file mode 100644 index 0000000..eddd186 Binary files /dev/null and b/docs/markdown/uml/requirements/use-case-diagram.png differ diff --git a/docs/pom.xml b/docs/pom.xml new file mode 100644 index 0000000..d7d63f6 --- /dev/null +++ b/docs/pom.xml @@ -0,0 +1,75 @@ + + 4.0.0 + + com.example + template + 2.0.0-SNAPSHOT + jar + + Template + + + UTF-8 + 1.8 + 1.8 + + + + + + + + + + com.kryshchuk.maven.plugins + umlet-maven-plugin + 1.2 + + + + ./uml + + **/*.uxf + + + + + + + convert-uml + + convert + + + + + + log4j + log4j + 1.2.17 + + + + + + org.apache.maven.plugins + maven-site-plugin + 3.9.0 + + + + + + + + com.kryshchuk.maven.plugins + umlet-maven-plugin + 1.2 + + + + + + \ No newline at end of file diff --git a/src/site/resources/uml/requirements/activity-create-account.uxf b/docs/uml/requirements/activity-create-account.uxf similarity index 100% rename from src/site/resources/uml/requirements/activity-create-account.uxf rename to docs/uml/requirements/activity-create-account.uxf diff --git a/src/site/resources/uml/requirements/analysis-classes.uxf b/docs/uml/requirements/analysis-classes.uxf similarity index 100% rename from src/site/resources/uml/requirements/analysis-classes.uxf rename to docs/uml/requirements/analysis-classes.uxf diff --git a/src/site/resources/uml/requirements/sequence-create-account.uxf b/docs/uml/requirements/sequence-create-account.uxf similarity index 100% rename from src/site/resources/uml/requirements/sequence-create-account.uxf rename to docs/uml/requirements/sequence-create-account.uxf diff --git a/src/site/resources/uml/requirements/sequence-make-withdrawal.uxf b/docs/uml/requirements/sequence-make-withdrawal.uxf similarity index 100% rename from src/site/resources/uml/requirements/sequence-make-withdrawal.uxf rename to docs/uml/requirements/sequence-make-withdrawal.uxf diff --git a/src/site/resources/uml/requirements/use-case-diagram.uxf b/docs/uml/requirements/use-case-diagram.uxf similarity index 100% rename from src/site/resources/uml/requirements/use-case-diagram.uxf rename to docs/uml/requirements/use-case-diagram.uxf diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e708b1c 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 0000000..442d913 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..4f906e0 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/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" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@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=. +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%" == "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%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/requirements/diagrams/activity-create-account.png b/requirements/diagrams/activity-create-account.png deleted file mode 100644 index d6d5501..0000000 Binary files a/requirements/diagrams/activity-create-account.png and /dev/null differ diff --git a/requirements/diagrams/analysis-classes.png b/requirements/diagrams/analysis-classes.png deleted file mode 100644 index f6dd757..0000000 Binary files a/requirements/diagrams/analysis-classes.png and /dev/null differ diff --git a/requirements/diagrams/sequence-create-account.png b/requirements/diagrams/sequence-create-account.png deleted file mode 100644 index 707b7bd..0000000 Binary files a/requirements/diagrams/sequence-create-account.png and /dev/null differ diff --git a/requirements/diagrams/sequence-make-withdrawal.png b/requirements/diagrams/sequence-make-withdrawal.png deleted file mode 100644 index 431b8d4..0000000 Binary files a/requirements/diagrams/sequence-make-withdrawal.png and /dev/null differ diff --git a/requirements/diagrams/use-case-diagram.png b/requirements/diagrams/use-case-diagram.png deleted file mode 100644 index 1294b4b..0000000 Binary files a/requirements/diagrams/use-case-diagram.png and /dev/null differ diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..ebed2dc --- /dev/null +++ b/settings.gradle @@ -0,0 +1,10 @@ +/* + * 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/6.8.3/userguide/multi_project_builds.html + */ + +rootProject.name = 'softeng-project-template'