PHPUnit_Stakx_TestCase::createVirtualFile() - Code Metrics - Inspection of "Move some generic stuff to abstract test class" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 990c12...aa6317 )

by Vladimir

created 2016-12-12 19:51 UTC

PHPUnit_Stakx_TestCase::createVirtualFile() A

↳ Parent: PHPUnit_Stakx_TestCase

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	3
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * @copyright 2016 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

use allejo\stakx\System\Filesystem;
use org\bovigo\vfs\vfsStream;
use org\bovigo\vfs\vfsStreamDirectory;
use org\bovigo\vfs\vfsStreamFile;
use Symfony\Component\Yaml\Yaml;

abstract class PHPUnit_Stakx_TestCase extends PHPUnit_Framework_TestCase
namespace YourVendor;

class YourClass { }
{
    const FM_OBJ_TEMPLATE = "---\n%s\n---\n\n%s";

    /**
     * @var vfsStreamFile
     */
    protected $dummyFile;

    /**
     * @var vfsStreamDirectory
     */
    protected $rootDir;

    /**
     * @var Filesystem
     */
    protected $fs;

    public function setUp()
    {
        $this->dummyFile    = vfsStream::newFile('foo.html.twig');
        $this->rootDir      = vfsStream::setup();
        $this->fs           = new Filesystem();
    }

    //
    // Assert Functions
    //

    public function assertFileExistsAndContains ($filePath, $needle, $message = '')
    {
        $this->assertFileExists($filePath, $message);

        $contents = file_get_contents($filePath);

        $this->assertContains($needle, $contents, $message);
    }

    //
    // Utility Functions
    //

    protected function createVirtualFile ($frontMatter = array(), $body = "Body Text", $classType)
// $a must always be passed; it's default value is never used.
function someFunction($a = 5, $b) { }
    {
        $fm = (empty($frontMatter)) ? '' : Yaml::dump($frontMatter, 2);

        $this->dummyFile
            ->setContent(sprintf("---\n%s\n---\n\n%s", $fm, $body))
            ->at($this->rootDir);

        return (new $classType($this->dummyFile->url()));
    }
}

1			<?php
2
3			/**
4			* @copyright 2016 Vladimir Jimenez
5			* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
6			*/
7
8			use allejo\stakx\System\Filesystem;
9			use org\bovigo\vfs\vfsStream;
10			use org\bovigo\vfs\vfsStreamDirectory;
11			use org\bovigo\vfs\vfsStreamFile;
12			use Symfony\Component\Yaml\Yaml;
13
14			abstract class PHPUnit_Stakx_TestCase extends PHPUnit_Framework_TestCase
			0 ignored issues – show Coding Style Compatibility introduced 2016-12-07 08:00 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history... Coding Style introduced 2016-12-07 08:00 UTC by Report Bug Copy Issue Report This class is not in CamelCase format. Classes in PHP are usually named in CamelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. The whole name starts with a capital letter as well. Thus the name database provider becomes `DatabaseProvider`. Loading history...
15			{
16			const FM_OBJ_TEMPLATE = "---\n%s\n---\n\n%s";
17
18			/**
19			* @var vfsStreamFile
20			*/
21			protected $dummyFile;
22
23			/**
24			* @var vfsStreamDirectory
25			*/
26			protected $rootDir;
27
28			/**
29			* @var Filesystem
30			*/
31			protected $fs;
32
33			public function setUp()
34			{
35			$this->dummyFile = vfsStream::newFile('foo.html.twig');
36			$this->rootDir = vfsStream::setup();
37			$this->fs = new Filesystem();
38			}
39
40			//
41			// Assert Functions
42			//
43
44			public function assertFileExistsAndContains ($filePath, $needle, $message = '')
45			{
46			$this->assertFileExists($filePath, $message);
47
48			$contents = file_get_contents($filePath);
49
50			$this->assertContains($needle, $contents, $message);
51			}
52
53			//
54			// Utility Functions
55			//
56
57			protected function createVirtualFile ($frontMatter = array(), $body = "Body Text", $classType)
			0 ignored issues – show Coding Style introduced 2016-12-12 19:53 UTC by Report Bug Copy Issue Report Parameters which have default values should be placed at the end. If you place a parameter with a default value before a parameter with a default value, the default value of the first parameter will never be used as it will always need to be passed anyway: // $a must always be passed; it's default value is never used. function someFunction($a = 5, $b) { } Loading history...
58			{
59			$fm = (empty($frontMatter)) ? '' : Yaml::dump($frontMatter, 2);
60
61			$this->dummyFile
62			->setContent(sprintf("---\n%s\n---\n\n%s", $fm, $body))
63			->at($this->rootDir);
64
65			return (new $classType($this->dummyFile->url()));
66			}
67			}

stakx-io / stakx

Push — master ( 990c12...aa6317 )

PHPUnit_Stakx_TestCase::createVirtualFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like