RuboCopとXPコーディング規約

RuboCopとXPコーディング規約 Powered�by�Rabbit�2.1.9
RuboCopとXP
コーディング規約
XP祭り�2016
早稲⽥大学�⻄早稲⽥キャンパス
2016-09-24�(Sat)
伊藤�浩⼀�(@koic)
(株)永和システムマネジメント

わたし

わたし
(株)永和システムマネジメントで
働くシニアリーダー。Rubyとか
メタルなんかが好きです�lml�lml
https://github.com/koic✓
https://twitter.com/koic✓
https://koic.hatenablog.com✓

�

はじ
めに

XPの中⼼となる活動
XPはコーディングをソフトウ
ェアプロジェクトのキーアク
ティビティ、つまり「中⼼と
なる活動」として選んでい
る。
[「エクストリームプログラミング�1st�序⽂」より
引用]

今⽇の話

今⽇の話
XPオリジナルプラクティスの
ひとつ『コーディング規約』
✓
もともと予定していた『スロー
テスト刑事�(デカ)�』は先週、
京都で使っちゃいました
http://www.slideshare.net/koic/
slow-test-cop
✓
✓
デカシリーズ第2弾(RuboCop)✓

Keywords
Coding�standard✓
RuboCop✓
XP�and�Community✓

Coding�standard
オリジナルXPのプラクティス
の1つでもある
✓

Coding�standard
読み⼿の負担を減らすリーダブ
ルなコードに近づける
✓
PRレビューなどのコードリー
ディング時につまらないところ
で引っ掛かりたくない
✓
チームメンバーのコードを似た
ようなコードに近づける要素
✓

ツールによる自動化
RubyではRuboCopという
Gemが有名
github.com/bbatsov/rubocop✓
✓

RuboCopのチーム活用例
CI�で�RSpec�と�RuboCop�の
実⾏結果をビルド結果とする
✓
PR�に対して�RuboCop�でコメ
ントを付ける
✓

RuboCop
正直あまり好きではなかったが
次のひと⾔との出会いで考え⽅
が変わった
✓

@onk�says

Yep!

現場のRuboCop
デフォルトの設定では取り締ま
りが厳しすぎることからカスタ
マイズされて使われたりする
有名な�onk/onkcop✓
esminc/deka̲eiwakun✓
SonicGarden/sgcop✓
その他非公開cop含め多様✓
✓

@onk�says
お互いに良いコーディング規
約があれば本家に提案しよう

原初のXPをふりかえる
XPは常識を原理とし、極限ま
で実践するからである。
[「エクストリームプログラミング�1st�序⽂」より
引用]

eXtreme例�(XPE1stより)
コードレビューがよいのであれ
ば、いつでもコードレビューを
⾏う
✓
テストが良いのであれば、全員
がいつでもテストをして、顧客
もテストを⾏う
✓
設計がよいのであれば、設計を
全員の⽇常の仕事の⼀部にする
✓

ツマミをフルボリュームに
良いコーディング規約なのであれ
ば、upstreamにそのコーディン
グ規約を提案する。

upstream�への�PR

PRの概要
Cop/Performance族✓
コーディング規約の中でも割と
有益性が明確な分野だと思って
いる
✓
sort�{�...�}�から�sort̲by�{�...�}�
にするよう取り締まる
✓

sortとsort̲byおさらい
安定なソートかそうでないか
ggr✓
警告を出すようにした⽅が良かった
かも�thx�#shibuyarb
✓
✓
パフォーマンスの違い
今回提案したい観点✓
✓
Cop/Performanceへの提案の
ためベンチマークを付けたい
✓

Enumerable#sort�ブロッ
クなし(参考)
��
��
��
��
��
��

Produces:
��
��
��
sort̲by�{�|a|�a�}�ブロックありのときは�sort�の⽅が速い。

Enumerable#sort�ブロッ
クあり�(今回用)
��
��
��
��
��
��

Produces:
��
��
��
sort�{�|a,�b|�a.to̲s�<=>�b.to̲s�}�ブロックありのときは�sort̲by
(&:to̲s)�の⽅が速い。

