FavIconRule - Code Metrics - phmLabs/Smoke - Measure and Improve Code Quality continuously with Scrutinizer

FavIconRule A
last analyzed 2019-05-12 19:55 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	26
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
wmc	2
lcom	1
cbo	2
dl	0
loc	26
rs	10
c	0
b	0
f	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	doValidation()	0	10	2

<?php

namespace whm\Smoke\Rules\Image;

use Psr\Http\Message\ResponseInterface;
use whm\Smoke\Http\Response;
use whm\Smoke\Rules\StandardRule;

/**
 * This rule checks if the favicon that is used is the framework default.
 */
class FavIconRule extends StandardRule
{
    protected $contentTypes = array('image');

    private $favicons = array(
        '231567a8cc45c2cf966c4e8d99a5b7fd' => 'symfony2',
        '53a151ba1af3acdefe16fbbdad937ee4' => 'wordpress',
        'e6a9dc66179d8c9f34288b16a02f987e' => 'drupal',
        '8718c2998236c796896b725f264092ee' => 'typo3',
        '1da050bcdd95e30c3cd984cf1d450f81' => 'neos2',
        'abe604b0b1b232bc1d37ea23e619eb2a' => 'magento',
        'c1f20852dd1caf078f49de77a2de8e3f' => 'vbulletin',
        'cfe845e2eaaf1bf4e86b5921df1d39f3' => 'phpbb',
    );

    protected function doValidation(ResponseInterface $response)
    {
        if (strpos((string) $response->getUri(), 'favicon.ico') === false) {
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;
        }

        $imageHash = md5((string)$response->getBody());

        $this->assert(!array_key_exists($imageHash, $this->favicons), 'Seems like you use the standard favicon of your framework (' . $this->favicons[$imageHash] . ').');
    }
}


1			<?php
2
3			namespace whm\Smoke\Rules\Image;
4
5			use Psr\Http\Message\ResponseInterface;
6			use whm\Smoke\Http\Response;
7			use whm\Smoke\Rules\StandardRule;
8
9			/**
10			* This rule checks if the favicon that is used is the framework default.
11			*/
12			class FavIconRule extends StandardRule
13			{
14			protected $contentTypes = array('image');
15
16			private $favicons = array(
17			'231567a8cc45c2cf966c4e8d99a5b7fd' => 'symfony2',
18			'53a151ba1af3acdefe16fbbdad937ee4' => 'wordpress',
19			'e6a9dc66179d8c9f34288b16a02f987e' => 'drupal',
20			'8718c2998236c796896b725f264092ee' => 'typo3',
21			'1da050bcdd95e30c3cd984cf1d450f81' => 'neos2',
22			'abe604b0b1b232bc1d37ea23e619eb2a' => 'magento',
23			'c1f20852dd1caf078f49de77a2de8e3f' => 'vbulletin',
24			'cfe845e2eaaf1bf4e86b5921df1d39f3' => 'phpbb',
25			);
26
27			protected function doValidation(ResponseInterface $response)
28			{
29			if (strpos((string) $response->getUri(), 'favicon.ico') === false) {
			0 ignored issues – show Bug introduced 2018-12-28 01:14 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Http\Message\ResponseInterface` as the method `getUri()` does only exist in the following implementations of said interface: `phm\HttpWebdriverClient\...t\Chrome\ChromeResponse`, `phm\HttpWebdriverClient\...t\Guzzle\GuzzleResponse`, `phm\HttpWebdriverClient\...\Client\Guzzle\Response`, `phm\HttpWebdriverClient\...esponse\BrowserResponse`, `whm\Smoke\Http\ConnectionRefusedResponse`, `whm\Smoke\Http\ErrorResponse`. 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...
30			return;
31			}
32
33			$imageHash = md5((string)$response->getBody());
34
35			$this->assert(!array_key_exists($imageHash, $this->favicons), 'Seems like you use the standard favicon of your framework (' . $this->favicons[$imageHash] . ').');
36			}
37			}
38

phmLabs / Smoke

FavIconRule A last analyzed 2019-05-12 19:55 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Available Fixes

Duplication Side-by-Side

Filter issues like

FavIconRule A
last analyzed 2019-05-12 19:55 UTC