DuplicateIdRule::validate()   A
last analyzed

Complexity

Conditions 5
Paths 7

Size

Total Lines 27

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 27
rs 9.1768
c 0
b 0
f 0
cc 5
nc 7
nop 1
1
<?php
2
3
namespace whm\Smoke\Rules\Xml;
4
5
use Psr\Http\Message\ResponseInterface;
6
use Symfony\Component\DomCrawler\Crawler;
7
use whm\Smoke\Rules\Rule;
8
use whm\Smoke\Rules\ValidationFailedException;
9
10
/**
11
 * This rule checks if a css id is duplicated.
12
 */
13
class DuplicateIdRule implements Rule
14
{
15
    public function validate(ResponseInterface $response)
16
    {
17
        if ($response->getContentType() !== 'text/html') {
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 getContentType() 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.

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...
18
            return;
19
        }
20
21
        $crawler = new Crawler((string)$response->getBody());
22
23
        $idList = $crawler->filterXPath('//*[@id!=""]');
24
25
        $foundIds = array();
26
        $duplicatedIds = array();
27
28
        foreach ($idList as $idElement) {
29
            $id = $idElement->getAttribute('id');
30
            if (array_key_exists($id, $foundIds)) {
31
                $duplicatedIds[$id] = true;
32
            } else {
33
                $foundIds[$id] = true;
34
            }
35
        }
36
37
        if (count($duplicatedIds) > 0) {
38
            unset($duplicatedIds['']);
39
            throw new ValidationFailedException('Duplicate ids found (' . implode(', ', array_keys($duplicatedIds)) . ')');
40
        }
41
    }
42
}
43