symfony 5 compatibility

.styleci.yml

@@ -3,3 +3,6 @@ preset: symfony
 enabled:
   - alpha_ordered_imports
   - short_array_syntax
+
+disabled:
+  - single_line_throw

.travis.yml

@@ -28,16 +28,15 @@ matrix:
   include:
     # Minimum supported dependencies with the latest and oldest PHP version
 
-    - php: 7.1
+    - php: 7.2
       env:
         - COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
-    - php: 7.2
+    - php: 7.3
       env:
         - COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
 
     # Test the latest stable release
 
-    - php: 7.1
     - php: 7.2
     - php: 7.3
       env:
@@ -49,6 +48,9 @@ matrix:
     - php: 7.3
       env: DEPENDENCIES="symfony/lts:^3"
 
+    - php: 7.3
+      env: DEPENDENCIES="symfony/flex" SYMFONY_VERSION="^4"
+
       # Latest commit to master
     - php: 7.3
       env: STABILITY="dev"
@@ -61,6 +63,7 @@ before_install:
   - if [[ $COVERAGE != true ]]; then phpenv config-rm xdebug.ini || true; fi
   - if ! [ -z "$STABILITY" ]; then composer config minimum-stability ${STABILITY}; fi;
   - if ! [ -v "$DEPENDENCIES" ]; then composer require --no-update ${DEPENDENCIES}; fi;
+  - if ! [ -v "$SYMFONY_VERSION" ]; then composer config extra.symfony.require ${SYMFONY_VERSION}; fi;
 
 install:
   # To be removed when this issue will be resolved: https://github.com/composer/composer/issues/5355

CHANGELOG.md

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+2.8.0
+-----
+
+### Fixed
+
+* Adjusted to work with Twig 3
+* Adjusted to work with Symfony 5
+
 2.7.2
 -----
 

composer.json

@@ -21,30 +21,30 @@
         }
     ],
     "require": {
-        "php": "^7.1",
+        "php": "^7.2",
         "friendsofsymfony/http-cache": "^2.5.2",
-        "symfony/framework-bundle": "^3.4.4 || ^4.0",
-        "symfony/http-foundation": "^3.4.4 || ^4.0",
-        "symfony/http-kernel": "^3.4.4 || ^4.0"
+        "symfony/framework-bundle": "^3.4.4 || ^4.1.12 || ^5.0",
+        "symfony/http-foundation": "^3.4.4 || ^4.1.12 || ^5.0",
+        "symfony/http-kernel": "^3.4.4 || ^4.1.12 || ^5.0"
     },
     "require-dev": {
         "php-http/guzzle6-adapter": "^1.0 || ^2.0",
         "php-http/message": "^1.0",
         "mockery/mockery": "^1.0",
         "monolog/monolog": "*",
-        "sensio/framework-extra-bundle": "^3.0",
-        "symfony/browser-kit": "^3.4.4 || ^4.0",
-        "symfony/console": "^3.4.4 || ^4.0",
-        "symfony/finder": "^3.4.4 || ^4.0",
-        "symfony/phpunit-bridge": "^4.2.4",
-        "symfony/security-bundle": "^3.4.4 || ^4.0",
-        "symfony/twig-bundle": "^3.4.4 || ^4.0",
-        "symfony/yaml": "^3.4.4 || ^4.0",
-        "symfony/css-selector": "^3.4.4 || ^4.0",
-        "symfony/expression-language": "^3.4.4 || ^4.0",
-        "symfony/monolog-bundle": "^3.0",
-        "symfony/routing": "^3.4.4 || ^4.0",
-        "matthiasnoback/symfony-dependency-injection-test": "^2.3",
+        "sensio/framework-extra-bundle": "^3.0 || ^4.0 || ^5.0",
+        "symfony/browser-kit": "^3.4.4 || ^4.1.12 || ^5.0",
+        "symfony/console": "^3.4.4 || ^4.1.12 || ^5.0",
+        "symfony/finder": "^3.4.4 || ^4.1.12 || ^5.0",
+        "symfony/phpunit-bridge": "^4.2.4 || ^5.0",
+        "symfony/security-bundle": "^3.4.5 || ^4.1.12 || ^5.0",
+        "symfony/twig-bundle": "^3.4.4 || ^4.1.12 || ^5.0",
+        "symfony/yaml": "^3.4.4 || ^4.1.12 || ^5.0",
+        "symfony/css-selector": "^3.4.4 || ^4.1.12 || ^5.0",
+        "symfony/expression-language": "^3.4.4 || ^4.1.12 || ^5.0",
+        "symfony/monolog-bundle": "^3.0 || ^4.1.12 || ^5.0",
+        "symfony/routing": "^3.4.4 || ^4.1.12 || ^5.0",
+        "matthiasnoback/symfony-dependency-injection-test": "^4.0",
         "sebastian/exporter": "^2.0"
     },
     "suggest": {
@@ -71,7 +71,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.5.x-dev"
+            "dev-master": "2.x-dev"
         }
     }
 }

