Tbpgr Blog

元エンジニア 人事 tbpgr(てぃーびー) のブログ

るりまのサンプルコードを作成するためのサンプルコードを発見する方法 #ruby_polisher

るりまのサンプルコードを作成する際に、Ruby の rdoc にサンプルコードがある場合は問題ありませんが、
新しくサンプルコードを作成する際は自分で考える必要があります。
その際にササッとよいサンプルが思い浮かばない、もしくはそもそもそのメソッドに対する理解を深めたい場合に
取れる選択肢をまとめます。

これは、るりまのサンプルコード拡充の過程で行ったことですが、
一段階抽象化して捉えるなら

「何かのライブラリを理解するための利用例をみつけるテクニック」

とみなすことができるので今回の活動に関わっていない人にも役立つと思います。

なお、「何を今更」という感想しかない圧倒的「チョットデキル」僥倖レベルの方もいると思いますが、
そういった方々からはさらなるテクニックを伝授していただけると界隈が潤うこと請け合いです。

経緯

るりまのサンプルコード追加に関する経緯についてはこちらの記事をご確認ください。

tbpgr.hatenablog.com

1. Ruby のテストケースを確認する

https://github.com/ruby/ruby で対象クラスのテストコードを探します。

2. ブログの記事を探す

技術系のブログを探します。
ググったり、Qiitaを調べたり、Stack Overflow を調べたりします。

3. 書籍を探す

Rubyの書籍を多く持っている方は書籍内でサンプルがあるかも。

4. GitHubを検索

ここまできても中々見当たらない場合は、
GitHub 全体を language:ruby +任意のキーワードで調べるとよいでしょう

5. メーリングリストを探す

ここにしかない情報がたまにある・・・ような気がします

http://blade.nagaokaut.ac.jp/ruby/ruby-dev/index.shtml

6. 人に聞く

強い仲間がいる人、SNSのつながりが強い人などは人に聞くのもよいでしょう

7. bugs-ruby で開発の経緯を探す

どこにも情報がない場合は、ここで確かめることになるでしょう。 そして、ここにもない場合は中の人にきかないとわからないかも。

まとめ

多くの人が自然にやっていることが多いかもしれません。
もし、この他に良い方法があればブコメや各々のブログなどで教えていただけると嬉しいです。