DoRuby! (ドルビー!) は現場のエンジニアによる、主にRubyなどの技術に関する様々な実践ノウハウを集めた技術情報サイトです。
-
- 2008.02.26
- カテゴリ：初心者向け - 役立ちツール
Rubyのマニュアルを手軽に参照する方法
こんにちは！
id:saronpasuです。
今回は、「Rubyのマニュアルを手軽に参照する方法」をご紹介します。
Rubyのマニュアルでよく知られているのが「Rubyリファレンスマニュアル」ですね。
でも、このマニュアルはブラウザを開いてみないといけません。
イケてるプログラマなら、ターミナルやプロンプトからリファレンスをみたいですよね？
ReFeについて
そこで、今回ご紹介するのが「ReFe」です！
この「ReFe」を使うと、ターミナルやプロンプトから次のように入力するだけで簡単にRubyのリファレンスが表示されます。
$ refe String
==== String ====
文字列クラス。任意の長さのバイト列を扱うことができます。
このクラスのメソッドのうち名前が ! で終るものは文字列の中身を
直接変更します。このような場合は ! のついていない同じ名前の
メソッドを使うほうが概して安全です。たとえば以下のような場合に問題に
なることがあります。
def foo(arg)
arg.sub!(/good/, 'bad')
arg
end
s = 'verygoodname'
p foo(s) # => 'verybadname'
p s # => 'verybadname'
また日本語文字列を正しく処理するためには組み込み変数 $KCODE を
文字コードにあわせて設定しておく必要があります。
………
==== String ====
文字列クラス。任意の長さのバイト列を扱うことができます。
このクラスのメソッドのうち名前が ! で終るものは文字列の中身を
直接変更します。このような場合は ! のついていない同じ名前の
メソッドを使うほうが概して安全です。たとえば以下のような場合に問題に
なることがあります。
def foo(arg)
arg.sub!(/good/, 'bad')
arg
end
s = 'verygoodname'
p foo(s) # => 'verybadname'
p s # => 'verybadname'
また日本語文字列を正しく処理するためには組み込み変数 $KCODE を
文字コードにあわせて設定しておく必要があります。
………
インストール方法
インストールは簡単です。
RubyGemsが入っていれば、
$ gem install -r refe
これでインストール完了です。
文字コードの設定
次にお使いの環境に合わせて、文字コードの設定をしましょう。
Windwosの場合
そのままお使いいただけます。
Mac OSXの場合
/opt/local/lib/ruby/gems/1.8/gems/refe-0.8.0.3/lib/refe/searcher.rbを編集する必要があります。
編集するのは次の２カ所です。
変更前(11行目)
require 'nkf'
変更後(11行目 〜 12行目)
require 'nkf'
require 'iconv'
require 'iconv'
変更前(18行目 〜 24行目)
def adjust_encoding( str )
if shift_jis_platform?
NKF.nkf('-Es', str)
else
str
end
end
変更後(18行目 〜 24行目)
def adjust_encoding( str )
if shift_jis_platform?
NKF.nkf('-Es', str)
else
Iconv.iconv('UTF-8', 'EUC-JP', str)
end
end
これでターミナルやプロンプト上からお手軽に日本語のリファレンスを参照する事ができます。
使い方
$ refe String scan
と、実行するとStringクラスのscanメソッドのリファレンスが表示されます。
refe に続いて、調べたいクラス名やモジュール名、メソッド名を入力すると
入力したクラスやメソッドについてのリファレンスが日本語で表示されます。
Rubyのコードを読んでいて、初めて見るクラスやメソッドが出てきたら、
これからは「ReFe」で調べてみるとすぐにわかりますね！
トラックバック URL
トラックバック一覧
≫ ReFeをUTF-8で表示する
saronpasuさんのブログにコメントできなかったorz なのでトラバで。 以下のようなエラーが出て怒られました^^; undefined local variable or method `lc... [続きを読む] posted from ZerockBlog 2008.04.21 10:45
Rubyでのwebシステム開発は
実績豊富なKBMJにお任せ下さい
実績豊富なKBMJにお任せ下さい
iPhone開発は
KBMJにお任せ下さい
KBMJにお任せ下さい
クラウドファイル共有サービス「DUB」
オープンソースECパッケージ
「エレコマ」
「エレコマ」
- saronpasu
- RubyやRuby on Railsで開発して行く上でのTipsや、トラブルにぶつかった際の解決方法なんかを公開して行きます。
