The previous post in the series - TDD commit by commit String Calculator (I). Last part ended with the basic functionality of string calculator. My “class” can parse numbers and sum them up. I have started with an empty project, slowly adding code with features. This post is the 2nd part of the series.
Step VI - Clean up
Before I can start adding new stuff, I need to make a little re-factorization. There are a couple of issues in the code.
R#, var and other fun
One of the issue, thanks to Pawel Sawicz for pointing this out, is the type of “object” returned by the main function. There is an “object type” instead of “int”. This problem, probably, was caused by R# auto method extraction (that’s one of the reasons why I have disabled R# for a while just to check how it affects my work. Blog post about my observations coming soon). Sadly, This issue wasn’t caught by the unit tests, I am not asserting the expecting “type” just the “value”. This problem is related to the excessive “var” keyword usage. With explicit “int” instead of “var”, there would be an error on compilation. This error is also an assertion, that’s why I think it is beneficial to use explicit types on the expected “object / value”.
Class name + one file
I also noticed that the main class name is “Class1.cs”. Well, what can I say, not a good file-name, when I started implementing features this wasn’t a problem but now when I do know the name of my main class, I don’t see a reason to leave it like this. It’s time to rename the file to match the “class name”. With this change in mind, it would be also great to split up the file into multiple files. One big file with code is a big “NO NO”. I don’t want to see the Custom exception or other not-relevant code, especially when I know that it won’t be modified in the foreseeable future. Little note. I am not introducing a new project for tests ‘Yet’.
Test first - first class citizen
The quality of the tests could also be slightly better. Right now each test contains code to create “new StringCalculator()”. It’s not that problematic but it creates an unwanted noise that distorts the readability of code. Unit test has to be clean, readable and easy to follow. I do believe in an idea of treating unit tests as “First Class Citizens”.
“The bottom line of all this is that we should consider our tests as being first. We already know we should write them first; but we should also clean them first, maintain them first, think of them first, and keep them first. We should give our tests the highest priority. That is what “Test First” really means. The Tests Come First!” Robert C Martin - http://blog.8thlight.com/uncle-bob/2013/09/23/Test-first.html
This is quite radical, I don’t agree with everything said here, but there is one thought that I do like. Take care of your tests, maintain them, clean and re-factor them. They are the description and the best documentation you have. After this “brief” introduction time for some code changes.
Commit - test cleanup
I have changed the “expected” value declaration from var to int and automatically compilation error popped up. Now, I can change the “value type” and check if the error is gone and a test is passing. Also, I have changed the name of the Test Class, but I am not splitting files yet. I don’t want to create noise and bloat up the commit diff. I introduced the “SetUp” function that is responsible for creating the instance of “StringCalcualtor”.
Commit - split file
Finally, the split is finished and I am happy ;)
Step VII - Newline character as deli-meter
The new requirement, allow the new lines between the number (instead of commas). Treat them as deli-meters. Simple example: for input “1\n2,3\n4”, calculator should return “10”.
Commit - Newline character test
The test is pretty straightforward, nothing to explain here. This now throws my custom exception, the input is not correct due to the “\n” characters.
Commit - Newline character test
Implementation is very simple. Do I need to create fancy code with “sparkles”? Not for this requirement. The split function accepts more separators and it’s just “Good Enough”. Can I refactor the code and tests? I don’t think so. The code is still quite straightforward. In this part, I just implemented one new feature.
Summary: - on expected value use explicit “type” instead of “var”, the compilation error is your friend - refactor your code and tests, “Test First” and treat your “Tests as First class citizens” - create “Good enough” software, don’t overcomplicate solutions.