Codeception\Util\ExpectationAnnotationParser

Complexity

Total Complexity

9

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	getExpectations()	0	9	2
A	getExpectationFullPath()	0	6	2
A	parseExpectation()	0	17	3

<?php


namespace Codeception\Util;


use Codeception\Configuration;
use Codeception\Exception\ParseException;
use Codeception\Test\Cest;
use Codeception\TestInterface;

class ExpectationAnnotationParser
{
    const DEFAULT_EXPECTATIONS_PATH = "tests/_unique_expectations/";
    const PATH_CONFIG_KEY = 'unique_expectations_path';
    /**
     * @var array
     */
    private $config;

    /**
     * ExpectationAnnotationParser constructor.
     *
     * @param array $config
     *
     * @throws \Codeception\Exception\ConfigurationException
     */
    public function __construct($config = [])
    {
        if(empty($config)){
            $config = Configuration::config();
        }
        $this->config = $config;
    }


    /**
     * @param TestInterface|Cest $test
     *
     * @return array
     */
    public function getExpectations(TestInterface $test)
    {
        if(!$test instanceof Cest){
            return [];
        }
        $expectations = Annotation::forMethod($test->getTestClass(), $test->getTestMethod())->fetchAll('expectation');

        return array_map([$this, 'parseExpectation'], $expectations);
    }

    /**
     * @param       $expectationsPath
     * @param array $matches

There is no parameter named $matches. Was it maybe removed?

     *
     * @return string
     */
    function getExpectationFullPath($path)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $expectationsPath = isset($this->config['paths'][self::PATH_CONFIG_KEY]) ? $this->config['paths'][self::PATH_CONFIG_KEY] : self::DEFAULT_EXPECTATIONS_PATH;

        return codecept_root_dir($expectationsPath . $path);
    }

    /**
     * @param $expectation
     *
     * @return string
     * @throws ParseException
     */
    public function parseExpectation($expectation)
    {
        $matches = [];
        $expectationRegex = '/\(?\"?(?<filePath>[a-zA-Z0-9_]+)(.json)?\"?\)?/';
        preg_match($expectationRegex, $expectation, $matches);

        if (empty($matches)) {
            throw new ParseException("The 'expectation' annotation could not be parsed (found: '$expectation')");
        }

        $expectationPath = $this->getExpectationFullPath("{$matches['filePath']}.json");
        if(!file_exists($expectationPath)){
            throw new ParseException("The expectation at $expectationPath could not be found ");
        }

        return $expectationPath;
    }
}