remove annotation for 3.X release

FriendsOfSymfony · Dec 13, 2023 · 4f2887d · 4f2887d
1 parent 5391f80
commit 4f2887d
Show file tree

Hide file tree

Showing 22 changed files with 128 additions and 541 deletions.
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -21,6 +21,7 @@ jobs:
           - php-version: '7.4'
           - php-version: '8.0'
           - php-version: '8.1'
+          - php-version: '8.2'
             dependencies: 'jean-beru/fos-http-cache-cloudfront'
           - php-version: '7.4'
             symfony-version: '4.*'

diff --git a/composer.json b/composer.json
@@ -21,11 +21,11 @@
         }
     ],
     "require": {
-        "php": "^7.3 || ^8.0",
+        "php": "^8.2",
         "friendsofsymfony/http-cache": "^2.15",
-        "symfony/framework-bundle": "^4.4.0 || ^5.0 || ^6.0",
-        "symfony/http-foundation": "^4.4.0 || ^5.0 || ^6.0",
-        "symfony/http-kernel": "^4.4.0 || ^5.0 || ^6.0"
+        "symfony/framework-bundle": "^6.4 || ^7.0",
+        "symfony/http-foundation": "^6.4 || ^7.0",
+        "symfony/http-kernel": "^6.4 || ^7.0"
     },
     "require-dev": {
         "php-http/guzzle7-adapter": "^0.1.1",
@@ -35,20 +35,19 @@
         "guzzlehttp/guzzle": "^7.2",
         "mockery/mockery": "^1.3.2",
         "monolog/monolog": "*",
-        "sensio/framework-extra-bundle": "^4.0 || ^5.5.1 || ^6.0",
         "doctrine/annotations": "^1.11",
-        "symfony/browser-kit": "^4.4 || ^5.0 || ^6.0",
-        "symfony/console": "^4.4 || ^5.0 || ^6.0",
-        "symfony/finder": "^4.4 || ^5.0 || ^6.0",
+        "symfony/browser-kit": "^6.0 || ^7.0",
+        "symfony/console": "^6.0 || ^7.0",
+        "symfony/finder": "^6.0 || ^7.0",
         "symfony/phpunit-bridge": "v5.3.7",
-        "symfony/security-bundle": "^4.4 || ^5.0 || ^6.0",
-        "symfony/twig-bundle": "^4.4 || ^5.0 || ^6.0",
+        "symfony/security-bundle": "^6.0 || ^7.0",
+        "symfony/twig-bundle": "^6.0 || ^7.0",
         "twig/twig": "^2.13",
-        "symfony/yaml": "^4.4 || ^5.0 || ^6.0",
-        "symfony/css-selector": "^4.4 || ^5.0 || ^6.0",
-        "symfony/expression-language": "^4.4 || ^5.0 || ^6.0",
+        "symfony/yaml": "^6.0 || ^7.0",
+        "symfony/css-selector": "^6.0 || ^7.0",
+        "symfony/expression-language": "^6.0 || ^7.0",
         "symfony/monolog-bundle": "^3.0",
-        "symfony/routing": "^4.4 || ^5.0 || ^6.0",
+        "symfony/routing": "^6.0 || ^7.0",
         "matthiasnoback/symfony-dependency-injection-test": "^4.0",
         "sebastian/exporter": "^2.0"
     },
@@ -74,5 +73,10 @@
         "classmap": [
             "tests/Functional/Fixtures/app/AppKernel.php"
         ]
+    },
+    "config": {
+        "allow-plugins": {
+            "php-http/discovery": true
+        }
     }
 }
diff --git a/src/Configuration/ConfigurationInterface.php b/src/Configuration/ConfigurationInterface.php
@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCacheBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCacheBundle\Configuration;
+
+/**
+ * ConfigurationInterface.
+ *
+ * @author Fabien Potencier <[email protected]>
+ */
+interface ConfigurationInterface
+{
+    /**
+     * Returns the alias name for an annotated configuration.
+     *
+     * @return string
+     */
+    public function getAliasName();
+
+    /**
+     * Returns whether multiple annotations of this type are allowed.
+     *
+     * @return bool
+     */
+    public function allowArray();
+}
diff --git a/src/Configuration/InvalidatePath.php b/src/Configuration/InvalidatePath.php
@@ -11,13 +11,11 @@
 
 namespace FOS\HttpCacheBundle\Configuration;
 
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationAnnotation;
-
 /**
  * @Annotation
  */
 #[\Attribute(\Attribute::IS_REPEATABLE | \Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD)]
