ナレッジエース

先日「まるごと Ruby! Vol.1」を読んでいて、xmpfilterとうい試行錯誤ツールがあることを知りました。

xmpfilterは、Rubyソースコード中の任意の行末に「# =>」という計算マーク(コメント)を入れておくことで、そこにその行の式の値を埋め込んで表示してくれるフィルターコマンドです。(irbでは一行ずつ表示される結果が、直接コードの行末に表示できるイメージ)

インストールもgemで一発。すぐに使えるうえ、標準でVimとEmacsから使うためのスクリプトまで用意されているスグレモノ。

超絶便利だと思うのですが、そのわりにあまり情報をみかけないので、ここではVimから便利に使うための方法について簡単に紹介します。

xmpfilterがやってくれること

xmpfilterについてははてなダイアリーのxmpfilterキーワードページにヘルプからの引用があるので、まずはそちらをご覧ください。

xmpfilterをインストールすると「xmpfiter」コマンドが使えるようになり、このコマンドに「# =>」の計算マークを付けたソースファイルを渡すことで、計算結果の書き込まれたコードが標準出力に表示されます。

xmpfilterコマンドをコマンドラインで実行

まるごと Ruby! Vol.1の記事によれば、xmpfilterが出力する結果には以下のものが含まれます。

• 「# =>」の行を複数回通った場合は、カンマ区切りで表示される
• 警告があった場合「# !>」で表示される
• エラーがあった場合「# ~>」で表示される
• 最後に「# >>」で標準出力が表示される

xmpfilterによって追加される情報はすべてコメントの形になっており、この出力結果をそのままソースコードとして使えるのがポイント。再度xmpfilterにかけた際には結果部分が上書き更新されます。

xmpfilterにはこのほかテストスクリプトの記述支援機能もあったりするので、興味のある方は調べてみてください。

xmpfilterのインストール

インストールは以下のgemコマンドを実行するだけです。(rcodetoolsパッケージにxmpfilterが含まれています)

gem install rcodetools

「ruby\lib\ruby\gems\1.8\gems\rcodetools-0.7.0.0」以下にインストールされるので「README.ja」を確認してください。

Vimからxmpfilterを使う

xmpfilterコマンドを毎回コマンドラインから実行するのは面倒なので、直接エディタから使えるようにしましょう。

rcodetoolsがインストールされたディレクトリの「README.vim」に、Vimから便利に使うための説明が書かれています。(ただし英語orz)

以下、「README.vim」を元に私が追加した設定。(ファンクションキーを全て他で使っていたため、とりあえずShift+F1～F4に変更しただけ)

" <S-F1>で現在行/選択行にxmpfilterを実行
map <silent> <S-F1> !xmpfilter -a<cr>
nmap <silent> <S-F1> V<S-F1>
imap <silent> <S-F1> <ESC><S-F1>a

" <S-F2>でバッファ全体にxmpfilterを実行 
nmap <silent> <S-F2> mzggVG!xmpfilter -a<cr>'z
imap <silent> <S-F2> <ESC><S-F2>

" <S-F3>で現在行/選択行に「# =>」マークを追加
vmap <silent> <S-F3> !xmpfilter -m<cr>
nmap <silent> <S-F3> V<S-F3>
imap <silent> <S-F3> <ESC><S-F3>a

" <S-F4>で現在行/選択行の「# =>」マークを削除
vmap <silent> <S-F4> ms:call RemoveRubyEval()<CR>
nmap <silent> <S-F4> V<S-F4>
imap <silent> <S-F4> <ESC><S-F4>a

function! RemoveRubyEval() range
  let begv = a:firstline
  let endv = a:lastline
  normal Hmt
  set lz
  execute ":" . begv . "," . endv . 's/\s*# \(=>\|!!\).*$//e'
  normal 'tzt`s
  set nolz
  redraw
endfunction

ファンクションキー一発で選択行やバッファ全体に対してxmpfilterが実行でき、実行した部分はその場で出力結果と置き換えられます。

xmpfilterをVim内で実行

Vimの「:!」(フィルタ)コマンドで実行されるだけなので、普通にアンドゥも効きます。「# =>」のマークも自分で書く必要はなく、選択行に対して付けたり外したりが可能。すばらしい。

参考書籍

まるごと Ruby! Vol.1

今回はこの中でるびきちさんが書かれていた「試行錯誤ツール、テスト/デバッグツールを使いこなす」の記事を参考にさせていただきました。xmpfilterの他にもRSpecやautotestなどのテストツールの使い方が詳しく・分かりやすく解説されています。超オススメ。