ViewTest::testPlaceholderSalt() - Code Metrics - Inspection of "View/WebView with placeholder salt #62" - yiisoft/view - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#75)

by Alexander

created 2020-02-22 15:09 UTC

ViewTest::testPlaceholderSalt() A

↳ Parent: ViewTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	5
c	0
b	0
f	0
dl	0
loc	8
rs	10
cc	1
nc	1
nop	0

<?php

declare(strict_types=1);

namespace Yiisoft\View\Tests;

use hiqdev\composer\config\Builder;
use Yiisoft\Di\Container;
use Yiisoft\Files\FileHelper;
use Yiisoft\View\Theme;
use Yiisoft\View\View;

/**
 * ViewTest.
 */
final class ViewTest extends \Yiisoft\View\Tests\TestCase
{
    /**
     * @var string path for the test files.
     */
    private $testViewPath = '';

    public function setUp(): void
    {
        parent::setUp();

        $this->testViewPath = sys_get_temp_dir() . '/' . str_replace('\\', '_', get_class($this)) . uniqid('', false);

        FileHelper::createDirectory($this->testViewPath);
    }

    public function tearDown(): void
    {
        parent::tearDown();
        FileHelper::removeDirectory($this->testViewPath);
    }

    /**
     * @see https://github.com/yiisoft/yii2/issues/13058
     */
    public function testExceptionOnRenderFile(): void
    {
        $view = $this->createView($this->testViewPath);

        $exceptionViewFile = $this->testViewPath . DIRECTORY_SEPARATOR . 'exception.php';
        file_put_contents($exceptionViewFile, <<<'PHP'
<h1>Exception</h1>
<?php throw new Exception('Test Exception'); ?>
PHP
        );
        $normalViewFile = $this->testViewPath . DIRECTORY_SEPARATOR . 'no-exception.php';
        file_put_contents($normalViewFile, <<<'PHP'
<h1>No Exception</h1>
PHP
        );

        $obInitialLevel = ob_get_level();

        try {
            $view->renderFile($exceptionViewFile);
        } catch (\Exception $e) {
            // shutdown exception
        }
        $view->renderFile($normalViewFile);

        $this->assertEquals($obInitialLevel, ob_get_level());
    }

    public function testRelativePathInView(): void
    {
        $themePath = $this->testViewPath . '/theme1';
        FileHelper::createDirectory($themePath);

        $baseView = "{$this->testViewPath}/theme1/base.php";
        file_put_contents($baseView, <<<'PHP'
<?= $this->render("sub") ?>
PHP
        );

        $subView = "{$this->testViewPath}/sub.php";
        $subViewContent = 'subviewcontent';
        file_put_contents($subView, $subViewContent);

        $view = $this->createView(
            $this->testViewPath,
            new Theme([
                $this->testViewPath => $themePath,
            ])
        );

        $this->assertSame($subViewContent, $view->render('//base'));
    }

    public function testLocalizedDirectory(): void
    {
        $view = $this->createView($this->testViewPath);
        $this->createFileStructure([
            'views' => [
                'faq.php' => 'English FAQ',
                'de-DE' => [
                    'faq.php' => 'German FAQ',
                ],
            ],
        ], $this->testViewPath);
        $viewFile = $this->testViewPath . DIRECTORY_SEPARATOR . 'views' . DIRECTORY_SEPARATOR . 'faq.php';
        $sourceLanguage = 'en-US';

        // Source language and target language are same. The view path should be unchanged.
        $currentLanguage = $sourceLanguage;
        $this->assertSame($viewFile, $view->localize($viewFile, $currentLanguage, $sourceLanguage));

        // Source language and target language are different. The view path should be changed.
        $currentLanguage = 'de-DE';
        $this->assertSame(
            $this->testViewPath . DIRECTORY_SEPARATOR . 'views' . DIRECTORY_SEPARATOR . $currentLanguage . DIRECTORY_SEPARATOR . 'faq.php',
            $view->localize($viewFile, $currentLanguage, $sourceLanguage)
        );
    }

