PhpCsFixerTest::testValidationScenario() - Code Metrics - Inspection of "Created PhpCsFixer action (#12)" - uuf6429/elder-brother - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3b50b8...d08537 )

by Christian

created 2016-11-14 13:37 UTC

PhpCsFixerTest::testValidationScenario() B

↳ Parent: PhpCsFixerTest

Complexity

Conditions	5
Paths	46

Size

Total Lines	72
Code Lines	44

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	72
rs	8.5164
cc	5
eloc	44
nc	46
nop	3

How to fix Long Method

<?php

namespace uuf6429\ElderBrother\Action;

use Symfony\Component\Console\Input;
use Symfony\Component\Console\Output;
use uuf6429\ElderBrother\Change;

class PhpCsFixerTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @param array           $fileContents
     * @param null|array      $expectedFileContents
     * @param null|\Exception $expectedException
     *
     * @throws \Exception
     *
     * @dataProvider validationScenarioDataProvider
     */
    public function testValidationScenario($fileContents, $expectedFileContents = null, $expectedException = null)
    {
        $createdFiles = [];

        try {
            $createdFiles = $this->createFiles($fileContents);

            $fileList = new Change\FileList(
                'cache' . mt_rand(),
                function () use ($createdFiles) {
                    return $createdFiles;
                }
            );

            $binFile = realpath(__DIR__ . '/../../../../vendor/friendsofphp/php-cs-fixer/php-cs-fixer');
            $this->assertNotFalse($binFile, 'PHP-CS-Fixer executable could not be located (cwd: ' . getcwd() . ').');

            $configFile = tempnam(sys_get_temp_dir(), 'pcc');
            $this->assertNotFalse(
                file_put_contents(
                    $configFile,
                    '<?php return Symfony\CS\Config\Config::create()'
                    . '->level(Symfony\CS\FixerInterface::SYMFONY_LEVEL)'
                    . '->fixers(["linefeed"]);'
                ),
                'PHP-CS-Fixer config file could not be saved: ' . $configFile
            );

            $action = new PhpCsFixer($fileList, $binFile, $configFile, false);

            try {
                $action->execute($this->getInputMock(), $this->getOutputMock());

                if (!is_null($expectedFileContents)) {
                    $this->assertEquals(
                        $expectedFileContents,
                        array_combine(
                            array_keys($fileContents),
                            array_map(
                                function ($file) {
                                    return file($file, FILE_IGNORE_NEW_LINES);
                                },
                                $createdFiles
                            )
                        )
                    );
                }

                $this->assertNull($expectedException, 'No exception should be thrown.');
            } catch (\Exception $ex) {
                if (!$expectedException) {
                    throw $ex;
                }

                // replace virtual filenames with fake filenames
                $message = str_replace(
                    $createdFiles,
                    array_keys($fileContents),
                    $ex->getMessage()
                );

                // do some asserting :)
                $this->assertSame(get_class($expectedException), get_class($ex));
                $this->assertSame($expectedException->getMessage(), $message);
            }

            $this->removeFiles($createdFiles);
        } catch (\Exception $ex) {
            $this->removeFiles($createdFiles);
            throw $ex;
        }
    }

    /**
     * @return array
     */
    public function validationScenarioDataProvider()
    {
        return [
            'no files should not cause exception' => [
                '$fileContents' => [],
                '$expectedFileContents' => [],
                '$expectedException' => null,
            ],
            'a file with an inline class and method' => [
                '$fileContents' => [
                    'file1.php' => '<?php class Test {public function sayHello(){echo "Hello!";}} ',
                ],
                '$expectedFileContents' => [
                    'file1.php' => [
                        '<?php class Test',
                        '{',
                        '    public function sayHello()',
                        '    {',
                        '        echo \'Hello!\';',
                        '    }',
                        '}',
                    ],
                ],
                '$expectedException' => null,
            ],
            'a file with a syntax error' => [
                '$fileContents' => [
                    'file2.php' => '<?php *e(cho Test1"; ',
                ],
                '$expectedFileContents' => [
                    'file2.php' => [
                        '<?php *e(cho Test1"; ',
                    ],
                ],
                '$expectedException' => null,
            ],
        ];
    }

    /**
     * @return Input\InputInterface
     */
    protected function getInputMock()
    {
        return $this->getMockBuilder(Input\InputInterface::class)
            ->getMock();
    }

    /**
     * @return Output\OutputInterface
     */
    protected function getOutputMock()
    {
        return new Output\NullOutput();
    }

    /**
     * @param array<string, string> $fileContents
     *
     * @return string[]
     */
    protected function createFiles($fileContents)
    {
        return array_values(
            array_map(
                function ($index, $content) {
                    $filename = tempnam(sys_get_temp_dir(), $index);
                    file_put_contents($filename, $content);

                    return $filename;
                },
                array_keys($fileContents),
                $fileContents
            )
        );
    }

    /**
     * @param string[] $files
     */
    protected function removeFiles($files)
    {
        foreach ($files as $file) {
            unlink($file);
        }
    }
}


