はじめに
2021年7月11日に開催されたKyoto.rbに参加させていただきました。 「るりま読書会」という題目での開催で、るりまはどうしても苦手意識があったので、それを払拭したいというのと、「他の方はどのように読んでいるのか」というところも知りたかったので、参加しました。
たくさんの学びがあったので、メモとして残しておきたいと思います。
会の流れ
るりまとは
るりまとは、Ruby リファレンスマニュアルの略で、Rubyの公式ドキュメント的な立ち位置にあるものです。
Rubyを書く人は間違いなく見ているドキュメントです。
前半
るりまが何を目的としてメンテナンスされているかから始まり、るりまの全体像や読み方の大枠、みなさんがどのようにるりまを読んでらっしゃるかの意見交換をしました。
後半
Enumerable
を運営の方主導で読み進めていただきました。
どんな風にるりまを読み進めているのかをリアルタイムで体感できて、自分でも読むときの参考にしたいと思いました。
各メソッドの説明もしてくださり、とてもわかりやすかったです!
Rubyリファレンスマニュアル(るりま)のTips
るりまの説明を聞いている中で、いくつも発見があったので箇条書きで書いていきます。
ページ下部のリンクから、issueを立てたりPRを送れるようになっている。
右上の[edit]リンクからも簡単にPRを送れる。
クラスの並びのインデントは、継承構造を表している。
組み込みライブラリは
require
なしで使えるライブラリで、標準添付ライブラリはrequire
して読み込めるライブラリ。- (メソッドが)ActiveSupportなのか、Rubyなのかわからない場合は、「Active Support コア拡張機能 - Railsガイド」をみてみる。
- 用語集・記号の意味
- 初心者はここを見ると、内容に入っていきやすい
- メソッドの説明の下に[permalink]というリンクがあり、誰かに共有するのに役立つ
みなさんの読み方
今回参加された方たちは、「他の人がどうやってるりまを読んでいるか知りたい」という方が多かったようです。
読み方についてたくさんの意見があったので、ピックアップして書いていきます。
- とりあえずEnumerableをながめて良いメソッドがないか探してみる
- 定期的に読み返して頭のインデックスを更新する
- 上から順番に眺めて、気になったメソッドをirbで実行してみる
- サンプルコードが必ず動くようになっているので、とりあえずコピペして動かしてみるのもアリ
- 1行ずつコピペしなくても、右上の[copy]ボタンで全コピーしてもちゃんと動くように書かれている(すごい!)
- 気になるメソッドをピンポイントで調べる
- 業務上必要になったら立ち返ってみる
- メソッドの存在だけ知っていれば良い
- 必要になったときに、見直してみる
- ユースケースがわからないと覚えづらいから
とても参考になったので、今後の学習に取り入れていきたいです。
雑感
長くRubyを触ってる方でもるりまを見て初めて知ることもあるということを知り、だからこそ定期的に読み直す価値があるのだなと思いました。
僕はまだるりまを通しで読んだことはないのですが、通して読んだり、よう使うクラスやライブラリについては定期的に読み直したりしていきたいです。
また、PRの敷居も低くなっている印象を受けたので、気づいたときには積極的にPRを送ってみたいと思いました。
謝辞
このような会を開催してくださったKyoto.rbの運営の皆様、ありがとうございます。
参考リンク
オブジェクト指向スクリプト言語 Ruby リファレンスマニュアル (Ruby 3.0.0 リファレンスマニュアル)
rurema/doctree: Repository of Japanese Ruby reference manual