CS Fixes

CHANGELOG.md

@@ -11,6 +11,14 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ### Removed
 
+## [2.3.0]
+### Added
+ - Builds support for PHP 7.4
+ - Various code cleaning (phpstan, psr12, docblock removal)
+
+### Removed
+ - Removed support for PHP 7.1
+
 ## [2.2.0]
 ### Added
  - Builds for PHP 7.1 & 7.2 (#160)

composer.json

@@ -49,15 +49,19 @@
         ]
     },
     "autoload-dev": {
-        "psr-4": { 
-            "PhpSchool\\PhpWorkshopTest\\": "test" 
+        "psr-4": {
+            "PhpSchool\\PhpWorkshopTest\\": "test"
         }
     },
     "scripts" : {
         "cs" : [
             "phpcs src --standard=PSR12 --encoding=UTF-8",
             "phpcs test --standard=PSR12 --encoding=UTF-8"
         ],
+        "cs-fix" : [
+            "phpcbf src --standard=PSR12 --encoding=UTF-8",
+            "phpcbf test --standard=PSR12 --encoding=UTF-8"
+        ],
         "static": "phpstan --ansi analyse --level max src"
     }
 }

src/Application.php

@@ -72,7 +72,7 @@ public function __construct(string $workshopTitle, string $diConfigFile)
     {
         Assertion::string($workshopTitle);
         Assertion::file($diConfigFile);
-        
+
         $this->workshopTitle = $workshopTitle;
         $this->diConfigFile = $diConfigFile;
     }
@@ -159,7 +159,7 @@ public function setBgColour(string $colour): void
     public function run(): int
     {
         $container = $this->getContainer();
-        
+
         foreach ($this->exercises as $exercise) {
             if (false === $container->has($exercise)) {
                 throw new \RuntimeException(

src/Check/CodeParseCheck.php

@@ -58,7 +58,7 @@ public function check(ExerciseInterface $exercise, Input $input): ResultInterfac
         } catch (Error $e) {
             return Failure::fromCheckAndCodeParseFailure($this, $e, $input->getRequiredArgument('program'));
         }
-        
+
         return Success::fromCheck($this);
     }
 

src/Check/ComposerCheck.php

@@ -40,7 +40,7 @@ public function check(ExerciseInterface $exercise, Input $input): ResultInterfac
         if (!$exercise instanceof ComposerExerciseCheck) {
             throw new \InvalidArgumentException();
         }
-        
+
         if (!file_exists(sprintf('%s/composer.json', dirname($input->getRequiredArgument('program'))))) {
             return new Failure($this->getName(), 'No composer.json file found');
         }
@@ -52,12 +52,12 @@ public function check(ExerciseInterface $exercise, Input $input): ResultInterfac
         if (!file_exists(sprintf('%s/vendor', dirname($input->getRequiredArgument('program'))))) {
             return new Failure($this->getName(), 'No vendor folder found');
         }
-        
+
         $lockFile = new LockFileParser(sprintf('%s/composer.lock', dirname($input->getRequiredArgument('program'))));
         $missingPackages = array_filter($exercise->getRequiredPackages(), function ($package) use ($lockFile) {
             return !$lockFile->hasInstalledPackage($package);
         });
-        
+
         if (count($missingPackages) > 0) {
             return new Failure(
                 $this->getName(),

src/CodePatcher.php

@@ -20,12 +20,12 @@ class CodePatcher
      * @var Parser
      */
     private $parser;
-    
+
     /**
      * @var Standard
      */
     private $printer;
-    
+
     /**
      * @var Patch|null
      */
@@ -49,7 +49,7 @@ public function __construct(Parser $parser, Standard $printer, Patch $defaultPat
         $this->printer = $printer;
         $this->defaultPatch = $defaultPatch;
     }
-    
+
     /**
      * Accepts an exercise and a string containing the students solution to the exercise.
      *
@@ -71,7 +71,7 @@ public function patch(ExerciseInterface $exercise, string $code): string
         if ($exercise instanceof SubmissionPatchable) {
             $code = $this->applyPatch($exercise->getPatch(), $code);
         }
-        
+
         return $code;
     }
 

src/Command/CreditsCommand.php

@@ -14,7 +14,7 @@ class CreditsCommand
      * @var OutputInterface
      */
     private $output;
-    
+
     /**
      * @var Color
      */
@@ -61,7 +61,7 @@ private function writeContributors(array $contributors): void
             $this->output->writeLine(sprintf("%s  %s", str_pad($name, (int) $nameColumnSize), $gitHubUser));
         }
     }
-    
+
     /**
      *
      * @return void
@@ -71,7 +71,7 @@ public function __invoke(): void
         if (empty($this->coreContributors)) {
             return;
         }
-        
+
         $this->output->writeLine(
             $this->color->__invoke("PHP School is bought to you by...")->yellow()->__toString()
         );
@@ -84,7 +84,7 @@ public function __invoke(): void
 
         $this->output->emptyLine();
         $this->output->emptyLine();
-        
+
         $this->output->writeLine(
             $this->color->__invoke("This workshop is brought to you by...")->yellow()->__toString()
         );

src/Command/HelpCommand.php

@@ -15,7 +15,7 @@ class HelpCommand
      * @var string
      */
     private $appName;
-    
+
     /**
      * @var OutputInterface
      */
@@ -37,7 +37,7 @@ public function __construct($appName, OutputInterface $output, Color $color)
         $this->color    = $color;
         $this->appName  = $appName;
     }
-    
+
     /**
      * @return void
      */

src/Command/VerifyCommand.php

@@ -35,7 +35,7 @@ class VerifyCommand
      * @var UserStateSerializer
      */
     private $userStateSerializer;
-    
+
     /**
      * @var ResultsRenderer
      */
@@ -84,7 +84,7 @@ public function __invoke(Input $input)
             $this->userState->addCompletedExercise($exercise->getName());
             $this->userStateSerializer->serialize($this->userState);
         }
