Merge pull request #15 from magento-commerce/9.0.0-RC

[Pangolin] SVC 9.0.0

Author: soumyau

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "magento/magento-semver",
     "description": "Magento Semantic Version Checker",
-    "version": "8.0.0",
+    "version": "9.0.0",
     "license": [
         "OSL-3.0",
         "AFL-3.0"

composer.lock

@@ -9,6 +9,7 @@
 
 namespace Magento\SemanticVersionChecker\Analyzer;
 
+use Magento\SemanticVersionChecker\ClassHierarchy\DependencyGraph;
 use PhpParser\Node\Stmt\Class_;
 use PHPSemVerChecker\Operation\ClassAdded;
 use PHPSemVerChecker\Operation\ClassRemoved;

src/Analyzer/ClassAnalyzer.php

@@ -24,7 +24,8 @@
 use Magento\SemanticVersionChecker\Operation\Visibility\MethodDecreased as VisibilityMethodDecreased;
 use Magento\SemanticVersionChecker\Operation\Visibility\MethodIncreased as VisibilityMethodIncreased;
 use PhpParser\Node\NullableType;
-use PhpParser\Node\Stmt;
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassLike;
 use PhpParser\Node\Stmt\ClassMethod;
 use PHPSemVerChecker\Comparator\Implementation;
@@ -38,12 +39,6 @@
 use PHPSemVerChecker\Operation\ClassMethodParameterTypingRemoved;
 use PHPSemVerChecker\Operation\ClassMethodRemoved;
 use PHPSemVerChecker\Report\Report;
-use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
-use PHPStan\PhpDocParser\Lexer\Lexer;
-use PHPStan\PhpDocParser\Parser\ConstExprParser;
-use PHPStan\PhpDocParser\Parser\PhpDocParser;
-use PHPStan\PhpDocParser\Parser\TokenIterator;
-use PHPStan\PhpDocParser\Parser\TypeParser;
 
 /**
  * Class method analyzer.
@@ -422,20 +417,62 @@ private function isReturnsEqualByNullability(ClassMethod $before, ClassMethod $a
      */
     private function getDocReturnDeclaration(ClassMethod $method)
     {
-        if ($method->getDocComment() !== null) {
-            $lexer           = new Lexer();
-            $typeParser      = new TypeParser();
-            $constExprParser = new ConstExprParser();
-            $phpDocParser    = new PhpDocParser($typeParser, $constExprParser);
-
-            $tokens        = $lexer->tokenize((string)$method->getDocComment());
-            $tokenIterator = new TokenIterator($tokens);
-            $phpDocNode    = $phpDocParser->parse($tokenIterator);
-            $tags          = $phpDocNode->getTagsByName('@return');
-            /** @var PhpDocTagNode $tag */
-            $tag = array_shift($tags);
+        if (
+            ($parsedComment = $method->getAttribute('docCommentParsed'))
+            && isset($parsedComment['return'])
+        ) {
+            $result = implode('|', $parsedComment['return']);
+
+            return $result;
+        } elseif ($this->dependencyGraph !== null) {
+            /** @var Class_ $methodClass */
+            $methodClass = $method->getAttribute('parent');
+            if ($methodClass) {
+                $ancestors = [];
+                if (!empty($methodClass->extends)) {
+                    $ancestors = $this->addAncestorsToArray($ancestors, $methodClass->extends);
+                }
+                if (!empty($methodClass->implements)) {
+                    $ancestors = $this->addAncestorsToArray($ancestors, $methodClass->implements);
+                }
+                /** @var Name $ancestor */
+                foreach ($ancestors as $ancestor) {
+                    $ancestorClass = $this->dependencyGraph->findEntityByName($ancestor->toString());
+                    if ($ancestorClass) {
+                        foreach ($ancestorClass->getMethodList() as $methodItem) {
+                            if ($method->name->toString() == $methodItem->name->toString()) {
+                                $result = $this->getDocReturnDeclaration($methodItem);
+                                if (!empty(trim($result))) {
+                                    return $result;
+                                }
+                            }
+                        }
+                    }
+                }
+            }
         }
-        return isset($tag) ? (string)$tag->value : ' ';
+
+        return ' ';
+    }
+
+    /**
+     * Add ancestors to array
+     *
+     * @param array $ancestors
+     * @param array|Name $toAdd
+     * @return array
+     */
+    private function addAncestorsToArray(array $ancestors, $toAdd)
+    {
+        if (!empty($toAdd)) {
+            if (is_array($toAdd)) {
+                $ancestors = array_merge($ancestors, $toAdd);
+            } else {
+                $ancestors[] = $toAdd;
+            }
+        }
+
+        return $ancestors;
     }
 
     /**

src/Analyzer/ClassMethodAnalyzer.php

@@ -30,7 +30,7 @@ public function create(DependencyGraph $dependencyGraph = null): AnalyzerInterfa
     {
         $analyzers = [
             new ClassAnalyzer(null, null, null, $dependencyGraph),
-            new InterfaceAnalyzer(),
+            new InterfaceAnalyzer(null, null, null, $dependencyGraph),
             new TraitAnalyzer(),
         ];
 

src/Analyzer/Factory/AnalyzerFactory.php

@@ -28,8 +28,8 @@ class NonApiAnalyzerFactory implements AnalyzerFactoryInterface
     public function create(DependencyGraph $dependencyGraph = null): AnalyzerInterface
     {
         $analyzers = [
-            new ClassAnalyzer(),
-            new InterfaceAnalyzer(),
+            new ClassAnalyzer(null, null, null, $dependencyGraph),
+            new InterfaceAnalyzer(null, null, null, $dependencyGraph),
             new TraitAnalyzer(),
         ];
 

src/Analyzer/Factory/NonApiAnalyzerFactory.php

@@ -139,7 +139,7 @@ protected function reportChanged($report, $registryBefore, $registryAfter, $toVe
     protected function getContentAnalyzers($context, $fileBefore, $fileAfter)
     {
         return [
-            new ClassMethodAnalyzer($context, $fileBefore, $fileAfter),
+            new ClassMethodAnalyzer($context, $fileBefore, $fileAfter, $this->dependencyGraph),
             new ClassConstantAnalyzer($context, $fileBefore, $fileAfter),
             new ClassMethodExceptionAnalyzer($context, $fileBefore, $fileAfter),
             new InterfaceExtendsAnalyzer($context, $fileBefore, $fileAfter)

src/Analyzer/InterfaceAnalyzer.php

@@ -35,6 +35,11 @@
  * - method param typehint moved from in-line to doc block
  * - method return typehint moved from doc block to in-line
  * - method return typehint moved from in-line to doc block
+ *
+ * TODO: this class should be rewritten using new possibility added by
+ * Magento\SemanticVersionChecker\Visitor\NameResolver
+ * Now all information (and resolved typed) about DocBlock params and return type exists in
+ * method node 'docCommentParsed' attribute
  */
 class MethodDocBlockAnalyzer
 {

src/Analyzer/MethodDocBlockAnalyzer.php

@@ -10,8 +10,9 @@
 namespace Magento\SemanticVersionChecker\ClassHierarchy;
 
 use Magento\SemanticVersionChecker\Helper\Node as NodeHelper;
+use Magento\SemanticVersionChecker\Visitor\ParentConnector;
 use PhpParser\NodeTraverser;
-use PhpParser\NodeVisitor\NameResolver;
+use Magento\SemanticVersionChecker\Visitor\NameResolver;
 use PhpParser\ParserFactory;
 
 /**
@@ -31,6 +32,7 @@ public function create(): StaticAnalyzer
         );
         $nodeTraverser               = new NodeTraverser();
 
+        $nodeTraverser->addVisitor(new ParentConnector());
         $nodeTraverser->addVisitor(new NameResolver());
 
         return new StaticAnalyzer($parser, $dependencyInspectionVisitor, $nodeTraverser);

src/ClassHierarchy/StaticAnalyzerFactory.php

@@ -21,7 +21,7 @@ class SuiteBeforeAfterActionGroupRefChanged extends MftfOperation
      * Operation Severity
      * @var int
      */
-    protected $level = Level::MAJOR;
+    protected $level = Level::MINOR;
 
     /**
      * Operation message.