InvalidUrlsRule   A
last analyzed

Complexity

Total Complexity 4

Size/Duplication

Total Lines 28
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 4

Importance

Changes 0
Metric Value
wmc 4
lcom 0
cbo 4
dl 0
loc 28
rs 10
c 0
b 0
f 0

1 Method

Rating   Name   Duplication   Size   Complexity  
A doValidation() 0 20 4
1
<?php
2
3
namespace whm\Smoke\Rules\Html;
4
5
use Psr\Http\Message\ResponseInterface;
6
use whm\Html\Document;
7
use whm\Smoke\Rules\StandardRule;
8
9
/**
10
 * This rule find invalid URLs which are hyperlinked in a given site.
11
 */
12
class InvalidUrlsRule extends StandardRule
13
{
14
    protected $contentTypes = array('text/html');
15
16
    /**
17
     * {@inheritdoc}
18
     */
19
    protected function doValidation(ResponseInterface $response)
20
    {
21
        $document = new Document((string)$response->getBody(), false);
22
        $urls = $document->getDependencies($response->getUri());
0 ignored issues
show
Bug introduced by
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

  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...
23
        $invalidUrls = array();
24
25
        foreach ($urls as $url) {
26
            if (function_exists('idn_to_ascii')) {
27
                $idnUrl = $url->getScheme() . '://' . idn_to_ascii($url->getHost(), 0, INTL_IDNA_VARIANT_UTS46) . $url->getPath();
28
            } else {
29
                $idnUrl = $url->getScheme() . '://' . $url->getHost() . $url->getPath();
30
            }
31
32
            if (!filter_var($idnUrl, FILTER_VALIDATE_URL)) {
33
                $invalidUrls[] = (string)$url;
34
            }
35
        }
36
37
        $this->assert(count($invalidUrls) === 0, 'Invalid urls found (' . implode(', ', $invalidUrls) . ').');
38
    }
39
}
40