new Insight: Dirty Class Detector

[szepeviktor]

/**
 * Dirty Class Detector.
 *
 * @package Dirtyclassdetector
 */

use PhpParser\Error;
use PhpParser\ParserFactory;
use PhpParser\Node;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitorAbstract;

require __DIR__.'/vendor/autoload.php';

$code = file_get_contents($argv[1]);

$hasSideEffect = false;

$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
try {
    $ast = $parser->parse($code);
} catch (Error $error) {
    echo "Parse error: {$error->getMessage()}\n";
    exit(1);
}

$cleaner = new NodeTraverser;
$cleaner->addVisitor(new class extends NodeVisitorAbstract {
    public function leaveNode(Node $node) {
        // TODO class+trait+interface count must be 1, declare count 0-1, group/use 0+
        if (
            $node instanceof Node\Stmt\Interface_
            || $node instanceof Node\Stmt\Trait_
            || $node instanceof Node\Stmt\Class_
            || $node instanceof Node\Stmt\Use_
            || $node instanceof Node\Stmt\GroupUse
            || $node instanceof Node\Stmt\Declare_
        ) {
            return NodeTraverser::REMOVE_NODE;
        }
    }
});
$cleaned = $cleaner->traverse($ast);

$detector = new NodeTraverser;
$detector->addVisitor(new class extends NodeVisitorAbstract {
    public function leaveNode(Node $node) {
        global $hasSideEffect;
        // TODO namespace 0-1, name 1 per namespace
        if ($node instanceof Node\Stmt\Namespace_ || $node instanceof Node\Name) {
            return;
        }
        echo "Side effect: {$node->getType()}\n";
        $hasSideEffect = true;
    }
});
$detector->traverse($cleaned);

if ($hasSideEffect) {
    exit(2);
}

[szepeviktor]

Uses nikic/php-parser

[nunomaduro]

Could you summarise what this code it's doing? It's not clear for me. 🤔

[szepeviktor]

namespace boo;

class dirt {
	function foo() {
		sleep(1);
	}
}
echo "I'm a junior developer";

• it parses the code
• removes interface/class/etc. and everything in it
• if the remaining thing is not a namespace statement it alerts you: "Dirty Class"

[szepeviktor]

I meet new code bases every month an I need this tool to make sure each file contains only 1 class.

[nunomaduro]

I see. It's a good Insight. I will add it!

[szepeviktor]

Thank you.

[nunomaduro]

There is already an Insight for this.

[szepeviktor]

Very well!!