PhpLeadingLineReviewNoBlade::review() - Code Metrics - Inspection of "fixed dd and add blade file" - padosoft/static-review - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e67f65...ca0828 )

by Alessandro

created 2016-02-24 12:26 UTC

PhpLeadingLineReviewNoBlade::review() A

↳ Parent: PhpLeadingLineReviewNoBlade

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	1

Metric	Value
c	1
b	1
f	1
dl	0
loc	13
rs	9.4285
cc	2
eloc	7
nc	2
nop	2

<?php

/*
 * This file is part of StaticReview
 *
 * Copyright (c) 2014 Samuel Parkinson <@samparkinson_>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @see http://github.com/sjparkinson/static-review/blob/master/LICENSE
 */

namespace Padosoft\StaticReview\PHP;

use StaticReview\File\FileInterface;
use StaticReview\Reporter\ReporterInterface;
use StaticReview\Review\AbstractFileReview;
use StaticReview\Review\ReviewableInterface;

class PhpLeadingLineReviewNoBlade extends AbstractFileReview
{
    /**
     * Determins if the given file should be revewed.
     *
     * @param  FileInterface $file
     * @return bool
     */
    public function canReviewFile(FileInterface $file)
    {
        return ($file->getExtension() === 'php' && substr($file->getFileName(),-strlen('blade.php'))!='blade.php');
    }

    /**
     * Checks if the set file starts with the correct character sequence, which
     * helps to stop any rouge whitespace making it in before the first php tag.
     *
     * @link http://stackoverflow.com/a/2440685
     */
    public function review(ReporterInterface $reporter, ReviewableInterface $file)
    {
        $cmd = sprintf('read -r LINE < %s && echo $LINE', $file->getFullPath());
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.
    }
}

        $process = $this->getProcess($cmd);
        $process->run();

        if (! in_array(trim($process->getOutput()), ['<?php', '#!/usr/bin/env php'])) {
            $message = 'File must begin with `<?php` or `#!/usr/bin/env php`';
            $reporter->error($message, $this, $file);

        }
    }
}


1			<?php
2
3			/*
4			* This file is part of StaticReview
5			*
6			* Copyright (c) 2014 Samuel Parkinson <@samparkinson_>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*
11			* @see http://github.com/sjparkinson/static-review/blob/master/LICENSE
12			*/
13
14			namespace Padosoft\StaticReview\PHP;
15
16			use StaticReview\File\FileInterface;
17			use StaticReview\Reporter\ReporterInterface;
18			use StaticReview\Review\AbstractFileReview;
19			use StaticReview\Review\ReviewableInterface;
20
21			class PhpLeadingLineReviewNoBlade extends AbstractFileReview
22			{
23			/**
24			* Determins if the given file should be revewed.
25			*
26			* @param FileInterface $file
27			* @return bool
28			*/
29			public function canReviewFile(FileInterface $file)
30			{
31			return ($file->getExtension() === 'php' && substr($file->getFileName(),-strlen('blade.php'))!='blade.php');
32			}
33
34			/**
35			* Checks if the set file starts with the correct character sequence, which
36			* helps to stop any rouge whitespace making it in before the first php tag.
37			*
38			* @link http://stackoverflow.com/a/2440685
39			*/
40			public function review(ReporterInterface $reporter, ReviewableInterface $file)
41			{
42			$cmd = sprintf('read -r LINE < %s && echo $LINE', $file->getFullPath());
			0 ignored issues – show Bug introduced 2016-02-24 12:28 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `StaticReview\Review\ReviewableInterface` as the method `getFullPath()` does only exist in the following implementations of said interface: `StaticReview\File\File`. 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...
43
44			$process = $this->getProcess($cmd);
45			$process->run();
46
47			if (! in_array(trim($process->getOutput()), ['<?php', '#!/usr/bin/env php'])) {
48			$message = 'File must begin with `<?php` or `#!/usr/bin/env php`';
49			$reporter->error($message, $this, $file);
50
51			}
52			}
53			}
54

padosoft / static-review

Push — master ( e67f65...ca0828 )

PhpLeadingLineReviewNoBlade::review() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like