Issues in FactoryTest.php - All Issues - 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

phpDocumentor/Transformer/Template/FactoryTest.php (4 issues)

Labels

Bug 4

Severity

Major 4

Mike van Riel 4

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @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\Transformer\Template;

use JMS\Serializer\Serializer;
use Mockery as m;
use org\bovigo\vfs\vfsStream;
use phpDocumentor\Transformer\Template;

class FactoryTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
{
    /** @var m\MockInterface|PathResolver */
    private $pathResolverMock;

    /** @var m\MockInterface|Serializer */
    private $serializerMock;

    /** @var Factory */
    private $fixture;

    /**
     * Sets up the fixture with mocked dependencies.
     */
    protected function setUp()
    {
        $this->pathResolverMock = m::mock('phpDocumentor\Transformer\Template\PathResolver');
        $this->serializerMock = m::mock('JMS\Serializer\Serializer');

        $this->fixture = new Factory($this->pathResolverMock, $this->serializerMock);
    }

    /**
     * @covers phpDocumentor\Transformer\Template\Factory::__construct
     */
    public function testIfDependenciesAreCorrectlyRegisteredOnInitialization()
    {
        $this->assertAttributeSame($this->pathResolverMock, 'pathResolver', $this->fixture);
        $this->assertAttributeSame($this->serializerMock, 'serializer', $this->fixture);
    }

    /**
     * @covers phpDocumentor\Transformer\Template\Factory::get
     * @covers phpDocumentor\Transformer\Template\Factory::fetchTemplateXmlFromPath
     * @covers phpDocumentor\Transformer\Template\Factory::createTemplateFromXml
     */
    public function testRetrieveInstantiatedTemplate()
    {
        // Arrange
        $templateName = 'clean';
        $template = new Template($templateName);
        vfsStream::setup('exampleDir')->addChild(vfsStream::newFile('template.xml')->setContent('xml'));
        $this->pathResolverMock->shouldReceive('resolve')->with($templateName)->andReturn(vfsStream::url('exampleDir'));
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.
}
        $this->serializerMock
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.
}
            ->shouldReceive('deserialize')
            ->with('xml', 'phpDocumentor\Transformer\Template', 'xml')
            ->andReturn($template);

        // Act
        $result = $this->fixture->get($templateName);

        // Assert
        $this->assertSame($template, $result);
    }

    /**
     * @covers phpDocumentor\Transformer\Template\Factory::getTemplatePath
     */
    public function testReturnTemplatePathFromResolver()
    {
        // Arrange
        $expected = 'test';
        $this->pathResolverMock->shouldReceive('getTemplatePath')->andReturn($expected);
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.
}

        // Act
        $result = $this->fixture->getTemplatePath();

        // Assert
        $this->assertSame($expected, $result);
    }

    /**
     * @covers phpDocumentor\Transformer\Template\Factory::getAllNames
     */
    public function testRetrieveAllTemplateNames()
    {
        // Arrange
        $expected = ['template1', 'template2'];
        $root = vfsStream::setup('exampleDir');
        $root->addChild(vfsStream::newDirectory($expected[0]));
        $root->addChild(vfsStream::newFile('aFile.txt'));
        $root->addChild(vfsStream::newDirectory($expected[1]));
        $this->pathResolverMock->shouldReceive('getTemplatePath')->andReturn(vfsStream::url('exampleDir'));
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.
}

        // Act
        $result = $this->fixture->getAllNames();

        // Assert
        $this->assertSame($expected, $result);
    }
}