    /**
     * Creates test files structure.
     * @param string $baseDirectory base directory path.
     * @param array $items file system objects to be created in format: objectName => objectContent
     * Arrays specifies directories, other values - files.
     */
    private function createFileStructure(array $items, string $baseDirectory = null): void
    {
        foreach ($items as $name => $content) {
            $itemName = $baseDirectory . '/' . $name;
            if (\is_array($content)) {
                if (isset($content[0], $content[1]) && $content[0] === 'symlink') {
                    symlink($baseDirectory . DIRECTORY_SEPARATOR . $content[1], $itemName);
                } else {
                    if (!mkdir($itemName, 0777, true) && !is_dir($itemName)) {
                        throw new \RuntimeException(sprintf('Directory "%s" was not created', $itemName));
                    }
                    $this->createFileStructure($content, $itemName);
                }
            } else {
                file_put_contents($itemName, $content);
            }
        }
    }

    public function testDefaultParameterIsPassedToView(): void
    {
        $config = require Builder::path('tests');

        $container = new Container($config);
        $view = $container->get(View::class);
        $view->setDefaultParameters(['parameter' => 'default_parameter']);
        $output = $view->render('//parameters');
        $this->assertStringContainsString('default_parameter', $output);
    }

    public function testDefaultParameterIsOverwrittenByLocalParameter(): void
    {
        $config = require Builder::path('tests');

        $container = new Container($config);
        $view = $container->get(View::class);
        $view->setDefaultParameters(['parameter' => 'default_parameter']);
        $output = $view->render('//parameters', [
            'parameter' => 'local_parameter',
        ]);
        $this->assertStringContainsString('local_parameter', $output);
    }

