Simple folding for ruby and rspec files.
Official vim-ruby plugin has too
granular fold support. Every if statement, block, method, class, module and
multi-line comment are folded.
The downside of this is that you might find yourself working too much through
the folds to get to the actual code.
This plugin folds *only* ruby methods. In rspec files, it blocks are
folded.
Benefits:
- it's easy to get to the "actual code" because folds are always just one level deep
- high-level file overview stays clean and readable because the code implementation within the methods is folded
Just use your favorite plugin manager.
Folds computation is slow for big files. This might result in noticeable lag when opening ruby files.
The solution to this is to limit fold creation only for small ruby files. The following option
let g:ruby_fold_lines_limit = 200
will only fold ruby files if they have less than 200LOC.
There is a pull request opened
for official vim-ruby plugin that adds more granular folding support. This PR
could make vim-ruby-fold plugin obsolete.
I tested the above PR for a couple weeks: it's roughly 30% faster at opening big ruby files (it's still takes quite some time to open ruby files with more than 1000 LOC).
The *big* downside is it makes insert mode horribly slow and laggy. I think this is due to folds computation after every character insert.
The vim-ruby-fold performs perfectly in this scenario because it computes
folds only when entering the buffer. For this reason I'm sticking with it for
the foreseeable future.