-        
+
         $this->resultsRenderer->render($results, $exercise, $this->userState, $this->output);
         return $results->isSuccessful() ? 0 : 1;
     }

src/ComposerUtil/LockFileParser.php

@@ -23,7 +23,7 @@ public function __construct(string $lockFilePath)
         if (!file_exists($lockFilePath)) {
             throw new InvalidArgumentException(sprintf('Lock File: "%s" does not exist', $lockFilePath));
         }
-        
+
         $this->contents = json_decode((string) file_get_contents($lockFilePath), true);
 
         if (!isset($this->contents['packages'])) {
@@ -66,7 +66,7 @@ public function hasInstalledPackage($packageName): bool
                 return true;
             }
         }
-        
+
         return false;
     }
 }

src/Result/Cgi/RequestFailure.php

@@ -14,7 +14,7 @@ class RequestFailure implements FailureInterface
      * @var RequestInterface
      */
     private $request;
-    
+
     /**
      * @var string
      */
@@ -24,12 +24,12 @@ class RequestFailure implements FailureInterface
      * @var string
      */
     private $actualOutput;
-    
+
     /**
      * @var array<string, string>
      */
     private $expectedHeaders;
-    
+
     /**
      * @var array<string, string>
      */

src/Result/Cli/RequestFailure.php

@@ -59,7 +59,7 @@ public function getArgs(): ArrayObject
     {
         return $this->args;
     }
-    
+
     /**
      * Get the expected output.
      *

src/Result/Failure.php

@@ -45,7 +45,7 @@ public static function fromNameAndReason(string $name, ?string $reason): self
     {
         return new self($name, $reason);
     }
-    
+
     /**
      * Static constructor to create from an instance of `PhpSchool\PhpWorkshop\Check\CheckInterface`.
      *

src/Result/FunctionRequirementsFailure.php

@@ -11,7 +11,7 @@
 class FunctionRequirementsFailure implements FailureInterface
 {
     use ResultTrait;
-    
+
     /**
      * @var array<int, string>
      */

src/Result/ResultTrait.php

@@ -14,7 +14,7 @@ trait ResultTrait
      * @var CheckInterface
      */
     private $check;
-    
+
     /**
      * Get the check name from the underlying check. Assumes that the `check` property has been
      * assigned an instance of `PhpSchool\PhpWorkshop\Check\CheckInterface`.

src/Solution/DirectorySolution.php

@@ -63,11 +63,11 @@ public function __construct(string $directory, string $entryPoint, array $exclus
                 sprintf('Entry point: "%s" does not exist in: "%s"', $entryPoint, $directory)
             );
         }
-        
+
         $this->files = array_map(function ($file) use ($directory) {
             return new SolutionFile($file, $directory);
         }, $files);
-        
+
         $this->entryPoint    = sprintf('%s/%s', $directory, $entryPoint);
         $this->baseDirectory = $directory;
     }

test/Check/CodeParseCheckTest.php

@@ -23,7 +23,7 @@ class CodeParseCheckTest extends TestCase
      * @var string
      */
     private $file;
