disable cache on psalm and enable unused code auditing

slimphp · May 14, 2024 · 3ab597e · 3ab597e
1 parent 542c05f
commit 3ab597e
Show file tree

Hide file tree

Showing 36 changed files with 33 additions and 8 deletions.
diff --git a/Slim/App.php b/Slim/App.php
@@ -32,6 +32,7 @@
 use function strtoupper;
 
 /**
+ * @api
  * @template TContainerInterface of (ContainerInterface|null)
  * @template-extends RouteCollectorProxy<TContainerInterface>
  */

diff --git a/Slim/CallableResolver.php b/Slim/CallableResolver.php
@@ -131,8 +131,6 @@ private function resolveSlimNotation(string $toResolve): array
         preg_match(CallableResolver::$callablePattern, $toResolve, $matches);
         [$class, $method] = $matches ? [$matches[1], $matches[2]] : [$toResolve, null];
 
-        /** @var string $class */
-        /** @var string|null $method */
         if ($this->container && $this->container->has($class)) {
             $instance = $this->container->get($class);
             if (!is_object($instance)) {

diff --git a/Slim/Error/Renderers/HtmlErrorRenderer.php b/Slim/Error/Renderers/HtmlErrorRenderer.php
@@ -39,7 +39,6 @@ private function renderExceptionFragment(Throwable $exception): string
     {
         $html = sprintf('<div><strong>Type:</strong> %s</div>', get_class($exception));
 
-        /** @var int|string $code */
         $code = $exception->getCode();
         $html .= sprintf('<div><strong>Code:</strong> %s</div>', $code);
 

diff --git a/Slim/Error/Renderers/JsonErrorRenderer.php b/Slim/Error/Renderers/JsonErrorRenderer.php
@@ -43,7 +43,6 @@ public function __invoke(Throwable $exception, bool $displayErrorDetails): strin
      */
     private function formatExceptionFragment(Throwable $exception): array
     {
-        /** @var int|string $code */
         $code = $exception->getCode();
         return [
             'type' => get_class($exception),

diff --git a/Slim/Error/Renderers/PlainTextErrorRenderer.php b/Slim/Error/Renderers/PlainTextErrorRenderer.php
@@ -43,7 +43,7 @@ private function formatExceptionFragment(Throwable $exception): string
         $text = sprintf("Type: %s\n", get_class($exception));
 
         $code = $exception->getCode();
-        /** @var int|string $code */
+
         $text .= sprintf("Code: %s\n", $code);
 
         $text .= sprintf("Message: %s\n", $exception->getMessage());

diff --git a/Slim/Exception/HttpBadRequestException.php b/Slim/Exception/HttpBadRequestException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpBadRequestException extends HttpSpecializedException
 {
     /**

diff --git a/Slim/Exception/HttpException.php b/Slim/Exception/HttpException.php
@@ -15,6 +15,7 @@
 use Throwable;
 
 /**
+ * @api
  * @method int getCode()
  */
 class HttpException extends RuntimeException

diff --git a/Slim/Exception/HttpForbiddenException.php b/Slim/Exception/HttpForbiddenException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpForbiddenException extends HttpSpecializedException
 {
     /**

diff --git a/Slim/Exception/HttpGoneException.php b/Slim/Exception/HttpGoneException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpGoneException extends HttpSpecializedException
 {
     /**

diff --git a/Slim/Exception/HttpInternalServerErrorException.php b/Slim/Exception/HttpInternalServerErrorException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpInternalServerErrorException extends HttpSpecializedException
 {
     /**

diff --git a/Slim/Exception/HttpNotImplementedException.php b/Slim/Exception/HttpNotImplementedException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpNotImplementedException extends HttpSpecializedException
 {
     /**

diff --git a/Slim/Exception/HttpTooManyRequestsException.php b/Slim/Exception/HttpTooManyRequestsException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpTooManyRequestsException extends HttpSpecializedException
 {
     /**

diff --git a/Slim/Exception/HttpUnauthorizedException.php b/Slim/Exception/HttpUnauthorizedException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpUnauthorizedException extends HttpSpecializedException
 {
     /**

diff --git a/Slim/Factory/AppFactory.php b/Slim/Factory/AppFactory.php
@@ -24,6 +24,7 @@
 use Slim\Interfaces\RouteCollectorInterface;
 use Slim\Interfaces\RouteResolverInterface;
 
+/** @api */
 class AppFactory
 {
     protected static ?Psr17FactoryProviderInterface $psr17FactoryProvider = null;

diff --git a/Slim/Factory/ServerRequestCreatorFactory.php b/Slim/Factory/ServerRequestCreatorFactory.php
@@ -17,6 +17,7 @@
 use Slim\Interfaces\Psr17FactoryProviderInterface;
 use Slim\Interfaces\ServerRequestCreatorInterface;
 
+/** @api */
 class ServerRequestCreatorFactory
 {
     protected static ?Psr17FactoryProviderInterface $psr17FactoryProvider = null;

diff --git a/Slim/Handlers/ErrorHandler.php b/Slim/Handlers/ErrorHandler.php
@@ -43,6 +43,7 @@
  *
  * It outputs the error message and diagnostic information in one of the following formats:
  * JSON, XML, Plain Text or HTML based on the Accept header.
+ * @api
  */
 class ErrorHandler implements ErrorHandlerInterface
 {

diff --git a/Slim/Handlers/Strategies/RequestResponseArgs.php b/Slim/Handlers/Strategies/RequestResponseArgs.php
@@ -18,6 +18,7 @@
 
 /**
  * Route callback strategy with route parameters as individual arguments.
+ * @api
  */
 class RequestResponseArgs implements InvocationStrategyInterface
 {

diff --git a/Slim/Handlers/Strategies/RequestResponseNamedArgs.php b/Slim/Handlers/Strategies/RequestResponseNamedArgs.php
@@ -17,6 +17,7 @@
 
 /**
  * Route callback strategy with route parameters as individual arguments.
+ * @api
  */
 class RequestResponseNamedArgs implements InvocationStrategyInterface
 {

diff --git a/Slim/Interfaces/MiddlewareDispatcherInterface.php b/Slim/Interfaces/MiddlewareDispatcherInterface.php
@@ -13,6 +13,7 @@
 use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 
+/** @api */
 interface MiddlewareDispatcherInterface extends RequestHandlerInterface
 {
     /**

diff --git a/Slim/Interfaces/Psr17FactoryProviderInterface.php b/Slim/Interfaces/Psr17FactoryProviderInterface.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Interfaces;
 
+/** @api */
 interface Psr17FactoryProviderInterface
 {
     /**

diff --git a/Slim/Interfaces/RouteCollectorInterface.php b/Slim/Interfaces/RouteCollectorInterface.php
@@ -13,6 +13,7 @@
 use InvalidArgumentException;
 use RuntimeException;
 
+/** @api */
 interface RouteCollectorInterface
 {
     /**

diff --git a/Slim/Interfaces/RouteCollectorProxyInterface.php b/Slim/Interfaces/RouteCollectorProxyInterface.php
@@ -15,6 +15,7 @@
 use Psr\Http\Message\UriInterface;
 
 /**
+ * @api
  * @template TContainerInterface of (ContainerInterface|null)
  */
 interface RouteCollectorProxyInterface

diff --git a/Slim/Interfaces/RouteGroupInterface.php b/Slim/Interfaces/RouteGroupInterface.php
@@ -13,6 +13,7 @@
 use Psr\Http\Server\MiddlewareInterface;
 use Slim\MiddlewareDispatcher;
 
+/** @api */
 interface RouteGroupInterface
 {
     public function collectRoutes(): RouteGroupInterface;

diff --git a/Slim/Interfaces/RouteInterface.php b/Slim/Interfaces/RouteInterface.php
@@ -14,6 +14,7 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\MiddlewareInterface;
 
+/** @api */
 interface RouteInterface
 {
     /**

diff --git a/Slim/Interfaces/RouteParserInterface.php b/Slim/Interfaces/RouteParserInterface.php
@@ -14,6 +14,7 @@
 use Psr\Http\Message\UriInterface;
 use RuntimeException;
 
+/** @api */
 interface RouteParserInterface
 {
     /**

diff --git a/Slim/Middleware/BodyParsingMiddleware.php b/Slim/Middleware/BodyParsingMiddleware.php
@@ -33,6 +33,7 @@
 
 use const LIBXML_VERSION;
 
+/** @api */
 class BodyParsingMiddleware implements MiddlewareInterface
 {
     /**

diff --git a/Slim/Middleware/ContentLengthMiddleware.php b/Slim/Middleware/ContentLengthMiddleware.php
@@ -15,6 +15,7 @@
 use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 
+/** @api */
 class ContentLengthMiddleware implements MiddlewareInterface
 {
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface

diff --git a/Slim/Middleware/ErrorMiddleware.php b/Slim/Middleware/ErrorMiddleware.php
@@ -25,6 +25,7 @@
 use function get_class;
 use function is_subclass_of;
 
+/** @api */
 class ErrorMiddleware implements MiddlewareInterface
 {
     protected CallableResolverInterface $callableResolver;

diff --git a/Slim/Middleware/MethodOverrideMiddleware.php b/Slim/Middleware/MethodOverrideMiddleware.php
@@ -18,6 +18,7 @@
 use function is_array;
 use function strtoupper;
 
+/** @api */
 class MethodOverrideMiddleware implements MiddlewareInterface
 {
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface

diff --git a/Slim/Middleware/OutputBufferingMiddleware.php b/Slim/Middleware/OutputBufferingMiddleware.php
@@ -23,6 +23,7 @@
 use function ob_get_clean;
 use function ob_start;
 
+/** @api */
 class OutputBufferingMiddleware implements MiddlewareInterface
 {
     public const APPEND = 'append';

diff --git a/Slim/MiddlewareDispatcher.php b/Slim/MiddlewareDispatcher.php
@@ -29,6 +29,7 @@
 use function sprintf;
 
 /**
+ * @api
  * @template TContainerInterface of (ContainerInterface|null)
  */
 class MiddlewareDispatcher implements MiddlewareDispatcherInterface

diff --git a/Slim/Routing/Route.php b/Slim/Routing/Route.php
@@ -34,6 +34,7 @@
 use function is_array;
 
 /**
+ * @api
  * @template TContainerInterface of (ContainerInterface|null)
  */
 class Route implements RouteInterface, RequestHandlerInterface
@@ -328,7 +329,6 @@ protected function appendGroupMiddlewareToRoute(): void
         $inner = $this->middlewareDispatcher;
         $this->middlewareDispatcher = new MiddlewareDispatcher($inner, $this->callableResolver, $this->container);
 
-        /** @var RouteGroupInterface $group */
         foreach (array_reverse($this->groups) as $group) {
             $group->appendMiddlewareToDispatcher($this->middlewareDispatcher);
         }

diff --git a/Slim/Routing/RouteContext.php b/Slim/Routing/RouteContext.php
@@ -15,6 +15,7 @@
 use Slim\Interfaces\RouteInterface;
 use Slim\Interfaces\RouteParserInterface;
 
+/** @api */
 final class RouteContext
 {
     public const ROUTE = '__route__';

diff --git a/Slim/Routing/RoutingResults.php b/Slim/Routing/RoutingResults.php
@@ -14,6 +14,7 @@
 
 use function rawurldecode;
 
+/** @api */
 class RoutingResults
 {
     public const NOT_FOUND = 0;

diff --git a/composer.json b/composer.json
@@ -91,7 +91,7 @@
         "phpunit": "phpunit",
         "phpcs": "phpcs",
         "phpstan": "phpstan --memory-limit=-1",
-        "psalm": "psalm"
+        "psalm": "psalm --no-cache"
     },
     "suggest": {
         "ext-simplexml": "Needed to support XML format in BodyParsingMiddleware",

diff --git a/psalm.xml b/psalm.xml
@@ -6,7 +6,7 @@
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
     findUnusedBaselineEntry="true"
-    findUnusedCode="false"
+    findUnusedCode="true"
 >
     <projectFiles>
         <directory name="Slim" />