BEAR.Package 1.10をリリースしました。

新しいインジェクターにより開発時のパフォーマンスが大幅に改善し、コンパイラはより最適化されたautoload.phpやpreload.phpを出力します。 最新の Ray.Aop/Di/Compilerはオンデマンドコンパイルの耐障害性が向上しました。

用意された新しいスケルトン BEAR.Skeleton 1.8はハイパーメディアとHTTPテストが追加され、より厳しいQAツールの設定に変更されました。

後方互換性

マイナーバージョンアップなので後方互換性は維持されます。@deprecatedとマークされたクラスも引き続き使用可能で将来の廃止も予定にありません。

BEAR.Injector

インジェクターが改善され開発時に高速になりました。特に連続してインジェクターを使うテストで顕著です。

シンプルになりました。ルートオブジェクトを取得するBootstrap、アプリケーションが扱う任意の依存を取得するAppInjector が統合されBEAR.Injector (BEAR\Package\Injector)になりました。

最適化され開発時にはコンパイルを行わないRay.Di Injector、プロダクションの時には従来と同じくPHPスクリプトをコンパイルするScriptInjectorとコンテキストに応じたインジェクターが用意されます。 インジェクターはシングルトンで管理され、リクエストが異なる場合も再利用され高速です。開発時のパフォーマンスが大幅にアップします。

複数のアプリケーションや複数のコンテキストのインジェクターは同一メモリ空間で共存できます。”admin”アプリで保存した記事を”client”アプリで確認するテストが連続して行えます。

$appInjecot = Injector::getInstance('app');
$htmlInjector =  Injector::getInstance('html-app');

リクエストの度にDIコンテナの再初期化を行ません。リクエストを連続して行うユニットテストのパフォーマンスが大幅に向上します。各インスタンスはシングルトン管理されるので、連続したテストでDB接続が枯渇することもありません。

従来のBootstrap、AppInjector から新しいインジェクターに移行するガイドを用意しています。

http://bearsunday.github.io/manuals/1.0/ja/upgrade/injector.html

コンパイラ

コンパイラが改善され、autoload.php、preloadがより正確に出力されオブジェクトグラフの描画出力(module.dot)も行われます。

ファイルの上書きに気が付くように(overwritten)の表示が行われるようになりました。 コンテントネゴシエーションを行う場合など(ex. api-app, html-app)1つのアプリケーションで複数コンテキストのコンパイルを行うときにはファイルの退避が必要です。

$ mv autoload.php api.autoload.php

prodキャッシュの変更

prodコンテキストのキャッシュを従来のapc + fileのチェーンキャッシュから、PhpFileCacheに変更しました。速度はやや劣りますが、取り扱いが簡単になります 。PhpFileCacheはファイルとして保存されるキャッシュなので/tmp/を消せばキャッシュを消すことができます。(opcache.validate_timestamps=0の場合） 一方PHPスクリプトなのでOPCodeにキャッシュされ、(opcache.validate_timestamps=1にした）プロダクションでファイルアクセスを無しにすることができます。

キャッシュクリア

新しいインジェクターでは、以前までのsrcのタイムスタンプをキャッシュキーに含める方法は廃止されました。これは元々、コンパイル環境とプロダクション環境が同一なことを前提として、APCのクリアもwebサーバーの再起動無しに行う、tmp削除の権限のないユーザーなどの理由で設置されたものですが、prodキャッシュの変更により単純に開発時はtmp/を消去するというのがキャッシュクリアの方法になります。

BEAR.Resource

BEAR.Resource 1.14.3 以降、ResourceObjectでdeclare(strict_types=1);を宣言してもstring以外もタイプできます。

public function onGet(int $num = 0)
{

BEAR.Skeletonの変更

新しいBEAR.PakcageのInjectorに対応したスケルトンを用意しました。加えてQAやテストのテンプレートを強化しました。

新しいテストスイート

新しいスケルトンは従来のリソースCRUDテストのテンプレートに加えて、ハイパーメディアとHTTPテストのテンプレートを付加しています。ハイパーメディアテストにはリンクを辿ったテストを記述することでユーザーのワークフローを表すことができます。

ハイパーメディアのテストを継承したHTTPテストはハイパーメディアのテストを継承することでほとんど記述をする必要がありません。PHPビルトインサーバーがテスト実行中にのみ立ち上げられられます。そのテストの結果はログフォルダにcurlのリクエストとレスポンスとして記録されます。この記録は実際にHttpResourceCleintで実行されたもので、複雑なクエリーやレスポンスの確認を仕様書以上に具体的なものとして確認することができます。クライアントサイドとサーバーサイドエンジニアのコミニケーションロスを減らす事ができるかもしれません。

QAの変更

  • 従来のbootstrapスクリプトからBootstrapクラスに変更しました。
  • phpmd.xmlをより厳しい値をデフォルトとして設定しました。
  • php-cs-fixerを外しdoctrine/conding-standardをベースとしてsquizlabs/php_codesniffer(phpcs)のみにしました。PSR12が適用されます。
  • phpstan / psalmをより厳しいデフォルトにしました。
  • pcovを使ったcoverageレポートを出力するcomposer pcovをcomposer.jsonに追加しました。
  • 静的解析を行うcomposer qaを追加しました。

新しいphpcsのルールは単にシンタックスだけでなく、if文内の変数アサインや、ループ中のcount実行などコーディングスタンダードが避けるべきと考えるプラクティスもエラーとしてレポートします。

array shapes記法

Index.phpのサンプルを以下のように変更しました。

  • strict_types=1に
  • bodyの配列を型を表すarray shapes記法(Object-like arrays)に。
  • return typeをstaticに
<?php

declare(strict_types=1);

namespace BEAR\Skeleton\Resource\Page;

use BEAR\Resource\ResourceObject;

class Index extends ResourceObject
{
    /** @var array{greeting: string} */
    public $body;

    /** @return static */
    public function onGet(string $name = 'BEAR.Sunday')
    {
        $this->body = [
            'greeting' => 'Hello ' . $name,
        ];

        return $this;
    }
}

return staticはPHP8で採用予定です。従来のResourceObjectリターンタイプより正確です。

array-shapeはネイティブのPHPは理解しませんが、qaツール(phpstan/psalm)は理解し、配列キーのアクセスを検査し間違っていればエラーとして報告します。PhpStorm + deep-assoc-completion klesunでは配列キーの補完もされます。

既存のプロジェクトに新しい記法や新しいQA設定値を適用するかしないかは完全にユーザーの自由です。QAツールとBEAR.Packageに密結合はありません。コーディングルールだけなど、部分的に適用することもできます。

マニュアル更新