src/Command/InvalidatePathCommand.php

@@ -80,5 +80,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
             $this->getCacheManager()->invalidatePath($path);
         }
+
+        return 0;
     }
 }

src/Command/InvalidateRegexCommand.php

@@ -77,5 +77,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $regex = $input->getArgument('regex');
 
         $this->getCacheManager()->invalidateRegex($regex);
+
+        return 0;
     }
 }

src/Command/InvalidateTagCommand.php

@@ -72,5 +72,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $tags = $input->getArgument('tags');
 
         $this->getCacheManager()->invalidateTags($tags);
+
+        return 0;
     }
 }

src/Command/RefreshPathCommand.php

@@ -80,5 +80,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
             $this->getCacheManager()->refreshPath($path);
         }
+
+        return 0;
     }
 }

src/EventListener/CacheControlListener.php

@@ -16,8 +16,16 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
+use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\HttpKernel\KernelEvents;
 
+if (Kernel::MAJOR_VERSION >= 5) {
+    class_alias(ResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\CacheControlResponseEvent');
+} else {
+    class_alias(FilterResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\CacheControlResponseEvent');
+}
+
 /**
  * Set caching settings on matching response according to the configurations.
  *
@@ -95,10 +103,8 @@ public function setSkip($skip = true)
 
     /**
      * Apply the header rules if the request matches.
-     *
-     * @param FilterResponseEvent $event
      */
-    public function onKernelResponse(FilterResponseEvent $event)
+    public function onKernelResponse(CacheControlResponseEvent $event)
     {
         $request = $event->getRequest();
         $response = $event->getResponse();

src/EventListener/FlashMessageListener.php

@@ -16,10 +16,18 @@
 use Symfony\Component\HttpFoundation\ResponseHeaderBag;
 use Symfony\Component\HttpFoundation\Session\Session;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
 use Symfony\Component\HttpKernel\HttpKernel;
+use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+if (Kernel::MAJOR_VERSION >= 5) {
+    class_alias(ResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\FlashMessageResponseEvent');
+} else {
+    class_alias(FilterResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\FlashMessageResponseEvent');
+}
+
 /**
  * This event handler reads all flash messages and moves them into a cookie.
  *
@@ -66,10 +74,8 @@ public static function getSubscribedEvents()
 
     /**
      * Moves flash messages from the session to a cookie inside a Response Kernel listener.
-     *
-     * @param FilterResponseEvent $event
      */
-    public function onKernelResponse(FilterResponseEvent $event)
+    public function onKernelResponse(FlashMessageResponseEvent $event)
     {
         if (HttpKernel::MASTER_REQUEST !== $event->getRequestType()) {
             return;

src/EventListener/InvalidationListener.php

@@ -24,9 +24,17 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\PostResponseEvent;
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
+use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
+if (Kernel::MAJOR_VERSION >= 5) {
+    class_alias(TerminateEvent::class, 'FOS\HttpCacheBundle\EventListener\InvalidationTerminateEvent');
+} else {
+    class_alias(PostResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\InvalidationTerminateEvent');
+}
+
 /**
  * On kernel.terminate event, this event handler invalidates routes for the
  * current request and flushes the CacheManager.
@@ -88,10 +96,8 @@ public function __construct(
      *   their routes to the cache manager;
      * - flush the cache manager in order to send invalidation requests to the
      *   HTTP cache.
-     *
-     * @param PostResponseEvent $event
      */
-    public function onKernelTerminate(PostResponseEvent $event)
+    public function onKernelTerminate(InvalidationTerminateEvent $event)
     {
         $request = $event->getRequest();
         $response = $event->getResponse();

src/EventListener/SessionListener.php

@@ -15,7 +15,18 @@
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
 use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
 use Symfony\Component\HttpKernel\EventListener\SessionListener as BaseSessionListener;
+use Symfony\Component\HttpKernel\Kernel;
+
+if (Kernel::MAJOR_VERSION >= 5) {
+    class_alias(RequestEvent::class, 'FOS\HttpCacheBundle\EventListener\SessionRequestEvent');
+    class_alias(ResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\SessionResponseEvent');
+} else {
+    class_alias(GetResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\SessionRequestEvent');
+    class_alias(FilterResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\SessionResponseEvent');
+}
 
 /**
  * Decorates the default Symfony session listener.
@@ -60,12 +71,12 @@ public function __construct(BaseSessionListener $inner, string $userHashHeader,
         $this->userIdentifierHeaders = $userIdentifierHeaders;
     }
 
-    public function onKernelRequest(GetResponseEvent $event)
+    public function onKernelRequest(SessionRequestEvent $event)
     {
         return $this->inner->onKernelRequest($event);
     }
 
-    public function onKernelResponse(FilterResponseEvent $event)
+    public function onKernelResponse(SessionResponseEvent $event)
     {
         if (!$event->isMasterRequest()) {
             return;

src/EventListener/TagListener.php

@@ -19,9 +19,17 @@
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\HttpKernel\KernelEvents;
 
+if (Kernel::MAJOR_VERSION >= 5) {
+    class_alias(ResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\TagResponseEvent');
+} else {
+    class_alias(FilterResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\TagResponseEvent');
+}
+
 /**
  * Event handler for the cache tagging tags.
  *
@@ -81,10 +89,8 @@ public function __construct(
      *
      * - For a safe (GET or HEAD) request, the tags are set on the response.
      * - For a non-safe request, the tags will be invalidated.
-     *
-     * @param FilterResponseEvent $event
      */
-    public function onKernelResponse(FilterResponseEvent $event)
+    public function onKernelResponse(TagResponseEvent $event)
     {
         $request = $event->getRequest();
         $response = $event->getResponse();

src/EventListener/UserContextListener.php

@@ -20,12 +20,22 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
 use Symfony\Component\HttpKernel\EventListener\AbstractSessionListener;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+if (Kernel::MAJOR_VERSION >= 5) {
+    class_alias(RequestEvent::class, 'FOS\HttpCacheBundle\EventListener\UserContextRequestEvent');
+    class_alias(ResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\UserContextResponseEvent');
+} else {
+    class_alias(GetResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\UserContextRequestEvent');
+    class_alias(FilterResponseEvent::class, 'FOS\HttpCacheBundle\EventListener\UserContextResponseEvent');
+}
+
 /**
  * Check requests and responses with the matcher.
  *
@@ -119,10 +129,8 @@ public function __construct(
      * the generated hash.
      *
      * If the ttl is bigger than 0, cache headers will be set for this response.
-     *
-     * @param GetResponseEvent $event
      */
-    public function onKernelRequest(GetResponseEvent $event)
+    public function onKernelRequest(UserContextRequestEvent $event)
     {
         if (HttpKernelInterface::MASTER_REQUEST != $event->getRequestType()) {
             return;
@@ -185,10 +193,8 @@ private function isAnonymous(Request $request)
     /**
      * Add the context hash header to the headers to vary on if the header was
      * present in the request.
-     *
-     * @param FilterResponseEvent $event
      */
-    public function onKernelResponse(FilterResponseEvent $event)
+    public function onKernelResponse(UserContextResponseEvent $event)
     {
         if (HttpKernelInterface::MASTER_REQUEST != $event->getRequestType()) {
             return;

tests/Functional/Command/CommandTestCase.php

@@ -14,11 +14,16 @@
 use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Symfony\Bundle\FrameworkBundle\Client;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Symfony\Component\Console\Input\StringInput;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Output\StreamOutput;
 
+if (!\class_exists(KernelBrowser::class)) {
+    \class_alias(Client::class, KernelBrowser::class);
+}
+
 abstract class CommandTestCase extends WebTestCase
 {
     use MockeryPHPUnitIntegration;
@@ -28,13 +33,9 @@ abstract class CommandTestCase extends WebTestCase
      *
      * The verbosity is always verbose because Symfony looks at the definition in the environment variables.
      *
-     * @param Client $client
-     * @param string $command
-     * @param int    $exitCode Expected command exit code
-     *
-     * @return string
+     * @param int $exitCode Expected command exit code
      */
-    protected function runCommand(Client $client, $command, $exitCode = 0)
+    protected function runCommand(KernelBrowser $client, $command, $exitCode = 0): string
     {
         $application = new Application($client->getKernel());
         $application->setAutoExit(false);