Route 477

■ [ruby] Rubyの新リファレンスマニュアルをコマンドラインから簡単に引くためのツールを書いた

Rubyリファレンスマニュアル刷新計画(通称るりま)のリファレンスを、コマンドラインから簡単に引けるようにするgemを作りました。

多くの人はWeb版か、chm版を使ってると思いますが、同じものがコマンドラインから見れるようになります。

インストール方法とかはgithubに書いてますが、

$ sudo gem install myrurema

$ rurema --init

$ rurema Array#length
Array#length
--- length    -> Integer
--- size      -> Integer

配列の長さを返します。配列が空のときは 0 を返します。

  p [1, nil, 3, nil].size    #=> 4

という感じです。初回のみ、データベースを構築するので数分から十数分かかります。

RubyとSubversionが必要です。

間違いを見つけたら

るりまはまだ未完成ですので、間違いとか、分かりにくい箇所がいろいろあると思います。

RedMineにアカウントを作って チケットを登録するか、 Web版のコメント欄で報告してください。

仕組み

~/.rurema以下にbitclustとdoctreeをチェックアウトし、データベースを作ります。

bitclust同梱のrefeはバージョン指定が必要だったりするのですが、myruremaではRUBY_VERSIONをデフォルトとすることでオプションがいらなくなりました。

rvmで1.8/1.9を共存してる場合も、それぞれのRubyでmyruremaをインストールすれば、自動的に現在のRubyバージョンのリファレンスが表示されるんじゃないかな。たぶん。

るりまのリファレンスは随時更新されているので、最新のリファレンスデータにアップデートするには

 $ rurema --update

とします。(svn upして、データベースを再構築します)

そのうちrurema --serverとか、リファレンス書く人用に rurema --preview /some/file とかできるようにしたいですね(パッチ歓迎！)