FileAssemblerTest::getProjectDescriptorBuilderMock() - Code Metrics - Inspection of "Delete Scrybe" - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 8eb671...133594 )

by Mike

created 2019-06-14 08:00 UTC

getProjectDescriptorBuilderMock() A

↳ Parent: FileAssemblerTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	22
rs	9.568
c	0
b	0
f	0

<?php
/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @author    Mike van Riel <[email protected]>
 * @author    Sven Hagemann <[email protected]>
 * @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Descriptor\Builder\Reflector;

use Mockery as m;
use phpDocumentor\Descriptor\Collection;
use phpDocumentor\Descriptor\PackageDescriptor;

use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\Php\File;

/**
 * Test class for \phpDocumentor\Descriptor\Builder
 *
 * @covers \phpDocumentor\Descriptor\Builder\Reflector\FileAssembler
 */
class FileAssemblerTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
{
    /** @var FileAssembler $fixture */
    protected $fixture;

    /** @var PackageDescriptor */
    private $defaultPackage;

    /**
     * Creates a new fixture to test with.
     */
    protected function setUp()
    {
        $this->fixture = new FileAssembler();
        $this->fixture->setBuilder($this->getProjectDescriptorBuilderMock());
        $this->defaultPackage = new PackageDescriptor();
        $this->defaultPackage->setName('\\PhpDocumentor');
    }

    /**
     * Creates a Descriptor from a provided class.
     */
    public function testCreateFileDescriptorFromReflector()
    {
        $filename = 'file.php';
        $content = '<?php ... ?>';
        $hash = md5($content);

        $abstractDescriptor = m::mock('phpDocumentor\Descriptor\DescriptorAbstract');
        $abstractDescriptor->shouldReceive('getLineNumber')->andReturn(1337);
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.
}

        $docBlockDescription = new DocBlock\Description(
            <<<DOCBLOCK
            /**
             * This is a example description
             */
DOCBLOCK
        );

        $docBlockMock = new DocBlock('This is a example description', $docBlockDescription);

        $fileReflectorMock = new File($hash, $filename, $content, $docBlockMock);
//        $fileReflectorMock->shouldReceive('getConstants')->once()->andReturn(

//            new Collection(array($abstractDescriptor))
//        );
//
//        $fileReflectorMock->shouldReceive('getFunctions')->once()->andReturn(
//            new Collection(array($abstractDescriptor))
//        );
//
//        $fileReflectorMock->shouldReceive('getClasses')->once()->andReturn(
//            new Collection(array($abstractDescriptor))
//        );
//
//        $fileReflectorMock->shouldReceive('getInterfaces')->once()->andReturn(
//            new Collection(array($abstractDescriptor))
//        );
//
//        $fileReflectorMock->shouldReceive('getTraits')->once()->andReturn(
//            new Collection(array($abstractDescriptor))
//        );
//
//        $fileReflectorMock->shouldReceive('getMarkers')->once()->andReturn(
//            array('type', 'message', 1337)
//        );
//
//        $fileReflectorMock->shouldReceive('getIncludes')->andReturn(new Collection);
//        $fileReflectorMock->shouldReceive('getNamespaceAliases')->andReturn(new Collection);

        $descriptor = $this->fixture->create($fileReflectorMock);

        $this->assertSame($filename, $descriptor->getName());
        $this->assertSame($hash, $descriptor->getHash());
        $this->assertSame($content, $descriptor->getSource());
        //TODO: check this when we are testing default package behavoir
        //$this->assertSame($this->defaultPackage, $descriptor->getPackage());

    }

    /**
     * Create a descriptor builder mock
     *
     * @return m\MockInterface
     */
    protected function getProjectDescriptorBuilderMock()
    {
        $projectDescriptorBuilderMock = m::mock('phpDocumentor\Descriptor\ProjectDescriptorBuilder');
        $projectDescriptorBuilderMock->shouldReceive('getDefaultPackage')
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.
}
            ->andReturn($this->defaultPackage);

        $projectDescriptorBuilderMock->shouldReceive(
            'getProjectDescriptor->getSettings->shouldIncludeSource'
        )->andReturn(true);
        $projectDescriptorBuilderMock->shouldReceive('buildDescriptor')->andReturnUsing(function ($param) {

            $mock = m::mock('phpDocumentor\Descriptor\DescriptorAbstract');
            $mock->shouldReceive('setLocation')->atLeast()->once();
            $mock->shouldReceive('getTags')->atLeast()->once()->andReturn(new Collection());
            $mock->shouldReceive('getFullyQualifiedStructuralElementName')
                ->once()
                ->andReturn('Frank_is_een_eindbaas');

            return $mock;
        });

        return $projectDescriptorBuilderMock;
    }
}


Push — develop ( 8eb671...133594 )

