refactor #805 Move some namespaces on generator (loic425)

This PR was merged into the 1.11 branch. Discussion ---------- | Q | A | --------------- | ----- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Related tickets | | License | MIT Based on #804 Commits ------- f906ded Move some namespaces on generator 11f8e43 Add a deprecation message d2cf42e Remove deprecation message, it fails 87db927 Fix deprecation message eec5022 Update src/Bundle/Resources/config/services.xml Co-authored-by: Dmitri Perunov <diimpp@gmail.com>
Sylius · Dec 9, 2023 · 4874194 · 4874194
2 parents 4875af4 + eec5022
commit 4874194
Show file tree

Hide file tree

Showing 9 changed files with 179 additions and 88 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -26,6 +26,7 @@ parameters:
         - %currentWorkingDirectory%/src/Component/Annotation/*
         - %currentWorkingDirectory%/src/Component/Factory/*
         - %currentWorkingDirectory%/src/Component/Metadata/*
+        - %currentWorkingDirectory%/src/Component/Generator/*
         - %currentWorkingDirectory%/src/Component/Reflection/ClassReflection.php
         - %currentWorkingDirectory%/src/Component/spec/*
         - %currentWorkingDirectory%/src/Component/Storage/*

diff --git a/psalm.xml b/psalm.xml
@@ -191,6 +191,7 @@
                 <directory name="src/Component/Annotation" />
                 <directory name="src/Component/Factory" />
                 <directory name="src/Component/Metadata" />
+                <directory name="src/Component/Generator" />
                 <directory name="src/Component/Storage" />
                 <file name="src/Bundle/Event/ResourceControllerEvent.php" />
             </errorLevel>
@@ -217,6 +218,7 @@
             <errorLevel type="suppress">
                 <directory name="src/Component/Factory" />
                 <directory name="src/Component/Metadata" />
+                <directory name="src/Component/Generator" />
                 <directory name="src/Component/Storage" />
             </errorLevel>
         </UnrecognizedStatement>

diff --git a/src/Bundle/Resources/config/services.xml b/src/Bundle/Resources/config/services.xml
@@ -36,8 +36,11 @@
     <services>
         <defaults public="true" />
 
-        <service id="sylius.random_generator" class="Sylius\Component\Resource\Generator\RandomnessGenerator" />
-        <service id="Sylius\Component\Resource\Generator\RandomnessGeneratorInterface" alias="sylius.random_generator" />
+        <service id="sylius.random_generator" class="Sylius\Resource\Generator\RandomnessGenerator" />
+        <service id="Sylius\Resource\Generator\RandomnessGeneratorInterface" alias="sylius.random_generator" />
+        <service id="Sylius\Component\Resource\Generator\RandomnessGeneratorInterface" alias="sylius.random_generator">
+            <deprecated package="sylius/resource-bundle" version="1.11">The "%alias_id%" service alias is deprecated since sylius/resource-bundle 1.11 and will be removed in sylius/resource-bundle 2.0. Use Sylius\Resource\Generator\RandomnessGeneratorInterface instead.</deprecated>
+        </service>
 
         <service id="sylius.form.type_extension.form.request_handler"
                  class="Sylius\Bundle\ResourceBundle\Form\Extension\HttpFoundation\HttpFoundationRequestHandler"

diff --git a/src/Component/Generator/RandomnessGenerator.php b/src/Component/Generator/RandomnessGenerator.php
@@ -13,54 +13,10 @@
 
 namespace Sylius\Component\Resource\Generator;
 
-use Webmozart\Assert\Assert;
+class_exists(\Sylius\Resource\Generator\RandomnessGenerator::class);
 
-final class RandomnessGenerator implements RandomnessGeneratorInterface
-{
-    private string $uriSafeAlphabet;
-
-    private string $digits;
-
-    public function __construct()
-    {
-        $this->digits = implode(range(0, 9));
-
-        $this->uriSafeAlphabet =
-            implode(range(0, 9))
-            . implode(range('a', 'z'))
-            . implode(range('A', 'Z'))
-            . implode(['-', '_', '~'])
-        ;
-    }
-
-    public function generateUriSafeString(int $length): string
+if (false) {
+    final class RandomnessGenerator extends \Sylius\Resource\Generator\RandomnessGenerator
     {
-        return $this->generateStringOfLength($length, $this->uriSafeAlphabet);
-    }
-
-    public function generateNumeric(int $length): string
-    {
-        return $this->generateStringOfLength($length, $this->digits);
-    }
-
-    public function generateInt(int $min, int $max): int
-    {
-        return random_int($min, $max);
-    }
-
-    private function generateStringOfLength(int $length, string $alphabet): string
-    {
-        $alphabetMaxIndex = strlen($alphabet) - 1;
-
-        Assert::greaterThanEq($alphabetMaxIndex, 1);
-
-        $randomString = '';
-
-        for ($i = 0; $i < $length; ++$i) {
-            $index = random_int(0, $alphabetMaxIndex);
-            $randomString .= $alphabet[$index];
-        }
-
-        return $randomString;
     }
 }
diff --git a/src/Component/Generator/RandomnessGeneratorInterface.php b/src/Component/Generator/RandomnessGeneratorInterface.php
@@ -13,11 +13,10 @@
 
 namespace Sylius\Component\Resource\Generator;
 
-interface RandomnessGeneratorInterface
-{
-    public function generateUriSafeString(int $length): string;
+interface_exists(\Sylius\Resource\Generator\RandomnessGeneratorInterface::class);
 
-    public function generateNumeric(int $length): string;
-
-    public function generateInt(int $min, int $max): int;
+if (false) {
+    interface RandomnessGeneratorInterface extends \Sylius\Resource\Generator\RandomnessGeneratorInterface
+    {
+    }
 }
diff --git a/src/Component/spec/Generator/RandomnessGeneratorSpec.php b/src/Component/spec/Generator/RandomnessGeneratorSpec.php
@@ -14,7 +14,9 @@
 namespace spec\Sylius\Component\Resource\Generator;
 
 use PhpSpec\ObjectBehavior;
-use Sylius\Component\Resource\Generator\RandomnessGeneratorInterface;
+use Sylius\Component\Resource\Generator\RandomnessGeneratorInterface as LegacyRandomnessGeneratorInterface;
+use Sylius\Resource\Generator\RandomnessGenerator as NewRandomnessGenerator;
+use Sylius\Resource\Generator\RandomnessGeneratorInterface;
 
 final class RandomnessGeneratorSpec extends ObjectBehavior
 {
@@ -23,41 +25,13 @@ function it_implements_randomness_generator_interface(): void
         $this->shouldImplement(RandomnessGeneratorInterface::class);
     }
 
-    function it_generates_random_uri_safe_string_of_length(): void
+    function it_implements_legacy_randomness_generator_interface(): void
     {
-        $length = 9;
-
-        $this->generateUriSafeString($length)->shouldBeString();
-        $this->generateUriSafeString($length)->shouldHaveLength($length);
-    }
-
-    function it_generates_random_numeric_string_of_length(): void
-    {
-        $length = 12;
-
-        $this->generateNumeric($length)->shouldBeString();
-        $this->generateNumeric($length)->shouldBeNumeric();
-        $this->generateNumeric($length)->shouldHaveLength($length);
-    }
-
-    function it_generates_random_int_in_range(): void
-    {
-        $min = 12;
-        $max = 2000000;
-
-        $this->generateInt($min, $max)->shouldBeInt();
-        $this->generateInt($min, $max)->shouldBeInRange($min, $max);
+        $this->shouldImplement(LegacyRandomnessGeneratorInterface::class);
     }
 
-    public function getMatchers(): array
+    function it_should_be_an_alias_of_randomness_generator(): void
     {
-        return [
-            'haveLength' => function ($subject, $length) {
-                return $length === strlen($subject);
-            },
-            'beInRange' => function ($subject, $min, $max) {
-                return $subject >= $min && $subject <= $max;
-            },
-        ];
+        $this->shouldBeAnInstanceOf(NewRandomnessGenerator::class);
     }
 }
diff --git a/src/Component/src/Generator/RandomnessGenerator.php b/src/Component/src/Generator/RandomnessGenerator.php
@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Resource\Generator;
+
+use Webmozart\Assert\Assert;
+
+final class RandomnessGenerator implements RandomnessGeneratorInterface
+{
+    private string $uriSafeAlphabet;
+
+    private string $digits;
+
+    public function __construct()
+    {
+        $this->digits = implode(range(0, 9));
+
+        $this->uriSafeAlphabet =
+            implode(range(0, 9))
+            . implode(range('a', 'z'))
+            . implode(range('A', 'Z'))
+            . implode(['-', '_', '~'])
+        ;
+    }
+
+    public function generateUriSafeString(int $length): string
+    {
+        return $this->generateStringOfLength($length, $this->uriSafeAlphabet);
+    }
+
+    public function generateNumeric(int $length): string
+    {
+        return $this->generateStringOfLength($length, $this->digits);
+    }
+
+    public function generateInt(int $min, int $max): int
+    {
+        return random_int($min, $max);
+    }
+
+    private function generateStringOfLength(int $length, string $alphabet): string
+    {
+        $alphabetMaxIndex = strlen($alphabet) - 1;
+
+        Assert::greaterThanEq($alphabetMaxIndex, 1);
+
+        $randomString = '';
+
+        for ($i = 0; $i < $length; ++$i) {
+            $index = random_int(0, $alphabetMaxIndex);
+            $randomString .= $alphabet[$index];
+        }
+
+        return $randomString;
+    }
+}
+
+class_alias(RandomnessGenerator::class, \Sylius\Component\Resource\Generator\RandomnessGenerator::class);
diff --git a/src/Component/src/Generator/RandomnessGeneratorInterface.php b/src/Component/src/Generator/RandomnessGeneratorInterface.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Resource\Generator;
+
+interface RandomnessGeneratorInterface
+{
+    public function generateUriSafeString(int $length): string;
+
+    public function generateNumeric(int $length): string;
+
+    public function generateInt(int $min, int $max): int;
+}
+
+class_alias(RandomnessGeneratorInterface::class, \Sylius\Component\Resource\Generator\RandomnessGeneratorInterface::class);
diff --git a/src/Component/tests/spec/Generator/RandomnessGeneratorSpec.php b/src/Component/tests/spec/Generator/RandomnessGeneratorSpec.php
@@ -0,0 +1,63 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace spec\Sylius\Resource\Generator;
+
+use PhpSpec\ObjectBehavior;
+use Sylius\Resource\Generator\RandomnessGeneratorInterface;
+
+final class RandomnessGeneratorSpec extends ObjectBehavior
+{
+    function it_implements_randomness_generator_interface(): void
+    {
+        $this->shouldImplement(RandomnessGeneratorInterface::class);
+    }
+
+    function it_generates_random_uri_safe_string_of_length(): void
+    {
+        $length = 9;
+
+        $this->generateUriSafeString($length)->shouldBeString();
+        $this->generateUriSafeString($length)->shouldHaveLength($length);
+    }
+
+    function it_generates_random_numeric_string_of_length(): void
+    {
+        $length = 12;
+
+        $this->generateNumeric($length)->shouldBeString();
+        $this->generateNumeric($length)->shouldBeNumeric();
+        $this->generateNumeric($length)->shouldHaveLength($length);
+    }
+
+    function it_generates_random_int_in_range(): void
+    {
+        $min = 12;
+        $max = 2000000;
+
+        $this->generateInt($min, $max)->shouldBeInt();
+        $this->generateInt($min, $max)->shouldBeInRange($min, $max);
+    }
+
+    public function getMatchers(): array
+    {
+        return [
+            'haveLength' => function ($subject, $length) {
+                return $length === strlen($subject);
+            },
+            'beInRange' => function ($subject, $min, $max) {
+                return $subject >= $min && $subject <= $max;
+            },
+        ];
+    }
+}