Introduce Rector, adding parameter, return and property types throughout

.github/workflows/continuous-integration.yml

@@ -6,6 +6,26 @@ on:
     branches:
     tags:
 
+
+env:
+  default_php: 8.1
+
 jobs:
   ci:
     uses: laminas/workflow-continuous-integration/.github/workflows/continuous-integration.yml@1.x
+
+  rector:
+    runs-on: ubuntu-latest
+    name: Run Rector on PHP
+    steps:
+      - uses: actions/checkout@v4.2.2
+      - uses: shivammathur/setup-php@2.32.0
+        with:
+          php-version: ${{ env.default_php }}
+          tools: composer
+
+      - name: Install dependencies
+        run: composer install --no-progress --prefer-dist
+
+      - name: Run Rector
+        run: composer rector

composer.json

@@ -44,6 +44,7 @@
         "phpbench/phpbench": "^1.3.1",
         "phpunit/phpunit": "^10.5.38",
         "psalm/plugin-phpunit": "^0.19.0",
+        "rector/rector": "^2.1.0",
         "vimeo/psalm": "^5.26.1"
     },
     "suggest": {
@@ -69,7 +70,11 @@
         ],
         "cs-check": "phpcs",
         "cs-fix": "phpcbf",
+        "rector": "rector -n -vv",
+        "rector:fix": "rector -vv",
         "static-analysis": "psalm --shepherd --stats",
+        "static-analysis:b": "psalm --update-baseline",
+        "static-analysis:clear": "psalm --clear-cache",
         "test": "phpunit --colors=always",
         "test-coverage": "phpunit --colors=always --coverage-clover clover.xml"
     },

phpcs.xml

@@ -15,6 +15,7 @@
     <!-- Paths to check -->
     <file>src</file>
     <file>test</file>
+    <file>rector.php</file>
 
     <!-- Include all rules from Laminas Coding Standard -->
     <rule ref="LaminasCodingStandard"/>

psalm-baseline.xml

@@ -1,13 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="5.26.1@d747f6500b38ac4f7dfc5edbcae6e4b637d7add0">
-  <file src="src/Aggregate/AggregateHydrator.php">
-    <DocblockTypeContradiction>
-      <code><![CDATA[null === $this->eventManager]]></code>
-    </DocblockTypeContradiction>
-    <MissingConstructor>
-      <code><![CDATA[$eventManager]]></code>
-    </MissingConstructor>
-  </file>
   <file src="src/ArraySerializableHydrator.php">
     <MixedArgument>
       <code><![CDATA[$original]]></code>
@@ -158,10 +150,6 @@
       <code><![CDATA[$value]]></code>
       <code><![CDATA[$value]]></code>
     </MissingClosureParamType>
-    <MixedArgument>
-      <code><![CDATA[$value]]></code>
-      <code><![CDATA[$value]]></code>
-    </MixedArgument>
   </file>
   <file src="src/NamingStrategy/UnderscoreNamingStrategy/StringSupportTrait.php">
     <DocblockTypeContradiction>
@@ -182,13 +170,6 @@
       <code><![CDATA[$matches]]></code>
       <code><![CDATA[$value]]></code>
     </MissingClosureParamType>
-    <MixedArgument>
-      <code><![CDATA[$matches[2]]]></code>
-      <code><![CDATA[$matches[2]]]></code>
-      <code><![CDATA[$matches[2]]]></code>
-      <code><![CDATA[$value]]></code>
-      <code><![CDATA[$value[0]]]></code>
-    </MixedArgument>
     <MixedArgumentTypeCoercion>
       <code><![CDATA[$pcreInfo->replacement]]></code>
     </MixedArgumentTypeCoercion>
@@ -237,33 +218,13 @@
   </file>
   <file src="src/Strategy/BooleanStrategy.php">
     <DocblockTypeContradiction>
-      <code><![CDATA[! is_int($falseValue) && ! is_string($falseValue)]]></code>
-      <code><![CDATA[! is_int($trueValue) && ! is_string($trueValue)]]></code>
       <code><![CDATA[! is_string($value) && ! is_int($value)]]></code>
       <code><![CDATA[is_bool($value)]]></code>
     </DocblockTypeContradiction>
-    <MixedArgument>
-      <code><![CDATA[is_object($falseValue) ? $falseValue::class : gettype($falseValue)]]></code>
-      <code><![CDATA[is_object($trueValue) ? $trueValue::class : gettype($trueValue)]]></code>
-      <code><![CDATA[is_object($value) ? $value::class : gettype($value)]]></code>
-      <code><![CDATA[is_object($value) ? $value::class : gettype($value)]]></code>
-    </MixedArgument>
     <MoreSpecificImplementedParamType>
       <code><![CDATA[$value]]></code>
       <code><![CDATA[$value]]></code>
     </MoreSpecificImplementedParamType>
-    <RedundantCondition>
-      <code><![CDATA[gettype($falseValue)]]></code>
-      <code><![CDATA[gettype($trueValue)]]></code>
-      <code><![CDATA[gettype($value)]]></code>
-      <code><![CDATA[gettype($value)]]></code>
-    </RedundantCondition>
-    <TypeDoesNotContainType>
-      <code><![CDATA[is_object($falseValue)]]></code>
-      <code><![CDATA[is_object($trueValue)]]></code>
-      <code><![CDATA[is_object($value)]]></code>
-      <code><![CDATA[is_object($value)]]></code>
-    </TypeDoesNotContainType>
   </file>
   <file src="src/Strategy/ClosureStrategy.php">
     <RiskyTruthyFalsyComparison>
