/ot-harjoitustyo

Practical excercise on course "Ohjelmistotekniikka". A simple software project.

Primary LanguageJava

ot-harjoitustyö - otlike

Mikä?

Kurssin "Ohjelmistotekniikka" harjoitustyönä tuotettu yksinkertainen roguelite-henkinen luolaseikkailu, jossa lätkitään mörköjä turpaan ja otetaan turpaan kahta kovemmin.

Apua! Koodissa on 9001 virhettä puuttuvista metodeista kun avaan tiedoston X editorissa Y!

Kehitysympäristösi ei todennäköisesti ymmärrä lombokilla (Project Lombok) generoituja gettreitä/settereitä/konstruktoreita ym. syntaksisokeria. Projekti käyttää lobokia generoimaan gettereitä yms. boilerplaten vähentämiseksi ja koodin luettavuuden parantamiseksi. Varjopuolena on kuitenkin etteivät editorit löydä generoituja metodeja, sillä ne eivät ole olemassa ennen kuin maven kääntämisen yhteydessä delombokoi koodin, generoiden edellämainitut metodit. (Generoitu koodi löytyy kääntämisen jälkeen polusta target/generated-sources/delombok).

Hätä ei suinkaan ole tämän näköinen sillä useimpiin kehitysympäristöihin löytyy lombok-liitännäinen, joka auttaa editoria havaitsemaan lombokilla generoidut metodit jo ennen kääntämistä.

TL;DR: Puttuvat metodit generoidaan kääntämisen yhteydessä, jos haluat editorin sisällä virheistä eroon lataa lombok-liitännäinen.

Dokumentaatio

Releaset

Komentorivitoiminnot

Testaus

Testien ajaminen tapahtuu komennolla

mvn test

Testikattavuusraportin generointi tapahtuu Mavenin JaCoCo-lisäosalla

mvn jacoco:report

jonka jälkeen selaimella tarkasteltava raportti löytyy polusta target/site/jacoco/index.html.

Suorittaminen

Pelin voi käynnistää suoraan kutsumalla

mvn compile exec:java

tai

mvn compile exec:java -Dexec.mainClass=toilari.otlite.Launcher

Pakkaus

Suoritettavan .jar-tiedoston saa generoitua komennolla

mvn package

Generoitu OTLite-1.0-SNAPSHOT.jar löytyy polusta target/.

JavaDoc

JavaDoc generoidaan komennolla

mvn javadoc:javadoc

jonka jälkeen selaimella tarkasteltavissa oleva dokumentaatio löytyy polusta target/site/apidocs/index.html.

Checkstyle

Käytössä oleva checkstyle on määritelty projektin juuressa löytyvässä checkstyle.xml-tidostossa. Checkstylen tarkistus tapahtuu komennolla

mvn jxr:jxr checkstyle:checkstyle

jonka jälkeen selaimella tarkasteltavissa oleva raportti löytyy polusta target/site/checkstyle.html.