virtalas/pakkaaja

pakkaaja

Java implementaatio Huffmanin koodauksesta ja Lempel-Ziw-Welch-algoritmistä.

Aja gradlella:

gradle run -Parguments="['hc', 'file.txt', 'output']"

tai

gradle run -Parguments="['test']"

Tarvittava Gradlen versio on 3.4 tai uudempi.

pakkaaja's Issues

Koodikatselmointi

Kohtasin ongelman, kun yritin ajaa projektia. Ajettuani komennon gradle run -Parguments="['hc', 'file.txt', 'output']" sain virheviestin

* What went wrong:
A problem occurred evaluating root project 'pakkaaja'.
> Could not find method implementation() for arguments [com.google.guava:guava:23.0] on root project 'pakkaaja'.

Ilmeisesti riippuvuus Googlen Guava kirjastoon on jotenkin rikki?

Yritin ajaa koodia vielä IntelliJ:llä, mutta sekään ei onnistunut, jostain syystä IntelliJ ei antanut valita pakkajaMainin Main-luokkaa. Joudun siis kommentoimaan koodia ajamatta itse ohjelmaa.

Olisin toivonut, että ohjelman käyttöohjeet olisivat selkeämmät, että esimerkiksi selitettäisiin, mikä tarkoitus eri argumenteilla on. Joillekin tämä on toki selvää, voidaan esimerkiksi olettaa, että argumentti "file.txt" olisi se tiedosto, joka halutaan pakata, mutta esimerkiks selvittääkseni, että "hc" luultavasti tarkoitti huffmann codea, piti projektia tutkia aika pitkälle README:n ulkopuolelle.

Testejä vaikuttaa olevan hyvin paljon, mutten valitettavasti saanut ajettua myöskään niitä (ajaminen ei onnistunut sen enempää IntelliJ:llä, ja komentoriviltä ajamine aiheutti saman virheviestin kuin aikaisemmin).

Koodi on jaoteltu mielekkäästi pieniin osiin, ja ohjelman rakenteessa on myös hyödynnetty hyvin rajapintoja ja abstrakteja luokkia. Luokkarakenteessa oli ehkä jotain hassuuksia, on esimerkiksi käsitteellisesti melko epäintuitiivista, että HuffmanLeaf perii luokan HuffmannTree -luokan (toki on olemassa yhden lehden puita), mutta eriysiesti tässä tapauksessa kyseinen suhde ei vaikuttanut minusta perustellulta.

Olisin ehkä kaivannut jotain teoreettista dokumentaatiota käytetyistä algoritmeista, kuten niiden perusperiaatteista, mutta tämän luulen johtuvan vain henkilökohtaisesta preferenssistä.

Kaiken kaikkiaan kattava ja hyvin edenneen näköinen projekti :)

Koodikatselmointi

Koodikatselmointi 1

Koodi ladattu 19.4.2018 noin klo 21.30

Yleistä

Mielenkiintoinen aihevalinta, vaikkakin itselle vieras. Aihemäärittely oli selkeä ja sen avulla pääsi jo kärryille. Pahoittelut silti, että en välttämättä osaa antaa kovin tarkkaa palautetta itse pakkaamisen toteutuksesta.

Yritin suorittaa ohjelman (gradle run), mikä aiheutti virheen Error: Could not find or load main class pakkaaja.Main. Kaikki Main-luokkaan liittyvä näytti kuitenkin olevan build.gradlessa kuten pitää. Samasta syystä myöskään jar-tiedoston suoritus ei ollut mahdollista. Muuten gradle build onnistui ja testit menivät läpi. NetBeans ei suostunut projektin kanssa lainkaan yhteistyöhön, mutta luulen, että ongelma oli NetBeanssissa.

Rakenne

Koodia on paljon, mutta se on helppolukuista ja kattavasti dokumentoitua. Main-luokka on tällä hetkellä aika massiivinen. Kaikki käyttöliittymään liittyvä toiminnallisuus olisi hyvä eriyttää yhteen tai useampaan luokkaan niin, että main-metodissa voidaan vain kutsua itse ohjelman käynnistävää komentoa. Muuten pakettirakenne ja luokkajako ovat selkeät.

Testaus

Yksikkötestikattavuus korkea. Pieniä huomioita:

• HuffmanCoderTest-luokan testi testCompress() ei oikeastaan testaa mitään, luo vain uuden MockInStream-olion..?
• Vähemmän oleellista, mutta kuitenkin: käyttämättömät @Before ja @After -metodit jokaisessa testiluokassa särähtivät silmään.