Passed
Pull Request — master (#3)
by Mariano
01:24
created

ExpectationAnnotationParser::getExpectations()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 2
eloc 4
c 1
b 0
f 0
nc 2
nop 1
dl 0
loc 8
rs 10
1
<?php
2
3
namespace Mcustiel\Phiremock\Codeception\Util;
4
5
use Codeception\Exception\ParseException;
6
use Codeception\Test\Cest;
7
use Codeception\TestInterface;
8
use Codeception\Util\Annotation;
9
10
class ExpectationAnnotationParser
11
{
12
    /** @var array */
13
    private $expectationsPath;
14
15
    public function __construct(string $expectationsPath)
16
    {
17
        $this->expectationsPath = $expectationsPath;
0 ignored issues
show
Documentation Bug introduced by
It seems like $expectationsPath of type string is incompatible with the declared type array of property $expectationsPath.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
18
    }
19
20
    /**
21
     * @param TestInterface|Cest $test
22
     *
23
     * @return array
24
     * @throws ParseException
25
     */
26
    public function getExpectations(TestInterface $test): array
27
    {
28
        if (!$test instanceof Cest) {
29
            return [];
30
        }
31
        $expectations = Annotation::forMethod($test->getTestClass(), $test->getTestMethod())->fetchAll('expectation');
32
33
        return array_map([$this, 'parseExpectation'], $expectations);
34
    }
35
36
    /** @throws ParseException */
37
    public function parseExpectation(string $expectationAnnotation): string
38
    {
39
        $matches = [];
40
        $expectationRegex = '/\(?\"?(?<filePath>[a-zA-Z0-9_\\/]+)(.json)?\"?\)?/';
41
        preg_match($expectationRegex, $expectationAnnotation, $matches);
42
43
        if (empty($matches)) {
44
            throw new ParseException("The 'expectation' annotation could not be parsed (found: '$expectationAnnotation')");
45
        }
46
47
        $expectationPath = $this->getExpectationFullPath("{$matches['filePath']}.json");
48
        if (!file_exists($expectationPath)) {
49
            throw new ParseException("The expectation at $expectationPath could not be found ");
50
        }
51
52
        return $expectationPath;
53
    }
54
55
    private function getExpectationFullPath($path): string
56
    {
57
        return sprintf('%s/%s', $this->expectationsPath, $path);
0 ignored issues
show
Bug introduced by
$this->expectationsPath of type array is incompatible with the type string expected by parameter $args of sprintf(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

57
        return sprintf('%s/%s', /** @scrutinizer ignore-type */ $this->expectationsPath, $path);
Loading history...
58
    }
59
}
60