Partial migration to support Slim 3 (and full phpunit 9 migration)

.gitignore

@@ -1,3 +1,4 @@
 .idea
 vendor/
-composer.lock
+composer.lock
+.phpunit.result.cache

CHANGELOG.md

@@ -0,0 +1,2 @@
+# unreleased
+    - BREAKING: You can no longer add routes after the app has been dispatched

composer.json

@@ -15,11 +15,12 @@
     ],
     "require": {
         "php":       ">=5.3.0",
-        "slim/slim": "2.*"
+        "slim/slim": "3.*"
     },
     "require-dev": {
-        "phpunit/phpunit": "4.3.5",
-        "mockery/mockery": "0.8.*"
+        "phpunit/phpunit": "^9",
+        "mockery/mockery": "0.8.*",
+        "rector/rector": "^0.12.15"
     },
     "autoload": {
         "psr-0": {

phpunit.xml.dist

@@ -8,17 +8,10 @@
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         syntaxCheck="false"
 >
     <testsuites>
         <testsuite name="Unit Tests">
             <directory>./tests/SlimController/Tests</directory>
-            <exclude>./tests/SlimController/Tests/Old/</exclude>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-            <directory>src</directory>
-        </whitelist>
-    </filter>
 </phpunit>

rector.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Core\Configuration\Option;
+use Rector\Php74\Rector\Property\TypedPropertyRector;
+use Rector\Set\ValueObject\LevelSetList;
+use Rector\PHPUnit\Set\PHPUnitLevelSetList;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    // get parameters
+    $parameters = $containerConfigurator->parameters();
+    $parameters->set(Option::PATHS, [
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ]);
+
+    // Define what rule sets will be applied
+    $containerConfigurator->import(LevelSetList::UP_TO_PHP_74);
+    $containerConfigurator->import(PHPUnitLevelSetList::UP_TO_PHPUNIT_90 );
+
+    // get services (needed for register a single rule)
+    // $services = $containerConfigurator->services();
+
+    // register a single rule
+    // $services->set(TypedPropertyRector::class);
+};

src/SlimController/Slim.php

@@ -17,7 +17,7 @@
 /**
  * Extended Slim base
  */
-class Slim extends \Slim\Slim
+class Slim extends \Slim\App
 {
 
     /**
@@ -108,19 +108,20 @@ public function addRoutes(array $routes, $globalMiddlewares = array())
                     throw new \InvalidArgumentException("Http method '$httpMethod' is not supported.");
                 }
 
+                if ('ANY' === $httpMethod) {
+                    $httpMethod = static::$ALLOWED_HTTP_METHODS;
+                } else {
+                    $httpMethod = [ $httpMethod ];
+                }
+
                 $routeMiddlewares = array_merge($localMiddlewares, $globalMiddlewares);
-                $route = $this->addControllerRoute($path, $classRoute, $routeMiddlewares);
+                $route = $this->addControllerRoute($httpMethod, $path, $classRoute, $routeMiddlewares);
 
                 if (!isset($this->routeNames[$classRoute])) {
-                    $route->name($classRoute);
+                    $route->setName($classRoute);
                     $this->routeNames[$classRoute] = 1;
                 }
 
-                if ('any' === $httpMethod) {
-                    call_user_func_array(array($route, 'via'), static::$ALLOWED_HTTP_METHODS);
-                } else {
-                    $route->via($httpMethod);
-                }
             }
         }
 
@@ -131,11 +132,11 @@ public function addRoutes(array $routes, $globalMiddlewares = array())
      * Add a new controller route
      *
      * <code>
-     * $app->addControllerRoute("/the/path", "className:methodName", array(function () { doSome(); }))
-     *  ->via('GET')->condition(..);
+     * $app->addControllerRoute(['GET'], "/the/path", "className:methodName", array(function () { doSome(); }))
+     *  ->condition(..);
      *
-     * $app->addControllerRoute("/the/path", "className:methodName")
-     * ->via('GET')->condition(..);
+     * $app->addControllerRoute(['GET'], "/the/path", "className:methodName")
+     * ->condition(..);
      * </code>
      *
      * @param string     $path
@@ -144,11 +145,13 @@ public function addRoutes(array $routes, $globalMiddlewares = array())
      *
      * @return \Slim\Route
      */
-    public function addControllerRoute($path, $route, array $middleware = array())
+    public function addControllerRoute($methods, $path, $route, array $middleware = array())
     {
         $callback = $this->buildCallbackFromControllerRoute($route);
 
+        $methods = is_array($methods) ? $methods : [ $methods ];
         array_unshift($middleware, $path);
+        array_unshift($middleware, $methods);
         array_push($middleware, $callback);
 
         $route = call_user_func_array(array($this, 'map'), $middleware);
@@ -165,13 +168,13 @@ public function addControllerRoute($path, $route, array $middleware = array())
      */
     protected function buildCallbackFromControllerRoute($route)
     {
-        list($controller, $methodName) = $this->determineClassAndMethod($route);
+        [$controller, $methodName] = $this->determineClassAndMethod($route);
         $app      = & $this;
         $callable = function () use ($app, $controller, $methodName) {
             // Get action arguments
             $args = func_get_args();
             // Try to fetch the instance from Slim's container, otherwise lazy-instantiate it
-            $instance = $app->container->has($controller) ? $app->container->get($controller) : new $controller($app);
+            $instance = $app->getContainer()->has($controller) ? $app->getContainer()->get($controller) : new $controller($app);
 
             return call_user_func_array(array($instance, $methodName), $args);
         };
@@ -189,14 +192,14 @@ protected function determineClassAndMethod($classMethod)
     {
 
         // determine class prefix (eg "\Vendor\Bundle\Controller") and suffix (eg "Controller")
-        $classNamePrefix = $this->config('controller.class_prefix');
-        if ($classNamePrefix && substr($classNamePrefix, -strlen($classNamePrefix) !== '\\')) {
+        $classNamePrefix = $this->getContainer()->get('settings')['controller.class_prefix'];
+        if ($classNamePrefix && substr($classNamePrefix, -strlen($classNamePrefix) !== 0)) {
             $classNamePrefix .= '\\';
         }
-        $classNameSuffix = $this->config('controller.class_suffix') ? : '';
+        $classNameSuffix = $this->getContainer()->get('settings')['controller.class_suffix'] ? : '';
 
         // determine method suffix or default to "Action"
-        $methodNameSuffix = $this->config('controller.method_suffix');
+        $methodNameSuffix = $this->getContainer()->get('settings')['controller.method_suffix'];
         if (is_null($methodNameSuffix)) {
             $methodNameSuffix = 'Action';
         }

src/SlimController/SlimController.php

@@ -25,7 +25,7 @@ abstract class SlimController
     /**
      * @const string
      */
-    const VERSION = '0.1.4';
+    public const VERSION = '0.1.4';
 
     /**
      * @var Slim
@@ -40,22 +40,22 @@ abstract class SlimController
     /**
      * @var string Prefix for params
      */
-    private $paramPrefix = 'data.';
+    private string $paramPrefix = 'data.';
 
     /**
      * @var array Stash of GET & POST params
      */
-    private $paramsParams = null;
+    private ?array $paramsParams = null;
 
     /**
      * @var array Stash of GET params
      */
-    private $paramsGet = null;
+    private ?array $paramsGet = null;
 
     /**
      * @var array Stash of POST params
      */
-    private $paramsPost = null;
+    private ?array $paramsPost = null;
 
     /**
      * Suffix was never specified and defaults to empty string 
@@ -67,22 +67,22 @@ abstract class SlimController
     /**
      * Constructor for TodoQueue\Controller\Login
      *
-     * @param \Slim\Slim $app Ref to slim app
+     * @param \Slim\App $app Ref to slim app
      */
-    public function __construct(\Slim\Slim &$app)
+    public function __construct(\Slim\App &$app)
     {
         $this->app = $app;
-        if ($renderTemplateSuffix = $app->config('controller.template_suffix')) {
+        if ($renderTemplateSuffix = $app->getContainer()->get('settings')['controller.template_suffix']) {
             $this->renderTemplateSuffix = $renderTemplateSuffix;
         }
-        if (!is_null($paramPrefix = $app->config('controller.param_prefix'))) {
+        if (!is_null($paramPrefix = $app->getContainer()->get('settings')['controller.param_prefix'])) {
             $this->paramPrefix = $paramPrefix;
             $prefixLength      = strlen($this->paramPrefix);
             if ($prefixLength > 0 && substr($this->paramPrefix, -$prefixLength) !== '.') {
                 $this->paramPrefix .= '.';
             }
         }
-        if ($app->config('controller.cleanup_params')) {
+        if ($app->getContainer()->get('settings')['controller.cleanup_params']) {
             $this->paramCleanup = true;
         }
     }
@@ -277,11 +277,7 @@ private function getAllParamNames($reqMode)
         $names    = array_keys($namesPre);
         if ($prefix = $this->paramPrefix) {
             $prefixLen = strlen($prefix);
-            $names     = array_map(function ($key) use ($prefixLen) {
-                return substr($key, $prefixLen);
-            }, array_filter($names, function ($in) use ($prefix) {
-                return strpos($in, $prefix) === 0;
-            }));
+            $names     = array_map(fn($key) => substr($key, $prefixLen), array_filter($names, fn($in) => strpos($in, $prefix) === 0));
         }
 
         return $names;

tests/SlimController/Tests/Fixtures/Controller/TestController.php

@@ -31,31 +31,31 @@ public function paramSingleArrayAction()
     public function paramMultiAction()
     {
         $params = $this->params(array('Some.param', 'Other.param', 'Other.missing'));
-        echo json_encode($params);
+        echo json_encode($params, JSON_THROW_ON_ERROR);
     }
 
     public function paramMultiMissingReqAction()
     {
         $params = $this->params(array('Some.param', 'Other.param'), 'get', true);
-        echo json_encode($params);
+        echo json_encode($params, JSON_THROW_ON_ERROR);
     }
 
     public function paramMultiDefaultAction()
     {
         $params = $this->params(array('Some.param', 'Other.param', 'Other.bla'), 'get', array('Other.bla' => 'great'));
-        echo json_encode($params);
+        echo json_encode($params, JSON_THROW_ON_ERROR);
     }
 
     public function paramGetAllAction()
     {
         $params = $this->params();
-        echo json_encode($params);
+        echo json_encode($params, JSON_THROW_ON_ERROR);
     }
 
     public function paramCleanupAction()
     {
         $messedUp = array('foo<bar>', '<other>Notgood');
-        echo json_encode($this->cleanupParam($messedUp));
+        echo json_encode($this->cleanupParam($messedUp), JSON_THROW_ON_ERROR);
     }
 
     public function renderAction()

tests/SlimController/Tests/Integration/CanCreateApplicationTest.php

@@ -2,13 +2,13 @@
 
 namespace SlimController\Tests\Integration;
 
-class CanCreateApplicationTest extends \PHPUnit_Framework_TestCase
+class CanCreateApplicationTest extends \PHPUnit\Framework\TestCase
 {
 
     public function testCanCreateSimpleApplication()
     {
         $app = new \SlimController\Slim();
-        $this->assertTrue(true); // if we got this far then creating the application worked
+        static::assertTrue(true); // if we got this far then creating the application worked
     }
 
 }