The purpose of this project is to train your refactoring skills in Scala.
You will find an implemented coding kata (e.g. Conway's game of life) together with acceptance-tests.
Your task is to refactor the implementation and produce a much nicer code-base. The acceptance-tests are there to guide you and let you know if you broke anything.
So far, the only kata implemented is "Coway's game of life".
It simulates a two-dimensional world / board, where a position can be occupied by a cell. A cell can be dead or alive. Alternatively, you can think in terms of a position being empty, having a live cell, or not.
Taken from Wikipedia:
- Any live cell with less than two live neighbours dies, as if caused by under-population.
- Any live cell with two or three live neighbours lives on to the next generation.
- Any live cell with more than three live neighbours dies, as if by overcrowding.
- Any dead cell with exactly three live neighbours becomes a live cell, as if by reproduction.
In order to help you, here is a partial list of what to aim for...
- Prefer constants to variables (
valvs.var) - Prefer immutable data structures (imm. Map, List, Seq, etc.)
- Prefer domain objects to generic data structures (e.g. case class vs. Map)
- Prefer immutable objects (generate new states instead)
- Don't misuse exceptions for flow-control (!!)
- Avoid type-casting (asInstanceOf)
- Prefer for/foreach/map/etc. over while-loops
- Strive for good intention-revealing names
- Avoid "magic numbers"
- Prefer Option over null
- Split logic into smaller pieces
- Follow the single-responsibility principle
- Strive for same levels of abstraction
- Strive for cohesion
- Remove dead code-branches
- See some comments are a code smell
- etc.
The code found in this project was made horrendous on purpose.
It does not represent the normal coding style of the author(s).