FactoryTest::testRetrieveInstantiatedTemplate() - Code Metrics - Inspection of "Fix style and stan issues" - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 373768...b82813 )

by Mike

created 2019-06-15 19:04 UTC

FactoryTest::testRetrieveInstantiatedTemplate() B

↳ Parent: FactoryTest

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	61
rs	8.8509
c	0
b	0
f	0

How to fix Long Method

<?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 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 Factory */
    private $fixture;

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

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

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

    /**
     * @covers phpDocumentor\Transformer\Template\Factory::get
     * @covers phpDocumentor\Transformer\Template\Factory::fetchTemplateXmlFromPath
     * @covers phpDocumentor\Transformer\Template\Factory::createTemplateFromXml
     * @todo test parameters in template and transformations
     */
    public function testRetrieveInstantiatedTemplate()
    {
        // Arrange
        $templateName = 'clean';
        $xml = <<<'XML'
<?xml version="1.0" encoding="utf-8"?>
<template>
  <name>clean</name>
  <author>Mike van Riel</author>
  <email>[email protected]</email>
  <version>1.0.0</version>
  <copyright>Mike van Riel 2013</copyright>
  <description><![CDATA[This is the description]]></description>
  <transformations>
    <transformation query="copy" writer="FileIo" source="templates/clean/htaccess.dist" artifact=".htaccess"/>
    <transformation query="copy" writer="FileIo" source="templates/clean/images" artifact="images"/>
    <transformation query="copy" writer="FileIo" source="templates/clean/css" artifact="css"/>
    <transformation query="copy" writer="FileIo" source="templates/clean/js" artifact="js"/>
    <transformation query="copy" writer="FileIo" source="templates/clean/font" artifact="font"/>
    <transformation writer="twig" query="namespace" source="templates/clean/namespace.html.twig" artifact="index.html"/>
    <transformation writer="twig" query="indexes.namespaces" source="templates/clean/namespace.html.twig" />
    <transformation writer="twig" query="indexes.classes" source="templates/clean/class.html.twig" />
    <transformation writer="twig" query="indexes.interfaces" source="templates/clean/interface.html.twig" />
    <transformation writer="twig" query="indexes.traits" source="templates/clean/class.html.twig" />
    <transformation writer="twig" query="files" source="templates/clean/file.html.twig" />
    <transformation 
        writer="twig" 
        query="files" 
        source="templates/clean/file.source.txt.twig" 
        artifact="files/{{path}}.txt"
    />
    <transformation writer="twig" source="templates/clean/reports/markers.html.twig" artifact="reports/markers.html"/>
    <transformation writer="twig" source="templates/clean/reports/errors.html.twig" artifact="reports/errors.html"/>
    <transformation 
        writer="twig" 
        source="templates/clean/reports/deprecated.html.twig" 
        artifact="reports/deprecated.html"
    />
    <transformation writer="twig" source="templates/clean/graphs/class.html.twig" artifact="graphs/class.html"/>
    <transformation writer="Graph" source="Class" artifact="graphs/classes.svg" />
  </transformations>
</template>
XML;
        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.
}

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

        // Assert
        $this->assertSame($templateName, $result->getName());
        $this->assertSame('Mike van Riel <[email protected]>', $result->getAuthor());
        $this->assertSame('1.0.0', $result->getVersion());
        $this->assertSame('Mike van Riel 2013', $result->getCopyright());
        $this->assertSame('This is the description', $result->getDescription());
        $this->assertSame(17, $result->count());
        $this->assertSame('copy', $result[0]->getQuery());
        $this->assertSame('FileIo', $result[0]->getWriter());
        $this->assertSame('templates/clean/htaccess.dist', $result[0]->getSource());
        $this->assertSame('.htaccess', $result[0]->getArtifact());
    }

    /**
     * @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);
    }
}


Push — develop ( 373768...b82813 )

FactoryTest::testRetrieveInstantiatedTemplate() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Available Fixes

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 Mockery as m;
15			use org\bovigo\vfs\vfsStream;
16			use phpDocumentor\Transformer\Template;
17
18			class FactoryTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
19			{
20			/** @var m\MockInterface\|PathResolver */
21			private $pathResolverMock;
22
23			/** @var Factory */
24			private $fixture;
25
26			/**
27			* Sets up the fixture with mocked dependencies.
28			*/
29			protected function setUp()
30			{
31			$this->pathResolverMock = m::mock('phpDocumentor\Transformer\Template\PathResolver');
32
33			$this->fixture = new Factory($this->pathResolverMock);
34			}
35
36			/**
37			* @covers phpDocumentor\Transformer\Template\Factory::__construct
38			*/
39			public function testIfDependenciesAreCorrectlyRegisteredOnInitialization()
40			{
41			$this->assertAttributeSame($this->pathResolverMock, 'pathResolver', $this->fixture);
42			}
43
44			/**
45			* @covers phpDocumentor\Transformer\Template\Factory::get
46			* @covers phpDocumentor\Transformer\Template\Factory::fetchTemplateXmlFromPath
47			* @covers phpDocumentor\Transformer\Template\Factory::createTemplateFromXml
48			* @todo test parameters in template and transformations
49			*/
50			public function testRetrieveInstantiatedTemplate()
51			{
52			// Arrange
53			$templateName = 'clean';
54			$xml = <<<'XML'
55			<?xml version="1.0" encoding="utf-8"?>
56			<template>
57			<name>clean</name>
58			<author>Mike van Riel</author>
59			<email>[email protected]</email>
60			<version>1.0.0</version>
61			<copyright>Mike van Riel 2013</copyright>
62			<description><![CDATA[This is the description]]></description>
63			<transformations>
64			<transformation query="copy" writer="FileIo" source="templates/clean/htaccess.dist" artifact=".htaccess"/>
65			<transformation query="copy" writer="FileIo" source="templates/clean/images" artifact="images"/>
66			<transformation query="copy" writer="FileIo" source="templates/clean/css" artifact="css"/>
67			<transformation query="copy" writer="FileIo" source="templates/clean/js" artifact="js"/>
68			<transformation query="copy" writer="FileIo" source="templates/clean/font" artifact="font"/>
69			<transformation writer="twig" query="namespace" source="templates/clean/namespace.html.twig" artifact="index.html"/>
70			<transformation writer="twig" query="indexes.namespaces" source="templates/clean/namespace.html.twig" />
71			<transformation writer="twig" query="indexes.classes" source="templates/clean/class.html.twig" />
72			<transformation writer="twig" query="indexes.interfaces" source="templates/clean/interface.html.twig" />
73			<transformation writer="twig" query="indexes.traits" source="templates/clean/class.html.twig" />
74			<transformation writer="twig" query="files" source="templates/clean/file.html.twig" />
75			<transformation
76			writer="twig"
77			query="files"
78			source="templates/clean/file.source.txt.twig"
79			artifact="files/{{path}}.txt"
80			/>
81			<transformation writer="twig" source="templates/clean/reports/markers.html.twig" artifact="reports/markers.html"/>
82			<transformation writer="twig" source="templates/clean/reports/errors.html.twig" artifact="reports/errors.html"/>
83			<transformation
84			writer="twig"
85			source="templates/clean/reports/deprecated.html.twig"
86			artifact="reports/deprecated.html"
87			/>
88			<transformation writer="twig" source="templates/clean/graphs/class.html.twig" artifact="graphs/class.html"/>
89			<transformation writer="Graph" source="Class" artifact="graphs/classes.svg" />
90			</transformations>
91			</template>
92			XML;
93			vfsStream::setup('exampleDir')->addChild(vfsStream::newFile('template.xml')->setContent($xml));
94			$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 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...
95
96			// Act
97			$result = $this->fixture->get($templateName);
98
99			// Assert
100			$this->assertSame($templateName, $result->getName());
101			$this->assertSame('Mike van Riel <[email protected]>', $result->getAuthor());
102			$this->assertSame('1.0.0', $result->getVersion());
103			$this->assertSame('Mike van Riel 2013', $result->getCopyright());
104			$this->assertSame('This is the description', $result->getDescription());
105			$this->assertSame(17, $result->count());
106			$this->assertSame('copy', $result[0]->getQuery());
107			$this->assertSame('FileIo', $result[0]->getWriter());
108			$this->assertSame('templates/clean/htaccess.dist', $result[0]->getSource());
109			$this->assertSame('.htaccess', $result[0]->getArtifact());
110			}
111
112			/**
113			* @covers phpDocumentor\Transformer\Template\Factory::getTemplatePath
114			*/
115			public function testReturnTemplatePathFromResolver()
116			{
117			// Arrange
118			$expected = 'test';
119			$this->pathResolverMock->shouldReceive('getTemplatePath')->andReturn($expected);
			0 ignored issues – show Bug introduced 2016-10-31 17:09 UTC by Report Bug Copy Issue Report 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...
120
121			// Act
122			$result = $this->fixture->getTemplatePath();
123
124			// Assert
125			$this->assertSame($expected, $result);
126			}
127
128			/**
129			* @covers phpDocumentor\Transformer\Template\Factory::getAllNames
130			*/
131			public function testRetrieveAllTemplateNames()
132			{
133			// Arrange
134			$expected = ['template1', 'template2'];
135			$root = vfsStream::setup('exampleDir');
136			$root->addChild(vfsStream::newDirectory($expected[0]));
137			$root->addChild(vfsStream::newFile('aFile.txt'));
138			$root->addChild(vfsStream::newDirectory($expected[1]));
139			$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 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...
140
141			// Act
142			$result = $this->fixture->getAllNames();
143
144			// Assert
145			$this->assertSame($expected, $result);
146			}
147			}
148

phpDocumentor / phpDocumentor

Push — develop ( 373768...b82813 )

FactoryTest::testRetrieveInstantiatedTemplate() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like