BigFilesRule::doValidation() - Code Metrics - Inspection of "SiteInfo rules" - phmLabs/Smoke - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9ad1a6...571f4d )

by Nils

created 2017-05-04 04:23 UTC

BigFilesRule::doValidation() B

↳ Parent: BigFilesRule

Complexity

Conditions	6
Paths	6

Size

Total Lines	25
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	25
rs	8.439
cc	6
eloc	15
nc	6
nop	1

<?php

namespace whm\Smoke\Rules\Html;

use phm\HttpWebdriverClient\Http\Response\ResourcesAwareResponse;
use Psr\Http\Message\ResponseInterface;
use whm\Smoke\Rules\Attribute;
use whm\Smoke\Rules\CheckResult;
use whm\Smoke\Rules\StandardRule;

/**
 * This rule calculates the size of a html document. If the document is bigger than a given value
 * the test will fail.
 */
class BigFilesRule extends StandardRule
{
    private $maxElementSize;

    protected $contentTypes = array('text/html');

    public function init($maxSize = 400)
    {
        $this->maxElementSize = $maxSize;
    }

    protected function doValidation(ResponseInterface $response)
    {
        $bigFiles = [];

        if ($response instanceof ResourcesAwareResponse) {
            foreach ($response->getResources() as $resource) {
                $resourceSize = round($resource['transferSize'] / 1000);

                if ($resourceSize > $this->maxElementSize) {
                    $bigFiles[] = ['name' => $resource['name'], 'size' => $resourceSize];
                }
            }
        }

        if (count($bigFiles) > 0) {
            $message = "Some files were found that are too big (max: " . $this->maxElementSize . " KB):<ul>";
            foreach ($bigFiles as $bigFile) {
                $message .= '<li>File: ' . $bigFile['name'] . ', Size: ' . $bigFile['size'] . ' KB</li>';
            }
            $message .= "</ul>";
            $result = new CheckResult(CheckResult::STATUS_FAILURE, $message, count($bigFiles));
            $result->addAttribute(new Attribute('resources', $response->getResources(), true));
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 $result;
        }
    }
}


1			<?php
2
3			namespace whm\Smoke\Rules\Html;
4
5			use phm\HttpWebdriverClient\Http\Response\ResourcesAwareResponse;
6			use Psr\Http\Message\ResponseInterface;
7			use whm\Smoke\Rules\Attribute;
8			use whm\Smoke\Rules\CheckResult;
9			use whm\Smoke\Rules\StandardRule;
10
11			/**
12			* This rule calculates the size of a html document. If the document is bigger than a given value
13			* the test will fail.
14			*/
15			class BigFilesRule extends StandardRule
16			{
17			private $maxElementSize;
18
19			protected $contentTypes = array('text/html');
20
21			public function init($maxSize = 400)
22			{
23			$this->maxElementSize = $maxSize;
24			}
25
26			protected function doValidation(ResponseInterface $response)
27			{
28			$bigFiles = [];
29
30			if ($response instanceof ResourcesAwareResponse) {
31			foreach ($response->getResources() as $resource) {
32			$resourceSize = round($resource['transferSize'] / 1000);
33
34			if ($resourceSize > $this->maxElementSize) {
35			$bigFiles[] = ['name' => $resource['name'], 'size' => $resourceSize];
36			}
37			}
38			}
39
40			if (count($bigFiles) > 0) {
41			$message = "Some files were found that are too big (max: " . $this->maxElementSize . " KB):<ul>";
42			foreach ($bigFiles as $bigFile) {
43			$message .= '<li>File: ' . $bigFile['name'] . ', Size: ' . $bigFile['size'] . ' KB</li>';
44			}
45			$message .= "</ul>";
46			$result = new CheckResult(CheckResult::STATUS_FAILURE, $message, count($bigFiles));
47			$result->addAttribute(new Attribute('resources', $response->getResources(), true));
			0 ignored issues – show Bug introduced 2017-05-04 04:25 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 `getResources()` does only exist in the following implementations of said interface: `phm\HttpWebdriverClient\...t\Chrome\ChromeResponse`. 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...
48			return $result;
49			}
50			}
51			}
52

phmLabs / Smoke

Push — master ( 9ad1a6...571f4d )

BigFilesRule::doValidation() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like