1			<?php
2			/**
3			* phpDocumentor
4			*
5			* PHP Version 5.3
6			*
7			* @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
8			* @license http://www.opensource.org/licenses/mit-license.php MIT
9			* @link http://phpdoc.org
10			*/
11
12			namespace phpDocumentor\Transformer\Template;
13
14			use JMS\Serializer\Serializer;
15			use Mockery as m;
16			use org\bovigo\vfs\vfsStream;
17			use phpDocumentor\Transformer\Template;
18
19			class FactoryTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
20			{
21			/** @var m\MockInterface\|PathResolver */
22			private $pathResolverMock;
23
24			/** @var m\MockInterface\|Serializer */
25			private $serializerMock;
26
27			/** @var Factory */
28			private $fixture;
29
30			/**
31			* Sets up the fixture with mocked dependencies.
32			*/
33			protected function setUp()
34			{
35			$this->pathResolverMock = m::mock('phpDocumentor\Transformer\Template\PathResolver');
36			$this->serializerMock = m::mock('JMS\Serializer\Serializer');
37
38			$this->fixture = new Factory($this->pathResolverMock, $this->serializerMock);
39			}
40
41			/**
42			* @covers phpDocumentor\Transformer\Template\Factory::__construct
43			*/
44			public function testIfDependenciesAreCorrectlyRegisteredOnInitialization()
45			{
46			$this->assertAttributeSame($this->pathResolverMock, 'pathResolver', $this->fixture);
47			$this->assertAttributeSame($this->serializerMock, 'serializer', $this->fixture);
48			}
49
50			/**
51			* @covers phpDocumentor\Transformer\Template\Factory::get
52			* @covers phpDocumentor\Transformer\Template\Factory::fetchTemplateXmlFromPath
53			* @covers phpDocumentor\Transformer\Template\Factory::createTemplateFromXml
54			*/
55			public function testRetrieveInstantiatedTemplate()
56			{
57			// Arrange
58			$templateName = 'clean';
59			$template = new Template($templateName);
60			vfsStream::setup('exampleDir')->addChild(vfsStream::newFile('template.xml')->setContent('xml'));
61			$this->pathResolverMock->shouldReceive('resolve')->with($templateName)->andReturn(vfsStream::url('exampleDir'));
			0 ignored issues – show Bug introduced 2016-10-31 17:09 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `shouldReceive` does only exist in `Mockery\MockInterface`, but not in `phpDocumentor\Transformer\Template\PathResolver`. 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...
62			$this->serializerMock
			0 ignored issues – show Bug introduced 2015-12-02 21:15 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `shouldReceive` does only exist in `Mockery\MockInterface`, but not in `JMS\Serializer\Serializer`. 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...
63			->shouldReceive('deserialize')
64			->with('xml', 'phpDocumentor\Transformer\Template', 'xml')
65			->andReturn($template);
66
67			// Act
68			$result = $this->fixture->get($templateName);
69
70			// Assert
71			$this->assertSame($template, $result);
72			}
73
74			/**
75			* @covers phpDocumentor\Transformer\Template\Factory::getTemplatePath
76			*/
77			public function testReturnTemplatePathFromResolver()
78			{
79			// Arrange
80			$expected = 'test';
81			$this->pathResolverMock->shouldReceive('getTemplatePath')->andReturn($expected);
			0 ignored issues – show Bug introduced 2016-10-31 17:09 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `shouldReceive` does only exist in `Mockery\MockInterface`, but not in `phpDocumentor\Transformer\Template\PathResolver`. 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...
82
83			// Act
84			$result = $this->fixture->getTemplatePath();
85
86			// Assert
87			$this->assertSame($expected, $result);
88			}
89
90			/**
91			* @covers phpDocumentor\Transformer\Template\Factory::getAllNames
92			*/
93			public function testRetrieveAllTemplateNames()
94			{
95			// Arrange
96			$expected = ['template1', 'template2'];
97			$root = vfsStream::setup('exampleDir');
98			$root->addChild(vfsStream::newDirectory($expected[0]));
99			$root->addChild(vfsStream::newFile('aFile.txt'));
100			$root->addChild(vfsStream::newDirectory($expected[1]));
101			$this->pathResolverMock->shouldReceive('getTemplatePath')->andReturn(vfsStream::url('exampleDir'));
			0 ignored issues – show Bug introduced 2016-10-31 17:09 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `shouldReceive` does only exist in `Mockery\MockInterface`, but not in `phpDocumentor\Transformer\Template\PathResolver`. 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...
102
103			// Act
104			$result = $this->fixture->getAllNames();
105
106			// Assert
107			$this->assertSame($expected, $result);
108			}
109			}
110

phpDocumentor / phpDocumentor

Push — develop ( 8eb671...133594 )

phpDocumentor/Transformer/Template/FactoryTest.php (4 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like