[TASK] Refactor type hints and method access modifiers

a-r-m-i-n · Dec 3, 2023 · 9eeb359 · 9eeb359
1 parent fd4c75c
commit 9eeb359
Show file tree

Hide file tree

Showing 12 changed files with 50 additions and 102 deletions.
diff --git a/src/Application.php b/src/Application.php
@@ -26,20 +26,11 @@
 
 class Application extends SingleCommandApplication
 {
-    /**
-     * @var Scanner
-     */
-    private $scanner;
+    private Scanner $scanner;
 
-    /**
-     * @var string
-     */
-    private $version;
+    private string $version;
 
-    /**
-     * @var bool
-     */
-    private $isVerbose = false;
+    private bool $isVerbose = false;
 
     public function __construct(string $name = 'ec', ?Scanner $scanner = null)
     {
@@ -91,8 +82,7 @@ protected function initialize(InputInterface $input, OutputInterface $output): v
 
         /** @var array|null $skip */
         $skip = $input->getOption('skip');
-        $skippingRules = $this->parseSkippingRules($skip);
-        $this->scanner->setSkippingRules($skippingRules);
+        $this->scanner->setSkippingRules($this->parseSkippingRules($skip));
     }
 
     protected function executing(Input $input, Output $output): int
@@ -239,7 +229,7 @@ protected function executing(Input $input, Output $output): int
         return $returnValue;
     }
 
