Allow base package, constraint and collection classes to be overridden

Author: bennothommo

src/Commands/Search.php

@@ -2,9 +2,8 @@
 
 namespace Winter\Packager\Commands;
 
+use Winter\Packager\Composer;
 use Winter\Packager\Exceptions\CommandException;
-use Winter\Packager\Package\Package;
-use Winter\Packager\Package\Collection;
 
 /**
  * Search command.
@@ -72,14 +71,14 @@ public function execute()
         foreach ($results as $result) {
             [$namespace, $name] = preg_split('/\//', $result['name'], 2);
 
-            $packages[] = new Package(
+            $packages[] = Composer::newPackage(
                 $namespace,
                 $name,
                 $result['description'] ?? ''
             );
         }
 
-        return new Collection($packages);
+        return Composer::newCollection($packages);
     }
 
     /**

src/Commands/Show.php

@@ -2,12 +2,9 @@
 
 namespace Winter\Packager\Commands;
 
+use Winter\Packager\Composer;
 use Winter\Packager\Enums\VersionStatus;
 use Winter\Packager\Exceptions\CommandException;
-use Winter\Packager\Package\Collection;
-use Winter\Packager\Package\DetailedPackage;
-use Winter\Packager\Package\Package;
-use Winter\Packager\Package\VersionedPackage;
 
 /**
  * Show command.
@@ -115,7 +112,7 @@ public function execute()
                 [$namespace, $name] = $this->nameSplit($result['name']);
 
                 if (isset($result['version'])) {
-                    $packages[] = new VersionedPackage(
+                    $packages[] = Composer::newVersionedPackage(
                         $namespace,
                         $name,
                         $result['description'] ?? '',
@@ -124,34 +121,34 @@ public function execute()
                         VersionStatus::tryFrom($result['latest-status'] ?? '') ?? VersionStatus::UP_TO_DATE
                     );
                 } else {
-                    $packages[] = new Package(
+                    $packages[] = Composer::newPackage(
                         $namespace,
                         $name,
                         $result['description'] ?? '',
                     );
                 }
             }
 
-            return new Collection($packages);
+            return Composer::newCollection($packages);
         } elseif (is_null($this->package) && $this->mode === 'available') {
             // Convert entire available package list into a package collection
             foreach ($results['available'] as $result) {
                 [$namespace, $name] = $this->nameSplit($result['name']);
 
-                $packages[] = new Package(
+                $packages[] = Composer::newPackage(
                     $namespace,
                     $name,
                     $result['description'] ?? '',
                 );
             }
 
-            return new Collection($packages);
+            return Composer::newCollection($packages);
         } elseif ($this->mode === 'self') {
             $result = $results;
             [$namespace, $name] = $this->nameSplit($result['name']);
 
             // Return the current package
-            return new DetailedPackage(
+            return Composer::newDetailedPackage(
                 $namespace,
                 $name,
                 $result['description'] ?? '',
@@ -170,7 +167,7 @@ public function execute()
             $result = $results;
             [$namespace, $name] = $this->nameSplit($result['name']);
 
-            return new DetailedPackage(
+            return Composer::newDetailedPackage(
                 $namespace,
                 $name,
                 $result['description'] ?? '',

src/Composer.php

@@ -4,6 +4,11 @@
 
 use Winter\Packager\Commands\Command;
 use Throwable;
+use Winter\Packager\Package\Collection;
+use Winter\Packager\Package\Constraint;
+use Winter\Packager\Package\DetailedPackage;
+use Winter\Packager\Package\Package;
+use Winter\Packager\Package\VersionedPackage;
 
 /**
  * Represents a Composer instance.
@@ -68,6 +73,18 @@ class Composer
         'version' => \Winter\Packager\Commands\Version::class,
     ];
 
+    /**
+     * @var array<string, string> Map of classes to use for packages, constraints and collections. This allows for
+     * custom classes to be used for these objects, should a developer wish to extend the functionality.
+     */
+    protected static $packageClasses = [
+        'package' => \Winter\Packager\Package\Package::class,
+        'versionedPackage' => \Winter\Packager\Package\VersionedPackage::class,
+        'detailedPackage' => \Winter\Packager\Package\DetailedPackage::class,
+        'collection' => \Winter\Packager\Package\Collection::class,
+        'constraint' => \Winter\Packager\Package\Constraint::class,
+    ];
+
     /**
      * Constructor
      *
@@ -347,4 +364,82 @@ public function getAuditAbandoned(): string
     {
         return $this->auditAbandoned;
     }
+
+    /**
+     * Defines the classes to use for packages, constraints and collections.
+     *
+     * You may either overwrite a single type by providing both a `$type` and `$class` as a string, or change multiple
+     * by providing an array of types and classes.
+     *
+     * It is up to you to ensure that the classes you provide are compatible with the classes they are replacing - at
+     * the very least, you should extend the classes used by default.
+     *
+     * @param string|array<string, string> $type
+     * @param string|null $class
+     */
+    public static function setPackageClass(string|array $type, ?string $class = null): void
+    {
+        if (is_array($type)) {
+            foreach ($type as $t => $c) {
+                static::setPackageClass($t, $c);
+            }
+            return;
+        }
+
+        if (!array_key_exists($type, static::$packageClasses)) {
+            throw new \Exception(
+                sprintf(
+                    'Invalid package class type "%s"',
+                    $type
+                )
+            );
+        }
+
+        static::$packageClasses[$type] = $class;
+    }
+
+    /**
+     * Create a new package instance.
+     */
+    public static function newPackage(mixed ...$arguments): Package
+    {
+        $class = static::$packageClasses['package'];
+        return new $class(...$arguments);
+    }
+
+    /**
+     * Create a new versioned package instance.
+     */
+    public static function newVersionedPackage(mixed ...$arguments): VersionedPackage
+    {
+        $class = static::$packageClasses['versionedPackage'];
+        return new $class(...$arguments);
+    }
+
+    /**
+     * Create a new detailed package instance.
+     */
+    public static function newDetailedPackage(mixed ...$arguments): DetailedPackage
+    {
+        $class = static::$packageClasses['detailedPackage'];
+        return new $class(...$arguments);
+    }
+
+    /**
+     * Create a new package collection instance.
+     */
+    public static function newCollection(mixed ...$arguments): Collection
+    {
+        $class = static::$packageClasses['collection'];
+        return new $class(...$arguments);
+    }
+
+    /**
+     * Create a new constraint instance.
+     */
+    public static function newConstraint(mixed ...$arguments): Constraint
+    {
+        $class = static::$packageClasses['constraint'];
+        return new $class(...$arguments);
+    }
 }