Add psalm, rename Exception to RoutingException

.github/workflows/tests.yml

@@ -32,3 +32,6 @@ jobs:
 
     - name: Run test suite
       run: vendor/bin/phpunit tests
+
+    - name: Run static analysis
+      run: vendor/bin/psalm

.gitignore

@@ -1,4 +1,5 @@
+.DS_Store
 .idea
 composer.lock
 vendor
-coverage
+coverage

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Parable Routing
 
+## 0.4.0
+
+_Changes_
+
+- Add static analysis using psalm.
+- `Exception` has been renamed to `RoutingException` for clarity.
+
 ## 0.3.1
 
 _Fixes_

Makefile

@@ -4,16 +4,20 @@ dependencies:
 		--no-plugins \
 		--no-scripts
 
+psalm:
+	vendor/bin/psalm --clear-cache
+	vendor/bin/psalm
+
 tests: dependencies
 	vendor/bin/phpunit --verbose tests
 
 coverage: dependencies
 	rm -rf ./coverage
-	vendor/bin/phpunit --coverage-html ./coverage tests
+	XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html ./coverage tests
 
 tests-clean:
 	vendor/bin/phpunit --verbose tests
 
 coverage-clean:
 	rm -rf ./coverage
-	vendor/bin/phpunit --coverage-html ./coverage tests
+	XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html ./coverage tests

composer.json

@@ -16,7 +16,8 @@
     "php": ">=8.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^8.0"
+    "phpunit/phpunit": "^8.0",
+    "vimeo/psalm": "^4.6"
   },
   "autoload": {
     "psr-4": {

psalm.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="4"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <UnresolvableInclude errorLevel="suppress" />
+    </issueHandlers>
+</psalm>

src/Route.php

@@ -88,11 +88,11 @@ public function setParameterValues(ParameterValues $values): void
         $parameters = $this->getParameters();
 
         if (count($values->getAll()) !== count($parameters)) {
-            throw new Exception('Number of values do not match Route parameters.');
+            throw new RoutingException('Number of values do not match Route parameters.');
         }
 
         if (array_diff($values->getNames(), $parameters)) {
-            throw new Exception('Values names do not match Route parameters.');
+            throw new RoutingException('Values names do not match Route parameters.');
         }
 
         $this->parameterValues = $values;

src/Router.php

@@ -74,7 +74,7 @@ public function buildRouteUrl(string $name, array $parameters = []): string
         $route = $this->getRouteByName($name);
 
         if ($route === null) {
-            throw new Exception(sprintf("Route '%s' not found.", $name));
+            throw new RoutingException(sprintf("Route '%s' not found.", $name));
         }
 
         if (!$route->hasParameters()) {
@@ -87,7 +87,7 @@ public function buildRouteUrl(string $name, array $parameters = []): string
             $parameter = '{' . $parameterName . '}';
 
             if (!str_contains($url, $parameter)) {
-                throw new Exception(sprintf(
+                throw new RoutingException(sprintf(
                     "Parameter '%s' not found in url '%s'.",
                     $parameterName,
                     $url

src/Exception.php → src/RoutingException.php

@@ -2,6 +2,6 @@
 
 namespace Parable\Routing;
 
-class Exception extends \Exception
+class RoutingException extends \Exception
 {
 }

tests/RouteTest.php

@@ -2,7 +2,7 @@
 
 namespace Parable\Routing\Tests;
 
-use Parable\Routing\Exception;
+use Parable\Routing\RoutingException;
 use Parable\Routing\Route;
 use Parable\Routing\Route\Metadata;
 use PHPUnit\Framework\TestCase;
@@ -61,7 +61,7 @@ public function testParameteredRouteAndParameterValues(): void
 
     public function testSetValuesThrowsOnInvalidCount(): void
     {
-        $this->expectException(Exception::class);
+        $this->expectException(RoutingException::class);
         $this->expectExceptionMessage('Number of values do not match Route parameters.');
 
         $route = new Route(
@@ -76,7 +76,7 @@ public function testSetValuesThrowsOnInvalidCount(): void
 
     public function testSetValuesThrowsOnInvalidValueNames(): void
     {
-        $this->expectException(Exception::class);
+        $this->expectException(RoutingException::class);
         $this->expectExceptionMessage('Values names do not match Route parameters.');
 
         $route = new Route(

tests/RouterTest.php

@@ -2,10 +2,10 @@
 
 namespace Parable\Routing\Tests;
 
-use Parable\Routing\Exception;
 use Parable\Routing\Route;
 use Parable\Routing\Route\ParameterValues;
 use Parable\Routing\Router;
+use Parable\Routing\RoutingException;
 use Parable\Routing\Tests\Classes\Controller;
 use PHPUnit\Framework\TestCase;
 
@@ -251,7 +251,7 @@ public function testBuildRouteUrl(): void
 
     public function testBuildRouteUrlThrowsOnUnknownName(): void
     {
-        $this->expectException(Exception::class);
+        $this->expectException(RoutingException::class);
         $this->expectExceptionMessage("Route 'nope' not found.");
 
         $this->router->buildRouteUrl('nope', ['id' => 2, 'name' => 'stuff']);
@@ -261,7 +261,7 @@ public function testBuildRouteUrlThrowsOnUrlWithWrongParameters(): void
     {
         $this->setUpDefaultRoutesAndAssert();
 
-        $this->expectException(Exception::class);
+        $this->expectException(RoutingException::class);
         $this->expectExceptionMessage("Parameter 'id2' not found in url '/complex/{id}/{name}'.");
 
         $this->router->buildRouteUrl('complex', ['id2' => 2, 'name2' => 'stuff']);