Github Github logo GitLab GitLab logo Twitter Twitter Mastodon Mastodon logo Wikipedia Wikipedia logo Stack Overflow Stack Overflow logo Stack Overflow Stack Overflow logo OpenStreetMap OpenStreetMap logo Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) Creative Commons BY-SA 3.0

Integrating vim and irb

for rapid, iterative ruby development

End of last year I came across a nice little screencast by Giles Bowkett where he demonstrated how to use vi inside irb. In his blog post he says:

I also ranted about how I think the failure of this technique to have already become incredibly popular means everybody but me is an idiot.

Giles Bowkett, vi In IRB: Screencasting FAIL

The technique itself is older, there’s a blog post dating back to October 2007 titled “Use vi (Or Any Text Editor) From Within irb” . And, of course, all the LISPers will point out that there’s nothing new about it (slime etc.). Bunch of arrogant ‘i-told-you-so’-s :).

I tried it out and completely agree, it’s an incredibly powerful way for doing some quick, explorative coding for all those cases where you don’t want to write specs upfront (maybe because you’re not quite sure of what you’re actually trying to achieve). The idea is that you fire up irb, then use vi (or any other editor) to write some code, which then gets eval’ed into your current irb session (after you leave the editor), so you can immediately interact and play with it.

This is especially useful when you’re working with web services, where you’re not quite sure about the format of the data returned. A quick ‘pp’ in irb will usually be good enough to see what’s happening, so you can refine your code in small iterative steps.

I’ve taken Giles’ original code (interactive_editor.rb) and customised it a little bit. For example, you now can edit any existing file (the original irbrc creates an empty tempfile). Also the code only gets eval’ed if you actually save the file:

In order to use it, just type vi in an irb session (creates a temporary file) or vi filename to load an existing file.

~~There’s a gotcha when using this script with jirb (irb in JRuby): because Java handles I/O in a different way it’s not possible to use standard console editors like vi/vim with it. In this case the script will try to use a graphical version of vim instead (on my system I use macvim. Of course it’s also possible to use the script with any other editor, it’s fairly easy to customise.~~

To improve the edit-irb workflow in vim a bit I use a modified version of mksession.vim, which saves the current state of the editor (line number etc.) just before going back to irb. So when you fix a bug and go back to vi you can carry on working exactly where you left off. Put it somewhere (for example ~/.vim) and add the line “runtime mksession.vim” to your .vimrc.

So don’t be an idiot and use this technique :)

Update (15/05/09)

Charles Nutter found a way to launch vi directly from jruby, using ffi (fork and exec on the JVM? JRuby to the Rescue!). I’ve updated irbrc accordingly, it works well except on Mac OS X where exec fails intermittently. Haven’t had time to figure out why, but couldn’t replicate this problem on a Linux box.

Update #2 (24/05/09)

FFI on JRuby is a bit buggy (at least on Mac OS X), I filed a bug report (JRUBY-3665). It kind of works, but the invocation of vim fails from time to time on this platform.

Update #3 (04/05/10)

It’s not a problem with FFI but the JVM: you cannot fork and reliably execute Java code afterwards (cf. JRUBY-3665) ). A workaround is to use posix_spawn, as shown here: spoon.rb. I’ve updated accordingly.

Update #4 (17/05/10)

The gist has been turned into a gem (interactive_editor), see vimcast episode 20: Running Vim within IRB.


vim+irb from Jan Berkel on Vimeo.