ブログ

ryuzeeによるブログ記事。不定期更新
アジャイル開発に取り組むチーム向けのコーチングや、技術顧問、認定スクラムマスター研修などの各種トレーニングを提供しています。ぜひお気軽にご相談ください(初回相談無料)

CakePHPのアプリのコーディング規約チェックを自動で行う方法

みなさんこんにちは。@ryuzeeです。

PHPで書かれたソースコードがコーディング規約に準拠しているかどうか確認するには、PHP_CodeSnifferというツールを使うのはよくご存知だと思いますが、今回はCakePHPを使って書いたソースコードの規約をチェックする方法を紹介します。 なお、このような規約チェックはローカル環境で気が向いた時にやるだけではなく、継続的インテグレーションにも組み込んで実施することが望まれます。

PHP_CodeSnifferのインストール

特にチャンネルの追加は必要ありません。

pear install PHP_CodeSniffer

インストールが完了すると、phpcsコマンドがインストールされます。 また標準では、Squiz, PEAR, Zend, MySource, PSR1, PSR2 , PHPCS の7個の規約がインストールされます。このうちMySourceは自分でのカスタマイズ用です。

CakePHP用の規約を導入する

上記でインストールされた規約はどれもCakePHPの規約とは若干異なっています。 なので、cakephpが公式に用意している規約を入手して利用します。

こちらのインストールもpearコマンドを使えばOKです。

pear channel-discover pear.cakephp.org
pear install cakephp/CakePHP_CodeSniffer

これで準備が完了しました。

規約チェックを行う

手元にサンプルアプリケーションを用意して早速検証しましょう。 サンプルの構成は、2テーブルからなる単純なもので、その他にVendorディレクトリに外部モジュールが入っています。

phpcs --report=summary  --standard=CakePHP --extensions=php ./app

これで./app以下を対象にした概要レポートが出力されます。概要だけなのでレポートはシンプルです。

詳細を出力したい場合は、引数のreportをcheckstyleに変更します。あわせてファイルに結果を出力します。

phpcs --report=checkstyle --report-checkstyle=./reports/checkstyle.xml \
--extensions=php ./app

これでcheckstyle.xmlにXML形式で詳細が出力されるようになりました。

ただこのままだと自分が作ったコード以外もチェックされてしまい鬱陶しいことこの上ないので対象ファイルの設定をします。–ignoreオプションにカンマ区切りで指定が可能で正規表現も使えます。

