RemoveSourcecodeTest::testRemovesSourceWhenDisabled() - Code Metrics - Inspection of "Merge pull request #2919 from phpDocumentor/fix/in..." - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bb645e...4d0389 )

by Jaap

created 2021-06-04 15:40 UTC

testRemovesSourceWhenDisabled() A

↳ Parent: RemoveSourcecodeTest

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0

<?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();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $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();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $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();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $projecDescriptor->setFiles(
            DescriptorCollection::fromClassString(
                DocumentationSetDescriptor::class,
                [$this->faker()->fileDescriptor()]
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            )
        );

        $versionDesciptor = $this->faker()->versionDescriptor([$apiDescriptor]);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $projecDescriptor->getVersions()->add($versionDesciptor);

        return $projecDescriptor;
    }

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

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


Push — master ( bb645e...4d0389 )

testRemovesSourceWhenDisabled() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* This file is part of phpDocumentor.
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*
11			* @link https://phpdoc.org
12			*/
13
14			namespace phpDocumentor\Compiler\Pass;
15
16			use phpDocumentor\Descriptor\ApiSetDescriptor;
17			use phpDocumentor\Descriptor\Collection as DescriptorCollection;
18			use phpDocumentor\Descriptor\DocumentationSetDescriptor;
19			use phpDocumentor\Descriptor\ProjectDescriptor;
20			use phpDocumentor\Faker\Faker;
21			use PHPUnit\Framework\TestCase;
22			use Prophecy\PhpUnit\ProphecyTrait;
23
24			/**
25			* @coversDefaultClass \phpDocumentor\Compiler\Pass\RemoveSourcecode
26			* @covers ::<private>
27			*/
28			final class RemoveSourcecodeTest extends TestCase
29			{
30			use Faker;
31			use ProphecyTrait;
32
33			/**
34			* @covers ::execute
35			*/
36			public function testRemovesSourceWhenDisabled() : void
37			{
38			$apiSetDescriptor = $this->faker()->apiSetDescriptor();
			0 ignored issues – show Bug introduced 2021-04-02 10:09 UTC by Report Bug Copy Issue Report The method `apiSetDescriptor` does only exist in `phpDocumentor\Faker\Provider`, but not in `Faker\Generator`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
39			$projectDescriptor = $this->giveProjectDescriptor($apiSetDescriptor);
40			$fixture = new RemoveSourcecode();
41
42			$fixture->execute($projectDescriptor);
43
44			foreach ($projectDescriptor->getFiles() as $file) {
45			self::assertNull($file->getSource());
46			}
47			}
48
49			/**
50			* @covers ::execute
51			*/
52			public function testRemovesSourceWhenSourceShouldBeIncluded() : void
53			{
54			$apiSetDescriptor = $this->faker()->apiSetDescriptor();
			0 ignored issues – show Bug introduced 2021-04-03 09:16 UTC by Report Bug Copy Issue Report The method `apiSetDescriptor` does only exist in `phpDocumentor\Faker\Provider`, but not in `Faker\Generator`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
55			$apiSetDescriptor->getSettings()['include-source'] = true;
56			$projectDescriptor = $this->giveProjectDescriptor($apiSetDescriptor);
57			$fixture = new RemoveSourcecode();
58
59			$fixture->execute($projectDescriptor);
60
61			foreach ($projectDescriptor->getFiles() as $file) {
62			self::assertNotNull($file->getSource());
63			}
64			}
65
66			private function giveProjectDescriptor(ApiSetDescriptor $apiDescriptor) : ProjectDescriptor
67			{
68			$projecDescriptor = $this->faker()->projectDescriptor();
			0 ignored issues – show Bug introduced 2021-06-04 15:18 UTC by Report Bug Copy Issue Report The method `projectDescriptor` does only exist in `phpDocumentor\Faker\Provider`, but not in `Faker\Generator`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
69			$projecDescriptor->setFiles(
70			DescriptorCollection::fromClassString(
71			DocumentationSetDescriptor::class,
72			[$this->faker()->fileDescriptor()]
			0 ignored issues – show Bug introduced 2021-06-04 15:18 UTC by Report Bug Copy Issue Report The method `fileDescriptor` does only exist in `phpDocumentor\Faker\Provider`, but not in `Faker\Generator`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
73			)
74			);
75
76			$versionDesciptor = $this->faker()->versionDescriptor([$apiDescriptor]);
			0 ignored issues – show Bug introduced 2021-06-04 15:18 UTC by Report Bug Copy Issue Report The method `versionDescriptor` does only exist in `phpDocumentor\Faker\Provider`, but not in `Faker\Generator`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
77			$projecDescriptor->getVersions()->add($versionDesciptor);
78
79			return $projecDescriptor;
80			}
81
82			/**
83			* @covers ::getDescription
84			*/
85			public function testGetDescription() : void
86			{
87			$pass = new RemoveSourcecode();
88
89			self::assertSame('Removing sourcecode from file descriptors', $pass->getDescription());
90			}
91			}
92

phpDocumentor / phpDocumentor

Push — master ( bb645e...4d0389 )

testRemovesSourceWhenDisabled() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like