PHPUnit_Stakx_TestCase::generateFM() - Code Metrics - Inspection of "Split up the PageManager class" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#41)

by Vladimir

created 2017-03-24 07:26 UTC

PHPUnit_Stakx_TestCase::generateFM() A

↳ Parent: PHPUnit_Stakx_TestCase

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	2
dl	0
loc	6
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\Core\StakxLogger;
use allejo\stakx\Manager\CollectionManager;
use allejo\stakx\System\Filesystem;
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 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();

        // 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();
    }

    /**
     * @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);
    }
}


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\Core\StakxLogger;
11			use allejo\stakx\Manager\CollectionManager;
12			use allejo\stakx\System\Filesystem;
13			use org\bovigo\vfs\vfsStream;
14			use org\bovigo\vfs\vfsStreamDirectory;
15			use org\bovigo\vfs\vfsStreamFile;
16			use Psr\Log\LoggerInterface;
17			use Symfony\Component\Console\Output\ConsoleOutput;
18			use Symfony\Component\Yaml\Yaml;
19
20			abstract class PHPUnit_Stakx_TestCase extends \PHPUnit_Framework_TestCase
			0 ignored issues – show 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...
21			{
22			const FM_OBJ_TEMPLATE = "---\n%s\n---\n\n%s";
23
24			/**
25			* @var vfsStreamFile
26			*/
27			protected $dummyFile;
28
29			/**
30			* @var vfsStreamDirectory
31			*/
32			protected $rootDir;
33
34			/**
35			* @var Filesystem
36			*/
37			protected $fs;
38
39			public function setUp()
40			{
41			$this->dummyFile = vfsStream::newFile('stakx.html.twig');
42			$this->rootDir = vfsStream::setup();
43			$this->fs = new Filesystem();
44
45			// Inspect the VFS as an array
46			// 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...
47			}
48
49			///
50			// Assertion functions
51			///
52
53			protected function assertStringContains($needle, $haystack, $message = '')
54			{
55			$this->assertNotFalse(strpos($haystack, $needle), $message);
56			}
57
58			protected function assertFileContains($fileContent, $filePath, $message = '')
59			{
60			(substr($filePath, -1, 1) == '/') && $filePath .= 'index.html';
61
62			$contents = file_get_contents($filePath);
63
64			$this->assertStringContains($fileContent, $contents, $message);
65			}
66
67			//
68			// Utility Functions
69			//
70
71			protected function bookCollectionProvider($jailed = false)
72			{
73			$cm = new CollectionManager();
74			$cm->setLogger($this->getMockLogger());
75			$cm->parseCollections(array(
76			array(
77			'name' => 'books',
78			'folder' => 'tests/allejo/stakx/Test/assets/MyBookCollection/',
79			),
80			));
81
82			return ($jailed) ? $cm->getCollections() : $cm->getJailedCollections();
83			}
84
85			/**
86			* @param string $classType
87			* @param array $frontMatter
88			* @param string $body
89			*
90			* @return mixed
			0 ignored issues – show Documentation introduced 2016-12-12 21:08 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `object`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
91			*/
92			protected function createVirtualFile($classType, $frontMatter = array(), $body = 'Body Text')
93			{
94			$this->dummyFile
95			->setContent($this->generateFM($frontMatter, $body))
96			->at($this->rootDir);
97
98			return new $classType($this->dummyFile->url());
99			}
100
101			protected function createMultipleVirtualFiles($classType, $elements)
102			{
103			$results = array();
104
105			foreach ($elements as $element) {
106			$filename = (isset($element['filename'])) ? $element['filename'] : hash('sha256', uniqid(mt_rand(), true), false);
107			$frontMatter = (empty($element['frontmatter'])) ? '' : Yaml::dump($element['frontmatter'], 2);
108			$body = (isset($element['body'])) ? $element['body'] : 'Body Text';
109
110			$file = vfsStream::newFile($filename);
111			$file
112			->setContent(sprintf("---\n%s\n---\n\n%s", $frontMatter, $body))
113			->at($this->rootDir);
114
115			$results[] = new $classType($file->url());
116			}
117
118			return $results;
119			}
120
121			/**
122			* Get a mock logger.
123			*
124			* @return LoggerInterface
125			*/
126			protected function getMockLogger()
127			{
128			return $this->getMock(LoggerInterface::class);
129			}
130
131			/**
132			* Get a real logger instance that will save output to the console.
133			*
134			* @return StakxLogger
135			*/
136			protected function getReadableLogger()
137			{
138			stream_filter_register('intercept', StreamInterceptor::class);
139			$stakxLogger = new StakxLogger(new ConsoleOutput());
140			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...
141
142			return $stakxLogger;
143			}
144
145			/**
146			* Generate a FrontMatter-ready syntax to be used as a file's content.
147			*
148			* @param array $frontMatter
149			* @param string $body
150			*
151			* @return string
152			*/
153			protected function generateFM(array $frontMatter = array(), $body = 'Body text')
154			{
155			$fm = (empty($frontMatter)) ? '' : Yaml::dump($frontMatter, 2);
156
157			return sprintf(self::FM_OBJ_TEMPLATE, $fm, $body);
158			}
159			}
160

stakx-io / stakx

Pull Request — master (#41)

PHPUnit_Stakx_TestCase::generateFM() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like