nurou/pathfinder-vis

Visualises commonly-used pathfinder algorithms in action.

Hi

I do my best to make web apps more pleasant to use.

Currently a product developer at Hoxhunt.

Computer science (BSc) & human-computer interaction (MSc).

Reach me through email or Twitter DMs.

pathfinder-vis's Issues

rewrite styles

add buttons inside table cells

for proper semantics and eventual accessibility improvements

make app usable with keyboard

add slider for visualisation speed

https://www.radix-ui.com/docs/primitives/components/slider

Koodikatselmointi

Ladattu klo 15.43 25.8.2020

• Testaus
  • Ohjelma ei läpäise kaikkia testejä. Moduuli components/Visualiser/util, jota käytetään osassa testeistä, näyttää puuttuvan kokonaan.
  • Testikattavuusraportin mukaan testien kattavuus on 0 %.
• Moduulin algorithms/Bfs käyttö ei onnistu, jos sen kansiota src/algorithms/BFS ei uudelleennimeä muotoon src/algorithms/Bfs. Ongelma johtuu luultavasti siitä, että käyttämäni käyttöjärjestelmä (Linux) erottelee isot ja pienet kirjaimet tiedostopoluissa. MacOS ja Windows eivät tee niin. Tästä syystä kansioiden ja tiedostojen nimien tulisi aina olla täsmälleen samat kuin niitä käyttävien moduulien import-lauseissa, jotta ne toimisivat varmasti kaikilla käyttöjärjestelmillä. TypeScript-kääntäjän asetus forceConsistentCasingInFileNames helpottaa näiden huomaamista.
• Array-olion prototyypin muokkaaminen kannattaa tehdä moduulitasolla eikä PriorityQueue-luokan konstruktorissa. Koska muutokset ovat globaaleja, niitä ei tarvitse tehdä joka kerta, kun uusi PriorityQueue-olio luodaan. Voisi myös olla hyvä idea jättää prototyyppi muokkaamatta ja tehdä sen sijaan uusi luokka, joka toteuttaa tarvittavat lisätoiminnallisuudet.
• Löysin muutaman bugin käyttöliittymästä:
  • Jos Show Distances -asetus on päällä, Reset Pathfinder -painikkeen painaminen piilottaa etäisyydet ruudukosta, mutta Show Distances -painike näyttää edelleen olevan painettuna. Jos haluaa saadaa ruudukon etäisyydet uudestaan näkyviin, on painiketta painettava uudestaan, jolloin se näyttää olevan pois päältä, vaikka se on oikeasti päällä.
  • Käyttöliittymässä on mahdollista painaa Regenerate Maze ja Reset Pathfinder -painikkeita kesken simulaation, jolloin käyttäjälle näkyvä ruudukko ei enää vastaa algoritmin prosessoimaa ruudukkoa, ja se esimerkiksi saattaa kulkea käyttäjälle näkyvien seinien läpi. Näiden painikkeiden painaminen voisi automaattisesti keskeyttää algoritmin suorituksen.
  • Käyttöliittymä mahdollistaa usean algoritmin päällekkäisen suorittamisen.

Vertaisarvio

• Projektin lataaminen ja käynnistäminen lokaalisti vaati hieman selvittelyä. Projektin lataamisen ja riippuvuuksien hakemisen jälkeen sain seuraavanlaisen virhe -viestin:

"Failed to compile.

./src/algorithms/index.ts
Cannot find file: 'index.tsx' does not match the corresponding name on disk: './src/algorithms/Bfs/BFS'."

Muuttamalla kansion BFS nimen BFS -> Bfs sain projektin käynnistymään.

• Ohjelman kansiorakenne on selkeä ja muuttujien nimet on valittu siten, että ne ovat hyvin kuvaavia. Koodi on hyvin kommentoitua ja helppolukuista.

• Testikattavuusraportti jäi yarn coverage ajon jälkeen tyhjäksi. Vaikutti kuitenkin siltä, että testejä oli kirjoitettu suhteellisen kattavasti. Testaamista voisi vielä jatkokehittää, kuten varmasti tarkoitus onkin, ja esimerkiksi algoritmien osalta voisi testata laajemmin niiden toimivuutta ja sitä, että tekevätkö ne todella niitä asioita mitä niiden on tarkoitus tehdä.

• Yleisesti ottaen ohjelma toimii hienosti ja vaikuttaisi olevan hyvin aikataulussa. Hyvää duunia!

swap react with preact

update favicon