Here is the bad news: the new developer you hired has written some terrible, atrocious code. No one can understand what it does.
The good news: at least there are unit tests to prove the code is working.
You job is to refactor the code and make it readable, while keeping the code in working order (pass all tests).
- Clone this repository
git clone https://github.com/DoDevJutsu/incomprehensible-finder-refactoring-c-sharp.git - Install all the dependencies.
- Run the tests.
- Start refactoring!
The primary goal is to refactor the code in Finder.cs - as it stands the code is incomprehensible.
- Start with simple rename refactors so you can better understand the abstractions you are working with. Rename any class or any variable.
- Move on to extract methods and making the code more modular.
- See if you can also eliminate switch statements and multiple exit points from methods.
Anything is fair game, create new classes, new methods, and rename tests. The only restriction is that the existing tests have to keep working. Lean on the tests and run them after every small change to make sure you are on the right path.
You can stop when you feel the code is good enough, something you can come back to in 6 months and understand.
- Martin Fowler Refactorings catalog
- Refactoring.guru Code Smells catalog
- Refactoring.guru Refactorings catalog
- CodelyTV Refactoring videos (Spanish)
This kata is the C# original Incomprehensible Finder Refactoring Kata created by K. Scott Allen. You can also find the kata in Java and in Php.
We put the original C# version in an independent repository in order to make it more easily available for the Software Craftsmanship Barcelona Coding Dojo session. Come with us and have some fun if you're near Barcelona the next Monday, August 22nd!