Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of Psy Shell.
Chris@0:  *
Chris@0:  * (c) 2012-2018 Justin Hileman
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Psy\CodeCleaner;
Chris@0: 
Chris@0: use PhpParser\Node;
Chris@0: use PhpParser\Node\Stmt\Class_;
Chris@0: use PhpParser\Node\Stmt\ClassMethod;
Chris@0: use Psy\Exception\FatalErrorException;
Chris@0: 
Chris@0: /**
Chris@0:  * The abstract class pass handles abstract classes and methods, complaining if there are too few or too many of either.
Chris@0:  */
Chris@0: class AbstractClassPass extends CodeCleanerPass
Chris@0: {
Chris@0:     private $class;
Chris@0:     private $abstractMethods;
Chris@0: 
Chris@0:     /**
Chris@0:      * @throws RuntimeException if the node is an abstract function with a body
Chris@0:      *
Chris@0:      * @param Node $node
Chris@0:      */
Chris@0:     public function enterNode(Node $node)
Chris@0:     {
Chris@0:         if ($node instanceof Class_) {
Chris@0:             $this->class = $node;
Chris@0:             $this->abstractMethods = [];
Chris@0:         } elseif ($node instanceof ClassMethod) {
Chris@0:             if ($node->isAbstract()) {
Chris@0:                 $name = sprintf('%s::%s', $this->class->name, $node->name);
Chris@0:                 $this->abstractMethods[] = $name;
Chris@0: 
Chris@0:                 if ($node->stmts !== null) {
Chris@0:                     $msg = sprintf('Abstract function %s cannot contain body', $name);
Chris@0:                     throw new FatalErrorException($msg, 0, E_ERROR, null, $node->getLine());
Chris@0:                 }
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @throws RuntimeException if the node is a non-abstract class with abstract methods
Chris@0:      *
Chris@0:      * @param Node $node
Chris@0:      */
Chris@0:     public function leaveNode(Node $node)
Chris@0:     {
Chris@0:         if ($node instanceof Class_) {
Chris@0:             $count = count($this->abstractMethods);
Chris@0:             if ($count > 0 && !$node->isAbstract()) {
Chris@0:                 $msg = sprintf(
Chris@0:                     'Class %s contains %d abstract method%s must therefore be declared abstract or implement the remaining methods (%s)',
Chris@0:                     $node->name,
Chris@0:                     $count,
Chris@0:                     ($count === 1) ? '' : 's',
Chris@0:                     implode(', ', $this->abstractMethods)
Chris@0:                 );
Chris@0:                 throw new FatalErrorException($msg, 0, E_ERROR, null, $node->getLine());
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: }