-    protected function scan(Finder $finder, int $fileCount, SymfonyStyle $io, bool $strict = false, bool $noProgress = false, bool $compact = false, bool $uncovered = false): int
+    private function scan(Finder $finder, int $fileCount, SymfonyStyle $io, bool $strict = false, bool $noProgress = false, bool $compact = false, bool $uncovered = false): int
     {
         $io->writeln('<comment>Starting scan...</comment>');
 
@@ -317,7 +307,7 @@ protected function scan(Finder $finder, int $fileCount, SymfonyStyle $io, bool $
         return $errorCountTotal > 0 ? 2 : 0;
     }
 
-    protected function fix(Finder $finder, SymfonyStyle $io, bool $strict = false): int
+    private function fix(Finder $finder, SymfonyStyle $io, bool $strict = false): int
     {
         $io->writeln('<comment>Starting to fix issues...</comment>');
 
@@ -350,7 +340,7 @@ protected function fix(Finder $finder, SymfonyStyle $io, bool $strict = false):
         return false === $hasUnfixableExceptions ? 0 : 1;
     }
 
-    protected function createProgressBar(SymfonyStyle $io, int $fileCount): ProgressBar
+    private function createProgressBar(SymfonyStyle $io, int $fileCount): ProgressBar
     {
         $progressBar = $io->createProgressBar($fileCount);
 
@@ -364,7 +354,12 @@ protected function createProgressBar(SymfonyStyle $io, int $fileCount): Progress
         return $progressBar;
     }
 
-    protected function parseSkippingRules(array $skippingRules = null): array
+    /**
+     * @param array<int, string>|null $skippingRules Strings in array may contain comma-separated values
+     *
+     * @return array|string[]
+     */
+    private function parseSkippingRules(array $skippingRules = null): array
     {
         if (!$skippingRules) {
             return [];

diff --git a/src/EditorConfig/Rules/File/CharsetRule.php b/src/EditorConfig/Rules/File/CharsetRule.php
@@ -10,10 +10,7 @@
 
 class CharsetRule extends Rule
 {
-    /**
-     * @var string
-     */
-    private $expectedEncoding;
+    private string $expectedEncoding;
 
     public function __construct(string $filePath, string $fileContent, string $expectedEncoding)
     {

diff --git a/src/EditorConfig/Rules/File/EndOfLineRule.php b/src/EditorConfig/Rules/File/EndOfLineRule.php
@@ -9,15 +9,8 @@
 
 class EndOfLineRule extends Rule
 {
-    /**
-     * @var string
-     */
-    private $endOfLine;
-
-    /**
-     * @var string
-     */
-    private $expectedEndOfLine;
+    private string $endOfLine;
+    private string $expectedEndOfLine;
 
     public function __construct(string $filePath, string $fileContent, string $endOfLine)
     {

diff --git a/src/EditorConfig/Rules/File/InsertFinalNewLineRule.php b/src/EditorConfig/Rules/File/InsertFinalNewLineRule.php
@@ -9,10 +9,7 @@
 
 class InsertFinalNewLineRule extends Rule
 {
-    /**
-     * @var string
-     */
-    private $newLineFormat;
+    private string $newLineFormat;
 
     public function __construct(string $filePath, string $fileContent, ?string $newLineFormat = null)
     {

diff --git a/src/EditorConfig/Rules/File/TrimTrailingWhitespaceRule.php b/src/EditorConfig/Rules/File/TrimTrailingWhitespaceRule.php
@@ -9,10 +9,7 @@
 
 class TrimTrailingWhitespaceRule extends Rule
 {
-    /**
-     * @var bool
-     */
-    private $insertFinalNewLine;
+    private bool $insertFinalNewLine;
 
     public function __construct(string $filePath, string $fileContent, bool $insertFinalNewLine)
     {

diff --git a/src/EditorConfig/Rules/FileResult.php b/src/EditorConfig/Rules/FileResult.php
@@ -6,25 +6,19 @@
 
 class FileResult
 {
-    /**
-     * @var string
-     */
-    private $filePath;
+    private string $filePath;
 
     /**
      * @var array|Rule[]
      */
-    private $rules;
+    private array $rules;
 
-    /**
-     * @var bool
-     */
-    private $isBinary;
+    private bool $isBinary;
 
     /**
-     * @var array
+     * @var array|UnfixableException[]
      */
-    private $unfixableExceptions = [];
+    private array $unfixableExceptions = [];
 
     public function __construct(string $filePath, array $rules, bool $isBinary = false)
     {

diff --git a/src/EditorConfig/Rules/Line/IndentionRule.php b/src/EditorConfig/Rules/Line/IndentionRule.php
@@ -9,19 +9,9 @@
 
 class IndentionRule extends Rule
 {
-    /**
-     * @var string
-     */
-    private $style;
-    /**
-     * @var int|null
-     */
-    private $size;
-
-    /**
-     * @var bool
-     */
-    private $strict;
+    private string $style;
+    private ?int $size;
+    private bool $strict;
 
     public function __construct(string $filePath, string $fileContent, string $style, ?int $size, bool $strict = false)
     {

diff --git a/src/EditorConfig/Rules/Line/MaxLineLengthRule.php b/src/EditorConfig/Rules/Line/MaxLineLengthRule.php
@@ -10,10 +10,7 @@
 
 class MaxLineLengthRule extends Rule
 {
-    /**
-     * @var int|null
-     */
-    private $maxLineLength;
+    private ?int $maxLineLength;
 
     public function __construct(string $filePath, string $fileContent = null, int $maxLineLength = null)
     {

diff --git a/src/EditorConfig/Rules/Rule.php b/src/EditorConfig/Rules/Rule.php
@@ -15,15 +15,12 @@ abstract class Rule implements RuleInterface
     public const MAX_LINE_LENGTH = 'max_line_length';
     public const TRIM_TRAILING_WHITESPACE = 'trim_trailing_whitespace';
 
-    /**
-     * @var string
-     */
-    protected $filePath;
+    protected string $filePath;
 
     /**
      * @var array|RuleError[]
      */
-    protected $errors = [];
+    protected array $errors = [];
 
     public static function getDefinitions(): array
     {

diff --git a/src/EditorConfig/Rules/RuleError.php b/src/EditorConfig/Rules/RuleError.php
@@ -6,15 +6,9 @@
 
 class RuleError
 {
-    /**
-     * @var string
-     */
-    private $message;
-
-    /**
-     * @var int|null
-     */
-    private $line;
+    private string $message;
+
+    private ?int $line;
 
     public function __construct(string $message, ?int $line = null)
     {

diff --git a/src/EditorConfig/Rules/Validator.php b/src/EditorConfig/Rules/Validator.php
@@ -19,14 +19,14 @@
 class Validator
 {
     /**
-     * @var array
+     * @var array|Declaration[]
      */
-    private $editorConfig;
+    private array $editorConfig;
 
     /**
-     * @var array
+     * @var array|string[]
      */
-    private $skippingRules;
+    private array $skippingRules;
 
     public function createValidatedFileResult(SplFileInfo $file, array $editorConfig, bool $strictMode = false, array $skippingRules = []): FileResult
     {
@@ -100,7 +100,7 @@ public function createValidatedFileResult(SplFileInfo $file, array $editorConfig
     /**
      * @param string $ruleName see \Armin\EditorconfigCli\EditorConfig\Rules\Rule class constants
      */
-    protected function hasRuleSet(string $ruleName): bool
+    private function hasRuleSet(string $ruleName): bool
     {
         return !in_array($ruleName, $this->skippingRules, true)
             && isset($this->editorConfig[$ruleName])

diff --git a/src/EditorConfig/Scanner.php b/src/EditorConfig/Scanner.php
@@ -15,35 +15,26 @@
 
 class Scanner
 {
-    /**
-     * @var string|null
-     */
-    private $rootPath;
+    private ?string $rootPath;
 
     /**
-     * @var array
+     * @var array|string[]
      */
-    private $skippingRules;
+    private array $skippingRules;
 
-    /**
-     * @var EditorConfig
-     */
-    private $editorConfig;
+    private EditorConfig $editorConfig;
 
-    /**
-     * @var Validator
-     */
-    private $validator;
+    private Validator $validator;
 
     /**
      * @var array|string[]
      */
-    private $skippedBinaryFiles = [];
+    private array $skippedBinaryFiles = [];
 
     /**
      * @var array|SplFileInfo[]
      */
-    private $unavailableFiles = [];
+    private array $unavailableFiles = [];
 
     public function __construct(?EditorConfig $editorConfig = null, ?Validator $validator = null, string $rootPath = null, array $skippingRules = [])
     {
@@ -60,11 +51,17 @@ public function setRootPath(?string $rootPath): void
         }
     }
 
+    /**
+     * @return array|string[]
+     */
     public function getSkippingRules(): array
     {
         return $this->skippingRules;
     }
 
+    /**
+     * @param array|string[] $skippingRules
+     */
     public function setSkippingRules(array $skippingRules): void
     {
         $this->skippingRules = $skippingRules;