Make Mutator::getDefinition return type non-nullable (#1958)

We are going to extract `Mutator` interface to a separate package, so other developers can require `infection/mutator` and use only that small package with interface(s) to write their custom mutators. And we 100% must require write definitions for their mutators. If we allow null, developers will simply return null which we are not interested in. For example Rector does the same - Rector requires providing description / diff / docs for their "rectors". It's a win-win - immediately clear what class is going to do. The same is for us. Later, even Remedies (3rd parameter will be non-nullable), but this is another story.
infection · May 5, 2024 · a3dfe76 · a3dfe76
1 parent 4a06906
commit a3dfe76
Show file tree

Hide file tree

Showing 165 changed files with 164 additions and 964 deletions.
diff --git a/devTools/phpstan-src-baseline.neon b/devTools/phpstan-src-baseline.neon
diff --git a/src/Mutator/Arithmetic/Assignment.php b/src/Mutator/Arithmetic/Assignment.php
@@ -50,7 +50,7 @@ final class Assignment implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/AssignmentEqual.php b/src/Mutator/Arithmetic/AssignmentEqual.php
@@ -50,7 +50,7 @@ final class AssignmentEqual implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/BitwiseAnd.php b/src/Mutator/Arithmetic/BitwiseAnd.php
@@ -50,7 +50,7 @@ final class BitwiseAnd implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces a bitwise AND operator (`&`) with a bitwise OR operator (`|`).',

diff --git a/src/Mutator/Arithmetic/BitwiseNot.php b/src/Mutator/Arithmetic/BitwiseNot.php
@@ -50,7 +50,7 @@ final class BitwiseNot implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Removes a bitwise NOT operator (`~`).',

diff --git a/src/Mutator/Arithmetic/BitwiseOr.php b/src/Mutator/Arithmetic/BitwiseOr.php
@@ -50,7 +50,7 @@ final class BitwiseOr implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces a bitwise OR operator (`|`) with a bitwise AND operator (`&`).',

diff --git a/src/Mutator/Arithmetic/BitwiseXor.php b/src/Mutator/Arithmetic/BitwiseXor.php
@@ -50,7 +50,7 @@ final class BitwiseXor implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces a bitwise XOR operator (`^`) with a bitwise AND operator (`&`).',

diff --git a/src/Mutator/Arithmetic/Decrement.php b/src/Mutator/Arithmetic/Decrement.php
@@ -50,7 +50,7 @@ final class Decrement implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/DivEqual.php b/src/Mutator/Arithmetic/DivEqual.php
@@ -50,7 +50,7 @@ final class DivEqual implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/Division.php b/src/Mutator/Arithmetic/Division.php
@@ -50,7 +50,7 @@ final class Division implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces a division operator (`/`) with a multiplication operator (`*`).',

diff --git a/src/Mutator/Arithmetic/Exponentiation.php b/src/Mutator/Arithmetic/Exponentiation.php
@@ -50,7 +50,7 @@ final class Exponentiation implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/Increment.php b/src/Mutator/Arithmetic/Increment.php
@@ -50,7 +50,7 @@ final class Increment implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/Minus.php b/src/Mutator/Arithmetic/Minus.php
@@ -50,7 +50,7 @@ final class Minus implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces a subtraction operator (`-`) with an addition operator (`+`).',

diff --git a/src/Mutator/Arithmetic/MinusEqual.php b/src/Mutator/Arithmetic/MinusEqual.php
@@ -50,7 +50,7 @@ final class MinusEqual implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/ModEqual.php b/src/Mutator/Arithmetic/ModEqual.php
@@ -50,7 +50,7 @@ final class ModEqual implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/Modulus.php b/src/Mutator/Arithmetic/Modulus.php
@@ -50,7 +50,7 @@ final class Modulus implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces a modulo operator (`%`) with a multiplication operator (`*`).',

diff --git a/src/Mutator/Arithmetic/MulEqual.php b/src/Mutator/Arithmetic/MulEqual.php
@@ -50,7 +50,7 @@ final class MulEqual implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/Multiplication.php b/src/Mutator/Arithmetic/Multiplication.php
@@ -53,7 +53,7 @@ final class Multiplication implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/Plus.php b/src/Mutator/Arithmetic/Plus.php
@@ -50,7 +50,7 @@ final class Plus implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/PlusEqual.php b/src/Mutator/Arithmetic/PlusEqual.php
@@ -50,7 +50,7 @@ final class PlusEqual implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/PowEqual.php b/src/Mutator/Arithmetic/PowEqual.php
@@ -50,7 +50,7 @@ final class PowEqual implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/RoundingFamily.php b/src/Mutator/Arithmetic/RoundingFamily.php
@@ -58,7 +58,7 @@ final class RoundingFamily implements Mutator
         'round',
     ];
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/ShiftLeft.php b/src/Mutator/Arithmetic/ShiftLeft.php
@@ -50,7 +50,7 @@ final class ShiftLeft implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Arithmetic/ShiftRight.php b/src/Mutator/Arithmetic/ShiftRight.php
@@ -50,7 +50,7 @@ final class ShiftRight implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/ArrayItem.php b/src/Mutator/Boolean/ArrayItem.php
@@ -50,7 +50,7 @@ final class ArrayItem implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/EqualIdentical.php b/src/Mutator/Boolean/EqualIdentical.php
@@ -50,7 +50,7 @@ final class EqualIdentical implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/FalseValue.php b/src/Mutator/Boolean/FalseValue.php
@@ -50,7 +50,7 @@ final class FalseValue implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces a boolean literal (`false`) with its opposite value (`true`). ',