-    
+
     public function setUp(): void
     {
         $this->check = new CodeParseCheck((new ParserFactory())->create(ParserFactory::PREFER_PHP7));
@@ -42,13 +42,13 @@ public function setUp(): void
     public function testUnParseableCodeReturnsFailure(): void
     {
         file_put_contents($this->file, '<?php $lol');
-        
+
         $result = $this->check->check(
             $this->createMock(ExerciseInterface::class),
             new Input('app', ['program' => $this->file])
         );
         $this->assertInstanceOf(Failure::class, $result);
-        
+
         $this->assertEquals('Code Parse Check', $result->getCheckName());
         $this->assertMatchesRegularExpression(
             sprintf('|^File: "%s" could not be parsed\. Error: "|', preg_quote($this->file)),

test/Check/ComposerCheckTest.php

@@ -37,7 +37,7 @@ public function setUp(): void
         $this->assertTrue($this->check->canRun(ExerciseType::CGI()));
         $this->assertTrue($this->check->canRun(ExerciseType::CLI()));
     }
-    
+
     public function testExceptionIsThrownIfNotValidExercise(): void
     {
         $exercise = $this->createMock(ExerciseInterface::class);

test/Check/FunctionRequirementsCheckTest.php

@@ -95,7 +95,7 @@ public function testFailureIsReturnedIfNotAllRequiredFunctionsHaveBeenUsed(): vo
             new Input('app', ['program' => __DIR__ . '/../res/function-requirements/fail-banned-function.php'])
         );
         $this->assertInstanceOf(FunctionRequirementsFailure::class, $failure);
-        
+
         $this->assertEquals(['file_get_contents', 'implode'], $failure->getMissingFunctions());
         $this->assertEquals([], $failure->getBannedFunctions());
     }

test/CodePatcherTest.php

@@ -28,8 +28,8 @@ public function testDefaultPatchIsAppliedIfAvailable(): void
         $expected = "<?php\n\nini_set(\"display_errors\", 1);\n\$original = true;";
         $this->assertEquals($expected, $patcher->patch($exercise, '<?php $original = true;'));
     }
-    
-    
+
+
     public function testPatcherDoesNotApplyPatchIfNotPatchableExercise(): void
     {
         $patcher = new CodePatcher((new ParserFactory())->create(ParserFactory::PREFER_PHP7), new Standard());
@@ -38,21 +38,21 @@ public function testPatcherDoesNotApplyPatchIfNotPatchableExercise(): void
         $code = '<?php $original = true;';
         $this->assertEquals($code, $patcher->patch($exercise, $code));
     }
-    
+
     /**
      * @dataProvider codeProvider
      */
     public function testPatcher(string $code, Patch $patch, string $expectedResult): void
     {
         $patcher = new CodePatcher((new ParserFactory())->create(ParserFactory::PREFER_PHP7), new Standard());
-        
+
         $exercise = $this->createMock(PatchableExercise::class);
-        
+
         $exercise
             ->expects($this->once())
             ->method('getPatch')
             ->willReturn($patch);
-        
+
         $result = $patcher->patch($exercise, $code);
         $this->assertEquals($expectedResult, $result);
     }

test/Command/CreditsCommandTest.php

@@ -60,17 +60,17 @@ public function testWithOnlyCoreContributors(): void
     public function testWithNoContributors(): void
     {
         $this->expectOutputString('');
-        
+
         $color = new Color();
         $color->setForceStyle(true);
-        
+
         $command = new CreditsCommand(
             [],
             [],
             new StdOutput($color, $this->createMock(Terminal::class)),
             $color
         );
-        
+
         $command->__invoke();
     }
 }

test/Command/MenuCommandInvokerTest.php

@@ -14,7 +14,7 @@ public function testInvoker(): void
         $menu
             ->expects($this->once())
             ->method('close');
-        
+
         $command = $this->getMockBuilder('stdClass')
             ->setMethods(['__invoke'])
             ->getMock();