Vertaisarviointi #2

Vertaisarviointi

Lataamisen ja arvioinnin aikaleima: 24.04.2020 - 18:00

Sovelluksen Toiminta

Toiminassa ei ole oikeastaan mitään valittamista, kaikki sovellukselle esitetyt ominaisuudet toimivat kuten pitääkin. Rekisteröitymislomake on validoitu ja sekä duplikaattinimimerkeille että salasanavirheille on oma tarkistuksensa. Postauksien listaus ja niiden järjestys ovat kuten voisi odottaa, ja kaikki toiminnallisuudet uuden postauksen ja kommentin luomisesta niiden muokkaamiseen ja poistamiseen toimivat moitteettomasti.

Kevyessä käytössä vastaan tuli ainoastaan kaksi hyvin minimaalista ongelmaa:

Navipalkin etusivulle vievän linkin erikoinen käytös jossa itse linkki ulottuu vain kahteen ensimmäiseen sanaan ja site-loppuosa on kuollutta aluetta
Uutta URL-postausta tehtäessä vaaditaan ilmeisesti koko https://-muotoinen osoite lyhyemmän muodon sijasta. Tämä tosin vaikuttaa olevan WTForms-pohjainen ongelma joten tosiaan minimaalisia asioita

Lyhyesti: Sovellus kattaa kaiken määrittelyssä esitetyn toiminnallisuuden ja toimii virheettömästi. Ainoat ongelmat ovat pieni muotoseikka ja ulkoisen kirjaston aiheuttama tiukkuus yhdessä syötteessä. Näiltä osin sovellus on erinomaisessa tilassa.

Rakenne ja Ohjelmakoodi

Myös sovelluksen rakenne on selkeä. Eri osa-alueet on eritelty omiin kansioihinsa kuten kurssilla vaaditaan. Kommentit voisi ehkä siirtää oman kansionsa alle erilliseksi postauksista, vaikka yhteys postauksiin löytyykin, mutta muilta osin erittely on suoritettu mallikkaasti.

Koodinkaan kanssa ei ole ongelmia. Yllä mainittu mahdollinen erottelu postausten ja niiden kommenttien välillä pätee myös täällä, mutta muuten tietyissä tiedostoissa tapahtuu juuri niitä asioita mitä nimen perusteella voisi olettaa, ja koodi on selkeää ja helppolukuista. Kommentteja ei juuri ole, mutta kurssia käyvälle aihe on tarpeeksi tuttu jotta kaikessa pysyy mukana.

Sovellus sisältää myös oman CSS-tyylittelynsä valmiin kirjaston kuten Bootstrapin sijasta, tästä boonusta. Tyylittely on myös toteutettu mallikkaasti, ainoa katselmoinnin aikana vastaan tullut ongelma oli yllä jo mainittu navigaatiopalkin indeksilinkin kuollut alue.

Yksi eritysihuomio itse koodia katsellessa oli sovelluksen uudelleenohjautumiskäyttäytyminen. auth-kansion alla tietyn näkymän käsittelyn lopuksi tapahtuva uudelleenohjaaminen on harkittua, ja vaihtoehtona kovakoodatun ohjautumiskohteen rinnalla on ainakin request.referrer. Suuret bonuspisteet tästä, esimerkiksi omassa sovelluksessani vastaava ei tullut edes mieleenkään. Toisaalta taas post-kansion alla vastaavaa toiminnallisuutta ei ole toteutettu, ja esimerkiksi postauksen äänestäminen new-listauksen alla vaihtaa näkymän äänijärjestyslistaukseen. Tähän ei olisi välttämättä edes osannut kiinnittää huomiota ilman tyylikkäämpää toteutusta sovelluksen muussa osassa, mutta nyt muidenkin uudelleenohjausten parantaminen on yksi mahdollinen QoL-parannuskohde jos ennen lopullista palautusta löytyy ylimääräistä aikaa.

Lyhyesti: Sekä sovelluksen rakenne että koodi ovat molemmat selkeitä. post-kansiota voisi pilkkoa pienempiin osiin, ainakin kommentit voisi ottaa erilleen jos mahdollista. Toiminnallisesti parannettavaa olisi vain joissain näkymissä käytössä olevan paremman uudelleenohjaamisen lisääminen kaikkiin siitä hyötyviin näkymiin. Kaikkiaan kuitenkin sekä rakenne että koodi ovat erinomaisessa kunnossa.

Dokumentaatio

Asennusohje on hyvin yksityiskohtainen, hyvä näin. Kurssilla oleville ohjeissa ei ole mitään uutta tai erikoista, mutta yleispätevyyden eteen on nähty vaivaa.

Tietokantakaavio vastaa sovelluksen nykytilaa ja sitä on myös avattu tarkemmin muutamalla lauseella. Samoin taulujen luomislauseet on laitettu näkyviin, tästä boonusta.

Samoin user storyt ovat ajan tasalla ja jokaiseen on liitetty pieni kuvaus ja käyttäjätoivetta vastaava SQL-kysely.

Sovelluksen käyttäminen on valmiiksi melko intuitiivista, mutta käyttöohjeeseen on silti kirjoitettu jokaiselle toiminnolle tarpeeksi pitkä ohje.

README sisältää lisäksi lyhyen kuvauksen sovelluksen tarkoituksesta sekä linkin herokuun. Ainoa varsinainen puute on työn rajoitteiden ja puuttuvien mutta suunniteltujen ominaisuuksien pohdiskelu, mikä viikkoa ennen lopullista palautusta on ymmärrettävää. Kaikkiaan dokumentaatiossa ei siis ole yhtään moitittavaa.

Lyhyesti: Dokumentaatio on täysin kunnossa. Ainoa puuttuva osa on ylipäätään järkevä lisätä vasta kehityksen loputtua, kaikki muu tarvittava löytyy ja on mallikasta.

Yhteenveto

Projekti on lupaamansa toiminnallisuuden osalta ainakin vertaisarvioijan silmään valmis. Siellä täällä on tilaa pienille viilauksille ja parannuksille, mutta kaikki suunnitellut toiminnot pelaavat ja kriittisiä ongelmia ei ole. Erinomainen projekti.