[TASK] Refactor validate method of rules

Resolves: #21
a-r-m-i-n · Dec 3, 2023 · fd4c75c · fd4c75c
1 parent 3e0a216
commit fd4c75c
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 35 deletions.
diff --git a/src/EditorConfig/Rules/File/CharsetRule.php b/src/EditorConfig/Rules/File/CharsetRule.php
@@ -21,20 +21,17 @@ public function __construct(string $filePath, string $fileContent, string $expec
         parent::__construct($filePath, $fileContent);
     }
 
-    protected function validate(string $content): bool
+    protected function validate(string $content): void
     {
         $actualEncoding = FileEncodingUtility::detect($content);
-        $result = $this->expectedEncoding === $actualEncoding;
-        if (!$result) {
+        if ($this->expectedEncoding !== $actualEncoding) {
             $this->addError(
                 null,
                 'This file has invalid encoding given! Expected: "%s", Given: "%s"',
                 $this->expectedEncoding,
                 $actualEncoding
             );
         }
-
-        return $result;
     }
 
     /**

diff --git a/src/EditorConfig/Rules/File/EndOfLineRule.php b/src/EditorConfig/Rules/File/EndOfLineRule.php
@@ -36,7 +36,7 @@ public function getEndOfLine(): string
         return $this->expectedEndOfLine;
     }
 
-    protected function validate(string $content): bool
+    protected function validate(string $content): void
     {
         $whitespacesOnly = (string)preg_replace('/[^\r\n]/i', '', $content);
 
@@ -53,8 +53,6 @@ protected function validate(string $content): bool
                 $this->endOfLine
             );
         }
-
-        return $result;
     }
 
     public function fixContent(string $content): string

diff --git a/src/EditorConfig/Rules/File/InsertFinalNewLineRule.php b/src/EditorConfig/Rules/File/InsertFinalNewLineRule.php
@@ -24,19 +24,16 @@ public function __construct(string $filePath, string $fileContent, ?string $newL
         parent::__construct($filePath, $fileContent);
     }
 
-    protected function validate(string $content): bool
+    protected function validate(string $content): void
     {
         if ('' === $content) {
-            return true;
+            return;
         }
 
         $lastChar = substr($content, -1);
-        $result = in_array($lastChar, ["\r", "\n"], true);
-        if (!$result) {
+        if (!in_array($lastChar, ["\r", "\n"], true)) {
             $this->addError(null, 'This file has no final new line given');
         }
-
-        return $result;
     }
 
     public function fixContent(string $content): string

diff --git a/src/EditorConfig/Rules/File/TrimTrailingWhitespaceRule.php b/src/EditorConfig/Rules/File/TrimTrailingWhitespaceRule.php
@@ -20,11 +20,11 @@ public function __construct(string $filePath, string $fileContent, bool $insertF
         parent::__construct($filePath, $fileContent);
     }
 
-    protected function validate(string $content): bool
+    protected function validate(string $content): void
     {
         $trim = rtrim($content);
         if ('' === $content) {
-            return true;
+            return;
         }
         if ($this->insertFinalNewLine) {
             $insertFinalNewLineRule = new InsertFinalNewLineRule($this->filePath, $content);
@@ -34,11 +34,7 @@ protected function validate(string $content): bool
         }
         if ($content !== $trim) {
             $this->addError(null, 'This file has trailing whitespaces');
-
-            return false;
         }
-
-        return true;
     }
 
     public function fixContent(string $content): string

diff --git a/src/EditorConfig/Rules/Line/IndentionRule.php b/src/EditorConfig/Rules/Line/IndentionRule.php
@@ -34,7 +34,7 @@ public function __construct(string $filePath, string $fileContent, string $style
         parent::__construct($filePath, $fileContent);
     }
 
-    protected function validate(string $content): bool
+    protected function validate(string $content): void
     {
         $lineEnding = LineEndingUtility::detectLineEnding($content, false);
         if (empty($lineEnding)) {
@@ -44,7 +44,6 @@ protected function validate(string $content): bool
         $lines = explode($lineEnding, $content);
 
         $lineCount = 0;
-        $isValid = true;
         foreach ($lines as $line) {
             ++$lineCount;
             $lineValid = true;
@@ -61,12 +60,10 @@ protected function validate(string $content): bool
 
             if ('tab' === $this->style && $whitespaces !== $beginningWhitespaces) {
                 $this->addError($lineCount, 'Expected indention style "tab" but found "spaces"');
-                $isValid = false;
                 $lineValid = false;
             }
             if ('space' === $this->style && false !== strpos($whitespaces, "\t")) {
                 $this->addError($lineCount, 'Expected indention style "space" but found "tabs"');
-                $isValid = false;
                 $lineValid = false;
             }
 
@@ -79,8 +76,6 @@ protected function validate(string $content): bool
                 }
             }
         }
-
-        return $isValid;
     }
 
     public function fixContent(string $content): string

diff --git a/src/EditorConfig/Rules/Line/MaxLineLengthRule.php b/src/EditorConfig/Rules/Line/MaxLineLengthRule.php
@@ -21,7 +21,7 @@ public function __construct(string $filePath, string $fileContent = null, int $m
         parent::__construct($filePath, $fileContent);
     }
 
-    protected function validate(string $content): bool
+    protected function validate(string $content): void
     {
         $lineEnding = LineEndingUtility::detectLineEnding($content, false);
         if (empty($lineEnding)) {
@@ -31,16 +31,13 @@ protected function validate(string $content): bool
         $lines = explode($lineEnding, $content);
 
         $lineCount = 0;
-        $isValid = true;
         foreach ($lines as $line) {
             ++$lineCount;
             $lineLength = strlen($line);
             if ($lineLength > $this->maxLineLength) {
                 $this->addError($lineCount, 'Max line length (%d chars) exceeded by %d chars', $this->maxLineLength, $lineLength);
             }
         }
-
-        return $isValid;
     }
 
     public function fixContent(string $content): string

diff --git a/src/EditorConfig/Rules/Line/TrimTrailingWhitespaceRule.php b/src/EditorConfig/Rules/Line/TrimTrailingWhitespaceRule.php
@@ -9,7 +9,7 @@
 
 class TrimTrailingWhitespaceRule extends Rule
 {
-    protected function validate(string $content): bool
+    protected function validate(string $content): void
     {
         $lineEnding = LineEndingUtility::detectLineEnding($content, false);
         if (empty($lineEnding)) {
@@ -19,7 +19,6 @@ protected function validate(string $content): bool
         $lines = explode($lineEnding, $content);
 
         $lineCount = 0;
-        $isValid = true;
         foreach ($lines as $line) {
             ++$lineCount;
 
@@ -28,8 +27,6 @@ protected function validate(string $content): bool
                 $this->addError($lineCount, 'Trailing whitespaces found');
             }
         }
-
-        return $isValid;
     }
 
     public function fixContent(string $content): string

diff --git a/src/EditorConfig/Rules/Rule.php b/src/EditorConfig/Rules/Rule.php
@@ -45,7 +45,7 @@ public function __construct(string $filePath, string $fileContent = null)
         $this->validate($fileContent ?? (string)file_get_contents($this->filePath));
     }
 
-    abstract protected function validate(string $content): bool;
+    abstract protected function validate(string $content): void;
 
     public function getFilePath(): string
     {