BehatPage::render() - Code Metrics - Inspection of "Add super simple syntax highlighting for behat fea..." - hiqdev/yii2-module-pages - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( abf061...1a1da2 )

by Andrii

created 2020-09-01 16:33 UTC

BehatPage::render() A

↳ Parent: BehatPage

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	0
cts	13
cp	0
rs	9.7333
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	6

<?php
/**
 * Yii2 Pages Module
 *
 * @link      https://github.com/hiqdev/yii2-module-pages
 * @package   yii2-module-pages
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\yii2\modules\pages\models;

use hiqdev\yii2\modules\pages\Module;
use Yii;

class BehatPage extends AbstractPage
{
    /**
     * @param array $params
     * @return string
     * @throws \yii\base\ExitException
     * @throws \yii\base\InvalidConfigException
     */
    public function render(array $params = []): string
    {
        $fullPath = Module::getInstance()->getStorage()->getLocalPath($this->path);
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.
    }
}
        $mimeType = mime_content_type($fullPath);

        if ($mimeType !== 'text/plain') {
            throw new \Exception('unexpected mime type for behat feature file');
        }

        $text = Module::getInstance()->getStorage()->read($this->path);
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.
    }
}
        $text = preg_replace('/\b(Feature|Scenario|Background:)\b/', '<b class=behat-command>\1</b>', $text);
        $text = preg_replace('/(@\S+)\b/', '<b class=behat-tag>\1</b>', $text);
        $text = preg_replace('/\b(Given|And|When|Then)\b/', '<b class=behat-step>\1</b>', $text);

        return "<pre>$text</pre>";
    }

    public function extractData($path)
    {
        return [];
    }
}


Push — master ( abf061...1a1da2 )

BehatPage::render() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1			<?php
2			/**
3			* Yii2 Pages Module
4			*
5			* @link https://github.com/hiqdev/yii2-module-pages
6			* @package yii2-module-pages
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hiqdev\yii2\modules\pages\models;
12
13			use hiqdev\yii2\modules\pages\Module;
14			use Yii;
15
16			class BehatPage extends AbstractPage
17			{
18			/**
19			* @param array $params
20			* @return string
21			* @throws \yii\base\ExitException
22			* @throws \yii\base\InvalidConfigException
23			*/
24			public function render(array $params = []): string
25			{
26			$fullPath = Module::getInstance()->getStorage()->getLocalPath($this->path);
			0 ignored issues – show Bug introduced 2020-09-01 16:35 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `hiqdev\yii2\modules\page...rfaces\StorageInterface` as the method `getLocalPath()` does only exist in the following implementations of said interface: `hiqdev\yii2\modules\page...orage\FileSystemStorage`. 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...
27			$mimeType = mime_content_type($fullPath);
28
29			if ($mimeType !== 'text/plain') {
30			throw new \Exception('unexpected mime type for behat feature file');
31			}
32
33			$text = Module::getInstance()->getStorage()->read($this->path);
			0 ignored issues – show Bug introduced 2020-09-01 16:35 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `hiqdev\yii2\modules\page...rfaces\StorageInterface` as the method `read()` does only exist in the following implementations of said interface: `hiqdev\yii2\modules\page...orage\FileSystemStorage`. 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...
34			$text = preg_replace('/\b(Feature\|Scenario\|Background:)\b/', '<b class=behat-command>\1</b>', $text);
35			$text = preg_replace('/(@\S+)\b/', '<b class=behat-tag>\1</b>', $text);
36			$text = preg_replace('/\b(Given\|And\|When\|Then)\b/', '<b class=behat-step>\1</b>', $text);
37
38			return "<pre>$text</pre>";
39			}
40
41			public function extractData($path)
42			{
43			return [];
44			}
45			}
46

hiqdev / yii2-module-pages

Push — master ( abf061...1a1da2 )

BehatPage::render() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like