Rubyで、gem installした後、ざっとドキュメントを見たいとき、どうするのが良いでしょうか?→gem serverで解決
教えてくんモードです。
Rubyで、gem installした後、ざっとドキュメントを見たいとき、どうするのが良いでしょうか?
(→解決しました「gem serverを動かして、表示されたURLをブラウザで見る」らしいです)
たとえば、Rubyで「はてなブックマーク」を使って遊びたいなと思ったとしましょう。るびこちゃんは以下のような行動を取りました。
(hatenaという文字列を含むモジュールを探しましょ♪) C:\>gem search hatena *** LOCAL GEMS *** (あ、gemって、デフォルトではローカルを探すんですね…) (じゃあ、--remoteオプションをつけましょ♪) C:\>gem search hatena --remote *** REMOTE GEMS *** hatenaapiauth (0.1.0) hatenaapigraph (0.2.2) hatenabm (0.1.2) hatenagraphup (1.2.2) (あったあった。きっと、hatenabmですね) C:\>gem install hatenabm Successfully installed hatenabm-0.1.2 1 gem installed Installing ri documentation for hatenabm-0.1.2... Installing RDoc documentation for hatenabm-0.1.2... (できたできた。簡単ですねえ) (ri documentationもインストールされたみたいですね) (じゃあ、さっそくドキュメントを見てみましょう) C:\>ri hatenabm Nothing known about hatenabm (あ、あれ?) (バージョン番号もいるんでしょうか?) C:\>ri hatenabm-0.1.2 Bad argument: hatenabm-0.1.2 (違うようですね…) (じゃあ、RDocのほうで見てみましょう) C:\>rdoc hatenabm File not found: hatenabm (これも違う…) (バージョン番号もいるんでしょうか?) C:\>rdoc hatenabm-0.1.2 File not found: hatenabm-0.1.2 (むきー!) (いやいや、ヘルプ読みましょ…) C:\>ri --help ... --gems Include documentation from Rubygems: ... (おー、このオプションが必要なのかしらん) C:\>ri --gems hatanabm No ri documentation found in: Was rdoc run to create documentation? (はてさて…) (もういい、自力で探すもん!) C:\>cd ruby C:\ruby>dir /s/b hatena* C:\ruby\lib\ruby\gems\1.8\cache\hatenabm-0.1.2.gem C:\ruby\lib\ruby\gems\1.8\doc\hatenabm-0.1.2 C:\ruby\lib\ruby\gems\1.8\doc\hatenabm-0.1.2\rdoc\classes\HatenaBM.html C:\ruby\lib\ruby\gems\1.8\doc\hatenabm-0.1.2\rdoc\classes\HatenaBM.src C:\ruby\lib\ruby\gems\1.8\doc\hatenabm-0.1.2\rdoc\files\lib\hatenabm_rb.html C:\ruby\lib\ruby\gems\1.8\doc\hatenabm-0.1.2\ri\HatenaBM C:\ruby\lib\ruby\gems\1.8\gems\hatenabm-0.1.2 C:\ruby\lib\ruby\gems\1.8\gems\hatenabm-0.1.2\lib\hatenabm.rb C:\ruby\lib\ruby\gems\1.8\specifications\hatenabm-0.1.2.gemspec (あったあった) C:\ruby>start C:\ruby\lib\ruby\gems\1.8\doc\hatenabm-0.1.2\rdoc
うーん、るびーすとのみなさんは、gem installした後、どうやってドキュメントを見てるんでしょうか?
C:\ruby>ruby --version ruby 1.8.6 (2007-09-24 patchlevel 111) [i386-mswin32]
追記
Twitterでつぶやいたら、igaiga555さんとhal_99さんから、gem serverを使えばと教えていただきました。コメント欄でもHexaさんに教えていただきました。感謝!
C:\ruby> gem server Starting gem server on http://localhost:8808/ C:\ruby> start http://localhost:8808/
追記2
上記で問題はないんですが、ユーザ的にはちょっぴり使いにくいなと思っちゃったりしました。
きっと、gem show hatenabmみたいなコマンドか、ri hatenabm みたいなコマンドを期待しちゃうのかも。perldocのほうがすぐにusageのexampleが手に入る…ように感じるのはperldocに慣れているからなのかなあ…。以前、このあたりの話題を弾さんがどこかに書いてたような気がする。