PHPKitchen\CodeSpecsCore\Expectation\Internal\ObjectExceptionMatcher

Complexity

Total Complexity

4

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	withMessageMatchesPattern()	0	4	1
A	withMessage()	0	3	1
A	when()	0	2	1
A	withCode()	0	3	1

<?php

namespace PHPKitchen\CodeSpecsCore\Expectation\Internal;

use PHPKitchen\CodeSpecsCore\Expectation\Matcher\Base\Matcher;

/**
 * ExceptionMatcher is designed to check that object throws valid exception.
 * This matcher being used in pair with {@link ObjectMatcher}.
 *
 * @property \Exception $actual
 *
 * @package PHPKitchen\CodeSpecsCore\Expectation
 * @author Dmitry Kolodko <prowwid@gmail.com>
 */
class ObjectExceptionMatcher extends Matcher {
    public function withMessage($message) {
        $this->startStep('has message "' . $message . '"')->expectExceptionMessage($message);
        return $this;
    }

    public function withMessageMatchesPattern($messagePattern) {
        $this->startStep('has message matching pattern "' . $messagePattern . '"')
            ->expectExceptionMessage($messagePattern);
        return $this;
    }

    public function withCode($code) {
        $this->startStep('has code "' . $code . '"')->expectExceptionCode($code);
        return $this;
    }

    /**
     * Identifies a situation when exception should be raised.
     * Supposed to executes method of the object.
     * This methods should to be used after {@link throwsException} and "with*" methods to gain expression like:
     * <pre>
     * $I->seeObject($a)->throwsException(Exception::class)->when(function($object) {$object->doParty();});
     * // or
     * $I->seeObject($a)->throwsException(IronyException::class)->withCode(500)->when(function($object) {$object->doParty();});
     * <pre/>
     * and finish scenario.
     */
    public function when(callable $callback) {
        call_user_func_array($callback, [$this->getActualValue()]);
    }
}