phpDocumentor\Configuration\ProvideTemplateOverridePathMiddlewareTest

Complexity

Total Complexity

3

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	test_the_override_path_is_a_subfolder_of_the_folder_with_the_loaded_config_file()	0	12	1
A	test_the_override_path_is_a_subfolder_of_cwd_when_there_is_no_loaded_config_file()	0	14	1
A	test_the_override_path_is_not_set_when_override_folder_does_not_exist()	0	11	1

<?php

declare(strict_types=1);

/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @link http://phpdoc.org
 */

namespace phpDocumentor\Configuration;

use League\Uri\Uri;
use phpDocumentor\Path;
use phpDocumentor\Transformer\Writer\Twig\EnvironmentFactory;
use PHPUnit\Framework\TestCase;
use function chdir;
use function dirname;
use function realpath;

final class ProvideTemplateOverridePathMiddlewareTest extends TestCase
{
    public function test_the_override_path_is_a_subfolder_of_the_folder_with_the_loaded_config_file() : void
    {
        // Cannot use vfsStream because code breaks out of virtual filesystems to support PHAR file.
        $configurationFilePath = __DIR__ . '/../../../../phpdoc.dist.xml';
        $overridePath = new Path(realpath(dirname($configurationFilePath) . '/.phpdoc/template'));

        $environmentFactory = $this->prophesize(EnvironmentFactory::class);
        $environmentFactory->withTemplateOverridesAt($overridePath)->shouldBeCalledOnce();

        $middleware = new ProvideTemplateOverridePathMiddleware($environmentFactory->reveal());
        $middleware->__invoke([], Uri::createFromString($configurationFilePath));
    }

    public function test_the_override_path_is_a_subfolder_of_cwd_when_there_is_no_loaded_config_file() : void
    {
        // Cannot use vfsStream because code breaks out of virtual filesystems to support PHAR file; so we chdir into
        // this project's folder. We know there is a .phpdoc/template folder there
        $folderContainingAPhpDocMetaFolder = __DIR__ . '/../../../..';
        chdir($folderContainingAPhpDocMetaFolder);
        $overridePath = new Path(realpath($folderContainingAPhpDocMetaFolder . '/.phpdoc/template'));

        $environmentFactory = $this->prophesize(EnvironmentFactory::class);
        $environmentFactory->withTemplateOverridesAt($overridePath)->shouldBeCalledOnce();

        $middleware = new ProvideTemplateOverridePathMiddleware($environmentFactory->reveal());
        $middleware->__invoke([], null);
    }

    public function test_the_override_path_is_not_set_when_override_folder_does_not_exist() : void
    {
        // This is obviously a fake, this folder does not have a config file
        $configurationFilePath = __DIR__ . '/phpdoc.dist.xml';

        $environmentFactory = $this->prophesize(EnvironmentFactory::class);
        $environmentFactory->withTemplateOverridesAt()->shouldNotBeCalled();

        $middleware = new ProvideTemplateOverridePathMiddleware($environmentFactory->reveal());
        $middleware->__invoke([], Uri::createFromString($configurationFilePath));
    }
}