GithubHelp home page GithubHelp logo

refactoring-dojo's Introduction

Refactoring Dojo

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.

Included Katas

Game of Life

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.

Rules

Taken from Wikipedia:

  1. Any live cell with less than two live neighbours dies, as if caused by under-population.
  2. Any live cell with two or three live neighbours lives on to the next generation.
  3. Any live cell with more than three live neighbours dies, as if by overcrowding.
  4. Any dead cell with exactly three live neighbours becomes a live cell, as if by reproduction.

Idiomatic and clean (Scala) code

In order to help you, here is a partial list of what to aim for...

  • Prefer constants to variables (val vs. 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.

Disclaimer

The code found in this project was made horrendous on purpose.

It does not represent the normal coding style of the author(s).

refactoring-dojo's People

Contributors

sebnozzi avatar zikolach avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.