Merge pull request #136 from facile-it/small-cs-improvements

Small CS improvements
facile-it · Apr 8, 2019 · bb3ca74 · bb3ca74
2 parents c9e31ee + 97dfba6
commit bb3ca74
Show file tree

Hide file tree

Showing 92 changed files with 238 additions and 338 deletions.
diff --git a/src/Paraunit/Command/CoverageCommand.php b/src/Paraunit/Command/CoverageCommand.php
@@ -35,7 +35,7 @@ public function __construct(CoverageConfiguration $configuration)
         ];
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -53,10 +53,8 @@ protected function configure()
     /**
      * @throws \Exception
      * @throws \InvalidArgumentException
-     *
-     * @return int|null
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
     {
         if (! $this->hasChosenCoverageMethod($input)) {
             $coverageMethods = implode($this->coverageMethods, ', ');

diff --git a/src/Paraunit/Command/ParallelCommand.php b/src/Paraunit/Command/ParallelCommand.php
@@ -22,9 +22,6 @@ class ParallelCommand extends Command
     /** @var PHPUnitOption[] */
     private $phpunitOptions;
 
-    /**
-     * @throws \Symfony\Component\Console\Exception\LogicException
-     */
     public function __construct(ParallelConfiguration $configuration)
     {
         $this->phpunitOptions = [
@@ -61,7 +58,7 @@ public function __construct(ParallelConfiguration $configuration)
         $this->configuration = $configuration;
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('run');
         $this->setDescription('Run all the requested tests in parallel');
@@ -83,10 +80,8 @@ protected function configure()
 
     /**
      * @throws \Exception
-     *
-     * @return int|null
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
     {
         $container = $this->configuration->buildContainer($input, $output);
 

diff --git a/src/Paraunit/Configuration/DependencyInjection/ParserDefinition.php b/src/Paraunit/Configuration/DependencyInjection/ParserDefinition.php
@@ -22,7 +22,7 @@
 
 class ParserDefinition
 {
-    public function configure(ContainerBuilder $container)
+    public function configure(ContainerBuilder $container): void
     {
         $logParser = new Definition(LogParser::class, [
             new Reference(LogFetcher::class),

diff --git a/src/Paraunit/Configuration/EnvVariables.php b/src/Paraunit/Configuration/EnvVariables.php
@@ -6,9 +6,9 @@
 
 class EnvVariables
 {
-    const LOG_DIR = 'PARAUNIT_LOG_DIR';
+    public const LOG_DIR = 'PARAUNIT_LOG_DIR';
 
-    const PIPELINE_NUMBER = 'PARAUNIT_PIPELINE_NUMBER';
+    public const PIPELINE_NUMBER = 'PARAUNIT_PIPELINE_NUMBER';
 
-    const PROCESS_UNIQUE_ID = 'PARAUNIT_PROCESS_UNIQUE_ID';
+    public const PROCESS_UNIQUE_ID = 'PARAUNIT_PROCESS_UNIQUE_ID';
 }
diff --git a/src/Paraunit/Configuration/PHPUnitOption.php b/src/Paraunit/Configuration/PHPUnitOption.php
@@ -18,9 +18,6 @@ class PHPUnitOption
     /** @var bool */
     private $hasValue;
 
-    /**
-     * @param string | null $shortName
-     */
     public function __construct(string $name, bool $hasValue = true, string $shortName = null)
     {
         $this->name = $name;

diff --git a/src/Paraunit/Configuration/ParallelConfiguration.php b/src/Paraunit/Configuration/ParallelConfiguration.php
@@ -16,9 +16,9 @@
 
 class ParallelConfiguration
 {
-    const TAG_EVENT_SUBSCRIBER = 'paraunit.event_subscriber';
+    public const TAG_EVENT_SUBSCRIBER = 'paraunit.event_subscriber';
 
-    const PUBLIC_ALIAS_FORMAT = '%s_public_alias';
+    public const PUBLIC_ALIAS_FORMAT = '%s_public_alias';
 
     /** @var ParallelContainerDefinition */
     protected $containerDefinition;

diff --git a/src/Paraunit/Lifecycle/EngineEvent.php b/src/Paraunit/Lifecycle/EngineEvent.php
@@ -8,9 +8,9 @@
 
 class EngineEvent extends Event
 {
-    const BEFORE_START = 'engine_event.before_start';
+    public const BEFORE_START = 'engine_event.before_start';
 
-    const START = 'engine_event.start';
+    public const START = 'engine_event.start';
 
-    const END = 'engine_event.end';
+    public const END = 'engine_event.end';
 }
diff --git a/src/Paraunit/Lifecycle/ProcessEvent.php b/src/Paraunit/Lifecycle/ProcessEvent.php
@@ -9,13 +9,13 @@
 
 class ProcessEvent extends Event
 {
-    const PROCESS_STARTED = 'process_event.process_started';
+    public const PROCESS_STARTED = 'process_event.process_started';
 
-    const PROCESS_TERMINATED = 'process_event.process_terminated';
+    public const PROCESS_TERMINATED = 'process_event.process_terminated';
 
-    const PROCESS_TO_BE_RETRIED = 'process_event.process_to_be_retried';
+    public const PROCESS_TO_BE_RETRIED = 'process_event.process_to_be_retried';
 
-    const PROCESS_PARSING_COMPLETED = 'process_event.process_parsing_completed';
+    public const PROCESS_PARSING_COMPLETED = 'process_event.process_parsing_completed';
 
     /** @var AbstractParaunitProcess */
     private $process;

diff --git a/src/Paraunit/Parser/JSON/LogFetcher.php b/src/Paraunit/Parser/JSON/LogFetcher.php
@@ -9,7 +9,7 @@
 
 class LogFetcher
 {
-    const LOG_ENDING_STATUS = 'paraunitEnd';
+    public const LOG_ENDING_STATUS = 'paraunitEnd';
 
     /** @var TempFilenameFactory */
     private $fileName;

diff --git a/src/Paraunit/Parser/JSON/LogPrinter.php b/src/Paraunit/Parser/JSON/LogPrinter.php
@@ -23,19 +23,19 @@
  */
 class LogPrinter extends Util\Printer implements TestListener
 {
-    const STATUS_ERROR = 'error';
+    public const STATUS_ERROR = 'error';
 
-    const STATUS_WARNING = 'warning';
+    public const STATUS_WARNING = 'warning';
 
-    const STATUS_FAIL = 'fail';
+    public const STATUS_FAIL = 'fail';
 
-    const STATUS_PASS = 'pass';
+    public const STATUS_PASS = 'pass';
 
-    const MESSAGE_INCOMPLETE_TEST = 'Incomplete Test: ';
+    public const MESSAGE_INCOMPLETE_TEST = 'Incomplete Test: ';
 
-    const MESSAGE_RISKY_TEST = 'Risky Test: ';
+    public const MESSAGE_RISKY_TEST = 'Risky Test: ';
 
-    const MESSAGE_SKIPPED_TEST = 'Skipped Test: ';
+    public const MESSAGE_SKIPPED_TEST = 'Skipped Test: ';
 
     /** @var resource */
     private $logFile;

diff --git a/src/Paraunit/Parser/JSON/TestStartParser.php b/src/Paraunit/Parser/JSON/TestStartParser.php
@@ -10,7 +10,7 @@
 
 class TestStartParser implements ParserChainElementInterface
 {
-    const UNKNOWN_FUNCTION = 'UNKNOWN -- log not found';
+    private const UNKNOWN_FUNCTION = 'UNKNOWN -- log not found';
 
     /** @var AbstractParaunitProcess */
     private $lastProcess;
@@ -37,10 +37,7 @@ public function handleLogItem(AbstractParaunitProcess $process, \stdClass $logIt
         return null;
     }
 
-    /**
-     * @return null|NullTestResult
-     */
-    private function handleLogTermination(AbstractParaunitProcess $process, \stdClass $logItem)
+    private function handleLogTermination(AbstractParaunitProcess $process, \stdClass $logItem): ?NullTestResult
     {
         if ($process->isWaitingForTestResult()) {
             $this->injectLastFunctionInEndingLog($process, $logItem);
@@ -51,13 +48,13 @@ private function handleLogTermination(AbstractParaunitProcess $process, \stdClas
         return new NullTestResult();
     }
 
-    private function saveProcessFunction(AbstractParaunitProcess $process, \stdClass $logItem)
+    private function saveProcessFunction(AbstractParaunitProcess $process, \stdClass $logItem): void
     {
         $this->lastProcess = $process;
         $this->lastFunction = property_exists($logItem, 'test') ? $logItem->test : self::UNKNOWN_FUNCTION;
     }
 
-    private function injectLastFunctionInEndingLog(AbstractParaunitProcess $process, \stdClass $logItem)
+    private function injectLastFunctionInEndingLog(AbstractParaunitProcess $process, \stdClass $logItem): void
     {
         $logItem->test = $this->lastFunction;
 
@@ -66,7 +63,7 @@ private function injectLastFunctionInEndingLog(AbstractParaunitProcess $process,
         }
     }
 
-    private function saveTestFQCN(AbstractParaunitProcess $process, \stdClass $logItem)
+    private function saveTestFQCN(AbstractParaunitProcess $process, \stdClass $logItem): void
     {
         if ($process->getTestClassName()) {
             return;

diff --git a/src/Paraunit/Printer/FinalPrinter.php b/src/Paraunit/Printer/FinalPrinter.php
@@ -15,7 +15,7 @@
 
 class FinalPrinter extends AbstractFinalPrinter implements EventSubscriberInterface
 {
-    const STOPWATCH_NAME = 'engine';
+    private const STOPWATCH_NAME = 'engine';
 
     /** @var Stopwatch */
     private $stopWatch;

diff --git a/src/Paraunit/Printer/ProcessPrinter.php b/src/Paraunit/Printer/ProcessPrinter.php
@@ -12,9 +12,9 @@
 
 class ProcessPrinter implements EventSubscriberInterface
 {
-    const MAX_CHAR_LENGTH = 80;
+    public const MAX_CHAR_LENGTH = 80;
 
-    const COUNTER_CHAR_LENGTH = 5;
+    private const COUNTER_CHAR_LENGTH = 5;
 
     /** @var SingleResultFormatter */
     private $singleResultFormatter;
@@ -45,9 +45,6 @@ public static function getSubscribedEvents(): array
         ];
     }
 
-    /**
-     * @throws \BadMethodCallException
-     */
     public function onProcessCompleted(ProcessEvent $processEvent): void
     {
         $process = $processEvent->getProcess();

diff --git a/src/Paraunit/Process/AbstractParaunitProcess.php b/src/Paraunit/Process/AbstractParaunitProcess.php
@@ -30,9 +30,6 @@ abstract class AbstractParaunitProcess
     /** @var bool */
     private $waitingForTestResult;
 
-    /**
-     * @throws \InvalidArgumentException
-     */
     public function __construct(string $filename)
     {
         $this->filename = $filename;
@@ -50,7 +47,7 @@ abstract public function getCommandLine(): string;
 
     abstract public function getExitCode(): ?int;
 
-    abstract public function start(int $pipelineNumber);
+    abstract public function start(int $pipelineNumber): void;
 
     public function getUniqueId(): string
     {

diff --git a/src/Paraunit/Process/SymfonyProcessWrapper.php b/src/Paraunit/Process/SymfonyProcessWrapper.php
@@ -29,7 +29,7 @@ public function isTerminated(): bool
         return $this->process->isTerminated();
     }
 
-    public function start(int $pipelineNumber)
+    public function start(int $pipelineNumber): void
     {
         $this->reset();
         $env = $this->process->getEnv();

diff --git a/tests/BaseFunctionalTestCase.php b/tests/BaseFunctionalTestCase.php
@@ -8,7 +8,7 @@ abstract class BaseFunctionalTestCase extends BaseIntegrationTestCase
 {
     protected function setup(): void
     {
-        parent::setUp();
+        parent::setup();
 
         $this->loadContainer();
     }

diff --git a/tests/Functional/Command/ParallelCommandTest.php b/tests/Functional/Command/ParallelCommandTest.php
@@ -16,7 +16,7 @@
 
 class ParallelCommandTest extends BaseTestCase
 {
-    public function testExecutionAllGreen()
+    public function testExecutionAllGreen(): void
     {
         $configurationPath = $this->getConfigForStubs();
         $application = new Application();
@@ -37,7 +37,7 @@ public function testExecutionAllGreen()
         $this->assertEquals(0, $exitCode);
     }
 
-    public function testExecutionAllGreenWithRepeatOption()
+    public function testExecutionAllGreenWithRepeatOption(): void
     {
         $configurationPath = $this->getConfigForStubs();
         $application = new Application();
@@ -59,7 +59,7 @@ public function testExecutionAllGreenWithRepeatOption()
         $this->assertEquals(0, $exitCode);
     }
 
-    public function testExecution()
+    public function testExecution(): void
     {
         $configurationPath = $this->getConfigForStubs();
         $application = new Application();
@@ -86,7 +86,7 @@ public function testExecution()
         $this->assertContains('Executed: 13 test classes (18 retried), 23 tests', $output);
     }
 
-    public function testExecutionWithLogo()
+    public function testExecutionWithLogo(): void
     {
         $configurationPath = $this->getConfigForStubs();
         $application = new Application();
@@ -104,7 +104,7 @@ public function testExecutionWithLogo()
         $this->assertContains('BBBBbBBBBBBB', $output, 'Shark logo missing');
     }
 
-    public function testExecutionWithDebugEnabled()
+    public function testExecutionWithDebugEnabled(): void
     {
         $configurationPath = $this->getConfigForStubs();
         $application = new Application();
@@ -135,7 +135,7 @@ public function testExecutionWithDebugEnabled()
         $this->assertSame($processRetried, substr_count($output, 'PROCESS TO BE RETRIED'));
     }
 
-    public function testExecutionWithParametersWithoutValue()
+    public function testExecutionWithParametersWithoutValue(): void
     {
         $configurationPath = $this->getConfigForStubs();
         $application = new Application();
@@ -153,7 +153,7 @@ public function testExecutionWithParametersWithoutValue()
         $this->assertSame(0, $exitCode);
     }
 
-    public function testExecutionWithoutConfiguration()
+    public function testExecutionWithoutConfiguration(): void
     {
         $application = new Application();
         $application->add(new ParallelCommand(new ParallelConfiguration()));
@@ -171,7 +171,7 @@ public function testExecutionWithoutConfiguration()
         $this->assertSame(0, $exitCode);
     }
 
-    public function testExecutionWithDeprecationListener()
+    public function testExecutionWithDeprecationListener(): void
     {
         $application = new Application();
         $application->add(new ParallelCommand(new ParallelConfiguration()));

diff --git a/tests/Functional/Configuration/PHPDbgBinFileTest.php b/tests/Functional/Configuration/PHPDbgBinFileTest.php
@@ -9,14 +9,14 @@
 
 class PHPDbgBinFileTest extends BaseFunctionalTestCase
 {
-    public function testIsAvailable()
+    public function testIsAvailable(): void
     {
         $bin = new PHPDbgBinFile();
 
         $this->assertTrue($bin->isAvailable());
     }
 
-    public function testGetPhpDbgBin()
+    public function testGetPhpDbgBin(): void
     {
         $bin = new PHPDbgBinFile();
 

diff --git a/tests/Functional/Filter/FilterTest.php b/tests/Functional/Filter/FilterTest.php
@@ -14,7 +14,7 @@ protected function setup(): void
         $this->setOption('configuration', $this->getStubPath() . DIRECTORY_SEPARATOR . 'phpunit_with_2_testsuites.xml');
         $this->setOption('testsuite', 'suite1,suite2');
 
-        parent::setUp(); // TODO: Change the autogenerated stub
+        parent::setup();
     }
 
     public function testFilterTestFiles(): void

diff --git a/tests/Functional/Parser/JSON/AbnormalTerminatedParserTest.php b/tests/Functional/Parser/JSON/AbnormalTerminatedParserTest.php
@@ -12,7 +12,7 @@
 
 class AbnormalTerminatedParserTest extends BaseFunctionalTestCase
 {
-    public function testHandleLogItemWithAbnormalTermination()
+    public function testHandleLogItemWithAbnormalTermination(): void
     {
         $process = new StubbedParaunitProcess();
         $log = new \stdClass();
@@ -29,7 +29,7 @@ public function testHandleLogItemWithAbnormalTermination()
     /**
      * @dataProvider otherStatusesProvider
      */
-    public function testHandleLogItemWithUncatchedLog($otherStatuses)
+    public function testHandleLogItemWithUncaughtLog(string $otherStatuses): void
     {
         $process = new StubbedParaunitProcess();
         $log = new \stdClass();