Projekti ladattu 12.1.2019 kello 00:07.

Yleinen palaute

Kaikki implementoidut käyttötapaukset toimivat ongelmitta, eikä niiden rikkominen onnistunut virheellisillä syötteillä, joskin syötteet olisi silti voinut validoida.

HEPPA-painike

• Suurella fonttikoolla oleva HEPPA-painike ylälaidassa, joka on toteutettu linkkinä, ei oikeasti ohjaakaan mihinkään. Tämä ei liene tarkoituksellista? Alkuoletus käyttäjillä kyseisen kaltaisista linkeistä on, että ne johtaisivat etusivulle.

Asennusohje

• Nykyisellään ohjeen paikallisesta asennuksesta puuttuu python3 -m venv venv alusta, ja tiedostonimen tulisi olla requirements.txt. Heroku-asennukseen olisi hyvä lisätä git remote add heroku https://git.heroku.com/projektinimi.git ja projektin lähettäminen Herokuun.

Validaattorit

• Tunnuksen luomisen ja kandidaatin lisäämisen yhteydessä olisi hyvä validoida käyttäjän syöte: nyt jopa tyhjällä käyttäjänimellä ja salasanalla voi luoda tunnuksen.

__init__.py-tiedostot

• Kansioista auth ja votes puuttuu __init__.py-tiedosto, joka olisi hyvä olla, sillä se kertoo Pythonille kyseisen kansion sisältävän projektin kannalta oleellista lähdekoodia.

Koodin toisteisuus

• Luokat Approval ja Veto ovat sisällöltään täysin samat, joten voisivatko ne vain periä jonkin luokan joka kattaa näiden nykyisen sisällön?
• Vastaavasti tiedoston candidates/views.py funktiot candidates_set_veto ja candidates_set_approved muistuttavat hyvin paljon toisiaan, joten polkua /candidates/<candidate_id>/<type>/ seuraava funktio voisi toimia näiden yhdistämiseen.

Kandidaatin konstruktori

• Tiedoston candidates/views.py funktiossa candidates_create() kandidaatti luodaan seuraavasti:

candidate = Candidate(form.name.data)
candidate.url = form.url.data
candidate.nominator_id = current_user.id

Olisi luontevaa pistää kyseiset arvot suoraan konstruktorin parametreiksi, ja näille nykyiset oletusarvot, mikäli tarvetta on:

def __init__(self, name, nominator_id, url = ""):

Latasin projektin sunnuntaina 6.1. klo 22.

Ohjelman asentaminen ja käynnistäminen

Suoritin seuraavat komennot ja sain seuraavan virheen:

$ git clone https://github.com/OAarne/heppa.git
[...]
$ cd heppa
$ python3 -m venv venv
$ pip install -r requirements.txt
[...]
$ python3 run.py
[...]
Traceback (most recent call last):
  File "run.py", line 3, in <module>
    app.logger.addHandler(logging.StreamHandler(sys.stdout))
NameError: name 'logging' is not defined

Ongelma poistuu jos run.py-tiedoston alkuun lisää rivin import logging, sys. README:ssä olisi ehkä syytä olla jonkinlainen asennusohje.

Ohjelman toiminta

Kirjautumaton käyttäjä

Ohjelma toimii odotetusti. Käyttäjä näkee listan ehdokkaista, mutta kaikki kirjautumista vaativat toiminnot johtavat kirjautumissivulle. Kirjautuminen toimii odotetusti.

Ehdokkaiden luonti

Kenttiä ei validoida. Ohjelmassa on määritelty, että ehdokkaan nimen ja URL:n kuuluu olla enintään 144 merkkiä pitkä, mutta tätä ei validoida. Postgres-tietokanta antaa virheen, jos yrittää luoda kandidaatin jolla on liian pitkä nimi ja tämä johtaa Internal Server Error -virheeseen. (Virhettä ei tule paikallisesti, sillä sqlite ei validoi kenttien pituuksia vaan antaa laittaa VARCHAR(144)-kenttään yli 144 merkkiä pitkiä merkkijonoja.)

144 merkin rajoitus on muuten aika mielivaltainen ja olisi varmaan järkevämpää käyttää db.Text-tietotyyppiä. Esimerkiksi URL voi hyvinkin olla pidempi kuin 144 merkkiä.

Kannattaa myös harkita tyhjän nimen kieltämistä.

Ehdokkaiden valitseminen

Toimii odotetusti, mutta valintaa ei voi perua.

Ehdokkaiden hyväksyminen

Toimii odotetusti.

Ehdokkaiden muokkaaminen

Edit-napin painaminen johtaa seuraavaan virheeseen:

werkzeug.routing.BuildError: Could not build url for endpoint 'candidates_edit'. Did you forget to specify values ['candidate_id']?

Koodin tyyli

Koodi on selkeää ja noudattaa hyviä käytänteitä.

Ainoat (pienet) löytämäni parannuskohteet ovat seuraavat:

• Kutsussa render_template("candidates/new.html", form = CandidateForm()) ja muissa vastaavissa yhtäsuuruusmerkin ympärillä on välilyönnit, mutta tätä ei suositella Pythonissa.
• find_winning_candidates()-metodissa on max-niminen muuttuja, mutta max on myös standardikirjaston funktio.
• Miksi joissakin kansioissa on __init__.py-tiedosto, mutta joissakin ei?

Yhteenveto

Yllä mainittuja virheitä lukuunottamatta ohjelma toimii odotetusti. Projekti on selvästi keskeneräinen, mutta suurin osa toteutetuista toiminnoista toimii oikein ja koodi on myös muutoin hyvälaatuista.