Merge pull request #106 from php-school/simplify-require-check

AydinHassan · AydinHassan · commit 4b9cd344055d · 2016-05-09T13:20:37.000+02:00
Resolves #104: Simplify require checks - BC Break
diff --git a/src/Check/CodeParseCheck.php b/src/Check/CodeParseCheck.php
@@ -77,4 +77,13 @@ public function getExerciseInterface()
     {
         return ExerciseInterface::class;
     }
+
+    /**
+     *
+     * @return string
+     */
+    public function getPosition()
+    {
+        return SimpleCheckInterface::CHECK_BEFORE;
+    }
 }
diff --git a/src/Check/ComposerCheck.php b/src/Check/ComposerCheck.php
@@ -79,4 +79,13 @@ public function getExerciseInterface()
     {
         return ComposerExerciseCheck::class;
     }
+
+    /**
+     *
+     * @return string
+     */
+    public function getPosition()
+    {
+        return SimpleCheckInterface::CHECK_BEFORE;
+    }
 }
diff --git a/src/Check/FileExistsCheck.php b/src/Check/FileExistsCheck.php
@@ -54,4 +54,13 @@ public function getExerciseInterface()
     {
         return ExerciseInterface::class;
     }
+
+    /**
+     *
+     * @return string
+     */
+    public function getPosition()
+    {
+        return SimpleCheckInterface::CHECK_BEFORE;
+    }
 }
diff --git a/src/Check/FunctionRequirementsCheck.php b/src/Check/FunctionRequirementsCheck.php
@@ -108,4 +108,13 @@ public function getExerciseInterface()
     {
         return FunctionRequirementsExerciseCheck::class;
     }
+
+    /**
+     *
+     * @return string
+     */
+    public function getPosition()
+    {
+        return SimpleCheckInterface::CHECK_AFTER;
+    }
 }
diff --git a/src/Check/PhpLintCheck.php b/src/Check/PhpLintCheck.php
@@ -58,4 +58,13 @@ public function getExerciseInterface()
     {
         return ExerciseInterface::class;
     }
+
+    /**
+     *
+     * @return string
+     */
+    public function getPosition()
+    {
+        return SimpleCheckInterface::CHECK_BEFORE;
+    }
 }
diff --git a/src/Check/SimpleCheckInterface.php b/src/Check/SimpleCheckInterface.php
@@ -13,6 +13,20 @@
  */
 interface SimpleCheckInterface extends CheckInterface
 {
+    /**
+     * Run this check before exercise verifying
+     *
+     * @return string
+     */
+    const CHECK_BEFORE = 'before';
+
+    /**
+     * Run this check after exercise verifying
+     *
+     * @return string
+     */
+    const CHECK_AFTER = 'after';
+
     /**
      * Can this check run this exercise?
      *
@@ -27,4 +41,11 @@ public function canRun(ExerciseType $exerciseType);
      * @return ResultInterface
      */
     public function check(ExerciseInterface $exercise, $fileName);
+
+    /**
+     * either static::CHECK_BEFORE | static::CHECK_AFTER
+     *
+     * @return string
+     */
+    public function getPosition();
 }
diff --git a/src/ExerciseDispatcher.php b/src/ExerciseDispatcher.php
@@ -7,6 +7,7 @@
 use PhpSchool\PhpWorkshop\Check\CheckInterface;
 use PhpSchool\PhpWorkshop\Check\CheckRepository;
 use PhpSchool\PhpWorkshop\Check\ListenableCheckInterface;
+use PhpSchool\PhpWorkshop\Check\SimpleCheckInterface;
 use PhpSchool\PhpWorkshop\Event\Event;
 use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exception\CheckNotApplicableException;