    public function testPlaceholderSalt(): void
    {
        $config = require Builder::path('tests');

        $container = new Container($config);
        $view = $container->get(View::class);
        $view->setPlaceholderSalt('apple');
        $this->assertSame(dechex(crc32('apple')), $view->getPlaceholderSignature());
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\View\Tests;
6
7			use hiqdev\composer\config\Builder;
8			use Yiisoft\Di\Container;
9			use Yiisoft\Files\FileHelper;
10			use Yiisoft\View\Theme;
11			use Yiisoft\View\View;
12
13			/**
14			* ViewTest.
15			*/
16			final class ViewTest extends \Yiisoft\View\Tests\TestCase
17			{
18			/**
19			* @var string path for the test files.
20			*/
21			private $testViewPath = '';
22
23			public function setUp(): void
24			{
25			parent::setUp();
26
27			$this->testViewPath = sys_get_temp_dir() . '/' . str_replace('\\', '_', get_class($this)) . uniqid('', false);
28
29			FileHelper::createDirectory($this->testViewPath);
30			}
31
32			public function tearDown(): void
33			{
34			parent::tearDown();
35			FileHelper::removeDirectory($this->testViewPath);
36			}
37
38			/**
39			* @see https://github.com/yiisoft/yii2/issues/13058
40			*/
41			public function testExceptionOnRenderFile(): void
42			{
43			$view = $this->createView($this->testViewPath);
44
45			$exceptionViewFile = $this->testViewPath . DIRECTORY_SEPARATOR . 'exception.php';
46			file_put_contents($exceptionViewFile, <<<'PHP'
47			<h1>Exception</h1>
48			<?php throw new Exception('Test Exception'); ?>
49			PHP
50			);
51			$normalViewFile = $this->testViewPath . DIRECTORY_SEPARATOR . 'no-exception.php';
52			file_put_contents($normalViewFile, <<<'PHP'
53			<h1>No Exception</h1>
54			PHP
55			);
56
57			$obInitialLevel = ob_get_level();
58
59			try {
60			$view->renderFile($exceptionViewFile);
61			} catch (\Exception $e) {
62			// shutdown exception
63			}
64			$view->renderFile($normalViewFile);
65
66			$this->assertEquals($obInitialLevel, ob_get_level());
67			}
68
69			public function testRelativePathInView(): void
70			{
71			$themePath = $this->testViewPath . '/theme1';
72			FileHelper::createDirectory($themePath);
73
74			$baseView = "{$this->testViewPath}/theme1/base.php";
75			file_put_contents($baseView, <<<'PHP'
76			<?= $this->render("sub") ?>
77			PHP
78			);
79
80			$subView = "{$this->testViewPath}/sub.php";
81			$subViewContent = 'subviewcontent';
82			file_put_contents($subView, $subViewContent);
83
84			$view = $this->createView(
85			$this->testViewPath,
86			new Theme([
87			$this->testViewPath => $themePath,
88			])
89			);
90
91			$this->assertSame($subViewContent, $view->render('//base'));
92			}
93
94			public function testLocalizedDirectory(): void
95			{
96			$view = $this->createView($this->testViewPath);
97			$this->createFileStructure([
98			'views' => [
99			'faq.php' => 'English FAQ',
100			'de-DE' => [
101			'faq.php' => 'German FAQ',
102			],
103			],
104			], $this->testViewPath);
105			$viewFile = $this->testViewPath . DIRECTORY_SEPARATOR . 'views' . DIRECTORY_SEPARATOR . 'faq.php';
106			$sourceLanguage = 'en-US';
107
108			// Source language and target language are same. The view path should be unchanged.
109			$currentLanguage = $sourceLanguage;
110			$this->assertSame($viewFile, $view->localize($viewFile, $currentLanguage, $sourceLanguage));
111
112			// Source language and target language are different. The view path should be changed.
113			$currentLanguage = 'de-DE';
114			$this->assertSame(
115			$this->testViewPath . DIRECTORY_SEPARATOR . 'views' . DIRECTORY_SEPARATOR . $currentLanguage . DIRECTORY_SEPARATOR . 'faq.php',
116			$view->localize($viewFile, $currentLanguage, $sourceLanguage)
117			);
118			}
119
120			/**
121			* Creates test files structure.
122			* @param string $baseDirectory base directory path.
123			* @param array $items file system objects to be created in format: objectName => objectContent
124			* Arrays specifies directories, other values - files.
125			*/
126			private function createFileStructure(array $items, string $baseDirectory = null): void
127			{
128			foreach ($items as $name => $content) {
129			$itemName = $baseDirectory . '/' . $name;
130			if (\is_array($content)) {
131			if (isset($content[0], $content[1]) && $content[0] === 'symlink') {
132			symlink($baseDirectory . DIRECTORY_SEPARATOR . $content[1], $itemName);
133			} else {
134			if (!mkdir($itemName, 0777, true) && !is_dir($itemName)) {
135			throw new \RuntimeException(sprintf('Directory "%s" was not created', $itemName));
136			}
137			$this->createFileStructure($content, $itemName);
138			}
139			} else {
140			file_put_contents($itemName, $content);
141			}
142			}
143			}
144
145			public function testDefaultParameterIsPassedToView(): void
146			{
147			$config = require Builder::path('tests');
148
149			$container = new Container($config);
150			$view = $container->get(View::class);
151			$view->setDefaultParameters(['parameter' => 'default_parameter']);
152			$output = $view->render('//parameters');
153			$this->assertStringContainsString('default_parameter', $output);
154			}
155
156			public function testDefaultParameterIsOverwrittenByLocalParameter(): void
157			{
158			$config = require Builder::path('tests');
159
160			$container = new Container($config);
161			$view = $container->get(View::class);
162			$view->setDefaultParameters(['parameter' => 'default_parameter']);
163			$output = $view->render('//parameters', [
164			'parameter' => 'local_parameter',
165			]);
166			$this->assertStringContainsString('local_parameter', $output);
167			}
168
169			public function testPlaceholderSalt(): void
170			{
171			$config = require Builder::path('tests');
172
173			$container = new Container($config);
174			$view = $container->get(View::class);
175			$view->setPlaceholderSalt('apple');
176			$this->assertSame(dechex(crc32('apple')), $view->getPlaceholderSignature());
177			}
178			}
179

yiisoft / view

Pull Request — master (#75)

ViewTest::testPlaceholderSalt() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like