チームで開発する際はコーディング規約を決めて行うことが多いと思います。 実際に書いたコードが規約に従っているかどうかを検査するため、筆者はRuboCopを使用しています。 コーディング規約そのものはWeb上に公開されているものを参考にして決めていますが、制限が厳しすぎる等の意見がチーム内であった場合は適宜規約を調整しています。 最近チーム内でABCSizeに基づく警告を出す閾値がもう少し高くても良いのではという意見が出たことをきっかけにいくつかのアプリケーションでの例を調べたので紹介します。
ABCSizeについて
ABCSize(ABCMetrics)は次のように定義されます。(ABC Metricより)
Assignment – an explicit transfer of data into a variable, e.g. = = /= %= += «= »= &= |= ^= »>= ++ –
Branch – an explicit forward program branch out of scope – a function call, class method call, or new operator
Condition – a logical/Boolean test, == != <= >= < > else case default try catch ? and unary conditionals.
A scalar ABC size value (or “aggregate magnitude”) is computed as:
|ABC| = sqrt((AA)+(BB)+(CC))
代入(A)、メソッド呼び出し等(B)、条件式(C)の数を数え、それぞれの2乗の和の平方根がABCSizeになります。
一般に一つのメソッドが複雑になりすぎると保守性が下がるため、メソッドを分割するための指標が必要になります。 RuboCopではメソッドごとにこのABCSizeを集計し、デフォルトで15を超えると警告を出すようになっています。
直感的には値が大きいほど複雑であることは分かりますが、どれくらいの値が適切であるかまでは分かりません。
各プロジェクトでの分布
設定値の目安にするため、いくつかのプロジェクトのソースコードにおけるメソッドごとのABCSizeの分布を調べました。 ある程度の開発期間・コード規模をもつプロジェクトとして次のリポジトリを対象とします。
これらのリポジトリ上のソースコード中のメソッドごとのABCSizeの分布は次のようになります。 横軸がABCSize、縦軸がメソッド数を表します。 (簡単のためABCSizeは小数第1位を四捨五入しています。)
Rails
Rubocop
rubygems.org
Gitlab
Redmine
spree
ABCSizeの設定値はどうすべきか
ABCSizeの分布をみるとどれも0〜20あたりにほとんどのメソッドが集中していることが読み取れます。
もう少し詳しく、ABCSizeの値に対してメソッドのカバー率を表す累積分布グラフが次のようになります。 横軸がABCSizeの値、縦軸がそのアプリケーションにおけるそのABCSize以下のメソッドの割合です。
累積分布のグラフからキリのいい割合におけるABCSizeを抜き出したのが次の表です。
| アプリ | 70% | 80% | 90% | 100% |
|---|---|---|---|---|
| RuboCop | 8 | 11 | 15 | 31 |
| Rails | 7 | 9 | 14 | 400 |
| rubygems.org | 6 | 8 | 12 | 40 |
| Gitlab | 6 | 9 | 13 | 243 |
| Redmine | 11 | 14 | 20 | 334 |
| spree | 7 | 9 | 14 | 364 |
過半数のプロジェクトで100%をカバーするには3桁の数字を設定しなければならず非現実的ですが、12〜15に設定すれば6個中5つのプロジェクトで90%をカバーできるため、このあたりが妥当な設定値と言えるのではないでしょうか。 ということで、もともとRubocopがデフォルトに設定している15という設定値が妥当であると結論付けて、特に値を変えずに使用しています。