@@ -24,9 +25,6 @@
  */
 class ExerciseDispatcher
 {
-    const CHECK_BEFORE = 'before';
-    const CHECK_AFTER = 'after';
-
     /**
      * @var CheckInterface[]
      */
@@ -77,42 +75,34 @@ public function __construct(
 
     /**
      * @param string $requiredCheck
-     * @param string $position
      * @throws InvalidArgumentException
      */
-    public function requireCheck($requiredCheck, $position)
+    public function requireCheck($requiredCheck)
     {
         if (!$this->checkRepository->has($requiredCheck)) {
             throw new InvalidArgumentException(sprintf('Check: "%s" does not exist', $requiredCheck));
         }
 
-        switch ($position) {
-            case static::CHECK_BEFORE:
-                $this->checksToRunBefore[] = $this->checkRepository->getByClass($requiredCheck);
-                break;
-            case static::CHECK_AFTER:
-                $this->checksToRunAfter[] = $this->checkRepository->getByClass($requiredCheck);
-                break;
-            default:
-                throw InvalidArgumentException::notValidParameter(
-                    'position',
-                    [static::CHECK_BEFORE, static::CHECK_AFTER],
-                    $position
-                );
-        }
-    }
+        $check = $this->checkRepository->getByClass($requiredCheck);
 
-    /**
-     * @param string $requiredCheck
-     * @throws InvalidArgumentException
-     */
-    public function requireListenableCheck($requiredCheck)
-    {
-        if (!$this->checkRepository->has($requiredCheck)) {
-            throw new InvalidArgumentException(sprintf('Check: "%s" does not exist', $requiredCheck));
-        }
+        if ($check instanceof SimpleCheckInterface) {
+            switch ($check->getPosition()) {
+                case SimpleCheckInterface::CHECK_BEFORE:
+                    $this->checksToRunBefore[] = $check;
+                    break;
+                case SimpleCheckInterface::CHECK_AFTER:
+                    $this->checksToRunAfter[] = $check;
+                    break;
+                default:
+                    throw InvalidArgumentException::notValidParameter(
+                        'position',
+                        [SimpleCheckInterface::CHECK_BEFORE, SimpleCheckInterface::CHECK_AFTER],
+                        $check->getPosition()
+                    );
+            }
 
-        $check = $this->checkRepository->getByClass($requiredCheck);
+            return;
+        }
 
         if (!$check instanceof ListenableCheckInterface) {
             throw new InvalidArgumentException(sprintf('Check: "%s" is not a listenable check', $requiredCheck));
diff --git a/test/Check/CodeParseCheckTest.php b/test/Check/CodeParseCheckTest.php
@@ -5,6 +5,7 @@
 use PhpParser\ParserFactory;
 use PhpSchool\PhpWorkshop\Check\CheckInterface;
 use PhpSchool\PhpWorkshop\Check\CodeParseCheck;
+use PhpSchool\PhpWorkshop\Check\SimpleCheckInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PhpSchool\PhpWorkshop\Result\Failure;
@@ -33,6 +34,7 @@ public function setUp()
         $this->check = new CodeParseCheck((new ParserFactory)->create(ParserFactory::PREFER_PHP7));
         $this->assertEquals('Code Parse Check', $this->check->getName());
         $this->assertEquals(ExerciseInterface::class, $this->check->getExerciseInterface());
+        $this->assertEquals(SimpleCheckInterface::CHECK_BEFORE, $this->check->getPosition());
 
         $this->assertTrue($this->check->canRun(ExerciseType::CGI()));
         $this->assertTrue($this->check->canRun(ExerciseType::CLI()));
diff --git a/test/Check/ComposerCheckTest.php b/test/Check/ComposerCheckTest.php
@@ -4,6 +4,7 @@
 
 use InvalidArgumentException;
 use PhpSchool\PhpWorkshop\Check\ComposerCheck;
+use PhpSchool\PhpWorkshop\Check\SimpleCheckInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PhpSchool\PhpWorkshop\ExerciseCheck\ComposerExerciseCheck;
@@ -35,6 +36,7 @@ public function setUp()
         $this->exercise = new ComposerExercise;
         $this->assertEquals('Composer Dependency Check', $this->check->getName());
         $this->assertEquals(ComposerExerciseCheck::class, $this->check->getExerciseInterface());
+        $this->assertEquals(SimpleCheckInterface::CHECK_BEFORE, $this->check->getPosition());
 
         $this->assertTrue($this->check->canRun(ExerciseType::CGI()));
         $this->assertTrue($this->check->canRun(ExerciseType::CLI()));
diff --git a/test/Check/DatabaseCheckTest.php b/test/Check/DatabaseCheckTest.php
@@ -108,7 +108,7 @@ public function testIfPDOThrowsExceptionItCleansUp()
             ->expects($this->once())
             ->method('configure')
             ->will($this->returnCallback(function (ExerciseDispatcher $dispatcher) {
-                $dispatcher->requireListenableCheck(DatabaseCheck::class);
+                $dispatcher->requireCheck(DatabaseCheck::class);
             }));
 
         $this->exercise
@@ -148,7 +148,7 @@ public function testSuccessIsReturnedIfDatabaseVerificationPassed()
             ->expects($this->once())
             ->method('configure')
             ->will($this->returnCallback(function (ExerciseDispatcher $dispatcher) {
-                $dispatcher->requireListenableCheck(DatabaseCheck::class);
+                $dispatcher->requireCheck(DatabaseCheck::class);
             }));
 
         $this->exercise
@@ -183,7 +183,7 @@ public function testRunExercise()
             ->expects($this->once())
             ->method('configure')
             ->will($this->returnCallback(function (ExerciseDispatcher $dispatcher) {
-                $dispatcher->requireListenableCheck(DatabaseCheck::class);
+                $dispatcher->requireCheck(DatabaseCheck::class);
             }));
 
         $results            = new ResultAggregator;
@@ -220,7 +220,7 @@ public function testFailureIsReturnedIfDatabaseVerificationFails()
             ->expects($this->once())
             ->method('configure')
             ->will($this->returnCallback(function (ExerciseDispatcher $dispatcher) {
-                $dispatcher->requireListenableCheck(DatabaseCheck::class);
+                $dispatcher->requireCheck(DatabaseCheck::class);
             }));
 
         $this->exercise
@@ -264,7 +264,7 @@ public function testAlteringDatabaseInSolutionDoesNotEffectDatabaseInUserSolutio
             ->expects($this->once())
             ->method('configure')
             ->will($this->returnCallback(function (ExerciseDispatcher $dispatcher) {
-                $dispatcher->requireListenableCheck(DatabaseCheck::class);
+                $dispatcher->requireCheck(DatabaseCheck::class);
             }));
 
         $this->exercise
diff --git a/test/Check/FileExistsCheckTest.php b/test/Check/FileExistsCheckTest.php
@@ -2,6 +2,7 @@
 
 namespace PhpSchool\PhpWorkshopTest\Check;
 
+use PhpSchool\PhpWorkshop\Check\SimpleCheckInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PHPUnit_Framework_TestCase;
 use PhpSchool\PhpWorkshop\Check\FileExistsCheck;
@@ -39,6 +40,7 @@ public function setUp()
         $this->exercise = $this->getMock(ExerciseInterface::class);
         $this->assertEquals('File Exists Check', $this->check->getName());
         $this->assertEquals(ExerciseInterface::class, $this->check->getExerciseInterface());
+        $this->assertEquals(SimpleCheckInterface::CHECK_BEFORE, $this->check->getPosition());
 
         $this->assertTrue($this->check->canRun(ExerciseType::CGI()));
         $this->assertTrue($this->check->canRun(ExerciseType::CLI()));
diff --git a/test/Check/FunctionRequirementsCheckTest.php b/test/Check/FunctionRequirementsCheckTest.php
@@ -5,6 +5,7 @@
 use InvalidArgumentException;
 use PhpParser\Parser;
 use PhpParser\ParserFactory;
+use PhpSchool\PhpWorkshop\Check\SimpleCheckInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PhpSchool\PhpWorkshopTest\Asset\FunctionRequirementsExercise;
 use PHPUnit_Framework_TestCase;
@@ -45,6 +46,7 @@ public function setUp()
         $this->exercise = new FunctionRequirementsExercise;
         $this->assertEquals('Function Requirements Check', $this->check->getName());
         $this->assertEquals(FunctionRequirementsExerciseCheck::class, $this->check->getExerciseInterface());
+        $this->assertEquals(SimpleCheckInterface::CHECK_AFTER, $this->check->getPosition());
 
         $this->assertTrue($this->check->canRun(ExerciseType::CGI()));
         $this->assertTrue($this->check->canRun(ExerciseType::CLI()));
diff --git a/test/Check/PhpLintCheckTest.php b/test/Check/PhpLintCheckTest.php
@@ -2,6 +2,7 @@
 
 namespace PhpSchool\PhpWorkshopTest\Check;
 
+use PhpSchool\PhpWorkshop\Check\SimpleCheckInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PHPUnit_Framework_TestCase;
 use PhpSchool\PhpWorkshop\Check\PhpLintCheck;
@@ -33,6 +34,7 @@ public function setUp()
         $this->exercise = $this->getMock(ExerciseInterface::class);
         $this->assertEquals('PHP Code Check', $this->check->getName());
         $this->assertEquals(ExerciseInterface::class, $this->check->getExerciseInterface());
+        $this->assertEquals(SimpleCheckInterface::CHECK_BEFORE, $this->check->getPosition());
 
         $this->assertTrue($this->check->canRun(ExerciseType::CGI()));
         $this->assertTrue($this->check->canRun(ExerciseType::CLI()));
diff --git a/test/ExerciseDispatcherTest.php b/test/ExerciseDispatcherTest.php

Original file line number	Diff line number	Diff line change
`@@ -77,4 +77,13 @@ public function getExerciseInterface()`
`77`	`77`	`{`
`78`	`78`	`return ExerciseInterface::class;`
`79`	`79`	`}`
	`80`	`+`
	`81`	`+ /**`
	`82`	`+ *`
	`83`	`+ * @return string`
	`84`	`+ */`
	`85`	`+ public function getPosition()`
	`86`	`+ {`
	`87`	`+ return SimpleCheckInterface::CHECK_BEFORE;`
	`88`	`+ }`
`80`	`89`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,4 +79,13 @@ public function getExerciseInterface()`
`79`	`79`	`{`
`80`	`80`	`return ComposerExerciseCheck::class;`
`81`	`81`	`}`
	`82`	`+`
	`83`	`+ /**`
	`84`	`+ *`
	`85`	`+ * @return string`
	`86`	`+ */`
	`87`	`+ public function getPosition()`
	`88`	`+ {`
	`89`	`+ return SimpleCheckInterface::CHECK_BEFORE;`
	`90`	`+ }`
`82`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,4 +54,13 @@ public function getExerciseInterface()`
`54`	`54`	`{`
`55`	`55`	`return ExerciseInterface::class;`
`56`	`56`	`}`
	`57`	`+`
	`58`	`+ /**`
	`59`	`+ *`
	`60`	`+ * @return string`
	`61`	`+ */`
	`62`	`+ public function getPosition()`
	`63`	`+ {`
	`64`	`+ return SimpleCheckInterface::CHECK_BEFORE;`
	`65`	`+ }`
`57`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -108,4 +108,13 @@ public function getExerciseInterface()`
`108`	`108`	`{`
`109`	`109`	`return FunctionRequirementsExerciseCheck::class;`
`110`	`110`	`}`
	`111`	`+`
	`112`	`+ /**`
	`113`	`+ *`
	`114`	`+ * @return string`
	`115`	`+ */`
	`116`	`+ public function getPosition()`
	`117`	`+ {`
	`118`	`+ return SimpleCheckInterface::CHECK_AFTER;`
	`119`	`+ }`
`111`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,4 +58,13 @@ public function getExerciseInterface()`
`58`	`58`	`{`
`59`	`59`	`return ExerciseInterface::class;`
`60`	`60`	`}`
	`61`	`+`
	`62`	`+ /**`
	`63`	`+ *`
	`64`	`+ * @return string`
	`65`	`+ */`
	`66`	`+ public function getPosition()`
	`67`	`+ {`
	`68`	`+ return SimpleCheckInterface::CHECK_BEFORE;`
	`69`	`+ }`
`61`	`70`	`}`