ndrsllwngr/ffp

Minesweepskell - a fun(ctional) Web Minesweeper written in Haskell. Advanced Functional Programming - Group project (2020)

Hi 👋

fn main() {
    let me = SoftwareEngineer {
        name: "Andreas Ellwanger",
        role: "Software Engineer",
        company: "Celonis",
        languages: Vec::from(["de_DE", "en_US"])
    };
    me.say_hi();
}

#[allow(dead_code)]
struct SoftwareEngineer<'a> {
    name: &'a str,
    role: &'a str,
    company: &'a str,
    languages: Vec<&'a str>
}

impl SoftwareEngineer<'_> {
    fn say_hi(&self) {
        println!("Thanks for dropping by, hope you find some of my work interesting. ~{}", self.name);
    }
}

ffp's Issues

Switch db to mongo

TODO

• Apply changes of stack new minesweepskell yesodweb/mongo to our current project
• Update github workflow
• rm postgres from package.yml

fyi

• run stack build after checking out these changes

INFO

Diff between mongo and postgres

$ diff -qr ffp test/minesweepskell --exclude=".stack-work" --exclude=".*" | sort

TODO

Files ffp/src/Application.hs and test/minesweepskell/src/Application.hs differ
Files ffp/test/TestImport.hs and test/minesweepskell/test/TestImport.hs differ

DONE

Files ffp/templates/default-layout.hamlet and test/minesweepskell/templates/default-layout.hamlet differ
Files ffp/templates/homepage.hamlet and test/minesweepskell/templates/homepage.hamlet differ
Files ffp/test/Handler/CommentSpec.hs and test/minesweepskell/test/Handler/CommentSpec.hs differ
Files ffp/src/Settings.hs and test/minesweepskell/src/Settings.hs differ
Files ffp/src/Model.hs and test/minesweepskell/src/Model.hs differ
Files ffp/src/Handler/Home.hs and test/minesweepskell/src/Handler/Home.hs differ
Files ffp/src/Handler/Comment.hs and test/minesweepskell/src/Handler/Comment.hs differ
Files ffp/src/Foundation.hs and test/minesweepskell/src/Foundation.hs differ

Files ffp/stack.yaml and test/minesweepskell/stack.yaml differ
Files ffp/stack.yaml.lock and test/minesweepskell/stack.yaml.lock differ
Files ffp/minesweepskell.cabal and test/minesweepskell/minesweepskell.cabal differ
Files ffp/package.yaml and test/minesweepskell/package.yaml differ
Files ffp/config/settings.yml and test/minesweepskell/config/settings.yml differ
Files ffp/config/test-settings.yml and test/minesweepskell/config/test-settings.yml differ

Only in ffp/config: client_session_key.aes

Only in ffp/static: tmp

Only in ffp: minesweepskell.iml
Only in ffp: yesod-devel

Files ffp/README.md and test/minesweepskell/README.md differ
Only in ffp: README-yesodweb-postgres.md

Only in ffp/config: models.persistentmodels
Only in ffp/config: routes.yesodroutes
Only in test/minesweepskell/config: models
Only in test/minesweepskell/config: routes

Verify oncontextmenu listener is removed/added correctly

Notes / Resources

HASKELL

TUTORIALS

• http://learnyouahaskell.com/chapters
• http://book.realworldhaskell.org/read/
• https://www.fpcomplete.com/tags/haskell/ (Articles)
• https://www.stackage.org/ (API Documentation)
• https://www.haskell.org/documentation/
• http://dev.stephendiehl.com/hask/ What I Wish I Knew When Learning Haskell

---

YESOD

TUTORIALS

• https://www.yesodweb.com/book/basics
• https://github.com/yogsototh/yosog
• https://wiki.haskell.org/Template_Haskell

YESOD INIT

• https://www.yesodweb.com/page/quickstart yesodweb/postgres & yesodweb/mongo
• https://github.com/yesodweb/stack-templates
• https://github.com/yesodweb/yesod-scaffold

POWERED BY YESOD

• https://github.com/yesodweb/yesod/wiki/Powered-by-Yesod
• https://www.yesodweb.com/book/shakespearean-templates
• https://github.com/dcastro/twenty48
• https://github.com/nbartlomiej/tfoo

---

MINESWEEPER

• Graphics - Get graphics as .svg from https://minesweeper.online/game/383764390
• https://github.com/jdcarbeck/haskellSweeper
• https://github.com/ljishen/Minesweeper
• https://github.com/basile-henry/infinisweep
• https://github.com/ShizukuIchi/minesweeper

---

BACKEND ONLY

• https://github.com/tzemanovic/haskell-yesod-realworld-example-app

---

IntelliJ Plugin

• https://github.com/rikvdkleij/intellij-haskell

Modify game logic to only set state to succeed if user has flagged all bombs and pushed button to end game

UI - Sprites

Get graphics as .svg from https://minesweeper.online/game/383764390

Further ToDos

SPRINT GOAL ♦️

