perander / otm-project

Welcome to the repository

Here you can find a food diary desktop application, work in progress.

Completed functionality to date:

• possibility to create a username

  • username is saved to a database

• possibility to create a food with its nutritional information

Documentation

Conception

Timeline

Architecture

Releases

All releases

Command line commands

Generating the executable jar-file

You can generate the file with the command

mvn package

The file will be created to the target-directory. It can be run with the command

java -jar path/target/filename

Running tests

The tests can be run with the command

mvn test

The test coverage report can be created with the command

mvn jacoco:report

You can see the report by opening the file target/site/jacoco/index.html with a browser.

Checkstyle

To see the results of the checkstyle-tests defined in the checkstyle.xml -file, run the command

mvn jxr:jxr checkstyle:checkstyle

Possible errors are explained in a file target/site/checkstyle.html (open with a browser).

JavaDoc

To see JavaDoc, run the command

mvn javadoc:javadoc

You can see the JavaDoc by opening the file target/site/apidocs/index.html

otm-project's Issues

Koodikatselmointi

Projekti ladattu 30.4.2018 klo 9:27

Kommentteja:

• Luokat, metodit, muuttujat ja parametrit on nimetty kuvaavasti
• Ohjelma on hyvin jaettu selkeisiin pakkauksiin (domain, dao ja ui), joilla kaikilla on omat erilliset vastuualueet
• Yleisesti koodi on helppolukuista ja metodien tarkoitukset ymmärtää hyvin
• DiaryUi:n start-metodi on aika pitkä ja kaikki eri näkymät luodaan sen sisällä. Metodin toiminnallisuutta voisi ehkä jakaa pienempiin metodeihin, joissa eri näkymät tai asetelmat luodaan? Metodin koodia on kyllä kommentoitu niin, että sitä on helppo lukea myös nykyisessä muodossa.
• EntryDao-, FoodDao- ja UserDao- luokkien metodeissa mahdollisia poikkeuksia on käsitelty try ... catch - rakenteen avulla, mutta niin, että catch - osuus puuttuu ja pelkkä try on kirjoitettu. Esimerkkinä EntryDaon findOne-metodi, jossa lukee "try (Connection connection = database.getConnection())", mutta catch puuttuu. Kaikki nämä metodit myös heittävät jo valmiiksi SQLExceptionin, joten niiden pitäisi toimia myös kokonaan ilman try ... catch - rakennetta.