Completed
Pull Request — master (#41)
by Vladimir
04:25
created

createMultipleVirtualFiles()   B

Complexity

Conditions 5
Paths 9

Size

Total Lines 19
Code Lines 12

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 5
eloc 12
nc 9
nop 2
dl 0
loc 19
rs 8.8571
c 1
b 0
f 0
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 by
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 by
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
    // Utility Functions
51
    //
52
53
    protected function bookCollectionProvider($jailed = false)
54
    {
55
        $cm = new CollectionManager();
56
        $cm->setLogger($this->getMockLogger());
57
        $cm->parseCollections(array(
58
            array(
59
                'name' => 'books',
60
                'folder' => 'tests/allejo/stakx/Test/assets/MyBookCollection/',
61
            ),
62
        ));
63
64
        return ($jailed) ? $cm->getCollections() : $cm->getJailedCollections();
65
    }
66
67
    /**
68
     * @param string $classType
69
     * @param array  $frontMatter
70
     * @param string $body
71
     *
72
     * @return mixed
0 ignored issues
show
Documentation introduced by
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...
73
     */
74
    protected function createVirtualFile($classType, $frontMatter = array(), $body = 'Body Text')
75
    {
76
        $this->dummyFile
77
            ->setContent($this->generateFM($frontMatter, $body))
78
            ->at($this->rootDir);
79
80
        return new $classType($this->dummyFile->url());
81
    }
82
83
    protected function createMultipleVirtualFiles($classType, $elements)
84
    {
85
        $results = array();
86
87
        foreach ($elements as $element) {
88
            $filename = (isset($element['filename'])) ? $element['filename'] : hash('sha256', uniqid(mt_rand(), true), false);
89
            $frontMatter = (empty($element['frontmatter'])) ? '' : Yaml::dump($element['frontmatter'], 2);
90
            $body = (isset($element['body'])) ? $element['body'] : 'Body Text';
91
92
            $file = vfsStream::newFile($filename);
93
            $file
94
                ->setContent(sprintf("---\n%s\n---\n\n%s", $frontMatter, $body))
95
                ->at($this->rootDir);
96
97
            $results[] = new $classType($file->url());
98
        }
99
100
        return $results;
101
    }
102
103
    /**
104
     * Get a mock logger.
105
     *
106
     * @return LoggerInterface
107
     */
108
    protected function getMockLogger()
109
    {
110
        return $this->getMock(LoggerInterface::class);
111
    }
112
113
    /**
114
     * Get a real logger instance that will save output to the console.
115
     *
116
     * @return StakxLogger
117
     */
118
    protected function getReadableLogger()
119
    {
120
        stream_filter_register('intercept', StreamInterceptor::class);
121
        $stakxLogger = new StakxLogger(new ConsoleOutput());
122
        stream_filter_append($stakxLogger->getOutputInterface()->getStream(), 'intercept');
0 ignored issues
show
Bug introduced by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
123
124
        return $stakxLogger;
125
    }
126
127
    /**
128
     * Generate a FrontMatter-ready syntax to be used as a file's content.
129
     *
130
     * @param array  $frontMatter
131
     * @param string $body
132
     *
133
     * @return string
134
     */
135
    protected function generateFM(array $frontMatter = array(), $body = 'Body text')
136
    {
137
        $fm = (empty($frontMatter)) ? '' : Yaml::dump($frontMatter, 2);
138
139
        return sprintf(self::FM_OBJ_TEMPLATE, $fm, $body);
140
    }
141
}
142