新しいアプリケーションを開発するにあたり、監査証跡を記録するロギングシステム が必要となりました。 既存のオープンソースのロガーライブラリを調べてみたところ、 要件を満たすライブラリが見つからないようです。 そこで要件を満たすライブラリを自前で作成することにしました。 実際に作成しはじめる前に、まずその要件をはっきりさせなければなりません。 言いかえれば、そのライブラリがどのように振る舞ってほしいのかをはっきりさせるということです。 他のメンバーと相談した結果、まず最低限の基本機能が確定しました。 それは、メッセージをファイルシステムに記録するということです。

さっさとエディタを立ち上げてコードを書きはじめたい気持ちはわかりますが、 まずは仕様 を書くことからはじめましょう。

New Filesystem Logger:
(新しいファイルシステムロガー)
- should create a new log file if none currently exists
  (は、ログファイルが存在しない場合は新規ファイルを作成しなければならない)
- should use an existing log file if one exists without truncating it
  (は、ログファイルが存在する場合は、既存の内容を残したままそのファイルを使用しなければならない)
- should throw Exception if existing log file not writeable
  (は、ログファイルに書き込めない場合には例外をスローしなければならない)

このシンプルなプレーンテキストの仕様を PHPSpec 形式に変換するには、 新しいコンテキストクラスを作成して その振る舞いを表すサンプルを定義します。

class DescribeNewFilesystemLogger extends PHPSpec_Context
{

    public function itShouldCreateCreateNewLogFileIfNoneExists()
    {
        $this->pending();
    }

    public function itShouldUseAnExistingLogFileIfOneExistsWithoutTruncatingIt()
    {
        $this->pending();
    }

    public function itShouldThrowExceptionIfExistingLogFileNotWriteable()
    {
        $this->pending();
    }

}

この雛形クラスでは、未確定の (pending) サンプルが定義されています。 未確定とは、まだ完成していないなどの状態を意味します。 このスペックを NewFilesystemLoggerSpec.php というファイル (もうひとつのファイル命名規約を用います。先頭の "Describe" を省略して最後に "Spec" を付加します) に保存してコマンドラインから実行すると、その出力は次のようになります。

PPP

Finished in 0.0468921661377 seconds

3 examples, 0 failures, 3 pending

PHPSpec を実行する際のコマンドラインは次のようになります。

phpspec NewFileSystemLoggerSpec

先ほど定義した仕様にもとづいて、 これらのサンプルメソッドの中身を作成していきましょう。

class DescribeNewFilesystemLogger extends PHPSpec_Context
{

    public function itShouldCreateCreateNewLogFileIfNoneExists()
    {
        $file = $this->getTmpFileName();
        $logger = new Logger($file);
        $this->spec(file_exists($file))->should->beTrue();
    }

    public function itShouldUseAnExistingLogFileIfOneExistsWithoutTruncatingIt()
    {
        $file = $this->getTmpFileName();
        file_put_contents($file, 'Hello' . "\n");
        $logger = new Logger($file);
        $this->spec(file_get_contents($file))->shouldNot->beEmpty();
    }

    public function itShouldThrowExceptionIfExistingLogFileNotWriteable()
    {
        $file = $this->getTmpFileName();
        file_put_contents($file, 'Hello' . "\n");
        $this->spec('Logger', $file)->should->throw('Exception');
    }

    public function after()
    {
        unlink($this->getTmpFileName());
    }

    public function getTmpFileName()
    {
        return sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'logger_tmp_file.log';
    }

}

これで、最初にプレーンテキストで定義したスペックを実行可能なコードサンプルに落とすことができました。 もちろん、今これを実行しても単に Fatal Error となるだけでしょう。 まだ Logger クラスが存在しないわけですから。 この続きは、また後ほど。

class Logger
{

    protected $_file = null;

    public function __construct($file)
    {
        if (!file_exists($file)) {
            $f = fopen($file, 'w');
            fclose($f);
        } elseif (file_exists($file) && is_writeable($file)) {
            $this->_file = $file;
        } else {
            throw new Exception('ログファイルに書き込めません'); 
        }
    }

}