PHPUnit_Stakx_TestCase::writeTempFile() - Code Metrics - Inspection of "Allow datasets to be the iterator for a dynamic Pa..." - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#48)

by Vladimir

created 2017-04-26 17:40 UTC

PHPUnit_Stakx_TestCase::writeTempFile() A

↳ Parent: PHPUnit_Stakx_TestCase

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	2
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php

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

namespace allejo\stakx\Test;

use allejo\stakx\Command\BuildableCommand;
use allejo\stakx\Core\StakxLogger;
use allejo\stakx\Manager\CollectionManager;
use allejo\stakx\Service;
use allejo\stakx\System\Filesystem;
use allejo\stakx\System\Folder;
use org\bovigo\vfs\vfsStream;
use org\bovigo\vfs\vfsStreamDirectory;
use org\bovigo\vfs\vfsStreamFile;
use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Yaml\Yaml;

abstract class PHPUnit_Stakx_TestCase extends \PHPUnit_Framework_TestCase

{
    const FM_OBJ_TEMPLATE = "---\n%s\n---\n\n%s";

    /** @var string */
    protected $assetFolder;

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

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

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


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

        Service::setParameter(BuildableCommand::USE_DRAFTS, false);
        Service::setParameter(BuildableCommand::WATCHING, false);

        // Inspect the VFS as an array
        // vfsStream::inspect(new vfsStreamStructureVisitor())->getStructure();

    }

    ///
    // Assertion functions
    ///

    protected function assertStringContains($needle, $haystack, $message = '')
    {
        $this->assertNotFalse(strpos($haystack, $needle), $message);
    }

    protected function assertFileContains($fileContent, $filePath, $message = '')
    {
        (substr($filePath, -1, 1) == '/') && $filePath .= 'index.html';

        $contents = file_get_contents($filePath);

        $this->assertStringContains($fileContent, $contents, $message);
    }

    ///
    // Utility Functions
    ///

    protected function bookCollectionProvider($jailed = false)
    {
        $cm = new CollectionManager();

        $cm->setLogger($this->getMockLogger());
        $cm->parseCollections(array(
            array(
                'name' => 'books',
                'folder' => 'tests/allejo/stakx/Test/assets/MyBookCollection/',
            ),
        ));

        return (!$jailed) ? $cm->getCollections() : $cm->getJailedCollections();
    }

    /**
     * Write a temporary file to the asset folder
     *
     * @param $fileName
     * @param $content
     *
     * @return string Path to the temporary file; relative to the project's root
     */
    protected function createTempFile($fileName, $content)
    {
        $folder = new Folder($this->assetFolder);
        $folder->writeFile($fileName, $content);

        return $this->fs->appendPath($this->assetFolder, $fileName);
    }

    protected function createBlankFile($filename, $classType, $content)
    {
        $file = vfsStream::newFile($filename);
        $file
            ->setContent($content)
            ->at($this->rootDir);

        return new $classType($file->url());
    }

    /**
     * @param string $classType
     * @param array  $frontMatter
     * @param string $body
     *
     * @return mixed
     */
    protected function createVirtualFile($classType, $frontMatter = array(), $body = 'Body Text')
    {
        $this->dummyFile
            ->setContent($this->generateFM($frontMatter, $body))
            ->at($this->rootDir);

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

    protected function createMultipleVirtualFiles($classType, $elements)
    {
        $results = array();

        foreach ($elements as $element) {
            $filename = (isset($element['filename'])) ? $element['filename'] : hash('sha256', uniqid(mt_rand(), true), false);
            $frontMatter = (empty($element['frontmatter'])) ? '' : Yaml::dump($element['frontmatter'], 2);
            $body = (isset($element['body'])) ? $element['body'] : 'Body Text';

            $file = vfsStream::newFile($filename);
            $file
                ->setContent(sprintf("---\n%s\n---\n\n%s", $frontMatter, $body))
                ->at($this->rootDir);

            $results[] = new $classType($file->url());
        }

        return $results;
    }

    /**
     * Get a mock logger.
     *
     * @return LoggerInterface
     */
    protected function getMockLogger()
    {
        return $this->getMock(LoggerInterface::class);
    }

    /**
     * Get a real logger instance that will save output to the console.
     *
     * @return StakxLogger
     */
    protected function getReadableLogger()
    {
        stream_filter_register('intercept', StreamInterceptor::class);
        $stakxLogger = new StakxLogger(new ConsoleOutput());
        stream_filter_append($stakxLogger->getOutputInterface()->getStream(), 'intercept');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return $stakxLogger;
    }

    /**
     * Generate a FrontMatter-ready syntax to be used as a file's content.
     *
     * @param array  $frontMatter
     * @param string $body
     *
     * @return string
     */
    protected function generateFM(array $frontMatter = array(), $body = 'Body text')
    {
        $fm = (empty($frontMatter)) ? '' : Yaml::dump($frontMatter, 2);


        return sprintf(self::FM_OBJ_TEMPLATE, $fm, $body);
    }

    /**
     * Create a temporary folder where temporary file writes will be made to
     *
     * Remember to remove the folder in during the ::tearDown()
     *
     * @param string $folderName
     */
    protected function createAssetFolder($folderName)
    {
        $this->assetFolder = $this->fs->getRelativePath($this->fs->appendPath(__DIR__, $folderName));

        $this->fs->mkdir($this->assetFolder);
    }
}


