phpDocumentor\Compiler\Pass\RemoveSourcecodeTest

Complexity

Total Complexity

6

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	testRemovesSourceWhenDisabled()	0	12	2
A	testRemovesSourceWhenSourceShouldBeIncluded()	0	13	2
A	giveProjectDescriptor()	0	15	1
A	testGetDescription()	0	6	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 https://phpdoc.org
 */

namespace phpDocumentor\Compiler\Pass;

use phpDocumentor\Descriptor\ApiSetDescriptor;
use phpDocumentor\Descriptor\Collection as DescriptorCollection;
use phpDocumentor\Descriptor\DocumentationSetDescriptor;
use phpDocumentor\Descriptor\ProjectDescriptor;
use phpDocumentor\Faker\Faker;
use PHPUnit\Framework\TestCase;
use Prophecy\PhpUnit\ProphecyTrait;

/**
 * @coversDefaultClass \phpDocumentor\Compiler\Pass\RemoveSourcecode
 * @covers ::<private>
 */
final class RemoveSourcecodeTest extends TestCase
{
    use Faker;
    use ProphecyTrait;

    /**
     * @covers ::execute
     */
    public function testRemovesSourceWhenDisabled() : void
    {
        $apiSetDescriptor = $this->faker()->apiSetDescriptor();

The method apiSetDescriptor does only exist in phpDocumentor\Faker\Provider, but not in Faker\Generator.

        $projectDescriptor = $this->giveProjectDescriptor($apiSetDescriptor);
        $fixture = new RemoveSourcecode();

        $fixture->execute($projectDescriptor);

        foreach ($projectDescriptor->getFiles() as $file) {
            self::assertNull($file->getSource());
        }
    }

    /**
     * @covers ::execute
     */
    public function testRemovesSourceWhenSourceShouldBeIncluded() : void
    {
        $apiSetDescriptor = $this->faker()->apiSetDescriptor();

The method apiSetDescriptor does only exist in phpDocumentor\Faker\Provider, but not in Faker\Generator.

        $apiSetDescriptor->getSettings()['include-source'] = true;
        $projectDescriptor = $this->giveProjectDescriptor($apiSetDescriptor);
        $fixture = new RemoveSourcecode();

        $fixture->execute($projectDescriptor);

        foreach ($projectDescriptor->getFiles() as $file) {
            self::assertNotNull($file->getSource());
        }
    }

    private function giveProjectDescriptor(ApiSetDescriptor $apiDescriptor) : ProjectDescriptor
    {
        $projecDescriptor = $this->faker()->projectDescriptor();

The method projectDescriptor does only exist in phpDocumentor\Faker\Provider, but not in Faker\Generator.

        $projecDescriptor->setFiles(
            DescriptorCollection::fromClassString(
                DocumentationSetDescriptor::class,
                [$this->faker()->fileDescriptor()]

The method fileDescriptor does only exist in phpDocumentor\Faker\Provider, but not in Faker\Generator.

            )
        );

        $versionDesciptor = $this->faker()->versionDescriptor([$apiDescriptor]);

The method versionDescriptor does only exist in phpDocumentor\Faker\Provider, but not in Faker\Generator.

        $projecDescriptor->getVersions()->add($versionDesciptor);

        return $projecDescriptor;
    }

    /**
     * @covers ::getDescription
     */
    public function testGetDescription() : void
    {
        $pass = new RemoveSourcecode();

        self::assertSame('Removing sourcecode from file descriptors', $pass->getDescription());
    }
}