rubyベストプラクティスchapter8.2

前章では総論として提示されたものの各論。

README

READMEには

1. ライブラリの概要
2. インストール方法
3. 代表的な使い方
4. 作者への連絡方法

を書く。
これらの全情報をREADMEに書く必要はなくて、必要に応じて別のファイルにして、
READMEにはリンクを示すようにしておこう。
基本的にはプロジェクトのほとんどの情報はREADMEから追えるようにしておくのがベスト。

ライブラリのレイアウト

1. libディレクトリに置こう
2. libディレクトリには名前がライブラリ名のrubyファイルとディレクトリを置こう
3. ディレクトリがネストしている場合でもlib直下のファイルをrequireすると他の必要なファイルもrequireされるようにしておこう
4. 基本はクラス名がファイル名
5. rubyの標準クラスを拡張する場合は一つのファイルに集約しよう
6. rubyの標準クラスを拡張する場合のファイル名はクラス名でなく、extensions_hoge.rbとか「拡張してます!」ってわかるファイル名にしよう

実行ファイル

1. binディレクトリに置こう
2. ファイルには#!行を書こう(「#!/usr/bin/env ruby」というのはおすすめでないそうな)
3. chmod +xで実行権限をつけておこう

テスト

1. testかspecディレクトリに置こう(cucumberはfeaturesですな)
2. helperファイルを使ってでDRYにしよう
3. ファイルやディレクトリの構成はライブラリの構成に合せた方がいい

サンプル

1. examplesディレクトリに置こう
2. ファイルやディレクトリの名前はコンセプト(実行してやろうとしていること)を元に付ける

Rubyベストプラクティス -プロフェッショナルによるコードとテクニック