PSR2変換ツール

Sat, 09 Dec 2017 02:30:18 +0900

前回で説明したPHPのコーディングスタイルの基準PSR2、これをすべて覚えて手動で実行しようというのは到底無理なこと、そこで登場するのが、php-cs-fixer、自動でそれを行ってくれるツールです。

インストールはいたって簡単。

今回は、phanやphpunitとは違い、プロジェクトが使用しているLaravelやPHPのバージョンに合わせる必要はないので、プロジェクトごとではなくグローバルに、つまり自分のホームディレクトリでのインストールとします。

$ composer global require friendsofphp/php-cs-fixer

これを実行すると、いくつかの必要なパッケージがインストールされます。

そして、~/.composer/vendor/bin/php-cs-fixerにファイル（実際はシムリンク）が作成されます。

どこでもこれが実行できるように、.bahsrcに以下の設定を入れておくことを勧めます。

.bashrc

...
export PATH="$PATH:$HOME/.composer/vendor/bin"
...

実行も簡単。例えば、変換対象のファイルを、test.phpとすると、

$ php-cs-fixer fix test.php
Loaded config default.
Using cache file ".php_cs.cache".
   1) test.php

Fixed all files in 0.193 seconds, 10.000 MB memory used

test.phpが、デフォルトのルールで、PSR1とPSR2に基づいて変換されます。

以下は、前回の例のファイルを崩したものです。

<?php

namespace Vendor\Package;
use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class Foo extends Bar implements FooInterface {

    protected $a, $b, $c;

    public function sampleMethod( $a,$b = null )
    {
        if ( $a === $b )
		{
            bar();
        }
		elseif ($a > $b)
		{
            $foo->bar($arg1);
        }
		else
		{
            BazClass::bar($arg2,$arg3);
        }
    }
}
?>

これをphp-cs-fixerで修正すると、前回のように

<?php

namespace Vendor\Package;

use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class Foo extends Bar implements FooInterface
{
    protected $a;
    protected $b;
    protected $c;

    public function sampleMethod($a, $b = null)
    {
        if ($a === $b) {
            bar();
        } elseif ($a > $b) {
            $foo->bar($arg1);
        } else {
            BazClass::bar($arg2, $arg3);
        }
    }
}

となります。

php-cs-fixerの実行では、.php_cs.cacheのファイルが作成されます。この中には、使用されたJSON設定が収められています。バージョン管理には要らないファイルなので、.gitignoreなどに含むようにしてください。

さて、php-cs-fixerを使用してLaravelのプロジェクト全体をPSR2準拠に変換します。Laravelのプロジェクトにはいろいろなディレクトリがあるために、変換必要なファイルだけを指定する必要があります。そのためには以下のような設定ファイル.php_csが必要です。

.php_cs

<?php

$finder = PhpCsFixer\Finder::create()
    ->exclude('bootstrap/cache')
    ->exclude('storage')
    ->exclude('vendor')
    ->in(__DIR__)
    ->name('*.php')
    ->notName('*.blade.php')
    ->ignoreDotFiles(true)
    ->ignoreVCS(true)
;

return PhpCsFixer\Config::create()
    ->setRules(array(
        '@PSR2' => true,
    ))
    ->setFinder($finder)
;

設定ファイル自体がphpのプログラムです。そこで見られるように、bootstrap/cache, storage, vendorのディレクトリ以外のphpファイルはすべてPSR2準拠に変換してくれます。しかし、bladeのファイルはphpファイルでないゆえに変換しません。

このファイルを、Laravelプロジェクトのルートディレクトリに置きます、そして変換は、そこで以下の実行だけです。

$ php-cs-fixer fix

変換前に、gitのブランチをこのために作成しておいてから実行してください。例えば、新ブランチをpsr2と命名して、変換後に差分をチェックしたいなら、

$ git diff master -w

と実行すれば、タブからスペースへの変更以外の変更をチェックできます。

最後に、このツールの作者は、有名なphpフレームワーク、symfonyのフレームワークの作者でもあります。Laravelのライブラリの一部はsymfonyのを利用しています。

PSR2

Fri, 08 Dec 2017 02:15:25 +0900

PHP5.6からPHP7.0へ移行したところで、クライアントのプロジェクトもLaravel5.2からLaravel5.5へのアップグレードが必要と思う最近。

というのは、Laravel5.5は、LTS(Long Term Support)のバージョンであり、長期サポートということで2年間続くからです。Laravelは、現在ほぼ1年に2回にメジャーなバージョンアップをします。あるバージョンでは前バージョンと異なる部分が大きいこともあり、現実的には変更や検証の作業が大変で毎回毎回はとても。ということで、Laravel5.5に移行したら当分はバージョンアップはマイナーだけで済むのではないかという考えです。

しかし、この検討中に、私らが開発で使用しているコーディングスタイルがLaravelのそれとは違うことに気づきました。一番大きい違いは、私らはインデントにタブ文字を使用していますが、現在のLaravelは、タブの代わりに空白文字（スペース）の使用です。なんと、Laravel5.1からすでにそうなっていたらしい。

調べてみると、Laravelは、PSR2というコーディングスタイルを現在採用しています。PSRは、PHP Standard Recommendationの略で、PHPのお勧めの標準という意味。標準にもいろいろなレベルがあって、コーディングスタイルのスタンダードだけでなく、ローディング、ログ、キャッシュなどいろいろなスタンダードがあります。

参照：http://www.php-fig.org/psr

さて、Laravelが使用しているPSR2は、

http://www.php-fig.org/psr/psr-2/

で詳しく説明されていますが、

要は、複数のプログラマが同じプロジェクトで開発を行うときに、コードの読みやすさのためのコーディングの規則ということです。

取り決めの例としては、

インデントには、タブではなく4文字のスペース文字を使用する。
namespaceの宣言の後には空行を１行入れる。useの宣言のブロックの後にも空行１行を入れる。
クラスの定義の括弧は、 class Foo { ... } でなく、 Class Foo { ... } である。
条件文(if, switch)やループ文(for, foreach)の括弧は、 if (true) { ... } else { ... } でなく、 if (true) { ... } else { ... } である。
PHPの定数、true, false, nullは必ず小文字

などなど、変数名に関しての規則も含み結構たくさんあります。

PSR2準拠のサンプルとして以下が表示されています。

<?php
namespace Vendor\Package;

use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class Foo extends Bar implements FooInterface
{
    public function sampleMethod($a, $b = null)
    {
        if ($a === $b) {
            bar();
        } elseif ($a > $b) {
            $foo->bar($arg1);
        } else {
            BazClass::bar($arg2, $arg3);
        }
    }

    final public static function bar()
    {
        // method body
    }
}

私は、昔からタブ派でなので、ここに来てスペース（空白）派になることには抵抗あります。また、bitbucketやgithubのサイトでコードが表示されるときにタブだと上下で揃わなくなったりとマイナスな面にも気づいていました。しかし、sublimeのようなエディターは特別に指定しなくても既存のインデントに合わせてくれるし、コーディングにおいてはタブからスペースへの変換はそう問題ないだろうと、PSRの標準に移行することに決めました。

決めたところで、問題は、現行のプログラムをどうすべてPSR2のコーディングスタイルに変換するか。次回の課題です。

PSR on ララジャパン

PSR2変換ツール

PSR2