FrontRenderTest::testSetLexer() - Code Metrics - Inspection of "Feature/add tests" - christophe-chausseray/front-render-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

by Christophe

created 2016-01-07 12:35 UTC

FrontRenderTest::testSetLexer() B

↳ Parent: FrontRenderTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	24
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	2

Metric	Value
c	2
b	0
f	2
dl	0
loc	24
rs	8.9714
cc	1
eloc	12
nc	1
nop	2

<?php

namespace Chris\Bundle\FrontRenderBundle\Tests\Render;

use Chris\Bundle\FrontRenderBundle\Listener\TwigListener;
use Chris\Bundle\FrontRenderBundle\Render\FrontRender;
use InvalidArgumentException;
use Symfony\Bundle\TwigBundle\TwigEngine;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Templating\TemplateNameParser;
use Twig_Error_Syntax;

class FrontRenderTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var string TEMPLATE
     */
    const TEMPLATE = 'index.html.twig';

    /**
     * @var string FAILED_TEMPLATE
     */
    const FAILED_TEMPLATE = 'failed.html.twig';

    /**
     * @var string FAILED_PATH
     */
    const FAILED_PATH = 'failedPath.html.twig';

    /**
     * @var EventDispatcher $eventDispatcher
     */
    protected $eventDispatcher;

    /**
     * @var \Twig_Loader_Filesystem $twigLoader
     */
    protected $twigLoader;

    /**
     * @var \Twig_Environment $twigEnvironment
     */
    protected $twigEnvironment;

    /**
     * @var TwigListener $twigListener
     */
    protected $twigListener;

    /**
     * @var TemplateNameParser $templateNameParser
     */
    protected $templateNameParser;

    /**
     * @var FileLocator $fileLocator
     */
    protected $fileLocator;

    /**
     * @var TwigEngine $engine
     */
    protected $engine;

    /**
     * @var FrontRender $frontRender
     */
    protected $frontRender;

    /**
     * Set up the front render test
     */
    public function setUp()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        parent::setUp();

        $this->eventDispatcher = \Phake::mock(EventDispatcher::class);

        $this->twigLoader      = \Phake::partialMock(\Twig_Loader_Filesystem::class, [$_SERVER['KERNEL_DIR'] . 'Tests/Template']);

        $this->twigEnvironment = \Phake::partialMock(\Twig_Environment::class, $this->twigLoader);

        $this->twigListener    = \Phake::partialMock(TwigListener::class, $this->twigEnvironment);


        $this->templateNameParser = \Phake::mock(TemplateNameParser::class);

        $this->fileLocator        = \Phake::mock(FileLocator::class);

        $this->engine             = \Phake::partialMock(TwigEngine::class, $this->twigEnvironment, $this->templateNameParser, $this->fileLocator);


        $lexer = $this->twigListener->getLexer();

        $this->twigEnvironment->setLexer($lexer);

    }

    /**
     * Test render of the template with parameter
     */
    public function testTemplateRenderWithParameter()

    {
        $this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, self::TEMPLATE);

        $this->frontRender->setParameters(
            [
                'applicationName' => 'Test Render',
            ]
        );

        $response = new Response($this->frontRender->render());

        $this->assertContains(
            'Welcome on Test Render',
            $response->getContent()
        );
    }

    /**
     * Test render of the template without parameter
     */
    public function testTemplateRenderWithoutParameter()

    {
        $this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, self::TEMPLATE);

        $response = new Response($this->frontRender->render());

        $this->assertNotContains(
            'Test Render',
            $response->getContent()
        );
    }

    /**
     * Test on the update of lexer
     *
     * @dataProvider lexerTags
     *
     * @param $oldTags
     * @param $newTags
     */
    public function testSetLexer($oldTags, $newTags)
    {
        $this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, self::TEMPLATE);

        $this->frontRender->setParameters(
            [
                'applicationName' => 'Test Render',
            ]
        );

        $response = new Response($this->frontRender->render());

        $this->assertEquals(200, $response->getStatusCode());

        $this->assertContains(
            $oldTags,
            $response->getContent()
        );

        $this->assertNotContains(
            $newTags,
            $response->getContent()
        );
    }

    /**
     * Test on the failed template
     *
     * @expectedException Twig_Error_Syntax
     */
    public function testExceptionOnSyntax()
    {
        $this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, self::FAILED_TEMPLATE);

        $this->frontRender->render();
    }

    /**
     * Test when the template doesn't exist
     *
     * @expectedException InvalidArgumentException
     */
    public function testExceptionOnFailedPath()
    {
        $this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, self::FAILED_PATH);

        $this->frontRender->render();
    }

    /**
     * Test when the template path is empty
     *
     * @expectedException Chris\Bundle\FrontRenderBundle\Exception\FrontRenderException
     */
    public function testExceptionOnEmptyPath()
    {
        $this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, '');

        $this->frontRender->render();
    }

    /**
     * Provide the lexer tags
     * 
     * @return array
     */
    public function lexerTags()
    {
        return [
            ['{#', '{*'],
            ['{%', '{@'],
            ['{{', '{\$']
        ];

    }


}