以上を背景
にcopで指
摘したい事

指摘を埋め込んだコード
��
��
��
��

こう指摘したい
��
��
�
��
��
��
��
��

プログラマーなので
既存のcopにないので新たなcop
を作ってみた。

新たなcop作り⽅概要
copで取り締まるASTを宣⾔し、
ASTの⾛査イベントについて、
Copサブクラスを作って書く
��
��
��

PRまでのざっくりした流れ
既存の類似コードを読む1.�
テストコード(RSpec)を書く2.�
whitequark/parserでAST
(抽象構⽂⽊)を作る
3.�
ASTに対するイベントを書く4.�
autocorrectを書く5.�
.travisを元に全ビルドを実施6.�

1.類似の
コードを
読む

類似のコードを読む
割りとコードがドキュメント✓
コードリーディングによる静的
解析とbinding.pryによる動的
解析の2軸が自分の基本
✓
今回はCop/Performance/
RedundantSortByが目的に近
い既存コード
目的に近いコードがあると楽✓
✓

2.テスト
コードを
書く

実装をよく分かっていないか
らこそレッドバーから始める
��
��
��
��
��
��
��
三角測量が⾜りずハードコーディングが残っていたのでテストを
⾜して直す指摘をPRコメントでもらって直したりした。

3.parser
でASTを
作る

RuboCopが使うParser
github.com/whitequark/parser
��
gemspecを眺めて良く知らない
ライブラリは軽く使ってみる
✓

既存のASTを作って学習
目的に近いredundant̲sort̲by.rb
にあるASTを再現させてみる。
��
��
��
��
��
��

参考:�S式より馴染む？
Generated�by�github.com/koic/ruby̲ast̲visualizer

今回作りたいASTを作る
��
��
��
��
��
��
��
��
��
��
��

今回のcopのASTへの実装
��
��
��
��
��
��
��
��
��
��
��
��

RuboCopのNodeについて
lib/rubocop/ast̲node.rbなど
読んでた
✓
��

4.ASTに対
するイベン
トを書く

on̲xxx�メソッド
メタプログラミングで実装され
ている
✓
lib/rubocop/ast̲node/
traversal.rbなど読んでた
✓
��
��

取り締まりについて書く
対象のASTに取り締まり対象が⾒
つかったらoﬀernseに追加する。
��
��
��
��
��
��
��
��

5.�autocorrectを書く
RuboCopには自動修正する--
auto-correctというオプショ
ンがある
✓

rubocop�--auto-correct�
オプションを付けて実⾏する
��
��
�
��
��
��
��
��

autocorrectの差分結果
自動修正される。
��
��
��
��
��

RuboCop::Node
node.children.last.children.last.
children.lastへの苦渋。

autocorrectの実装
method名をASTから引っ張ってく
るところに苦渋の後が⾒える。
��
��
��
��
��
��
��

6.travisを
元に全ビル
ドを実施

.travis重要
RuboCop自体がRuboCopで取り
締まられている。
��
��
��

PR前に全ビルドを実施
project̲spec.rbよく出来てる
デフォルトの取り締まりとなる
conﬁg/enabled.ymlへの設定記述
がなくてエラー
✓
CHANGELOG.mdのリンクが不⾜
していてエラー
✓
✓
Line�is�too�long.の取り締まり
が厳しくてつらい
✓

問題点を指
摘してもら
ったうえで

めでたく即⽇マージされた

onkcop
作者より

XPE2nd�24章『コミュニテ
ィとXP』

Programmingを中⼼に
Aが良いならAをeXtremeに...✓
Bが良いならBをeXtremeに...✓
Cが良いならCをeXtremeに...✓

コーディング規約が良いなら
お互いに良いコーディング規
約があれば本家に提案しよう

RuboCopとXPコーディング規約

Recomendados

Recomendados

Mais conteúdo relacionado

Mais procurados

Mais procurados (6)

Mais de Koichi ITO

Mais de Koichi ITO (20)

RuboCopとXPコーディング規約