Adjust from invalidateDomain to clearCache

Author: alexander-schranz

src/Command/ClearCommand.php

@@ -0,0 +1,69 @@
+<?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\Command;
+
+use FOS\HttpCacheBundle\CacheManager;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * A command to trigger cache invalidation by path from the command line.
+ *
+ * @author Alexander Schranz <[email protected]>
+ */
+class ClearCommand extends BaseInvalidateCommand
+{
+    use PathSanityCheck;
+
+    protected static $defaultName = 'fos:httpcache:invalidate';
+
+    /**
+     * If no cache manager is specified explicitly, fos_http_cache.cache_manager
+     * is automatically loaded.
+     *
+     * @param CacheManager|null $cacheManager The cache manager to talk to
+     */
+    public function __construct(CacheManager $cacheManager = null)
+    {
+        parent::__construct($cacheManager);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this
+            ->setName(static::$defaultName) // BC with 2.8
+            ->setDescription('Invalidate the whole http cache.')
+            ->setHelp(
+                <<<'EOF'
+The <info>%command.name%</info> command invalidates the whole cache in the configured caching proxies.
+
+Example:
+
+    <info>php %command.full_name%</info>
+EOF
+            )
+        ;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $this->getCacheManager()->clearCache();
+
+        return 0;
+    }
+}

src/Command/InvalidateDomainCommand.php

@@ -21,7 +21,7 @@
             <tag name="console.command"/>
         </service>
 
-        <service id="fos_http_cache.command.invalidate_domain" class="FOS\HttpCacheBundle\Command\InvalidateDomainCommand">
+        <service id="fos_http_cache.command.clear" class="FOS\HttpCacheBundle\Command\ClearCommand">
             <argument type="service" id="fos_http_cache.cache_manager" />
             <tag name="console.command"/>
         </service>

src/Resources/config/cache_manager_commands.xml

@@ -13,7 +13,7 @@
 
 use FOS\HttpCacheBundle\CacheManager;
 
-class InvalidateDomainCommandTest extends CommandTestCase
+class ClearCommandTest extends CommandTestCase
 {
     public function testExecuteVerbose()
     {
@@ -24,22 +24,17 @@ public function testExecuteVerbose()
             ->zeroOrMoreTimes()
             ->andReturnTrue()
         ;
-        $mock->shouldReceive('invalidateDomain')
+        $mock->shouldReceive('clearCache')
             ->once()
-            ->with('localhost')
-        ;
-        $mock->shouldReceive('invalidateDomain')
-            ->once()
-            ->with('example.localhost')
         ;
         $mock->shouldReceive('flush')
             ->once()
             ->andReturn(2)
         ;
         $client->getContainer()->set('fos_http_cache.cache_manager', $mock);
 
-        $output = $this->runCommand($client, 'fos:httpcache:invalidate:domain localhost example.localhost');
+        $output = $this->runCommand($client, 'fos:httpcache:clear');
 
-        $this->assertEquals("Sent 2 invalidation request(s)\n", $output);
+        $this->assertEquals("Sent 1 invalidation request(s)\n", $output);
     }
 }

tests/Functional/Command/InvalidateDomainCommandTest.php renamed to tests/Functional/Command/ClearCommandTest.php

@@ -12,13 +12,13 @@
 namespace FOS\HttpCacheBundle\Tests\Unit\Command;
 
 use FOS\HttpCacheBundle\CacheManager;
-use FOS\HttpCacheBundle\Command\InvalidateDomainCommand;
+use FOS\HttpCacheBundle\Command\ClearCommand;
 use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Tester\CommandTester;
 
-class InvalidateDomainCommandTest extends TestCase
+class ClearCommandTest extends TestCase
 {
     use MockeryPHPUnitIntegration;
 
@@ -30,29 +30,27 @@ public function testExecuteMissingParameters()
         $invalidator = \Mockery::mock(CacheManager::class);
 
         $application = new Application();
-        $application->add(new InvalidateDomainCommand($invalidator));
+        $application->add(new ClearCommand($invalidator));
 
-        $command = $application->find('fos:httpcache:invalidate:domain');
+        $command = $application->find('fos:httpcache:clear');
         $commandTester = new CommandTester($command);
         $commandTester->execute(['command' => $command->getName()]);
     }
 
     public function testExecuteParameter()
     {
         $invalidator = \Mockery::mock(CacheManager::class)
-            ->shouldReceive('invalidateDomain')->once()->with('localhost')
-            ->shouldReceive('invalidateDomain')->once()->with('example.localhost')
+            ->shouldReceive('clearCache')->once()
             ->getMock()
         ;
 
         $application = new Application();
-        $application->add(new InvalidateDomainCommand($invalidator));
+        $application->add(new ClearCommand($invalidator));
 
-        $command = $application->find('fos:httpcache:invalidate:domain');
+        $command = $application->find('fos:httpcache:clear');
         $commandTester = new CommandTester($command);
         $commandTester->execute([
             'command' => $command->getName(),
-            'domains' => ['localhost', 'example.localhost'],
         ]);
 
         // the only output should be generated by the listener in verbose mode