@@ -282,21 +243,11 @@
     <MixedArgument>
       <code><![CDATA[$data]]></code>
       <code><![CDATA[$object]]></code>
-      <code><![CDATA[is_object($value) ? $value::class : gettype($value)]]></code>
-      <code><![CDATA[is_object($value) ? $value::class : gettype($value)]]></code>
     </MixedArgument>
     <MoreSpecificImplementedParamType>
       <code><![CDATA[$value]]></code>
       <code><![CDATA[$value]]></code>
     </MoreSpecificImplementedParamType>
-    <RedundantCondition>
-      <code><![CDATA[gettype($value)]]></code>
-      <code><![CDATA[gettype($value)]]></code>
-    </RedundantCondition>
-    <TypeDoesNotContainType>
-      <code><![CDATA[is_object($value)]]></code>
-      <code><![CDATA[is_object($value)]]></code>
-    </TypeDoesNotContainType>
   </file>
   <file src="src/Strategy/DateTimeImmutableFormatterStrategy.php">
     <MixedAssignment>
@@ -309,41 +260,15 @@
   <file src="src/Strategy/ExplodeStrategy.php">
     <DocblockTypeContradiction>
       <code><![CDATA[is_array($value)]]></code>
-      <code><![CDATA[is_string($value)]]></code>
     </DocblockTypeContradiction>
-    <MixedArgument>
-      <code><![CDATA[is_object($value) ? $value::class : gettype($value)]]></code>
-      <code><![CDATA[is_object($value) ? $value::class : gettype($value)]]></code>
-    </MixedArgument>
     <MoreSpecificImplementedParamType>
       <code><![CDATA[$value]]></code>
-      <code><![CDATA[$value]]></code>
     </MoreSpecificImplementedParamType>
-    <RedundantCast>
-      <code><![CDATA[(string) $value]]></code>
-      <code><![CDATA[(string) $value]]></code>
-    </RedundantCast>
-    <RedundantCondition>
-      <code><![CDATA[gettype($value)]]></code>
-      <code><![CDATA[gettype($value)]]></code>
-      <code><![CDATA[is_numeric($value)]]></code>
-      <code><![CDATA[is_string($value) || is_numeric($value)]]></code>
-    </RedundantCondition>
-    <RedundantConditionGivenDocblockType>
-      <code><![CDATA[is_string($value)]]></code>
-    </RedundantConditionGivenDocblockType>
-    <TypeDoesNotContainType>
-      <code><![CDATA[is_object($value)]]></code>
-      <code><![CDATA[is_object($value)]]></code>
-    </TypeDoesNotContainType>
   </file>
   <file src="src/Strategy/HydratorStrategy.php">
     <ArgumentTypeCoercion>
       <code><![CDATA[$this->objectClassName]]></code>
     </ArgumentTypeCoercion>
-    <DocblockTypeContradiction>
-      <code><![CDATA[gettype($value)]]></code>
-    </DocblockTypeContradiction>
     <MixedInferredReturnType>
       <code><![CDATA[object|string|null]]></code>
     </MixedInferredReturnType>
@@ -353,9 +278,6 @@
     <MoreSpecificImplementedParamType>
       <code><![CDATA[$value]]></code>
     </MoreSpecificImplementedParamType>
-    <RedundantConditionGivenDocblockType>
-      <code><![CDATA[is_object($value)]]></code>
-    </RedundantConditionGivenDocblockType>
   </file>
   <file src="src/Strategy/SerializableStrategy.php">
     <MixedArgument>
@@ -492,11 +414,6 @@
       <code><![CDATA[$entity->field3]]></code>
     </UndefinedPropertyFetch>
   </file>
-  <file src="test/HydratorObjectPropertyTest.php">
-    <MissingClosureParamType>
-      <code><![CDATA[$property]]></code>
-    </MissingClosureParamType>
-  </file>
   <file src="test/HydratorStrategyTest.php">
     <MixedArgument>
       <code><![CDATA[$attributes['entities']]]></code>
@@ -529,11 +446,6 @@
     </UndefinedInterfaceMethod>
   </file>
   <file src="test/HydratorTest.php">
-    <MissingClosureParamType>
-      <code><![CDATA[$property]]></code>
-      <code><![CDATA[$property]]></code>
-      <code><![CDATA[$property]]></code>
-    </MissingClosureParamType>
     <MixedArgument>
       <code><![CDATA[$property]]></code>
       <code><![CDATA[$property]]></code>
@@ -628,8 +540,6 @@
   <file src="test/Strategy/BooleanStrategyTest.php">
     <InvalidArgument>
       <code><![CDATA[5]]></code>
-      <code><![CDATA[false]]></code>
-      <code><![CDATA[true]]></code>
     </InvalidArgument>
   </file>
   <file src="test/Strategy/CollectionStrategyTest.php">
@@ -711,7 +621,6 @@
   <file src="test/Strategy/SerializableStrategyTest.php">
     <MixedAssignment>
       <code><![CDATA[$serialized]]></code>
-      <code><![CDATA[$serialized]]></code>
     </MixedAssignment>
   </file>
 </files>