Koodikatselmointi

[otahontas]

Projekti ladattu su 24.9. klo 22.34

---

Building:

• Compiling ok (os x 10.14, rust / cargo vers. 1.37.0), yhtä warningia herjaa ("trait objects without an explicit dyn are deprecated") koskien huffman/mod.rs riviä 28. Rust ei oo mulle erityisen tuttua, mutta ilmeisesti koodissa pitäisi eksplikoida, mitä abstraktin tyypin ilmentymää ollaan ajamassa?
• Asennusohjeiden "cargo run --help" -komennosta saa käsityksen, että se olisi käyttöohje tähän ohjelmaan. Tuon voisi fiksata väärinkäsityksien välttämiseksi? (tai jos tarkoituksena todella oli generoida cli-käyttöohje ohjelmasta, se ei toiminut).

Suoritus:

• Esimerkkien sekä stomper&libstomper -dokumenttien avulla suoritus onnistui. Flagien tarkoitusperät jäivät vähän epäselviksi, mutta ilmeisesti -d purkaa ja ilman flagia vaan pakataan. Tämän voisi täsmentää käyttöohjeeseen.
• Dokumentaatiossa ei ollut mainintoja siitä, minkä kokoisia filuja halutaan maksimissaan pakata. Testasin laatimiasi testejä hieman modifioiden eri kokoisilla ja tyyppisillä tiedostoilla ohjelmaa:
  1. Generoitu tiedosto 10 megaa (cli:ltä mkfile-työkalulla): lzw ei jaksanut pyörittää säädyllisessä ajassa, huffman taas kadotti kaiken tiedon eikä purku näin ollen onnistunut.
  2. Generoitu tiedosto 1 megaa: lwz pakkasi tiedoston noin 3 sekunnissa 5,8kilotavuun (tämä suhteellisen tehokas pakkaus johtunee mkfilen generoiman filun sisällöstä), purku myös suht tehokas. Huffman kadotti jälleen sisällön kokonaan.
  3. 1-megainen tekstitiedosto headilla generoituna (base64 /dev/urandom | head -c 10000000 > file.txt): lzw pakkasi tiedoston 1,6-megaiseksi ja purki sen takaisin 1-megaiseksi, joten tässä lienee joku bugi? Huffman kadotti jälleen sisällön.
• Itse laatimasi testit testasivat minusta oikeita asioita, joskaan eivät kauhean kattavasti. Lisää testausta vaan peliin!

Koodi:

• Frontin / CUI:n osalta koodi oli aika simppeliä ja luettavaa. Hyvä, että argumenttien lukeminen oli hajotettu omaksi luokakseen.
• Compressor-abstrahoinnin käyttö auttoi hahmottamisessa, tästä plussaa
• Kirjaston koodi LZW:n osalta on minusta suhteellisen selkeää, luettavaa ja itsensäselittävää. Tämä yhdistettynä tiedostojen tiiviyteen tekee projektista ymmärretävän.
• Huffmanin implementaatio taitaa olla kesken? En kommentoi sitä siis enempää. Node-moduulin osalta koodi ei ollut kauhean itseselittävää, joten metodeita koskevat kommentit helpottaisivat lukemista.
• Testit samoissa tiedostoissa häiritsevät kuitenkin lukemista, ne olisi varmaankin syytä eristää omaan moduuliinsa?

Tiivistys:

• Dokumenaatiota voisi parantaa käyttäjälle ymmärrettävämmäksi (jos laadit erillisen suoritettavan binaarin, man page olisi bueno homma!)
• Testien eritteleminen ja testaamisen laajentaminen (eri tyyppisillä inputeilla testaaminen tai vastaavasti pakattavien tiedostojen scouppia kannattaa pienentää).

Tsemppiä loppukurssiin!

[S4ndyk]

Kiitos palautteesta! Joo tuo cargo run --help ei toimi siksi että se kutsuukin --help vipua cargolle eikä siis minun ohjelmalle. Pahoittelut tästä. Tuo dyn varoitus on uutta rustia ja projetkin aloittamisen jälkeen sattui juuri tulemaan uusi rust versio joten en ollut tietoinen tästä. Projekti on vielä tosiaan vaiheessaa monessa kohtaa!