1			<?php
2
3			/**
4			* @copyright 2017 Vladimir Jimenez
5			* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
6			*/
7
8			namespace allejo\stakx\Test;
9
10			use allejo\stakx\Command\BuildableCommand;
11			use allejo\stakx\Core\StakxLogger;
12			use allejo\stakx\Manager\CollectionManager;
13			use allejo\stakx\Service;
14			use allejo\stakx\System\Filesystem;
15			use allejo\stakx\System\Folder;
16			use org\bovigo\vfs\vfsStream;
17			use org\bovigo\vfs\vfsStreamDirectory;
18			use org\bovigo\vfs\vfsStreamFile;
19			use Psr\Log\LoggerInterface;
20			use Symfony\Component\Console\Output\ConsoleOutput;
21			use Symfony\Component\Yaml\Yaml;
22
23			abstract class PHPUnit_Stakx_TestCase extends \PHPUnit_Framework_TestCase
			0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report `PHPUnit_Stakx_TestCase` does not seem to conform to the naming convention (`^[A-Z][a-zA-Z0-9]$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history... Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report `PHPUnit_Stakx_TestCase` does not seem to conform to the naming convention (`^Abstract\|Factory$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. 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...
24			{
25			const FM_OBJ_TEMPLATE = "---\n%s\n---\n\n%s";
26
27			/** @var string */
28			protected $assetFolder;
29
30			/**
31			* @var vfsStreamFile
32			*/
33			protected $dummyFile;
34
35			/**
36			* @var vfsStreamDirectory
37			*/
38			protected $rootDir;
39
40			/**
41			* @var Filesystem
42			*/
43			protected $fs;
			0 ignored issues – show Comprehensibility introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Avoid variables with short names like $fs. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
44
45			public function setUp()
46			{
47			$this->dummyFile = vfsStream::newFile('stakx.html.twig');
48			$this->rootDir = vfsStream::setup();
49			$this->fs = new Filesystem();
50
51			Service::setParameter(BuildableCommand::USE_DRAFTS, false);
52			Service::setParameter(BuildableCommand::WATCHING, false);
53
54			// Inspect the VFS as an array
55			// vfsStream::inspect(new vfsStreamStructureVisitor())->getStructure();
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-03-22 07:23 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
56			}
57
58			///
59			// Assertion functions
60			///
61
62			protected function assertStringContains($needle, $haystack, $message = '')
63			{
64			$this->assertNotFalse(strpos($haystack, $needle), $message);
65			}
66
67			protected function assertFileContains($fileContent, $filePath, $message = '')
68			{
69			(substr($filePath, -1, 1) == '/') && $filePath .= 'index.html';
70
71			$contents = file_get_contents($filePath);
72
73			$this->assertStringContains($fileContent, $contents, $message);
74			}
75
76			///
77			// Utility Functions
78			///
79
80			protected function bookCollectionProvider($jailed = false)
81			{
82			$cm = new CollectionManager();
			0 ignored issues – show Comprehensibility introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Avoid variables with short names like $cm. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
83			$cm->setLogger($this->getMockLogger());
84			$cm->parseCollections(array(
85			array(
86			'name' => 'books',
87			'folder' => 'tests/allejo/stakx/Test/assets/MyBookCollection/',
88			),
89			));
90
91			return (!$jailed) ? $cm->getCollections() : $cm->getJailedCollections();
92			}
93
94			/**
95			* Write a temporary file to the asset folder
96			*
97			* @param $fileName
98			* @param $content
99			*
100			* @return string Path to the temporary file; relative to the project's root
101			*/
102			protected function createTempFile($fileName, $content)
103			{
104			$folder = new Folder($this->assetFolder);
105			$folder->writeFile($fileName, $content);
106
107			return $this->fs->appendPath($this->assetFolder, $fileName);
108			}
109
110			protected function createBlankFile($filename, $classType, $content)
111			{
112			$file = vfsStream::newFile($filename);
113			$file
114			->setContent($content)
115			->at($this->rootDir);
116
117			return new $classType($file->url());
118			}
119
120			/**
121			* @param string $classType
122			* @param array $frontMatter
123			* @param string $body
124			*
125			* @return mixed
126			*/
127			protected function createVirtualFile($classType, $frontMatter = array(), $body = 'Body Text')
128			{
129			$this->dummyFile
130			->setContent($this->generateFM($frontMatter, $body))
131			->at($this->rootDir);
132
133			return new $classType($this->dummyFile->url());
134			}
135
136			protected function createMultipleVirtualFiles($classType, $elements)
137			{
138			$results = array();
139
140			foreach ($elements as $element) {
141			$filename = (isset($element['filename'])) ? $element['filename'] : hash('sha256', uniqid(mt_rand(), true), false);
142			$frontMatter = (empty($element['frontmatter'])) ? '' : Yaml::dump($element['frontmatter'], 2);
143			$body = (isset($element['body'])) ? $element['body'] : 'Body Text';
144
145			$file = vfsStream::newFile($filename);
146			$file
147			->setContent(sprintf("---\n%s\n---\n\n%s", $frontMatter, $body))
148			->at($this->rootDir);
149
150			$results[] = new $classType($file->url());
151			}
152
153			return $results;
154			}
155
156			/**
157			* Get a mock logger.
158			*
159			* @return LoggerInterface
160			*/
161			protected function getMockLogger()
162			{
163			return $this->getMock(LoggerInterface::class);
164			}
165
166			/**
167			* Get a real logger instance that will save output to the console.
168			*
169			* @return StakxLogger
170			*/
171			protected function getReadableLogger()
172			{
173			stream_filter_register('intercept', StreamInterceptor::class);
174			$stakxLogger = new StakxLogger(new ConsoleOutput());
175			stream_filter_append($stakxLogger->getOutputInterface()->getStream(), 'intercept');
			0 ignored issues – show Bug introduced 2017-03-19 09:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Output\OutputInterface` as the method `getStream()` does only exist in the following implementations of said interface: `Symfony\Component\Console\Output\ConsoleOutput`, `Symfony\Component\Console\Output\StreamOutput`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
176
177			return $stakxLogger;
178			}
179
180			/**
181			* Generate a FrontMatter-ready syntax to be used as a file's content.
182			*
183			* @param array $frontMatter
184			* @param string $body
185			*
186			* @return string
187			*/
188			protected function generateFM(array $frontMatter = array(), $body = 'Body text')
189			{
190			$fm = (empty($frontMatter)) ? '' : Yaml::dump($frontMatter, 2);
			0 ignored issues – show Comprehensibility introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Avoid variables with short names like $fm. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
191
192			return sprintf(self::FM_OBJ_TEMPLATE, $fm, $body);
193			}
194
195			/**
196			* Create a temporary folder where temporary file writes will be made to
197			*
198			* Remember to remove the folder in during the ::tearDown()
199			*
200			* @param string $folderName
201			*/
202			protected function createAssetFolder($folderName)
203			{
204			$this->assetFolder = $this->fs->getRelativePath($this->fs->appendPath(__DIR__, $folderName));
205
206			$this->fs->mkdir($this->assetFolder);
207			}
208			}
209

stakx-io / stakx

Pull Request — master (#48)

PHPUnit_Stakx_TestCase::writeTempFile() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like