.gitignore

@@ -245,6 +245,9 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
+### Maven ###
+target/
+
 ### Gradle ###
 .gradle
 build/

.gitlab-ci.yml

-image: gradle:jdk12
-
-before_script:
-  - export GRADLE_USER_HOME=`pwd`/.gradle
-
-cache:
-  paths:
-    - .gradle/wrapper
-    - .gradle/caches
+image: maven:3.9.9-eclipse-temurin-17
 
 build:
   stage: build
   script:
-    - ./gradlew -Pci=gitlab build
+    - mvn "-Dci=gitlab" process-resources
+
+pages:
+  script:
+    - mvn "-Dci=gitlab" process-resources
+    - cp -r target/docs/* public
+#  only:
+#    - master
   artifacts:
     paths:
-    - lectures/build/docs
-    expire_in: 1 week
+      - public

.gitpod.Dockerfile

+FROM gitpod/workspace-full-vnc
+                    
+USER gitpod
+
+# Install custom tools, runtime, etc. using apt-get
+# For example, the command below would install "bastet" - a command line tetris clone:
+#
+# RUN sudo apt-get -q update && #     sudo apt-get install -yq bastet && #     sudo rm -rf /var/lib/apt/lists/*
+#
+# More information: https://www.gitpod.io/docs/config-docker/

.gitpod.yml

+tasks:
+  - init: echo "Replace me with a build script for the project."
+    command: echo "Replace me with something that should run on every start, or just
+      remove me entirely."
+image:
+  file: .gitpod.Dockerfile

.mailmap

+Hallvard Trætteberg <hal@ntnu.no> Hallvard Trætteberg <hal@ntnu.no>
+Hallvard Trætteberg <hal@ntnu.no> Hallvard Traetteberg <hal@ntnu.no>
+Adrian Stoica <george.a.stoica@ntnu.no> Adrian Stoica <george.a.stoica@ntnu.no>  
+Adrian Stoica <george.a.stoica@ntnu.no> georgeas <george.a.stoica@ntnu.no>
+Adrian Stoica <george.a.stoica@ntnu.no> George Adrian Stoica <george.a.stoica@ntnu.no>
+Pål-Edward Larsen <paaledwl@stud.ntnu.no> Pål-Edward Larsen <paaledwl@stud.ntnu.no>
+Pål-Edward Larsen <paaledwl@stud.ntnu.no> paaledwl <paaledwl@stud.ntnu.no>

.vscode/tasks.json

+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "gradle run",
+            "type": "shell",
+            "command": "gradle",
+            "args": ["run"]
+        },
+        {
+            "label": "gradle version",
+            "type": "shell",
+            "command": "gradle",
+            "args": ["--version"]
+        },
+        {
+            "label": "java -version",
+            "type": "shell",
+            "command": "java",
+            "args": ["-version"]
+        },
+        {
+            "label": "sdk use java 12.0.2-open",
+            "type": "shell",
+            "command": "sdk",
+            "args": ["use", "java", "12.0.2-open"]
+        }
+    ]
+}
\ No newline at end of file

README.md

+[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.idi.ntnu.no/#https://gitlab.stud.idi.ntnu.no/it1901/course-material) 
+
 # course-material
 
 Course material for IT1901
\ No newline at end of file

antipatterns/.gitignore

+target/
+.classpath
+.project

antipatterns/pom.xml

+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+  	<modelVersion>4.0.0</modelVersion>
+  	<groupId>it1901</groupId>
+  	<artifactId>antipatterns</artifactId>
+  	<version>0.0.1-SNAPSHOT</version>
+  
+	<dependencies>
+
+		<!-- Test with JUnit5 -->
+		<dependency>
+			<groupId>org.junit.jupiter</groupId>
+			<artifactId>junit-jupiter-api</artifactId>
+			<version>5.4.2</version>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.junit.jupiter</groupId>
+			<artifactId>junit-jupiter-engine</artifactId>
+			<version>5.4.2</version>
+			<scope>test</scope>
+		</dependency>		
+	</dependencies>
+
+	<build>
+		<plugins>
+			<!-- Compiling code -->
+			<plugin>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<version>3.8.1</version>
+				<configuration>
+					<encoding>UTF-8</encoding>
+					<release>13</release>
+				</configuration>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-surefire-plugin</artifactId>
+                <version>3.0.0-M5</version>
+                <!-- 
+                <configuration>
+                    <argLine>${argLine} dash dash add-exports javafx.graphics/com.sun.javafx.application=ALL-UNNAMED</argLine>
+                </configuration>
+                 -->
+			</plugin>
+		</plugins>
+  	</build>
+</project>
\ No newline at end of file

antipatterns/src/main/java/antipatterns/DataClassWithEffectivelyFinalFields.java

+package antipatterns;
+
+public class DataClassWithEffectivelyFinalFields {
+
+  private final String name; // should be final
+  private final int number; // should be final
+
+  public DataClassWithEffectivelyFinalFields(final String name, final int number) {
+    this.name = name;
+    this.number = number;
+  }
+
+  public String getName() {
+    return name;
+  }
+
+  public int getNumber() {
+    return number;
+  }
+}

antipatterns/src/main/java/antipatterns/DataClassWithLittleLogic.java

+package antipatterns;
+
+// ok, but see the test
+public class DataClassWithLittleLogic {
+
+  private String name;
+  private int number;
+
+  public DataClassWithLittleLogic(final String name, final int number) {
+    this.name = name;
+    this.number = number;
+  }
+
+  @Override
+  public String toString() {
+    return String.format("[DataClassWithLittleLogic name=%s number=%s]", name, number);
+  }
+
+  public DataClassWithLittleLogic() {
+  }
+
+  public String getName() {
+    return name;
+  }
+  public void setName(final String name) {
+    this.name = name;
+  }
+
+  public int getNumber() {
+    return number;
+  }
+  public void setNumber(final int number) {
+    this.number = number;
+  }
+}

antipatterns/src/main/java/antipatterns/DataClassWithValidation.java

+package antipatterns;
+
+// see DataClassWithValidationTest
+public class DataClassWithValidation {
+
+  private String name;
+
+  public DataClassWithValidation(final String name) {
+    // should use setName to ensure validation logic is run
+    this.name = name;
+  }
+
+  public DataClassWithValidation() {
+  }
+
+  public String getName() {
+    return name;
+  }
+  public void setName(final String name) {
+    if (name.startsWith(" ")) {
+      // should rather use trim() or strip() and check the length
+      throw new IllegalArgumentException("Name cannot begin with blank");
+    }
+    this.name = name;
+  }
+}

antipatterns/src/main/java/antipatterns/NonEncapsulatedList.java

+package antipatterns;
+
+import java.util.Collection;
+import java.util.Iterator;
+
+public class NonEncapsulatedList implements Iterable<String> {
+
+  private final Collection<String> names;
+
+  public NonEncapsulatedList(final Collection<String> names) {
+    this.names = names;
+  }
+
+  public Collection<String> getNames() {
+    return names;
+  }
+
+  public Iterator<String> iterator() {
+    return names.iterator();
+  }
+}

antipatterns/src/test/java/antipatterns/DataClassWithLittleLogicTest.java

+package antipatterns;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+public class DataClassWithLittleLogicTest {
+
+  private DataClassWithLittleLogic instance1, instance2;
+
+  @BeforeEach
+  public void setup() {
+    instance1 = new DataClassWithLittleLogic();
+    instance2 = new DataClassWithLittleLogic("High", 5);
+  }
+
+  @Test
+  public void testConstructor() {
+    Assertions.assertEquals("High", instance2.getName());
+  }
+
+  @Test
+  public void testToString() {
+    Assertions.assertEquals("[DataClassWithLittleLogic name=High number=5]", instance2.toString());
+  }
+
+  @Test
+  public void testSetName() {
+    instance1.setName("Low");
+    Assertions.assertEquals("Low", instance1.getName());
+  }
+}

antipatterns/src/test/java/antipatterns/DataClassWithValidationTest.java

+package antipatterns;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+public class DataClassWithValidationTest {
+
+  @Test
+  public void testSetName() {
+    try {
+      new DataClassWithValidation(" name starting with blank");
+      Assertions.fail("Should throw IllegalArgumentException");
+    } catch (final IllegalArgumentException iae) {
+    } catch (final Exception iae) {
+      Assertions.fail("Should throw IllegalArgumentException");
+    }
+
+    try {
+      new DataClassWithValidation("ok name");
+    } catch (final Exception iae) {
+      Assertions.fail();
+    }
+  }
+
+  @Test
+  public void testBetterSetName_invalidName() {
+    Assertions.assertThrows(IllegalArgumentException.class, () -> new DataClassWithValidation(" name starting with blank"));
+  }
+
+  @Test
+  public void testBetterSetName_validName() {
+    new DataClassWithValidation("ok name");
+  }
+}

gradlew

-#!/usr/bin/env sh
-
-##############################################################################
-##
-##  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"'
-
-# 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, switch paths to Windows format before running java
-if $cygwin ; 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=$((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"
-
-# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
-  cd "$(dirname "$0")"
-fi
-
-exec "$JAVACMD" "$@"

gradlew.bat

-@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 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"
-
-@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 init
-
-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 init
-
-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
-
-:init
-@rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
-@rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
-: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 %CMD_LINE_ARGS%
-
-: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

lectures/.gitignore

@@ -2,4 +2,4 @@
 .gradle
 
 # Ignore Gradle build output directory
-build
+build/

lectures/README.md

+# Materiale laget med asciidoctor
+
+Mappa **asciidoctor** inneholder tekstlig materiale, mens **revealjs**-mappa
+inneholder lysarkene. 
+
+## Hvordan bygge
+
+Bygging av både dokumentasjon og lysark skjer med gradle.
+
+Bruk `gradle asciidoctor` for å generere HTML for det tekstlige og `gradle asciidoctorRevealJs` for lysarkene.
+Konvertering kan også gjøres med den generelle `gradle build`.

lectures/asciidoc/README.adoc

-== Multi-eksempel
-
-Dette eksemplet viser hvordan rigger et multi-prosjekt med gradle,
-med del-prosjekter for
-
-- domenelogikk (core)
-- brukergrensesnitt med JavaFX og FXML (fx)
-- React-basert web-klient (react)
-- web-server med JAX-RS og Jersey (jersey)
-
-=== Bygging med Gradle
-
-https://docs.gradle.org/current/userguide/userguide.html[Gradle] er et såkalt byggesystem, som automatiserer oppgaver knyttet til utvikling og kvalitetssikring av programvare, f.eks.
-kompilering, kjørings av enhetstester og integrasjonstester, konvertering av dokumentasjon til HTML, pakking som kjørbart program, osv.
-Det finnes teknisk sett ikke grenser for hva et byggesystem kan gjøre, generelt handler det om å automatisere bort alt praktisk fikkel,
-som ellers hindrer en å jobbe effektivt.
-
-Det finnes flere byggesystem, de viktigste i Java-verdenen er https://maven.apache.org[Maven] og Gradle, mens Javascript-verdenen har sine, bl.a. https://docs.npmjs.com[npm].
-I dette prosjektet har vi valgt å bruke Gradle, fordi det er enklere å skrive og lese oppsettet og trigge kjøring, mer fleksiblet og
-det vi ønsker å automatisere i akkurat dette prosjektet er innafor det Gradle håndterer godt. For andre Java-prosjekter https://phauer.com/2018/moving-back-from-gradle-to-maven/[kan Maven være et bedre alternativ].
-Siden ett av prosjektet bruker Javascript og npm, så
-bruker vi et eget Gradle-tillegg som bygger bro til npm. 
-
-Gradle er bygget rundt tre sentrale elementer:
-
-- oppgaver (tasks) - det som automatiseres, f.eks. kompilering, kjøring av tester, osv.
-- prosjekter - enhetene som oppgaver utføres innenfor
-- tillegg (plugins) - angir hvilke oppgaver som hører til et visst type prosjekt.
-
-Oppsettet for bygging består bl.a. i å angi hvilke (del)-prosjekter som inngår i hovedprosjektet,
-hvilke avhengigheter det er til eksterne moduler og mellom prosjektene, hvilke tillegg som bør aktiveres for disse prosjektene
-(basert på hva slags type prosjekt det er) og hvordan hver type oppgave skal konfigureres.
-
-NOTE: Det litt spesielle med Gradle er at filene for å sette opp et Gradle-bygg egentlig er https://docs.gradle.org/current/userguide/groovy_build_script_primer.html[kode skrevet i det Java-lignende språket Groovy].
-Koden brukes primært til konfigurasjon, altså bygge opp beskrivelsen av oppgavene,  prosjektene og tilleggene og. API-et er utformet slik at koden skal se deklarativ ut.
-En kan flette inn vanlig kode også, hvis en skjønner litt om hvordan API-et virker. Dette gir enorm fleksibilitet, men kan også gjøre filene vanskelige å forstå.
-
-De to viktigste filene for å sette opp et Gradle-bygg er *settings.gradle* og *build.gradle*.