Add some info. about the ruby based test framework

[hynek]

Thanks!

Since this is a Python project, how about adding some details how to get up and running with vim spec? I have to figure it out myself every time too. :|

Is there a better way than gem install bundler; bundle install?

Thanks again!

[has2k1]

At first I was baffled by the inclusion of Ruby in a Python project, that's why added the section. However the test framework is really neat and seems like the only option.

Given that I have just used it and I wasn't familiar with Ruby other than gem install package, let me list some of the hurdles and we can sort out which details wouldn't be too much for CONTRIBUTING.md. At the minimum these hints would have gotten me going much faster.

---

• gem install vimrunner
• gem install rspec
• Run the tests with rspec spec. Do not do ruby spec/indent/indent_spec.rb or ruby spec/spec_helper.rb. It is totally wrong with very misleading error messages.
• When writing tests, it may be helpful to turn on GUI mode by editing spec/spec_helper.rb line 8 to vim = Vimrunner.start_gvim or vim = Vimrunner.start_mvim It helps you understand what is happening.
• Focus on the describe blocks in spec/indent/indent_spec.rb, that is where the tests are added.
• When you get the hang of it and can add new tests, in GUI mode you can pause with
  • vim.command('sleep 5')
• A Ruby cheatsheet maybe helpful.

---

That is the gist of how I worked my way around.

[hynek]

I’ve finally merged it. Thanks and sorry for the delay!