Skip to content

Latest commit

 

History

History
113 lines (60 loc) · 3.28 KB

README.md

File metadata and controls

113 lines (60 loc) · 3.28 KB
Raw

Description

This Vim plugin implements interactive Ruby debugger in Vim.

Features

  1. It can debug any Ruby application (Rails, by default), using ruby-debug-ide gem
  2. The debugger looks like in the Netbeans - you can go through the code, watch variables, breakpoints in separate window, set and remove breakpoints.
  3. It supports command-line rdebug commands. E.g., you can execute ':RdbCommand p User.all' in command line of VIM and it will display result like usual echo VIM command.

Requirements

  1. Vim >= 7.0, compiled with +signs and +clientserver. You can verify it by VIM command:

    :echo has("signs") && has("clientserver") && v:version > 700

    It should show result '1'.

  2. ruby-debug-ide gem.

  3. For linux: 'lsof' program.

  4. For OS X:

    The vim that ships with OS X does not use ruby, nor does it support --servername, so MacVim must be used.

    Make sure that both MacVim, and mvim are installed.

    If they are not, you can use homebrew (http://mxcl.github.com/homebrew/):

    brew install macvim

    This will install MacVim, along with the mvim command line utility.

Installation

  1. Clone the repo

    git clone git://github.com/astashov/vim-ruby-debugger.git

    or just download the archive from here:

    http://github.com/astashov/vim-ruby-debugger/tarball/master

    You will get the 'vim-ruby-debugger' dir with the plugin.

  2. Copy contents of the 'vim-ruby-debugger' dir to your ~/.vim/ (or to ~/.vim/bundle/vim-ruby-debugger if you use pathogen).

  3. Generate the local tags file

    :helptags ~/.vim/doc

    Now, you can use

    :help ruby-debugger

    to get help for the ruby-debugger plugin.

  4. If using MacVim:

    Modify your ~/.vimrc to add the following line:

    let g:ruby_debugger_progname = 'mvim'

I've tested the plugin in Windows and Linux. All tests should be passed there.

Using#

  1. Run Vim. If you use gvim, it will automatically start the server, but if you use vim, you need to set servername explicitly, e.g., vim --servername VIM

  2. Go to the directory with some your Rails application.

     :cd ~/projects/rails

  3. Run Server with Debugger:

     :Rdebugger

    It will kill any listeners of ports 39767 and 39768 and run rdebug-ide and ~/.vim/bin/ruby_debugger.rb on these ports accordingly.

  4. Set breakpoint somewhere by <Leader>b (e.g., '\b'). You should see 'xx' symbol at current line.

  5. Open page with the breakpoint in the browser. Vim should automatically set current line to breakpoint.

  6. After this, you can use commands:

     <Leader>b - set breakpoint at current line
 <Leader>v - open/close window with variables. You can expand/collapse variables by 'o' in normal mode or left-mouse double-click
 <Leader>n - step over
 <Leader>s - step into
 <Leader>c - continue

Testing

If you want to run tests, replace in /autoload directory ruby_debugger.vim to ruby_debugger.vim from additionals/autoload directory. And then, in command mode execute

     :call g:TU.run()

Screenshot

Screenshot

Thanks

Special thanks to tpope (for rails.vim) and Marty Grenfell (for NERDTree), mostly, I learn Vim Scripting from their projects.