Ladattu 25.4.2020 20:30 ja uudelleen 28.4 20:00
Editoitu, koska tämähän oli pelkkä koodikatselmointi. Jätin kuitenkin muutkin jos niistä saa mielipiteitä

Koodi

Yleisesti: Koodi on selkeää ja helppo lukuista.

• Nimeä luokat, metodit, attribuutit, parametrit ja muuttujat selkeästi ja johdonmukaisesti. Käytössä camelCaset, englanniksi ja hyvin kuvaavia. Hyvä
• Ei pitkiä metodeja (Muutamia pitkiä metodeja UI:ssa ja näistä sai jo dokumentaatiossa tiedon, että todennäköisesti korjataan.) Yleisesti hyvällä tasolla.
• Ei copy-pastea. Hyvä!
• Luokkien Single Responsibility
• Pakkaukset. Selkeästi jaoteltu käyttöliittymä, logiikka, luokat ja daot. Hyvä
• Testaus Reippaasti virheitä, varsinkin filelanguagedaossa toStringien kanssa häikkää joita en saanut ratkaistua.

Tags ei toiminut, mutta varmasti tulossa. Koodikatselmoinnin hengenssä loisin uuden snippetin listalla ja sitten vasta päivittäisi snippetin tietokantaan, näin sain toimimaan:

private void addNewSnippet() {
        System.out.println("\nYou are adding a snippet in " + snippetMan.getLanguage());
        System.out.println("\nPlease give a short description for your snippet:");
        String desc = skanner.nextLine();
        System.out.println("Insert the code to be saved below");
        String code = skanner.nextLine();

        System.out.println("Please give tags to make your code easier to find. Separate them by line changes. Empty line quits");
        List<String> lista = new ArrayList<>();
        while (true) {
            String tagi = skanner.nextLine();
            if (tagi.equals("")) {
                break;
            }
            lista.add(tagi);
        }
        Snippet uusi = snippetMan.createSnippet(desc, code, lista);
        snippetMan.updateSnippet(uusi);
    }

SnippetManager

Löydetty yksinkertainen ja mielekäs perusajatus, josta rakennetaan sovellusta. Sovelluksen tekstikäyttöliittymä antaa yksinkertaisen mielikuvan, mutta toisaalta toimii hyvin myös näin.

Testauksessa sovelluksessa esiintyi virheitä ja jopa pysähtyi. Nämä tulee varmasti saada pois (ellei sitten johtunut testaajasta..)

Kurssiin kuuluu myös dokumentaatiota ja ohjelmistotuotannon perusteiden hallintaa (vesiputoismalli / ketteräohjelmistokehitys), jotka olivat kunnossa.

Oli mielenkiintoista tutustua projektiin, kiitos. Voimaa ja menestystä viimeisille viikoille!

Dokumentaatio

Yleisesti: Siisti ja kurssin mukainen, lisäisin tyylilejä luettavuuden parantamiseksi. Hyvä

README

Readme on kurssin tämän vaiheen mukainen (esittely, linkit, komentorivitoiminnot).
Muutos ehdotukset:

• luettavuutta voisi hieman parantaa lisäämällä boldausta tai tyylejä esim. komentorivi komennoille:

koodia tähän

• Releasen linkki ei toimi (
  vrt. https://github.com/sanikk/ot-harjoitust/blob/master / https://github.com/sanikk/ot-harjoitust/releases/tag/Viikko5 ) muutospyyntö tehty.

• Poistaisin turhat kommentit, mielestäni Readme esittelee sovelluksen / projektin. Sen tämän hetkinen tilanne tai puutokset voisi siirtää dokumentaatioon (esim: "Ei pitäisi olla virheitä, tosin TextUI on jätetty tarkistuksen ulkopuolelle. Siistin sen kyllä lähes virheettömäksi mutta muutama pidempi metodi siellä.").

Määrittely dokumentti

Kurssin tämän hetken mukainen ja siisti.

Arkkitehtuurikuvaus

• Kurssin tämän hetken mukainen ja siisti. Teksti muotoinen, olisiko kuvallinen kuvaus myös tarpeellinen?

Työaikakirjanpito

Työ edennyt tasaisesti ja kirjanpito ajantasalla. Täsmää committeihin eikä sisällä laskareihin käytettyä aikaa.
Muutos ehdotus: kirjanpito vaikka taulukkoon, parantaa luettavuutta:

Repo

Yleisesti siisti. Ja sisältää asiallisen .gitignoren.
Muutos ehdotus: Onko TestiUI tarpeellinen repossa?

Sovellus

Käynnistyy ja toiminnallisuus oli selkeä. En saanut lisättyä snippettiä error: "SNIPPETS" not found"). Testaus jäi vähäiseksi, koska tästä syystä. edit. korjattu uusimmassa versiossa
Muutos ehdotukset:

• Jos valitulla kielellä ei ole yhtään snippettiä mutta silti haluaa nähdä listan niistä, ilmoitus ettei ole yhtään ja päävalikon valinnat? __Tyhmä käyttäjä valitsee snippetin jota ei ole olemassa, joka aiheuttaa errorin ( Exception in thread "main" java.lang.IndexOutOfBoundsException: Index 1 out of bounds for length 0) ja sovellus sulkeutuu.
• Yleisesti lisää validointia ettei "tyhmä käyttäjälle" anneta mahdollisuutta tehdä vääriä valintoja.
• Käyttäjälle näkyy UI:ssa virheilmoitukset (esim. Error getting full list: Table "SNIPPETS" not found; SQL statement), onko tämä välttämätöntä?. edit. korjattu uusimmassa versiossa

Komentorivikomennot

Muutamia ongelmia aiheutuu tietokantaongelmasta.

• sovelluksen saa suoritettua komentoriviltä
• testeissä paljon snippetistä johtuvia virheitä
• mvn test jacoco:report ei luo tiedostoa target/site/jacoco/index.html
• mvn package ei luo jar hakemistoon target
• checkstyle hyvällä tasolla

Release week5

Release käynnistyy ja toimii. Pysähtyy erroreihin.