1		<?php
2
3		namespace Chris\Bundle\FrontRenderBundle\Tests\Render;
4
5		use Chris\Bundle\FrontRenderBundle\Listener\TwigListener;
6		use Chris\Bundle\FrontRenderBundle\Render\FrontRender;
7		use InvalidArgumentException;
8		use Symfony\Bundle\TwigBundle\TwigEngine;
9		use Symfony\Component\Config\FileLocator;
10		use Symfony\Component\EventDispatcher\EventDispatcher;
11		use Symfony\Component\HttpFoundation\Response;
12		use Symfony\Component\Templating\TemplateNameParser;
13		use Twig_Error_Syntax;
14
15		class FrontRenderTest extends \PHPUnit_Framework_TestCase
16		{
17		/**
18		* @var string TEMPLATE
19		*/
20		const TEMPLATE = 'index.html.twig';
21
22		/**
23		* @var string FAILED_TEMPLATE
24		*/
25		const FAILED_TEMPLATE = 'failed.html.twig';
26
27		/**
28		* @var string FAILED_PATH
29		*/
30		const FAILED_PATH = 'failedPath.html.twig';
31
32		/**
33		* @var EventDispatcher $eventDispatcher
34		*/
35		protected $eventDispatcher;
36
37		/**
38		* @var \Twig_Loader_Filesystem $twigLoader
39		*/
40		protected $twigLoader;
41
42		/**
43		* @var \Twig_Environment $twigEnvironment
44		*/
45		protected $twigEnvironment;
46
47		/**
48		* @var TwigListener $twigListener
49		*/
50		protected $twigListener;
51
52		/**
53		* @var TemplateNameParser $templateNameParser
54		*/
55		protected $templateNameParser;
56
57		/**
58		* @var FileLocator $fileLocator
59		*/
60		protected $fileLocator;
61
62		/**
63		* @var TwigEngine $engine
64		*/
65		protected $engine;
66
67		/**
68		* @var FrontRender $frontRender
69		*/
70		protected $frontRender;
71
72		/**
73		* Set up the front render test
74		*/
75		public function setUp()
		0 ignored issues – show Coding Style introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report `setUp` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
76		{
77		parent::setUp();
78
79		$this->eventDispatcher = \Phake::mock(EventDispatcher::class);
		0 ignored issues – show Documentation Bug introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report It seems like `\Phake::mock(\Symfony\Co...EventDispatcher::class)` of type `object<Phake_IMock>` is incompatible with the declared type `object<Symfony\Component...atcher\EventDispatcher>` of property `$eventDispatcher`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
80		$this->twigLoader = \Phake::partialMock(\Twig_Loader_Filesystem::class, [$_SERVER['KERNEL_DIR'] . 'Tests/Template']);
		0 ignored issues – show Documentation Bug introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report It seems like `\Phake::partialMock(\Twi...'] . 'Tests/Template'))` of type `object<Phake_IMock>` is incompatible with the declared type `object<Twig_Loader_Filesystem>` of property `$twigLoader`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
81		$this->twigEnvironment = \Phake::partialMock(\Twig_Environment::class, $this->twigLoader);
		0 ignored issues – show Documentation Bug introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report It seems like `\Phake::partialMock(\Twi...ass, $this->twigLoader)` of type `object<Phake_IMock>` is incompatible with the declared type `object<Twig_Environment>` of property `$twigEnvironment`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
82		$this->twigListener = \Phake::partialMock(TwigListener::class, $this->twigEnvironment);
		0 ignored issues – show Documentation Bug introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report It seems like `\Phake::partialMock(\Chr...$this->twigEnvironment)` of type `object<Phake_IMock>` is incompatible with the declared type `object<Chris\Bundle\Fron...\Listener\TwigListener>` of property `$twigListener`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
83
84		$this->templateNameParser = \Phake::mock(TemplateNameParser::class);
		0 ignored issues – show Documentation Bug introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report It seems like `\Phake::mock(\Symfony\Co...plateNameParser::class)` of type `object<Phake_IMock>` is incompatible with the declared type `object<Symfony\Component...ing\TemplateNameParser>` of property `$templateNameParser`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
85		$this->fileLocator = \Phake::mock(FileLocator::class);
		0 ignored issues – show Documentation Bug introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report It seems like `\Phake::mock(\Symfony\Co...fig\FileLocator::class)` of type `object<Phake_IMock>` is incompatible with the declared type `object<Symfony\Component\Config\FileLocator>` of property `$fileLocator`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
86		$this->engine = \Phake::partialMock(TwigEngine::class, $this->twigEnvironment, $this->templateNameParser, $this->fileLocator);
		0 ignored issues – show Documentation Bug introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report It seems like `\Phake::partialMock(\Sym...er, $this->fileLocator)` of type `object<Phake_IMock>` is incompatible with the declared type `object<Symfony\Bundle\TwigBundle\TwigEngine>` of property `$engine`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
87
88		$lexer = $this->twigListener->getLexer();
		0 ignored issues – show Bug introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report The method `getLexer()` does not seem to exist on `object<Phake_IMock>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
89		$this->twigEnvironment->setLexer($lexer);
		0 ignored issues – show Bug introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report The method `setLexer()` does not seem to exist on `object<Phake_IMock>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
90		}
91
92		/**
93		* Test render of the template with parameter
94		*/
95	View Code Duplication	public function testTemplateRenderWithParameter()
		0 ignored issues – show Duplication introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
96		{
97		$this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, self::TEMPLATE);
98
99		$this->frontRender->setParameters(
100		[
101		'applicationName' => 'Test Render',
102		]
103		);
104
105		$response = new Response($this->frontRender->render());
106
107		$this->assertContains(
108		'Welcome on Test Render',
109		$response->getContent()
110		);
111		}
112
113		/**
114		* Test render of the template without parameter
115		*/
116	View Code Duplication	public function testTemplateRenderWithoutParameter()
		0 ignored issues – show Duplication introduced 2016-01-07 12:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
