rename AbstractMatchResult → MatchResult (#26)

add factory method to create `MatchResult`s from id added tests
plesk · Oct 12, 2023 · 5d8bb6c · 5d8bb6c
1 parent 8e74858
commit 5d8bb6c
Show file tree

Hide file tree

Showing 19 changed files with 95 additions and 22 deletions.
diff --git a/src/MatchResult/CakePHP.php b/src/MatchResult/CakePHP.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class CakePHP extends AbstractMatchResult
+class CakePHP extends MatchResult
 {
     public const ID = 'cakephp';
     public const NAME = 'CakePHP';

diff --git a/src/MatchResult/CodeIgniter.php b/src/MatchResult/CodeIgniter.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class CodeIgniter extends AbstractMatchResult
+class CodeIgniter extends MatchResult
 {
     public const ID = 'codeigniter';
     public const NAME = 'CodeIgniter';

diff --git a/src/MatchResult/Composer.php b/src/MatchResult/Composer.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Composer extends AbstractMatchResult
+class Composer extends MatchResult
 {
     public const ID = 'composer';
     public const NAME = 'Composer';

diff --git a/src/MatchResult/DotNet.php b/src/MatchResult/DotNet.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class DotNet extends AbstractMatchResult
+class DotNet extends MatchResult
 {
     public const ID = 'dotnet';
     public const NAME = '.NET';

diff --git a/src/MatchResult/Drupal.php b/src/MatchResult/Drupal.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Drupal extends AbstractMatchResult
+class Drupal extends MatchResult
 {
     public const ID = 'drupal';
     public const NAME = 'Drupal';

diff --git a/src/MatchResult/Joomla.php b/src/MatchResult/Joomla.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Joomla extends AbstractMatchResult
+class Joomla extends MatchResult
 {
     public const ID = 'joomla';
     public const NAME = 'Joomla!';

diff --git a/src/MatchResult/Laravel.php b/src/MatchResult/Laravel.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Laravel extends AbstractMatchResult
+class Laravel extends MatchResult
 {
     public const ID = 'laravel';
     public const NAME = 'Laravel';

diff --git a/src/MatchResult/AbstractMatchResult.php → src/MatchResult/MatchResult.php b/src/MatchResult/AbstractMatchResult.php → src/MatchResult/MatchResult.php
@@ -9,7 +9,7 @@
 use League\Flysystem\PathTraversalDetected;
 use League\Flysystem\WhitespacePathNormalizer;
 
-abstract class AbstractMatchResult implements MatchResultInterface, JsonSerializable
+class MatchResult implements MatchResultInterface, JsonSerializable
 {
     public const ID = null;
     public const NAME = null;
@@ -61,4 +61,37 @@ public function jsonSerialize(): array
             'application' => $this->getApplication(),
         ];
     }
+
+    public static function createById(
+        string $id,
+        ?string $path = null,
+        ?string $version = null,
+        ?string $application = null
+    ): MatchResultInterface {
+        $classname = match ($id) {
+            CakePHP::ID => CakePHP::class,
+            CodeIgniter::ID => CodeIgniter::class,
+            Composer::ID => Composer::class,
+            DotNet::ID => DotNet::class,
+            Drupal::ID => Drupal::class,
+            Joomla::ID => Joomla::class,
+            Laravel::ID => Laravel::class,
+            NodeJs::ID => NodeJs::class,
+            Php::ID => Php::class,
+            Prestashop::ID => Prestashop::class,
+            Python::ID => Python::class,
+            Ruby::ID => Ruby::class,
+            Symfony::ID => Symfony::class,
+            Typo3::ID => Typo3::class,
+            Wordpress::ID => Wordpress::class,
+            Yii::ID => Yii::class,
+            default => null,
+        };
+
+        if (!$classname) {
+            return new EmptyMatchResult();
+        }
+
+        return new $classname(path: $path ?? '', version: $version, application: $application);
+    }
 }
diff --git a/src/MatchResult/NodeJs.php b/src/MatchResult/NodeJs.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class NodeJs extends AbstractMatchResult
+class NodeJs extends MatchResult
 {
     public const ID = 'nodejs';
     public const NAME = 'Node.js';

diff --git a/src/MatchResult/Php.php b/src/MatchResult/Php.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Php extends AbstractMatchResult
+class Php extends MatchResult
 {
     public const ID = 'php';
     public const NAME = 'PHP';

diff --git a/src/MatchResult/Prestashop.php b/src/MatchResult/Prestashop.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Prestashop extends AbstractMatchResult
+class Prestashop extends MatchResult
 {
     public const ID = 'prestashop';
     public const NAME = 'PrestaShop';

diff --git a/src/MatchResult/Python.php b/src/MatchResult/Python.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Python extends AbstractMatchResult
+class Python extends MatchResult
 {
     public const ID = 'python';
     public const NAME = 'Python';

diff --git a/src/MatchResult/Ruby.php b/src/MatchResult/Ruby.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Ruby extends AbstractMatchResult
+class Ruby extends MatchResult
 {
     public const ID = 'ruby';
     public const NAME = 'Ruby';

diff --git a/src/MatchResult/Symfony.php b/src/MatchResult/Symfony.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Symfony extends AbstractMatchResult
+class Symfony extends MatchResult
 {
     public const ID = 'symfony';
     public const NAME = 'Symfony';

diff --git a/src/MatchResult/Typo3.php b/src/MatchResult/Typo3.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Typo3 extends AbstractMatchResult
+class Typo3 extends MatchResult
 {
     public const ID = 'typo3';
     public const NAME = 'TYPO3';

diff --git a/src/MatchResult/Wordpress.php b/src/MatchResult/Wordpress.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Wordpress extends AbstractMatchResult
+class Wordpress extends MatchResult
 {
     public const ID = 'wordpress';
     public const NAME = 'WordPress';

diff --git a/src/MatchResult/Yii.php b/src/MatchResult/Yii.php
@@ -5,7 +5,7 @@
 
 namespace Plesk\Wappspector\MatchResult;
 
-class Yii extends AbstractMatchResult
+class Yii extends MatchResult
 {
     public const ID = 'yii';
     public const NAME = 'Yii';

diff --git a/tests/MatchResult/MatchResultTest.php b/tests/MatchResult/MatchResultTest.php
@@ -7,17 +7,21 @@
 
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
-use Plesk\Wappspector\MatchResult\AbstractMatchResult;
+use Plesk\Wappspector\MatchResult\EmptyMatchResult;
+use Plesk\Wappspector\MatchResult\MatchResult;
+use Plesk\Wappspector\MatchResult\Php;
+use Plesk\Wappspector\MatchResult\Python;
+use Plesk\Wappspector\MatchResult\Wordpress;
 
-#[CoversClass(AbstractMatchResult::class)]
+#[CoversClass(MatchResult::class)]
 class MatchResultTest extends TestCase
 {
     /**
      * @dataProvider pathDataProvider
      */
     public function testParentDirNormalization($originalPath, $normalizedPath): void
     {
-        $matchResult = new class ($originalPath) extends AbstractMatchResult {
+        $matchResult = new class ($originalPath) extends MatchResult {
             public function getId(): string
             {
                 return 'mock';
@@ -47,4 +51,40 @@ public static function pathDataProvider(): array
             ['/parent/../../', '/'],
         ];
     }
+
+    public function testFactoryMethodEmptyResult(): void
+    {
+        $this->assertInstanceOf(EmptyMatchResult::class, MatchResult::createById('someunknownid'));
+    }
+
+    /**
+     * @dataProvider idsProvider
+     */
+    public function testFactoryMethod(string $id, string $classname): void
+    {
+        $this->assertInstanceOf($classname, MatchResult::createById($id));
+    }
+
+    public static function idsProvider(): array
+    {
+        return [
+            [Wordpress::ID, Wordpress::class],
+            [Php::ID, Php::class],
+            [Python::ID, Python::class],
+        ];
+    }
+
+    public function testFactoryMethodArgs(): void
+    {
+        $args = [
+            'path' => 'var/www',
+            'version' => '1.2.3',
+            'application' => 'My App',
+        ];
+        $result = MatchResult::createById('php', ...$args);
+        $this->assertInstanceOf(Php::class, $result);
+        $this->assertEquals($args['path'], $result->getPath());
+        $this->assertEquals($args['version'], $result->getVersion());
+        $this->assertEquals($args['application'], $result->getApplication());
+    }
 }
diff --git a/tests/Matchers/UpLevelMatcherTraitTest.php b/tests/Matchers/UpLevelMatcherTraitTest.php
@@ -14,8 +14,8 @@
 use Plesk\Wappspector\FileSystemFactory;
 use Plesk\Wappspector\Matchers\MatcherInterface;
 use Plesk\Wappspector\Matchers\UpLevelMatcherTrait;
-use Plesk\Wappspector\MatchResult\AbstractMatchResult;
 use Plesk\Wappspector\MatchResult\EmptyMatchResult;
+use Plesk\Wappspector\MatchResult\MatchResult;
 use Plesk\Wappspector\MatchResult\MatchResultInterface;
 
 #[CoversClass(UpLevelMatcherTrait::class)]
@@ -48,7 +48,7 @@ protected function doMatch(Filesystem $fs, string $path): MatchResultInterface
                 foreach ($list as $item) {
                     /** @var StorageAttributes $item */
                     if ($item->isFile() && str_ends_with($item->path(), '.md')) {
-                        return new class ($path) extends AbstractMatchResult {
+                        return new class ($path) extends MatchResult {
                             public function getId(): string
                             {
                                 return 'markdown';