SyntaxRule::init() - Code Metrics - phmLabs/Smoke - Measure and Improve Code Quality continuously with Scrutinizer

SyntaxRule::init() A
last analyzed 2019-05-12 19:55 UTC

↳ Parent: SyntaxRule

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace whm\Smoke\Rules\Js;

use Psr\Http\Message\ResponseInterface;
use whm\Smoke\Rules\Rule;
use whm\Smoke\Rules\ValidationFailedException;

/**
 * This rule uses jshint to validate js files. It will find js syntax errors.
 */
class SyntaxRule implements Rule
{
    private $jsHintExecutable;
    private $tmpDir;

    /**
     * @param $jsHintExecutable string The path to the jshint executable
     * @param $tmpDir string The directory the temporary js file should be stored
     */
    public function init($jsHintExecutable = '', $tmpDir = '/tmp')
    {
        $this->jsHintExecutable = $jsHintExecutable;
        $this->tmpDir = $tmpDir;
    }

    public function validate(ResponseInterface $response)
    {
        if ($response->getContentType() !== 'application/javascript') {
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;
        }

        $filename = $this->tmpDir . DIRECTORY_SEPARATOR . md5((string)$response->getBody()) . '.js';
        file_put_contents($filename, (string)$response->getBody());
        $conf = __DIR__ . DIRECTORY_SEPARATOR . 'jsHint.conf';

        $command = $this->jsHintExecutable . ' --config ' . $conf . ' --verbose ' . $filename . ' | grep -E E[0-9]+.$';
        $validationResult = shell_exec($command);

        unlink($filename);

        if (!is_null($validationResult)) {
            $errorMsg = str_replace($filename . ':', '', $validationResult);
            throw new ValidationFailedException('JavaScript error found: ' . $errorMsg);
        }
    }
}


1			<?php
2
3			namespace whm\Smoke\Rules\Js;
4
5			use Psr\Http\Message\ResponseInterface;
6			use whm\Smoke\Rules\Rule;
7			use whm\Smoke\Rules\ValidationFailedException;
8
9			/**
10			* This rule uses jshint to validate js files. It will find js syntax errors.
11			*/
12			class SyntaxRule implements Rule
13			{
14			private $jsHintExecutable;
15			private $tmpDir;
16
17			/**
18			* @param $jsHintExecutable string The path to the jshint executable
19			* @param $tmpDir string The directory the temporary js file should be stored
20			*/
21			public function init($jsHintExecutable = '', $tmpDir = '/tmp')
22			{
23			$this->jsHintExecutable = $jsHintExecutable;
24			$this->tmpDir = $tmpDir;
25			}
26
27			public function validate(ResponseInterface $response)
28			{
29			if ($response->getContentType() !== 'application/javascript') {
			0 ignored issues – show Bug introduced 2018-06-04 19:37 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 `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 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			$filename = $this->tmpDir . DIRECTORY_SEPARATOR . md5((string)$response->getBody()) . '.js';
34			file_put_contents($filename, (string)$response->getBody());
35			$conf = __DIR__ . DIRECTORY_SEPARATOR . 'jsHint.conf';
36
37			$command = $this->jsHintExecutable . ' --config ' . $conf . ' --verbose ' . $filename . ' \| grep -E E[0-9]+.$';
38			$validationResult = shell_exec($command);
39
40			unlink($filename);
41
42			if (!is_null($validationResult)) {
43			$errorMsg = str_replace($filename . ':', '', $validationResult);
44			throw new ValidationFailedException('JavaScript error found: ' . $errorMsg);
45			}
46			}
47			}
48

phmLabs / Smoke

SyntaxRule::init() A last analyzed 2019-05-12 19:55 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

SyntaxRule::init() A
last analyzed 2019-05-12 19:55 UTC