• Apply lenses to Data.matrix #28
• Use actual randomSeed (either via user input or generated) #29
• Add ServerSideEvents [Tfoo, Chan] to update UI instantly 🗼 #31
• Human Readable unique GameID generieren (like HarmfulExpectationsCeaseParticularly) @timunkulus
• Generate games of predefined sizes / difficulty ⚡️
• Rework user interface (minimal and clean design language, remove boilerplate) #30 @ndrsllwngr @timunkulus
  • Render digits using Attributes to remove flickering
  • Add game instructions (controls)
  • Go Back & Pause Button is just one
  • Completed game history in colors
• BUG: It should be possible to put only as many flags as totally available @griase94
• BUG: Show elapsed time of finished games @timunkulus
• BUG: Pause a game that has no move yet will cause timeElapsed to be already counted @timunkulus
• On reset finished game: leave game in DB and create new gameID @griase94
• Update README.md (incl. usage, topics and short description) and align with lecture topics 🔺 #17 (comment)
• Refactor project, cleanup code, align routes, give variables suitable names [86bae6f]
• Format files with linter (e.g. stylish-haskell -r -i src/*), be careful that {-# LANGUAGE are preserved
• Test project
  • game logic
  • moves
  • interactions & routing
  • warnings

BACKEND

• Don't allow flagging of already revealed cells
• Error Handling in Requests und Logik (z.b. outOfBound) ❓

FRONTEND

• Landing page: Show total time of each game which is in final state (lost/won)

OPTIONAL

BUGS

• Performance Issues ❓

NOT DOING

• host project on heroku (https://github.com/mfine/heroku-buildpack-stack)
• UI - implement right-click instead of alt+left-click to flag a cell
• UI - add pressed state to unrevealed cell & face status
• Leaderboard (sorted by time, grouped by size+difficulty) would be possible, if we would allow players to enter username (similar to retro game machines)
• Add unit-tests
• Error handling on route responses (e.g. show not found page)
• Make use of advanced monads
• Game page: Show move history on /game/#id page (🤔 not sure if useful at all. any information gain?)

---

DONE

• View updated sich nach Move 32febbe
• Bomben durchstreichen wenn angeklickt und danach Spiel abschließen d0b3c7d
• Reveal All wenn alle Bomben geflaggt wurden d0b3c7d
• Spiel vorzeitig abschließbar machen können (Related #15)
• Zeit reinbringen und anzeigen
• Reset Route and action in front end
• Add reveal all button (makeMove)
• Stop timer if final state of game 10f2a25
• add face button in the middle with different emotions
• Pause Game Funktion (führt zu Startseite zurück)
• Reveal all button
• Anzahl an übrigen Flags anzeigen bc8684e
• Spiel in Datenbank als nur ein Eintrag abspeichern ed7b3d2
• Game Logik anpassen: Spiel ist erst gewonnen, wenn alle Flags verteilt wurden!
• localhost is hardcoded at the moment, better solution? b2ac90b
• Landing page: List all paused/ongoing games which are in the DB 2ee7cc3
• Lift state and only save paused or finished games in db #27
• Make use of lenses #25
• Make use of TVars #27
• Warnings Fixen [cb3c361, #26 ]

---

REQUIREMENTS (Uni2Work)

1. Webapplikation mit yesod
2. Monaden

Fortgeschrittenere Themen, welche sich zu Monaden anrechnen lassen sind z.B. Monad-Transformer, Lifting, fortgeschrittene Verwendungen von Zustandsmonaden, etc.
Beachten Sie bitte, dass zu einer zufriedenstellenden Anrechnung des Themas Monaden mehr als einfacher monadischer Code (z.B. nicht nur do-Notation) vorhanden sein muss.

3. Datenbankanbindung (Persistent)

zusätzlich eine Datenbankanbindung implementieren (z.B. mit Persistent), beispielsweise um Spielstände persistent zu speichern, um zu einem späteren Zeitpunkt mit dem Spiel fortfahren zu können.

4. Tests (?)
5. AI/Automated Problem Solving

Das Thema KI / Automated Problem Solving ist des Weiteren nicht direkt ein Thema der funktionalen Programmierung.

UPDATED REQUIREMENTS

1. TVars (nebenläufigkeit)

TVars decken ja eigentlich sogar auch Nebenläufiges Programmieren

2. Lenses

Sie könnten noch ein paar Lenses für irgendwelche Datentypen (die sie ja wahrscheinlich sowieso haben) definieren und deren Verwendung demonstrieren.

3. Unlösbare Probleme (State monade)

Die unlösbaren Probleme sind sicherlich auch ein guter Punkt, den Sie in der Abgabe ja kurz dokumentieren und begründen könnten (was geht da, warum nicht).

Deploy yesod-app

• https://medium.com/@BlunderBrain/yesod-on-heroku-so-easy-no-one-is-writing-about-it-e1db42a73f97

Boilerplate Yesod

• Take a look at https://github.com/tzemanovic/haskell-yesod-realworld-example-app

Add delete game option to /game