getProjectDescriptorBuilderMock() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2			/**
3			* phpDocumentor
4			*
5			* PHP Version 5.3
6			*
7			* @author Mike van Riel <[email protected]>
8			* @author Sven Hagemann <[email protected]>
9			* @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
10			* @license http://www.opensource.org/licenses/mit-license.php MIT
11			* @link http://phpdoc.org
12			*/
13
14			namespace phpDocumentor\Descriptor\Builder\Reflector;
15
16			use Mockery as m;
17			use phpDocumentor\Descriptor\Collection;
18			use phpDocumentor\Descriptor\PackageDescriptor;
19
20			use phpDocumentor\Reflection\DocBlock;
21			use phpDocumentor\Reflection\Php\File;
22
23			/**
24			* Test class for \phpDocumentor\Descriptor\Builder
25			*
26			* @covers \phpDocumentor\Descriptor\Builder\Reflector\FileAssembler
27			*/
28			class FileAssemblerTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
29			{
30			/** @var FileAssembler $fixture */
31			protected $fixture;
32
33			/** @var PackageDescriptor */
34			private $defaultPackage;
35
36			/**
37			* Creates a new fixture to test with.
38			*/
39			protected function setUp()
40			{
41			$this->fixture = new FileAssembler();
42			$this->fixture->setBuilder($this->getProjectDescriptorBuilderMock());
43			$this->defaultPackage = new PackageDescriptor();
44			$this->defaultPackage->setName('\\PhpDocumentor');
45			}
46
47			/**
48			* Creates a Descriptor from a provided class.
49			*/
50			public function testCreateFileDescriptorFromReflector()
51			{
52			$filename = 'file.php';
53			$content = '<?php ... ?>';
54			$hash = md5($content);
55
56			$abstractDescriptor = m::mock('phpDocumentor\Descriptor\DescriptorAbstract');
57			$abstractDescriptor->shouldReceive('getLineNumber')->andReturn(1337);
			0 ignored issues – show Bug introduced 2017-10-10 14:32 UTC by Report Bug Copy Issue Report The method `andReturn` does only exist in `Mockery\ExpectationInterface`, but not in `Mockery\HigherOrderMessage`. 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...
58
59			$docBlockDescription = new DocBlock\Description(
60			<<<DOCBLOCK
61			/**
62			* This is a example description
63			*/
64			DOCBLOCK
65			);
66
67			$docBlockMock = new DocBlock('This is a example description', $docBlockDescription);
68
69			$fileReflectorMock = new File($hash, $filename, $content, $docBlockMock);
70			// $fileReflectorMock->shouldReceive('getConstants')->once()->andReturn(
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-08-11 12:47 UTC by Report Bug Copy Issue Report `62%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
71			// new Collection(array($abstractDescriptor))
72			// );
73			//
74			// $fileReflectorMock->shouldReceive('getFunctions')->once()->andReturn(
75			// new Collection(array($abstractDescriptor))
76			// );
77			//
78			// $fileReflectorMock->shouldReceive('getClasses')->once()->andReturn(
79			// new Collection(array($abstractDescriptor))
80			// );
81			//
82			// $fileReflectorMock->shouldReceive('getInterfaces')->once()->andReturn(
83			// new Collection(array($abstractDescriptor))
84			// );
85			//
86			// $fileReflectorMock->shouldReceive('getTraits')->once()->andReturn(
87			// new Collection(array($abstractDescriptor))
88			// );
89			//
90			// $fileReflectorMock->shouldReceive('getMarkers')->once()->andReturn(
91			// array('type', 'message', 1337)
92			// );
93			//
94			// $fileReflectorMock->shouldReceive('getIncludes')->andReturn(new Collection);
95			// $fileReflectorMock->shouldReceive('getNamespaceAliases')->andReturn(new Collection);
96
97			$descriptor = $this->fixture->create($fileReflectorMock);
98
99			$this->assertSame($filename, $descriptor->getName());
100			$this->assertSame($hash, $descriptor->getHash());
101			$this->assertSame($content, $descriptor->getSource());
102			//TODO: check this when we are testing default package behavoir
103			//$this->assertSame($this->defaultPackage, $descriptor->getPackage());
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-11 13:44 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
104			}
105
106			/**
107			* Create a descriptor builder mock
108			*
109			* @return m\MockInterface
110			*/
111			protected function getProjectDescriptorBuilderMock()
112			{
113			$projectDescriptorBuilderMock = m::mock('phpDocumentor\Descriptor\ProjectDescriptorBuilder');
114			$projectDescriptorBuilderMock->shouldReceive('getDefaultPackage')
			0 ignored issues – show Bug introduced 2019-03-14 17:21 UTC by Report Bug Copy Issue Report The method `andReturn` does only exist in `Mockery\ExpectationInterface`, but not in `Mockery\HigherOrderMessage`. 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...
115			->andReturn($this->defaultPackage);
116
117			$projectDescriptorBuilderMock->shouldReceive(
118			'getProjectDescriptor->getSettings->shouldIncludeSource'
119			)->andReturn(true);
120			$projectDescriptorBuilderMock->shouldReceive('buildDescriptor')->andReturnUsing(function ($param) {
			0 ignored issues – show Unused Code introduced 2015-12-02 21:15 UTC by Report Bug Copy Issue Report The parameter `$param` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
121			$mock = m::mock('phpDocumentor\Descriptor\DescriptorAbstract');
122			$mock->shouldReceive('setLocation')->atLeast()->once();
123			$mock->shouldReceive('getTags')->atLeast()->once()->andReturn(new Collection());
124			$mock->shouldReceive('getFullyQualifiedStructuralElementName')
125			->once()
126			->andReturn('Frank_is_een_eindbaas');
127
128			return $mock;
129			});
130
131			return $projectDescriptorBuilderMock;
132			}
133			}
134

phpDocumentor / phpDocumentor

Push — develop ( 8eb671...133594 )

getProjectDescriptorBuilderMock() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like