1			<?php
2
3			namespace uuf6429\ElderBrother\Action;
4
5			use Symfony\Component\Console\Input;
6			use Symfony\Component\Console\Output;
7			use uuf6429\ElderBrother\Change;
8
9			class PhpCsFixerTest extends \PHPUnit_Framework_TestCase
10			{
11			/**
12			* @param array $fileContents
13			* @param null\|array $expectedFileContents
14			* @param null\|\Exception $expectedException
15			*
16			* @throws \Exception
17			*
18			* @dataProvider validationScenarioDataProvider
19			*/
20			public function testValidationScenario($fileContents, $expectedFileContents = null, $expectedException = null)
21			{
22			$createdFiles = [];
23
24			try {
25			$createdFiles = $this->createFiles($fileContents);
26
27			$fileList = new Change\FileList(
28			'cache' . mt_rand(),
29			function () use ($createdFiles) {
30			return $createdFiles;
31			}
32			);
33
34			$binFile = realpath(__DIR__ . '/../../../../vendor/friendsofphp/php-cs-fixer/php-cs-fixer');
35			$this->assertNotFalse($binFile, 'PHP-CS-Fixer executable could not be located (cwd: ' . getcwd() . ').');
36
37			$configFile = tempnam(sys_get_temp_dir(), 'pcc');
38			$this->assertNotFalse(
39			file_put_contents(
40			$configFile,
41			'<?php return Symfony\CS\Config\Config::create()'
42			. '->level(Symfony\CS\FixerInterface::SYMFONY_LEVEL)'
43			. '->fixers(["linefeed"]);'
44			),
45			'PHP-CS-Fixer config file could not be saved: ' . $configFile
46			);
47
48			$action = new PhpCsFixer($fileList, $binFile, $configFile, false);
49
50			try {
51			$action->execute($this->getInputMock(), $this->getOutputMock());
52
53			if (!is_null($expectedFileContents)) {
54			$this->assertEquals(
55			$expectedFileContents,
56			array_combine(
57			array_keys($fileContents),
58			array_map(
59			function ($file) {
60			return file($file, FILE_IGNORE_NEW_LINES);
61			},
62			$createdFiles
63			)
64			)
65			);
66			}
67
68			$this->assertNull($expectedException, 'No exception should be thrown.');
69			} catch (\Exception $ex) {
70			if (!$expectedException) {
71			throw $ex;
72			}
73
74			// replace virtual filenames with fake filenames
75			$message = str_replace(
76			$createdFiles,
77			array_keys($fileContents),
78			$ex->getMessage()
79			);
80
81			// do some asserting :)
82			$this->assertSame(get_class($expectedException), get_class($ex));
83			$this->assertSame($expectedException->getMessage(), $message);
84			}
85
86			$this->removeFiles($createdFiles);
87			} catch (\Exception $ex) {
88			$this->removeFiles($createdFiles);
89			throw $ex;
90			}
91			}
92
93			/**
94			* @return array
95			*/
96			public function validationScenarioDataProvider()
97			{
98			return [
99			'no files should not cause exception' => [
100			'$fileContents' => [],
101			'$expectedFileContents' => [],
102			'$expectedException' => null,
103			],
104			'a file with an inline class and method' => [
105			'$fileContents' => [
106			'file1.php' => '<?php class Test {public function sayHello(){echo "Hello!";}} ',
107			],
108			'$expectedFileContents' => [
109			'file1.php' => [
110			'<?php class Test',
111			'{',
112			' public function sayHello()',
113			' {',
114			' echo \'Hello!\';',
115			' }',
116			'}',
117			],
118			],
119			'$expectedException' => null,
120			],
121			'a file with a syntax error' => [
122			'$fileContents' => [
123			'file2.php' => '<?php *e(cho Test1"; ',
124			],
125			'$expectedFileContents' => [
126			'file2.php' => [
127			'<?php *e(cho Test1"; ',
128			],
129			],
130			'$expectedException' => null,
131			],
132			];
133			}
134
135			/**
136			* @return Input\InputInterface
137			*/
138			protected function getInputMock()
139			{
140			return $this->getMockBuilder(Input\InputInterface::class)
141			->getMock();
142			}
143
144			/**
145			* @return Output\OutputInterface
146			*/
147			protected function getOutputMock()
148			{
149			return new Output\NullOutput();
150			}
151
152			/**
153			* @param array<string, string> $fileContents
154			*
155			* @return string[]
156			*/
157			protected function createFiles($fileContents)
158			{
159			return array_values(
160			array_map(
161			function ($index, $content) {
162			$filename = tempnam(sys_get_temp_dir(), $index);
163			file_put_contents($filename, $content);
164
165			return $filename;
166			},
167			array_keys($fileContents),
168			$fileContents
169			)
170			);
171			}
172
173			/**
174			* @param string[] $files
175			*/
176			protected function removeFiles($files)
177			{
178			foreach ($files as $file) {
179			unlink($file);
180			}
181			}
182			}
183

uuf6429 / elder-brother

Push — master ( 3b50b8...d08537 )

PhpCsFixerTest::testValidationScenario() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like