117		{
118		$this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, self::TEMPLATE);
119
120		$response = new Response($this->frontRender->render());
121
122		$this->assertNotContains(
123		'Test Render',
124		$response->getContent()
125		);
126		}
127
128		/**
129		* Test on the update of lexer
130		*
131		* @dataProvider lexerTags
132		*
133		* @param $oldTags
134		* @param $newTags
135		*/
136		public function testSetLexer($oldTags, $newTags)
137		{
138		$this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, self::TEMPLATE);
139
140		$this->frontRender->setParameters(
141		[
142		'applicationName' => 'Test Render',
143		]
144		);
145
146		$response = new Response($this->frontRender->render());
147
148		$this->assertEquals(200, $response->getStatusCode());
149
150		$this->assertContains(
151		$oldTags,
152		$response->getContent()
153		);
154
155		$this->assertNotContains(
156		$newTags,
157		$response->getContent()
158		);
159		}
160
161		/**
162		* Test on the failed template
163		*
164		* @expectedException Twig_Error_Syntax
165		*/
166		public function testExceptionOnSyntax()
167		{
168		$this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, self::FAILED_TEMPLATE);
169
170		$this->frontRender->render();
171		}
172
173		/**
174		* Test when the template doesn't exist
175		*
176		* @expectedException InvalidArgumentException
177		*/
178		public function testExceptionOnFailedPath()
179		{
180		$this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, self::FAILED_PATH);
181
182		$this->frontRender->render();
183		}
184
185		/**
186		* Test when the template path is empty
187		*
188		* @expectedException Chris\Bundle\FrontRenderBundle\Exception\FrontRenderException
189		*/
190		public function testExceptionOnEmptyPath()
191		{
192		$this->frontRender = new FrontRender($this->engine, $this->eventDispatcher, '');
193
194		$this->frontRender->render();
195		}
196
197		/**
198		* Provide the lexer tags
199		*
200		* @return array
201		*/
202		public function lexerTags()
203		{
204		return [
205		['{#', '{*'],
206		['{%', '{@'],
207		['{{', '{\$']
208		];
209
210		}
211
212
213		}
214

christophe-chausseray / front-render-bundle

Pull Request — master (#1)

FrontRenderTest::testSetLexer() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like