GoogleMobileFriendlyRule::init() - Code Metrics - Inspection of "missing init" - phmLabs/Smoke - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1cc311...2edd5e )

by Nils

created 2019-05-09 07:23 UTC

GoogleMobileFriendlyRule::init() A

↳ Parent: GoogleMobileFriendlyRule

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace whm\Smoke\Rules\Seo;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\UriInterface;
use whm\Html\Uri;
use whm\Smoke\Rules\Attribute;
use whm\Smoke\Rules\CheckResult;
use whm\Smoke\Rules\Rule;

class GoogleMobileFriendlyRule implements Rule
{
    const ENDPOINT = 'https://www.googleapis.com/pagespeedonline/v3beta1/mobileReady?url=#url#&strategy=mobile';

    private function getEndpoint(UriInterface $uri)
    {
        return str_replace('#url#', urlencode((string)$uri), self::ENDPOINT);
    }

    public function init()
    {
        
    }

    public function validate(ResponseInterface $response)
    {
        $uri = $response->getUri();
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.
    }
}

        if (Uri::isBasicAuth($uri)) {
            $result = new CheckResult(CheckResult::STATUS_SKIPPED, 'Google mobile friendliness cannot be checked for an URL with http basic auth.');
            return $result;
        }

        $endpoint = $this->getEndpoint($uri);

        $result = json_decode(file_get_contents($endpoint, false,
            stream_context_create(
                array(
                    'http' => array(
                        'ignore_errors' => true,
                    ),
                )
            )));

        if (property_exists($result, 'error')) {
            $checkResult = new CheckResult(CheckResult::STATUS_FAILURE, 'Google mobile friendly test was not passed. Error "' . $result->error->message . '"');
            $checkResult->addAttribute(new Attribute('Google response', json_encode($result), true));
            return $checkResult;
        }

        $passResult = $result->ruleGroups->USABILITY;

        if (!$passResult->pass) {
            $result = new CheckResult(CheckResult::STATUS_FAILURE, 'Google mobile friendly test was not passed. Score ' . $passResult->score . '/100.', (int)$passResult->score);

        } else {
            $result = new CheckResult(CheckResult::STATUS_SUCCESS, 'Google mobile friendly test passed. Score ' . $passResult->score . '/100.', (int)$passResult->score);
        }

        $result->addAttribute(new Attribute('google_result', json_encode($result), true));
        return $result;
    }
}

1			<?php
2
3			namespace whm\Smoke\Rules\Seo;
4
5			use Psr\Http\Message\ResponseInterface;
6			use Psr\Http\Message\UriInterface;
7			use whm\Html\Uri;
8			use whm\Smoke\Rules\Attribute;
9			use whm\Smoke\Rules\CheckResult;
10			use whm\Smoke\Rules\Rule;
11
12			class GoogleMobileFriendlyRule implements Rule
13			{
14			const ENDPOINT = 'https://www.googleapis.com/pagespeedonline/v3beta1/mobileReady?url=#url#&strategy=mobile';
15
16			private function getEndpoint(UriInterface $uri)
17			{
18			return str_replace('#url#', urlencode((string)$uri), self::ENDPOINT);
19			}
20
21			public function init()
22			{
23
24			}
25
26			public function validate(ResponseInterface $response)
27			{
28			$uri = $response->getUri();
			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...
29
30			if (Uri::isBasicAuth($uri)) {
31			$result = new CheckResult(CheckResult::STATUS_SKIPPED, 'Google mobile friendliness cannot be checked for an URL with http basic auth.');
32			return $result;
33			}
34
35			$endpoint = $this->getEndpoint($uri);
36
37			$result = json_decode(file_get_contents($endpoint, false,
38			stream_context_create(
39			array(
40			'http' => array(
41			'ignore_errors' => true,
42			),
43			)
44			)));
45
46			if (property_exists($result, 'error')) {
47			$checkResult = new CheckResult(CheckResult::STATUS_FAILURE, 'Google mobile friendly test was not passed. Error "' . $result->error->message . '"');
48			$checkResult->addAttribute(new Attribute('Google response', json_encode($result), true));
49			return $checkResult;
50			}
51
52			$passResult = $result->ruleGroups->USABILITY;
53
54			if (!$passResult->pass) {
55			$result = new CheckResult(CheckResult::STATUS_FAILURE, 'Google mobile friendly test was not passed. Score ' . $passResult->score . '/100.', (int)$passResult->score);
56
57			} else {
58			$result = new CheckResult(CheckResult::STATUS_SUCCESS, 'Google mobile friendly test passed. Score ' . $passResult->score . '/100.', (int)$passResult->score);
59			}
60
61			$result->addAttribute(new Attribute('google_result', json_encode($result), true));
62			return $result;
63			}
64			}

phmLabs / Smoke

Push — master ( 1cc311...2edd5e )

GoogleMobileFriendlyRule::init() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like