diff --git a/src/Mutator/Boolean/IdenticalEqual.php b/src/Mutator/Boolean/IdenticalEqual.php
@@ -52,7 +52,7 @@ final class IdenticalEqual implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/InstanceOf_.php b/src/Mutator/Boolean/InstanceOf_.php
@@ -51,7 +51,7 @@ final class InstanceOf_ implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces an instanceof comparison with `true` and `false`.',

diff --git a/src/Mutator/Boolean/LogicalAnd.php b/src/Mutator/Boolean/LogicalAnd.php
@@ -50,7 +50,7 @@ final class LogicalAnd implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces an AND operator (`&&`) with an OR operator (`||`).',

diff --git a/src/Mutator/Boolean/LogicalAndAllSubExprNegation.php b/src/Mutator/Boolean/LogicalAndAllSubExprNegation.php
@@ -47,7 +47,7 @@
  */
 final class LogicalAndAllSubExprNegation extends AbstractAllSubExprNegation
 {
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/LogicalAndNegation.php b/src/Mutator/Boolean/LogicalAndNegation.php
@@ -51,7 +51,7 @@ final class LogicalAndNegation implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/LogicalAndSingleSubExprNegation.php b/src/Mutator/Boolean/LogicalAndSingleSubExprNegation.php
@@ -50,7 +50,7 @@ final class LogicalAndSingleSubExprNegation extends AbstractSingleSubExprNegatio
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/LogicalLowerAnd.php b/src/Mutator/Boolean/LogicalLowerAnd.php
@@ -50,7 +50,7 @@ final class LogicalLowerAnd implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces an AND logical operator (`and`) with an OR logical operator (`or`).',

diff --git a/src/Mutator/Boolean/LogicalLowerOr.php b/src/Mutator/Boolean/LogicalLowerOr.php
@@ -50,7 +50,7 @@ final class LogicalLowerOr implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces an OR logical operator (`or`) with an AND logical operator (`AND`).',

diff --git a/src/Mutator/Boolean/LogicalNot.php b/src/Mutator/Boolean/LogicalNot.php
@@ -50,7 +50,7 @@ final class LogicalNot implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Removes a negation operator (`!`), e.g. transforms `!$foo` with `$foo`.',

diff --git a/src/Mutator/Boolean/LogicalOr.php b/src/Mutator/Boolean/LogicalOr.php
@@ -52,7 +52,7 @@ final class LogicalOr implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces an OR operator (`||`) with an AND operator (`&&`).',

diff --git a/src/Mutator/Boolean/LogicalOrAllSubExprNegation.php b/src/Mutator/Boolean/LogicalOrAllSubExprNegation.php
@@ -47,7 +47,7 @@
  */
 final class LogicalOrAllSubExprNegation extends AbstractAllSubExprNegation
 {
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/LogicalOrNegation.php b/src/Mutator/Boolean/LogicalOrNegation.php
@@ -51,7 +51,7 @@ final class LogicalOrNegation implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/LogicalOrSingleSubExprNegation.php b/src/Mutator/Boolean/LogicalOrSingleSubExprNegation.php
@@ -50,7 +50,7 @@ final class LogicalOrSingleSubExprNegation extends AbstractSingleSubExprNegation
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/NotEqualNotIdentical.php b/src/Mutator/Boolean/NotEqualNotIdentical.php
@@ -50,7 +50,7 @@ final class NotEqualNotIdentical implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/NotIdenticalNotEqual.php b/src/Mutator/Boolean/NotIdenticalNotEqual.php
@@ -52,7 +52,7 @@ final class NotIdenticalNotEqual implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Boolean/TrueValue.php b/src/Mutator/Boolean/TrueValue.php
@@ -65,7 +65,7 @@ public function __construct(TrueValueConfig $config)
         $this->allowedFunctions = array_flip($config->getAllowedFunctions());
     }
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Replaces a boolean literal (`true`) with its opposite value (`false`). ',

diff --git a/src/Mutator/Boolean/Yield_.php b/src/Mutator/Boolean/Yield_.php
@@ -50,7 +50,7 @@ final class Yield_ implements Mutator
 {
     use GetMutatorName;
 
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             <<<'TXT'

diff --git a/src/Mutator/Cast/CastArray.php b/src/Mutator/Cast/CastArray.php
@@ -44,7 +44,7 @@
  */
 final class CastArray extends AbstractCastMutator
 {
-    public static function getDefinition(): ?Definition
+    public static function getDefinition(): Definition
     {
         return new Definition(
             'Removes an array cast operator (`(array)`).',