feature #32446 [Lock] rename and deprecate Factory into LockFactory (Simperfit)

fabpot · fabpot · commit 4078686d3eeb · 2019-07-09T08:22:23.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Lock] rename and deprecate Factory into LockFactory | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | yes | Tests pass? | yes  | Fixed tickets | none  | License | MIT | Doc PR   As highlighted in #32198 (review) we need to rename the factory to LockFactory for consistency and readability. Commits ------- fc75eb9 [Lock] rename and deprecate Factory into LockFactory
diff --git a/src/Symfony/Component/Console/Command/LockableTrait.php b/src/Symfony/Component/Console/Command/LockableTrait.php
@@ -12,8 +12,8 @@
 namespace Symfony\Component\Console\Command;
 
 use Symfony\Component\Console\Exception\LogicException;
-use Symfony\Component\Lock\Factory;
 use Symfony\Component\Lock\Lock;
+use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Lock\Store\FlockStore;
 use Symfony\Component\Lock\Store\SemaphoreStore;
 
@@ -48,7 +48,7 @@ private function lock($name = null, $blocking = false)
             $store = new FlockStore();
         }
 
-        $this->lock = (new Factory($store))->createLock($name ?: $this->getName());
+        $this->lock = (new LockFactory($store))->createLock($name ?: $this->getName());
         if (!$this->lock->acquire($blocking)) {
             $this->lock = null;
 
diff --git a/src/Symfony/Component/Console/Tests/Command/LockableTraitTest.php b/src/Symfony/Component/Console/Tests/Command/LockableTraitTest.php
@@ -13,7 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Tester\CommandTester;
-use Symfony\Component\Lock\Factory;
+use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Lock\Store\FlockStore;
 use Symfony\Component\Lock\Store\SemaphoreStore;
 
@@ -47,7 +47,7 @@ public function testLockReturnsFalseIfAlreadyLockedByAnotherCommand()
             $store = new FlockStore();
         }
 
-        $lock = (new Factory($store))->createLock($command->getName());
+        $lock = (new LockFactory($store))->createLock($command->getName());
         $lock->acquire();
 
         $tester = new CommandTester($command);
diff --git a/src/Symfony/Component/Lock/Factory.php b/src/Symfony/Component/Lock/Factory.php
@@ -19,6 +19,8 @@
  * Factory provides method to create locks.
  *
  * @author Jérémy Derussé <jeremy@derusse.com>
+ *
+ * @deprecated "Symfony\Component\Lock\Factory" is deprecated since Symfony 4.4 and will be removed in 5.0 use "Symfony\Component\Lock\LockFactory" instead
  */
 class Factory implements LoggerAwareInterface
 {
diff --git a/src/Symfony/Component/Lock/LockFactory.php b/src/Symfony/Component/Lock/LockFactory.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Lock;
+
+/**
+ * Factory provides method to create locks.
+ *
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ * @author Hamza Amrouche <hamza.simperfit@gmail.com>
+ */
+class LockFactory extends Factory
+{
+}
diff --git a/src/Symfony/Component/Lock/Tests/LockFactoryTest.php b/src/Symfony/Component/Lock/Tests/LockFactoryTest.php
@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Lock\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Lock\LockFactory;
+use Symfony\Component\Lock\LockInterface;
+use Symfony\Component\Lock\StoreInterface;
+
+/**
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ */
+class LockFactoryTest extends TestCase
+{
+    public function testCreateLock()
+    {
+        $store = $this->getMockBuilder(StoreInterface::class)->getMock();
+        $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
+        $factory = new LockFactory($store);
+        $factory->setLogger($logger);
+
+        $lock = $factory->createLock('foo');
+
+        $this->assertInstanceOf(LockInterface::class, $lock);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`	`* Factory provides method to create locks.`
`20`	`20`	`*`
`21`	`21`	`* @author Jérémy Derussé <jeremy@derusse.com>`
	`22`	`+ *`
	`23`	`+ * @deprecated "Symfony\Component\Lock\Factory" is deprecated since Symfony 4.4 and will be removed in 5.0 use "Symfony\Component\Lock\LockFactory" instead`
`22`	`24`	`*/`
`23`	`25`	`class Factory implements LoggerAwareInterface`
`24`	`26`	`{`