Refactor code to remove potential nullability issues

Updated method signatures across codebase to remove nullable string types for validation input. These changes ensure consistency in handling input values from CSV files. The prior handling could potentially lead to null value related errors, thus this update improves the overall stability of the CSV validation process.
JBZoo · Mar 13, 2024 · 2757bb1 · 2757bb1
1 parent 5f4c4ac
commit 2757bb1
Show file tree

Hide file tree

Showing 41 changed files with 71 additions and 77 deletions.
diff --git a/src/Rules/AbstarctRule.php b/src/Rules/AbstarctRule.php
@@ -33,7 +33,7 @@ abstract class AbstarctRule
     private string $columnNameId;
     private string $ruleCode;
 
-    abstract public function validateRule(?string $cellValue): ?string;
+    abstract public function validateRule(string $cellValue): ?string;
 
     public function __construct(string $columnNameId, null|array|bool|float|int|string $options = null)
     {
@@ -42,7 +42,7 @@ public function __construct(string $columnNameId, null|array|bool|float|int|stri
         $this->ruleCode     = $this->getRuleCode();
     }
 
-    public function validate(?string $cellValue, int $line = 0): ?Error
+    public function validate(string $cellValue, int $line = 0): ?Error
     {
         $error = $this->validateRule($cellValue);
         if ($error !== null) {

diff --git a/src/Rules/AllMustContain.php b/src/Rules/AllMustContain.php
@@ -18,15 +18,15 @@
 
 final class AllMustContain extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $inclusions = $this->getOptionAsArray();
         if (\count($inclusions) === 0) {
             return null;
         }
 
         foreach ($inclusions as $inclusion) {
-            if (\strpos((string)$cellValue, (string)$inclusion) === false) {
+            if (\strpos($cellValue, (string)$inclusion) === false) {
                 return "Value \"<c>{$cellValue}</c>\" must contain all of the following:" .
                     ' "<green>["' . \implode('", "', $inclusions) . '"]</green>"';
             }

diff --git a/src/Rules/AllowValues.php b/src/Rules/AllowValues.php
@@ -18,7 +18,7 @@
 
 class AllowValues extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $allowedValues = $this->getOptionAsArray();
 

diff --git a/src/Rules/AtLeastContains.php b/src/Rules/AtLeastContains.php
@@ -18,15 +18,15 @@
 
 final class AtLeastContains extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $inclusions = $this->getOptionAsArray();
         if (\count($inclusions) === 0) {
             return null;
         }
 
         foreach ($inclusions as $inclusion) {
-            if (\strpos((string)$cellValue, (string)$inclusion) !== false) {
+            if (\strpos($cellValue, (string)$inclusion) !== false) {
                 return null;
             }
         }

diff --git a/src/Rules/CardinalDirection.php b/src/Rules/CardinalDirection.php
@@ -18,13 +18,13 @@
 
 final class CardinalDirection extends AllowValues
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;
         }
 
-        return parent::validateRule((string)$cellValue);
+        return parent::validateRule($cellValue);
     }
 
     public function getOptionAsArray(): array

diff --git a/src/Rules/DateFormat.php b/src/Rules/DateFormat.php
@@ -18,14 +18,14 @@
 
 final class DateFormat extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $expectedDateFormat = $this->getOptionAsString();
         if ($expectedDateFormat === '') {
             return 'Date format is not defined';
         }
 
-        if ($cellValue === null || $cellValue === '') {
+        if ($cellValue === '') {
             return 'Date format of value "" is not valid. Expected format: "' . $expectedDateFormat . '"';
         }
 

diff --git a/src/Rules/ExactValue.php b/src/Rules/ExactValue.php
@@ -18,9 +18,9 @@
 
 final class ExactValue extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
-        if ($this->getOptionAsString() !== (string)$cellValue) {
+        if ($this->getOptionAsString() !== $cellValue) {
             return "Value \"<c>{$cellValue}</c>\" is not strict equal to " .
                 "\"<green>{$this->getOptionAsString()}<green>\"";
         }

diff --git a/src/Rules/IsBool.php b/src/Rules/IsBool.php
@@ -18,13 +18,13 @@
 
 final class IsBool extends AllowValues
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;
         }
 
-        return parent::validateRule(\strtolower((string)$cellValue));
+        return parent::validateRule(\strtolower($cellValue));
     }
 
     public function getOptionAsArray(): array

diff --git a/src/Rules/IsDomain.php b/src/Rules/IsDomain.php
@@ -18,15 +18,15 @@
 
 final class IsDomain extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;
         }
 
         $domainPattern = '/^(?!-)[A-Za-z0-9-]+(\.[A-Za-z0-9-]+)*(\.[A-Za-z]{2,})$/';
 
-        if (\preg_match($domainPattern, (string)$cellValue) === 0) {
+        if (\preg_match($domainPattern, $cellValue) === 0) {
             return "Value \"<c>{$cellValue}</c>\" is not a valid domain";
         }
 

diff --git a/src/Rules/IsEmail.php b/src/Rules/IsEmail.php
@@ -18,7 +18,7 @@
 
 final class IsEmail extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;

diff --git a/src/Rules/IsFloat.php b/src/Rules/IsFloat.php
@@ -18,13 +18,13 @@
 
 class IsFloat extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;
         }
 
-        if (\preg_match('/^-?\d+(\.\d+)?$/', (string)$cellValue) === 0) {
+        if (\preg_match('/^-?\d+(\.\d+)?$/', $cellValue) === 0) {
             return "Value \"<c>{$cellValue}</c>\" is not a float number";
         }
 

diff --git a/src/Rules/IsInt.php b/src/Rules/IsInt.php
@@ -18,13 +18,13 @@
 
 final class IsInt extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;
         }
 
-        if (\preg_match('/^-?\d+$/', (string)$cellValue) === 0) {
+        if (\preg_match('/^-?\d+$/', $cellValue) === 0) {
             return "Value \"<c>{$cellValue}</c>\" is not an integer";
         }
 

diff --git a/src/Rules/IsIp.php b/src/Rules/IsIp.php
@@ -18,7 +18,7 @@
 
 final class IsIp extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;

diff --git a/src/Rules/IsLatitude.php b/src/Rules/IsLatitude.php
@@ -21,7 +21,7 @@ final class IsLatitude extends IsFloat
     private float $min = -90.0;
     private float $max = 90.0;
 
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;

diff --git a/src/Rules/IsLongitude.php b/src/Rules/IsLongitude.php
@@ -21,7 +21,7 @@ final class IsLongitude extends IsFloat
     private float $min = -180.0;
     private float $max = 180.0;
 
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;

diff --git a/src/Rules/IsUrl.php b/src/Rules/IsUrl.php
@@ -18,7 +18,7 @@
 
 final class IsUrl extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;

diff --git a/src/Rules/IsUuid4.php b/src/Rules/IsUuid4.php
@@ -18,15 +18,15 @@
 
 final class IsUuid4 extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;
         }
 
         $uuid4 = '/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/';
 
-        if (\preg_match($uuid4, (string)$cellValue) === 0) {
+        if (\preg_match($uuid4, $cellValue) === 0) {
             return 'Value is not a valid UUID v4';
         }
 

diff --git a/src/Rules/Max.php b/src/Rules/Max.php
@@ -18,7 +18,7 @@
 
 final class Max extends IsFloat
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $result = parent::validateRule($cellValue);
         if ($result !== null) {

diff --git a/src/Rules/MaxDate.php b/src/Rules/MaxDate.php
@@ -18,10 +18,10 @@
 
 final class MaxDate extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $minDate  = $this->getOptionAsDate();
-        $cellDate = new \DateTimeImmutable((string)$cellValue);
+        $cellDate = new \DateTimeImmutable($cellValue);
 
         if ($cellDate->getTimestamp() > $minDate->getTimestamp()) {
             return "Value \"<c>{$cellValue}</c>\" is more than the maximum " .

diff --git a/src/Rules/MaxLength.php b/src/Rules/MaxLength.php
@@ -18,10 +18,10 @@
 
 final class MaxLength extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $minLength = $this->getOptionAsInt();
-        $length    = \mb_strlen((string)$cellValue);
+        $length    = \mb_strlen($cellValue);
 
         if ($length > $minLength) {
             return "Value \"<c>{$cellValue}</c>\" (length: {$length}) is too long. " .

diff --git a/src/Rules/MaxPrecision.php b/src/Rules/MaxPrecision.php
@@ -18,7 +18,7 @@
 
 final class MaxPrecision extends Precision
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $valuePrecision = self::getFloatPrecision($cellValue);
 

diff --git a/src/Rules/MaxWordCount.php b/src/Rules/MaxWordCount.php
@@ -18,10 +18,10 @@
 
 final class MaxWordCount extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $wordCount = $this->getOptionAsInt();
-        $count     = \str_word_count((string)$cellValue);
+        $count     = \str_word_count($cellValue);
 
         if ($count > $wordCount) {
             return "Value \"<c>{$cellValue}</c>\" has {$count} words, " .

diff --git a/src/Rules/Min.php b/src/Rules/Min.php
@@ -18,7 +18,7 @@
 
 final class Min extends IsFloat
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $result = parent::validateRule($cellValue);
         if ($result !== null) {

diff --git a/src/Rules/MinDate.php b/src/Rules/MinDate.php
@@ -18,10 +18,10 @@
 
 final class MinDate extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $minDate  = $this->getOptionAsDate();
-        $cellDate = new \DateTimeImmutable((string)$cellValue);
+        $cellDate = new \DateTimeImmutable($cellValue);
 
         if ($cellDate->getTimestamp() < $minDate->getTimestamp()) {
             return "Value \"<c>{$cellValue}</c>\" is less than the minimum " .

diff --git a/src/Rules/MinLength.php b/src/Rules/MinLength.php
@@ -18,10 +18,10 @@
 
 final class MinLength extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $minLength = $this->getOptionAsInt();
-        $length    = \mb_strlen((string)$cellValue);
+        $length    = \mb_strlen($cellValue);
 
         if ($length < $minLength) {
             return "Value \"<c>{$cellValue}</c>\" (length: {$length}) is too short. " .

diff --git a/src/Rules/MinPrecision.php b/src/Rules/MinPrecision.php
@@ -18,7 +18,7 @@
 
 final class MinPrecision extends Precision
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $valuePrecision = self::getFloatPrecision($cellValue);
 

diff --git a/src/Rules/MinWordCount.php b/src/Rules/MinWordCount.php
@@ -18,10 +18,10 @@
 
 final class MinWordCount extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         $wordCount = $this->getOptionAsInt();
-        $count     = \str_word_count((string)$cellValue);
+        $count     = \str_word_count($cellValue);
 
         if ($count < $wordCount) {
             return "Value \"<c>{$cellValue}</c>\" has {$count} words, " .

diff --git a/src/Rules/NotEmpty.php b/src/Rules/NotEmpty.php
@@ -18,13 +18,13 @@
 
 final class NotEmpty extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;
         }
 
-        if ($cellValue === null || $cellValue === '') {
+        if ($cellValue === '') {
             return 'Value is empty';
         }
 

diff --git a/src/Rules/OnlyCapitalize.php b/src/Rules/OnlyCapitalize.php
@@ -18,13 +18,13 @@
 
 final class OnlyCapitalize extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;
         }
 
-        if ($cellValue !== null && $cellValue !== \ucfirst($cellValue)) {
+        if ($cellValue !== \ucfirst($cellValue)) {
             return "Value \"<c>{$cellValue}</c>\" should be in capitalize";
         }
 

diff --git a/src/Rules/OnlyLowercase.php b/src/Rules/OnlyLowercase.php
@@ -18,13 +18,13 @@
 
 final class OnlyLowercase extends AbstarctRule
 {
-    public function validateRule(?string $cellValue): ?string
+    public function validateRule(string $cellValue): ?string
     {
         if (!$this->getOptionAsBool()) {
             return null;
         }
 
-        if ($cellValue !== null && $cellValue !== \mb_strtolower($cellValue)) {
+        if ($cellValue !== \mb_strtolower($cellValue)) {
             return "Value \"<c>{$cellValue}</c>\" should be in lowercase";
         }