minttu / ernu Goto Github PK

Currently everything bleeds to outer scope

Koodi ladattu klo. 15:13, 26.12.2014

Yleensäottaen koodi näyttää mallikkaalta: osat on jaettu asiallisiin luokkiin ja pakkauksiin, eikä nimettömiä ja mitäänsanomattomia metodeja/muuttujia löydy. Useissa kohdissa kuitenkin toivoisi, että 50-100 riviä pitkät metodit olisi jaettu pienempiin metodeihin. Esimerkkinä tästä Tokenizer-luokasta löytynyt tokenize() metodi, jonka 90 rivin sisältä löytyy mm. loputon switch-lauseke. Switch-lauseketta itseään ei tietenkään välttämättä ole edullista yrittää pilkkoa, mutta sen voisi laittaa omaan metodiinsa (esim. handleChar(char c) tms.). Omasta mielestäni olisi myös hyvä idea, että minkään case avainsanan alla ei ole kovin montaa riviä koodia, vaan juurikin yksi metodikutsu ja break;. Toinen missä toivoisin eritoten koodin pilkkomista on CLI luokan parseArguments metodi, joka tuntuu tekevän aika montaa asiaa.

Yleensäottaenkin kaikki epäselvät koodinpätkät olisi hyvä pilkkoa pienempiin, selvempiin koodinpätkiin. Eräs rivin rumilus löytyy ApplyFunction luokan call metodista:

return (new CallNode(node, ((ArrayNode) args).getValues())).getValue(environment);

Tällainen olisi hyvä orjallisesti pilkkoa muutamaan riviin:

List<Node> values = ((ArrayNode) args).getValues();
CallNode node = new CallNode(node, values);
return node.getValue(environment);

En ole tietenkään 100% perillä ohjelman toiminnasta, mutta mielestäni CLI luokan parseArguments metodissa esiintyvät System.exit(1) kutsut voi hyvin vaihtaa pelkkiin returneihin, sillä ohjelma toimii kokoajan yhdessä threadissa, eikä shutdown hookkeja ole missään käytetty. Tämä tuskin vaikuttaa käytännössä mihinkään, mutta mielestäni returnit ovat tyylillisesti parempi vaihtoehto.

Token luokassa equals metodi on korvattu, muttei hashcode. Vaikkei välittömästi tarpeen, voi laajennettavuus kärsiä.

Parser luokan loputon konstruktori saattaisi olla mukavaa jakaa addInfixParsers() ja addPrefixParsers() tms. metodeihin.

Precedence luokan voisi muuttaa enum luokaksi: referenssi.

Kaikki ohjelman ongelmakohdat ovat yllä kuvailtujen tapaisia, eikä niitä ole kuitenkaan loputtomasti. Kuten alussa mainitsin, koodi on esimerkillisesti omissa luokissaan (ja niitähän riittää...), ja jokainen luokka ajaa omaa asiaansa. Ongelmat ovat tiivistetysti pääasiassa metodien sisällä: epäselviä koodinpätkiä, turhan paljon koodia niissä, yms.

Varmasti tulevien refaktorointien edessä nämä pointit kuitenkin. Hyvää työtä näin kaikenkaikkiaan :)

Since speed has no importance in this project, all numbers should be able to be really big.

One of the three would be nice. Objects like in JS, structs like in C or classes like in Java.

(^_^) import("math", "functional")
(^_^) math.sqrt(2)
Unknown symbol "root"

Since math.sqrt is executed in the current environment, it can't find other symbols in the namespace it was defined in. Possible fixes would be to find the defining namespace, and execute it there, with the arguments still being in the calling namespace. Or just rethink the whole thing, it sucks anyways.

Ladattu 6.1. klo 11:36

Ihan aluksi täytyy sanoa että projekti vaikuttaa todella hyvin toteutetulta. Luokissa on noudatettu single responsibility -periaatetta ja koodi on siistiä ja selkeästi jäsenneltyä, kaiken kaikkiaan erinomaista työtä. Oma ohjelmointitaitoni ei riitä kommentoimaan sitä, olisiko jokin ohjelmalogiikan osa kannattanut toteuttaa toisin. Ennemminkin lähdekoodin tutkiminen on ollut itselleni oppimiskokemus.

Projektin buildaamisessa törmäsin ongelmiin, varmaan ihan omaa kädettömyyttäni. Ihan aluksi git-commit-id-plugin -plugari ei suostunut toimimaan. Sain seuraavan virheilmoituksen:
Failed to execute goal pl.project13.maven:git-commit-id-plugin:2.1.12:revision (default) on project ernu: .git directory could not be found! Please specify a valid [dotGitDirectory] in your pom.xml -> [Help 1]

Kun en löytänyt muutakaan ratkaisua, poistin plugarin pomista.
Buildissa yksi testi epäonnistui (fi.imberg.juhani.ernu.interpreter.builtin.PrintFunctionTest).
Liittyikö testin epäonnistuminen pomin silpomiseen vai ei, en osaa sanoa. Kivasti ohjelma kuitenkin kääntyi ja vaikutti toimivan oletetusti. Versionumero ei tietysti näkynyt. Sellaisen ominaisuuden huomasin, että toistolausekkeen kirjoittaminen REPL-komentoriville aiheuttaa NoSuchElementException -poikkeuksen.

Dokumentaation puolesta käyttöohjeen ja esimerkkiohjelmien olemassaolo on erinomainen juttu, ja käyttöohje on hyvin kirjoitettu.

Kun en itse osannut löytää moitittavaa, kävin lunttaamassa mitä sanottavaa tilastokeskus oli edellisessä katselmoinnissa keksinyt. Silmäillen näytti siltä että ainakin kaikki mainitsemansa ongelmakohdat ovat hyvällä mallilla projektin nykyisessä versiossa.