Do you find Test Driven Development (TDD) good in theory but hard to practice? Do you think it requires too much discipline and you don’t have time? Or, are you just struggling to get your workflow streamlined? Fighting to glue your tools together?
Well, you can improve a lot, by borrowing some tricks from me. I’ve practiced TDD with Ruby for many years now, and built an entire web framework only with these techniques.
They are simple, effective and easy to learn.
This is a series of a few articles about TDD, Ruby and Vim. Today we’ll focus on time management and flow.
Programming is a time consuming activity. While working, it’s easy to follow the rabbit down to the hole and focusing on the small details. To don’t to loose the big picture, it’s really important be in control of time and priorities.
There is an article of mine, about time management, healthy habits, and Pomodoro Technique that I truly recommend to read. It will help you to prioritize tasks, have a consistent routine and ship code as soon is “good enough”™.
Always use Git, even for code spikes. It’s free and you don’t need to necessary use GitHub, just consider it as a local ”time machine” for your code.
Let’s say you’re working for 20 minutes and did a lot of changes. Then you take a path that breaks everything. At this point it’s hard to revert the mistake by hand without to compromise the good job that you did until now.
As rule of thumb: commit once you do some progress. That puts code in a safe place. I have a couple of ZSH aliases to the rescue. For the first commit:
gaa && gc -m “WIP”, and then
gaa && gca.
➜ which gaa gaa: aliased to git add --all ➜ which gc gc: aliased to git commit ➜ which gca gca: aliased to git commit --amend --date="$(date)"
To don’t break the flow, I don’t care about the commit message at the beginning, as I can always finalise it at the end of the feature.
Fast Feedback Loop
TDD is a technique that guides you to do incremental changes both in testing and production code. Once a modification is in place, it’s really important to run tests as soon as possible.
To streamline the process, it’s really important to get the result of your tests in a matter of a few seconds. Ideally, in less than a second. Now, this is hard to achieve if you run the entire test suite of an application. You can narrow the scope to the current Vim buffer instead.
If you use Minitest:
:map <leader>r :!greenbar bundle exec ruby<cr> :map <leader>re :!greenbar bundle exec ruby -Itest %<cr>
Or if you use RSpec:
:map <leader>r :!greenbar bundle exec ruby<cr> :map <leader>re :!greenbar bundle exec rspec %<cr>
<leader>r for the suite and
<leader>re for the current test file.
Another TDD hallmark is the “red-green-refactor” cycle. Start with a failing test (”red” state), write the simplest production code to make it pass (”green”), and then refactor.
A corollary of this principle is that we are never allowed to refactor when the status is ”red”.
I’ve created Vim plugin, that colors the status bar with the current state in the cycle: vim-greenbar.
Don’t Break The Flow
True focus is really hard to achieve, there isn’t anything else that makes us so productive. You should do everything to keep that state. Sometimes an idea for a refactoring suddenly sparks, or your mind is carrying on a lot of informations about the things to fix and make better.
FIXME convention in code it’s really useful, but it’s bound to the module/class/method that needs to be improved. We need to open it, locate the right line, write.. while you’re struggling to not break the flow.
What if taking notes is just a couple of keystrokes away?
Here’s another small tool to the rescue: vim-devnotes. It opens a split window where you can quickly write a note. When closed, it reports in the status bar, the number of remaining issues to address.
I have a keyboard mapping for this:
Leave The Field With A Red Test
When you are going to wrap your work in the evening, make sure you have committed and pushed all the changes. Then write the next test, but leave it ”red”. You don’t have to commit, it’s just a hint to start tomorrow.
If you don’t want to miss the next post about Vim setup, please consider to subscribe to my mailing list.