phpcs --report=checkstyle --report-checkstyle=./reports/checkstyle.xml \
--extensions=php --ignore=Vendor/*,Plugin/* ./app

Jenkinsと連携する

Jenkinsで自動で実行するには、Checkstyle PluginをJenkinsにインストールした上で、上記のコマンドラインをビルドのところで設定することになります。

cd ${WORKSPACE} && phpcs --report=checkstyle \
--report-checkstyle=${WORKSPACE}/reports/checkstyle.xml \
--standard=CakePHP --extensions=php \
--ignore=Vendor/*,Plugin/* ./app || id

この時気をつけるのは、標準でphpcsコマンドは1つでも規約違反があると、終了コードでエラーを返すので、コマンドの最後に適当なコマンドをつけて、常に正常終了するように設定しておくことです。

また実行後に./reports/checkstyle.xmlが出力されるので、ビルド後のアクションの設定でCheckstyleの取り込みを選択し、このファイルを指定します。

以上で、設定は完了しました。 実行してみると、以下のように出力されます(左メニューからアクセス)。

で、問題のあった箇所は修正していけばよいでしょう。 件数の推移はプロジェクトのトップページで以下のように見ることができます。

以上で完了です。

まとめ

コーディング規約の準拠チェック等をやる場合に人手でやるのはあまりに非効率です。そもそも機械に任せたほうが正確に検証を行うことができます。そのため自動化して頻繁にチェックし、少なくとも規約違反を増やさないようにしていくと良いのではないかと思います。それによって本来時間をかけるべきところに時間をかけられるようになります。

ただし念のために言っておくと、コーディング規約を定めるべきだ、とか絶対守るべきだ、と言っているわけではないです。 あくまで規約があるのであれば、それは自動検証すべきということです。 このあたりはアプリケーションの規模、開発の規模、アプリケーションのライフサイクル等に依存します。

それでは。

  • スクラム実践者が知るべき97のこと
  • 著者/訳者:Gunther Verheyen / 吉羽龍太郎 原田騎郎 永瀬美穂
  • 出版社:オライリージャパン(2021-03-23)
  • 定価:¥ 2,640
  • スクラムはアジャイル開発のフレームワークですが、その実装は組織やチームのレベルに応じてさまざまです。本書はスクラムの実践において、さまざまな課題に対処してきた実践者が自らの経験や考え方を語るエッセイ集です。日本語書き下ろしコラムを追加で10本収録
  • プロダクトマネジメント ―ビルドトラップを避け顧客に価値を届ける
  • 著者/訳者:Melissa Perri / 吉羽龍太郎
  • 出版社:オライリージャパン(2020-10-26)
  • 定価:¥ 2,640
  • プロダクト開発を作った機能の数やベロシティなどのアウトプットで計測すると、ビルドトラップと呼ばれる失敗に繋がります。本書ではいかにしてビルドトラップを避けて顧客に価値を届けるかを解説しています。
  • SCRUM BOOT CAMP THE BOOK 【増補改訂版】
  • 著者/訳者:西村直人 永瀬美穂 吉羽龍太郎
  • 出版社:翔泳社(2020-05-20)
  • 定価:¥ 2,640
  • スクラム初心者に向けて基本的な考え方の解説から始まり、プロジェクトでの実際の進め方やよく起こる問題への対応法まで幅広く解説。マンガと文章のセットでスクラムを短期間で理解できます。スクラムの概要を正しく理解したい人、もう一度おさらいしたい人にオススメ。
  • みんなでアジャイル ―変化に対応できる顧客中心組織のつくりかた
  • 著者/訳者:Matt LeMay / 吉羽龍太郎、永瀬美穂、原田騎郎、有野雅士
  • 出版社:オライリージャパン(2020-3-19)
  • 定価:¥ 2,640
  • アジャイルで本当の意味での成果を出すには、開発チームだけでアジャイルに取り組むのではなく、組織全体がアジャイルになる必要があります。本書にはどうやってそれを実現するかのヒントが満載です
  • レガシーコードからの脱却 ―ソフトウェアの寿命を延ばし価値を高める9つのプラクティス
  • 著者/訳者:David Scott Bernstein / 吉羽龍太郎、永瀬美穂、原田騎郎、有野雅士
  • 出版社:オライリージャパン( 2019-9-18 )
  • 定価:¥ 3,132
  • レガシーコードになってから慌てるのではなく、日々レガシーコードを作らないようにするにはどうするか。その観点で、主にエクストリームプログラミングに由来する9つのプラクティスとその背後にある原則をわかりやすく説明しています。
  • Effective DevOps ―4本柱による持続可能な組織文化の育て方
  • 著者/訳者:Jennifer Davis、Ryn Daniels / 吉羽 龍太郎、長尾高弘
  • 出版社:オライリージャパン( 2018-3-24 )
  • 定価:¥ 3,888
  • 主にDevOpsの文化的な事柄に着目し、異なるゴールを持つチームが親和性を高め、矛盾する目標のバランスを取りながら最大限の力を発揮する方法を解説します
  • ジョイ・インク 役職も部署もない全員主役のマネジメント
  • 著者/訳者:リチャード・シェリダン / 原田騎郎, 安井力, 吉羽龍太郎, 永瀬美穂, 川口恭伸
  • 出版社:翔泳社( 2016-12-20 )
  • 定価:¥ 1,944
  • 米国で何度も働きやすい職場として表彰を受けているメンローの創業者かつCEOであるリチャード・シェリダン氏が、職場に喜びをもたらす知恵や経営手法、より良い製品の作り方などを惜しみなく紹介しています
  • アジャイルコーチの道具箱 – 見える化の実例集
  • 著者/訳者:Jimmy Janlén / 原田騎郎, 吉羽龍太郎, 川口恭伸, 高江洲睦, 佐藤竜也
  • 出版社:Leanpub( 2016-04-12 )
  • 定価:$14.99
  • この本は、チームの協調とコミュニケーションを改善したり、行動を変えるための見える化の実例を集めたものです。96個(+2)の見える化の方法をそれぞれ1ページでイラストとともに解説しています。アジャイル開発かどうかに関係なくすぐに使えるカタログ集です
  • カンバン仕事術 ―チームではじめる見える化と改善
  • 著者/訳者:原田騎郎 安井力 吉羽龍太郎 角征典 高木正弘
  • 出版社:オライリージャパン( 2016-03-25 )
  • 定価:¥ 2,138
  • チームの仕事や課題を見える化する手法「カンバン」について、その導入から実践までを図とともにわかりやすく解説した書籍。カンバンの原則などの入門的な事柄から、サービスクラス、プロセスの改善など、一歩進んだ応用的な話題までを網羅的に解説します。
  • Software in 30 Days スクラムによるアジャイルな組織変革“成功"ガイド
  • 著者/訳者:Ken Schwaber、Jeff Sutherland著、角征典、吉羽龍太郎、原田騎郎、川口恭伸訳
  • 出版社:アスキー・メディアワークス( 2013-03-08 )
  • 定価:¥ 1,680
  • スクラムの父であるジェフ・サザーランドとケン・シュエイバーによる著者の日本語版。ビジネス層、マネジメント層向けにソフトウェア開発プロセス変革の必要性やアジャイル型開発プロセスの優位性について説明
  • How to Change the World 〜チェンジ・マネジメント3.0〜
  • 著者/訳者:Jurgen Appelo, 前川哲次(翻訳), 川口恭伸(翻訳), 吉羽龍太郎(翻訳)
  • 出版社:達人出版会
  • 定価:500円
  • どうすれば自分たちの組織を変えられるだろう?それには、組織に変革を起こすチェンジ・マネジメントを学習することだ。アジャイルな組織でのマネージャーの役割を説いた『Management 3.0』の著者がコンパクトにまとめた変化のためのガイドブック