Merge pull request #174 from simon-mundy/qa/feature-src

Feature - Reformatting for linting, format and analysis with Mago

Author: simon-mundy

analyzer-baseline.toml

@@ -15,4 +15,6 @@ baseline = "lint-baseline.toml"
 baseline = "analyzer-baseline.toml"
 class-initializers = [
     "PhpDb\\ResultSet\\AbstractResultSet::initialize",
+    "PhpDb\\TableGateway\\Feature\\AbstractFeature::setTableGateway",
+    "PhpDb\\RowGateway\\Feature\\AbstractFeature::setRowGateway",
 ]

lint-baseline.toml

@@ -4,6 +4,9 @@
 
 namespace PhpDb\Feature;
 
+/**
+ * @api
+ */
 interface FeatureInterface
 {
     /** @return array<string, string[]> */

mago.toml

@@ -9,10 +9,14 @@
 use PhpDb\RowGateway\Exception;
 use PhpDb\RowGateway\Exception\RuntimeException;
 
+/**
+ * @api
+ */
 abstract class AbstractFeature extends AbstractRowGateway implements FeatureInterface
 {
     protected AbstractRowGateway $rowGateway;
 
+    /** @var array<string, mixed> */
     protected array $sharedData = [];
 
     /** @return array<string, string[]> */

src/Feature/FeatureInterface.php

@@ -7,6 +7,9 @@
 use PhpDb\Feature\FeatureInterface as BaseFeatureInterface;
 use PhpDb\RowGateway\AbstractRowGateway;
 
+/**
+ * @api
+ */
 interface FeatureInterface extends BaseFeatureInterface
 {
     public function setRowGateway(AbstractRowGateway $rowGateway): void;

src/RowGateway/Feature/AbstractFeature.php

@@ -13,15 +13,17 @@
  */
 class FeatureSet
 {
-    final public const APPLY_HALT = 'halt';
+    final public const string APPLY_HALT = 'halt';
 
     protected ?AbstractRowGateway $rowGateway = null;
 
     /** @var FeatureInterface[] */
     protected array $features = [];
 
+    /** @var array<array-key, mixed> */
     protected array $magicSpecifications = [];
 
+    /** @param FeatureInterface[] $features */
     public function __construct(array $features = [])
     {
         if ([] !== $features) {
@@ -38,6 +40,7 @@ public function addFeature(FeatureInterface $feature): static
         return $this;
     }
 
+    /** @param FeatureInterface[] $features */
     public function addFeatures(array $features): static
     {
         foreach ($features as $feature) {
@@ -46,6 +49,12 @@ public function addFeatures(array $features): static
         return $this;
     }
 
+    /**
+     * @param array<array-key, mixed> $args
+     *
+     * @mago-expect analysis:string-member-selector
+     * @mago-expect analysis:mixed-assignment
+     */
     public function apply(string $method, array $args): void
     {
         foreach ($this->features as $feature) {
@@ -60,31 +69,51 @@ public function apply(string $method, array $args): void
         }
     }
 
+    /**
+     * @mago-expect analysis:unused-parameter
+     *
+     * @param array<array-key, mixed> $arguments
+     */
     public function callMagicCall(string $method, array $arguments): mixed
     {
         return null;
     }
 
+    /**
+     * @mago-expect analysis:unused-parameter
+     */
     public function callMagicGet(string $property): mixed
     {
         return null;
     }
 
+    /**
+     * @mago-expect analysis:unused-parameter
+     */
     public function callMagicSet(string $property, mixed $value): mixed
     {
         return null;
     }
 
+    /**
+     * @mago-expect analysis:unused-parameter
+     */
     public function canCallMagicCall(string $method): bool
     {
         return false;
     }
 
+    /**
+     * @mago-expect analysis:unused-parameter
+     */
     public function canCallMagicGet(string $property): false
     {
         return false;
     }
 
+    /**
+     * @mago-expect analysis:unused-parameter
+     */
     public function canCallMagicSet(string $property): false
     {
         return false;

src/RowGateway/Feature/FeatureInterface.php

@@ -31,7 +31,7 @@
 /**
  * @property AdapterInterface $adapter
  * @property int $lastInsertValue
- * @property string $table
+ * @property TableIdentifier|string|array|null $table
  */
 abstract class AbstractTableGateway implements TableGatewayInterface
 {

src/RowGateway/Feature/FeatureSet.php

@@ -7,10 +7,14 @@
 use Override;
 use PhpDb\TableGateway\AbstractTableGateway;
 
+/**
+ * @api
+ */
 abstract class AbstractFeature extends AbstractTableGateway implements FeatureInterface
 {
     protected AbstractTableGateway $tableGateway;
 
+    /** @var array<string, mixed> */
     protected array $sharedData = [];
 
     /** @return array<string, string[]> */

src/TableGateway/AbstractTableGateway.php

@@ -19,11 +19,14 @@
 
 use function get_class;
 
+/**
+ * @api
+ */
 class EventFeature extends AbstractFeature implements EventFeatureEventsInterface, EventsCapableInterface
 {
     protected EventManagerInterface $eventManager;
 
-    protected ?EventFeature\TableGatewayEvent $event;
+    protected EventFeature\TableGatewayEvent $event;
 
     public function __construct(
         ?EventManagerInterface $eventManager = null,
@@ -37,7 +40,9 @@ public function __construct(
             TableGateway::class,
         ]);
 
-        $this->event = $tableGatewayEvent ?: new EventFeature\TableGatewayEvent();
+        $this->event = $tableGatewayEvent instanceof EventFeature\TableGatewayEvent
+            ? $tableGatewayEvent
+            : new EventFeature\TableGatewayEvent();
     }
 
     /**