-class InvalidatePath extends ConfigurationAnnotation
+class InvalidatePath implements ConfigurationInterface
 {
     /**
      * @var array
@@ -34,7 +32,13 @@ public function __construct(
             $values = $data;
         }
 
-        parent::__construct($values);
+        foreach ($values as $k => $v) {
+            if (!method_exists($this, $name = 'set'.$k)) {
+                throw new \RuntimeException(sprintf('Unknown key "%s" for annotation "@%s".', $k, static::class));
+            }
+
+            $this->$name($v);
+        }
     }
 
     /**

diff --git a/src/Configuration/InvalidateRoute.php b/src/Configuration/InvalidateRoute.php
@@ -11,15 +11,14 @@
 
 namespace FOS\HttpCacheBundle\Configuration;
 
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationAnnotation;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 
 /**
  * @Annotation
  */
 #[\Attribute(\Attribute::IS_REPEATABLE | \Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD)]
-class InvalidateRoute extends ConfigurationAnnotation
+class InvalidateRoute implements ConfigurationInterface
 {
     /**
      * @var string
@@ -44,7 +43,13 @@ public function __construct(
 
         $values['params'] = $values['params'] ?? $params;
 
-        parent::__construct($values);
+        foreach ($values as $k => $v) {
+            if (!method_exists($this, $name = 'set'.$k)) {
+                throw new \RuntimeException(sprintf('Unknown key "%s" for annotation "@%s".', $k, static::class));
+            }
+
+            $this->$name($v);
+        }
     }
 
     /**

diff --git a/src/Configuration/Tag.php b/src/Configuration/Tag.php
@@ -12,15 +12,14 @@
 namespace FOS\HttpCacheBundle\Configuration;
 
 use FOS\HttpCacheBundle\Exception\InvalidTagException;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationAnnotation;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 
 /**
  * @Annotation
  */
 #[\Attribute(\Attribute::IS_REPEATABLE | \Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD)]
-class Tag extends ConfigurationAnnotation
+class Tag implements ConfigurationInterface
 {
     private $tags;
 
@@ -39,7 +38,13 @@ public function __construct(
 
         $values['expression'] = $values['expression'] ?? $expression;
 
-        parent::__construct($values);
+        foreach ($values as $k => $v) {
+            if (!method_exists($this, $name = 'set'.$k)) {
+                throw new \RuntimeException(sprintf('Unknown key "%s" for annotation "@%s".', $k, static::class));
+            }
+
+            $this->$name($v);
+        }
     }
 
     /**

diff --git a/src/DependencyInjection/Compiler/TagListenerPass.php b/src/DependencyInjection/Compiler/TagListenerPass.php
diff --git a/src/EventListener/InvalidationListener.php b/src/EventListener/InvalidationListener.php
@@ -211,6 +211,7 @@ private function invalidateRoutes(array $routes, Request $request)
         $values['request'] = $request;
 
         foreach ($routes as $route) {
+
             $params = [];
 
             if (null !== $route->getParams()) {
@@ -223,7 +224,6 @@ private function invalidateRoutes(array $routes, Request $request)
                     $params[$key] = $value;
                 }
             }
-
             $this->cacheManager->invalidateRoute($route->getName(), $params);
         }
     }

diff --git a/src/EventListener/Php8AttributesListener.php b/src/EventListener/Php8AttributesListener.php
@@ -2,7 +2,7 @@
 
 namespace FOS\HttpCacheBundle\EventListener;
 
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationInterface;
+use FOS\HttpCacheBundle\Configuration\ConfigurationInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;

diff --git a/src/FOSHttpCacheBundle.php b/src/FOSHttpCacheBundle.php
@@ -15,7 +15,6 @@
 use FOS\HttpCacheBundle\DependencyInjection\Compiler\HashGeneratorPass;
 use FOS\HttpCacheBundle\DependencyInjection\Compiler\LoggerPass;
 use FOS\HttpCacheBundle\DependencyInjection\Compiler\SessionListenerPass;
-use FOS\HttpCacheBundle\DependencyInjection\Compiler\TagListenerPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -27,7 +26,6 @@ class FOSHttpCacheBundle extends Bundle
     public function build(ContainerBuilder $container): void
     {
         $container->addCompilerPass(new LoggerPass());
-        $container->addCompilerPass(new TagListenerPass());
         $container->addCompilerPass(new HashGeneratorPass());
         $container->addCompilerPass(new SessionListenerPass());
 

diff --git a/src/Http/RequestMatcher/QuerystringRequestMatcher.php b/src/Http/RequestMatcher/QuerystringRequestMatcher.php
@@ -12,18 +12,23 @@
 namespace FOS\HttpCacheBundle\Http\RequestMatcher;
 
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\RequestMatcher as SymfonyRequestMatcher;
+use Symfony\Component\HttpFoundation\RequestMatcherInterface;
 
 /**
  * Extend the Symfony RequestMatcher class to support query string matching.
  */
-class QuerystringRequestMatcher extends SymfonyRequestMatcher
+class QuerystringRequestMatcher implements RequestMatcherInterface
 {
     /**
      * @var string Regular expression to match the query string part of the request url
      */
     private $queryString;
 
+    public function __construct($queryString = null)
+    {
+        $this->queryString = $queryString;
+    }
+
     /**
      * @param string $queryString
      */
@@ -37,10 +42,6 @@ public function setQueryString($queryString)
      */
     public function matches(Request $request): bool
     {
-        if (!parent::matches($request)) {
-            return false;
-        }
-
         if (null === $this->queryString) {
             return true;
         }

diff --git a/src/Http/ResponseMatcher/ExpressionResponseMatcher.php b/src/Http/ResponseMatcher/ExpressionResponseMatcher.php
@@ -11,7 +11,7 @@
 
 namespace FOS\HttpCacheBundle\Http\ResponseMatcher;
 
-use Sensio\Bundle\FrameworkExtraBundle\Security\ExpressionLanguage as SecurityExpressionLanguage;
+use FOS\HttpCacheBundle\Security\ExpressionLanguage as SecurityExpressionLanguage;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Symfony\Component\HttpFoundation\Response;
 

diff --git a/src/Security/ExpressionLanguage.php b/src/Security/ExpressionLanguage.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCacheBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCacheBundle\Security;
+
+use Symfony\Component\Security\Core\Authorization\ExpressionLanguage as BaseExpressionLanguage;
+
+/**
+ * Adds some function to the default Symfony Security ExpressionLanguage.
+ *
+ * @author Fabien Potencier <[email protected]>
+ */
+class ExpressionLanguage extends BaseExpressionLanguage
+{
+    protected function registerFunctions()
+    {
+        parent::registerFunctions();
+
+        $this->register('is_granted', function ($attributes, $object = 'null') {
+            return sprintf('$auth_checker->isGranted(%s, %s)', $attributes, $object);
+        }, function (array $variables, $attributes, $object = null) {
+            return $variables['auth_checker']->isGranted($attributes, $object);
+        });
+    }
+}