refactor #806 Move some namespaces on reflection (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 #805

Only ClassReflection needs a bc-layer cause the other classes have been introduced in 1.11.

Commits
-------

ffeaa37 Move some namespaces on reflection
b98ab44 Apply suggestions from code review
cea38d6 Remove an unnecessary empty line

psalm.xml

@@ -134,7 +134,7 @@
 
         <PossiblyFalseOperand>
             <errorLevel type="suppress">
-                <file name="src/Component/Reflection/ClassInfoTrait.php" />
+                <file name="src/Component/src/Reflection/ClassInfoTrait.php" />
             </errorLevel>
         </PossiblyFalseOperand>
 
@@ -192,6 +192,7 @@
                 <directory name="src/Component/Factory" />
                 <directory name="src/Component/Metadata" />
                 <directory name="src/Component/Generator" />
+                <directory name="src/Component/Reflection" />
                 <directory name="src/Component/Storage" />
                 <file name="src/Bundle/Event/ResourceControllerEvent.php" />
             </errorLevel>

src/Bundle/DependencyInjection/SyliusResourceExtension.php

@@ -21,12 +21,12 @@
 use Sylius\Bundle\ResourceBundle\Form\Type\DefaultResourceType;
 use Sylius\Bundle\ResourceBundle\SyliusResourceBundle;
 use Sylius\Component\Resource\Factory\FactoryInterface as LegacyFactoryInterface;
-use Sylius\Component\Resource\Reflection\ClassReflection;
 use Sylius\Resource\Factory\Factory;
 use Sylius\Resource\Factory\FactoryInterface;
 use Sylius\Resource\Metadata\AsResource;
 use Sylius\Resource\Metadata\Metadata;
 use Sylius\Resource\Metadata\ResourceMetadata;
+use Sylius\Resource\Reflection\ClassReflection;
 use Sylius\Resource\State\ProcessorInterface;
 use Sylius\Resource\State\ProviderInterface;
 use Sylius\Resource\State\ResponderInterface;

src/Bundle/Routing/CrudRoutesAttributesLoader.php

@@ -14,8 +14,8 @@
 namespace Sylius\Bundle\ResourceBundle\Routing;
 
 use Sylius\Component\Resource\Annotation\SyliusCrudRoutes as LegacySyliusCrudRoutes;
-use Sylius\Component\Resource\Reflection\ClassReflection;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
+use Sylius\Resource\Reflection\ClassReflection;
 use Symfony\Bundle\FrameworkBundle\Routing\RouteLoaderInterface;
 use Symfony\Component\Routing\RouteCollection;
 use Symfony\Component\Yaml\Yaml;

src/Bundle/Routing/RouteAttributesFactory.php

@@ -14,8 +14,8 @@
 namespace Sylius\Bundle\ResourceBundle\Routing;
 
 use Sylius\Component\Resource\Annotation\SyliusRoute as LegacySyliusRoute;
-use Sylius\Component\Resource\Reflection\ClassReflection;
 use Sylius\Resource\Annotation\SyliusRoute;
+use Sylius\Resource\Reflection\ClassReflection;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
 use Webmozart\Assert\Assert;

src/Bundle/Routing/RoutesAttributesLoader.php

@@ -13,7 +13,7 @@
 
 namespace Sylius\Bundle\ResourceBundle\Routing;
 
-use Sylius\Component\Resource\Reflection\ClassReflection;
+use Sylius\Resource\Reflection\ClassReflection;
 use Symfony\Bundle\FrameworkBundle\Routing\RouteLoaderInterface;
 use Symfony\Component\Routing\RouteCollection;
 

src/Component/Reflection/ClassReflection.php

@@ -13,58 +13,10 @@
 
 namespace Sylius\Component\Resource\Reflection;
 
-use Symfony\Component\Finder\Finder;
+class_exists(\Sylius\Resource\Reflection\ClassReflection::class);
 
-final class ClassReflection
-{
-    public static function getResourcesByPaths(array $paths): iterable
+if (false) {
+    final class ClassReflection extends \Sylius\Resource\Reflection\ClassReflection
     {
-        foreach ($paths as $resourceDirectory) {
-            $resources = self::getResourcesByPath($resourceDirectory);
-
-            foreach ($resources as $className) {
-                yield $className;
-            }
-        }
-    }
-
-    public static function getResourcesByPath(string $path): iterable
-    {
-        $finder = new Finder();
-        $finder->files()->in($path)->name('*.php')->sortByName(true);
-
-        foreach ($finder as $file) {
-            $fileContent = (string) file_get_contents((string) $file->getRealPath());
-
-            preg_match('/namespace (.+);/', $fileContent, $matches);
-
-            $namespace = $matches[1] ?? null;
-
-            if (!preg_match('/class +([^{ ]+)/', $fileContent, $matches)) {
-                // no class found
-                continue;
-            }
-
-            $className = trim($matches[1]);
-
-            if (null !== $namespace) {
-                yield $namespace . '\\' . $className;
-            } else {
-                yield $className;
-            }
-        }
-    }
-
-    /**
-     * @psalm-param class-string $className
-     *
-     * @return \ReflectionAttribute[]
-     */
-    public static function getClassAttributes(string $className, ?string $attributeName = null): array
-    {
-        $reflectionClass = new \ReflectionClass($className);
-
-        /** @psalm-suppress ArgumentTypeCoercion */
-        return $reflectionClass->getAttributes($attributeName);
     }
 }

src/Component/Tests/Reflection/ClassInfoTraitTest.php

@@ -15,7 +15,7 @@
 
 use App\Entity\Book;
 use PHPUnit\Framework\TestCase;
-use Sylius\Component\Resource\Reflection\ClassInfoTrait;
+use Sylius\Resource\Reflection\ClassInfoTrait;
 
 final class ClassInfoTraitTest extends TestCase
 {

src/Component/Tests/Reflection/ClassReflectionTest.php

@@ -17,12 +17,12 @@
 use App\Entity\Route\ShowBook;
 use App\Entity\Route\ShowBookWithPriority;
 use PHPUnit\Framework\TestCase;
-use Sylius\Component\Resource\Reflection\ClassReflection;
 use Sylius\Component\Resource\Tests\Dummy\DummyClassOne;
 use Sylius\Component\Resource\Tests\Dummy\DummyClassTwo;
 use Sylius\Component\Resource\Tests\Dummy\TraitPass;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
 use Sylius\Resource\Annotation\SyliusRoute;
+use Sylius\Resource\Reflection\ClassReflection;
 
 final class ClassReflectionTest extends TestCase
 {

src/Component/spec/Reflection/ClassReflectionSpec.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 spec\Sylius\Component\Resource\Reflection;
+
+use PhpSpec\ObjectBehavior;
+use Sylius\Resource\Reflection\ClassReflection as NewClassReflection;
+
+final class ClassReflectionSpec extends ObjectBehavior
+{
+    function it_is_an_alias_of_the_class_reflection(): void
+    {
+        $this->shouldBeAnInstanceOf(NewClassReflection::class);
+    }
+}

src/Component/src/Doctrine/Common/State/PersistProcessor.php

@@ -17,9 +17,9 @@
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Doctrine\Persistence\ManagerRegistry;
 use Doctrine\Persistence\ObjectManager as DoctrineObjectManager;
-use Sylius\Component\Resource\Reflection\ClassInfoTrait;
 use Sylius\Resource\Context\Context;
 use Sylius\Resource\Metadata\Operation;
+use Sylius\Resource\Reflection\ClassInfoTrait;
 use Sylius\Resource\State\ProcessorInterface;
 
 final class PersistProcessor implements ProcessorInterface

src/Component/src/Doctrine/Common/State/RemoveProcessor.php

@@ -15,9 +15,9 @@
 
 use Doctrine\Persistence\ManagerRegistry;
 use Doctrine\Persistence\ObjectManager as DoctrineObjectManager;
-use Sylius\Component\Resource\Reflection\ClassInfoTrait;
 use Sylius\Resource\Context\Context;
 use Sylius\Resource\Metadata\Operation;
+use Sylius\Resource\Reflection\ClassInfoTrait;
 use Sylius\Resource\State\ProcessorInterface;
 
 final class RemoveProcessor implements ProcessorInterface

src/Component/src/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactory.php

@@ -13,7 +13,6 @@
 
 namespace Sylius\Resource\Metadata\Resource\Factory;
 
-use Sylius\Component\Resource\Reflection\ClassReflection;
 use Sylius\Resource\Metadata\AsResource;
 use Sylius\Resource\Metadata\HttpOperation;
 use Sylius\Resource\Metadata\MetadataInterface;
@@ -22,6 +21,7 @@
 use Sylius\Resource\Metadata\RegistryInterface;
 use Sylius\Resource\Metadata\Resource\ResourceMetadataCollection;
 use Sylius\Resource\Metadata\ResourceMetadata;
+use Sylius\Resource\Reflection\ClassReflection;
 use Sylius\Resource\Symfony\Request\State\Responder;
 use Sylius\Resource\Symfony\Routing\Factory\OperationRouteNameFactory;
 

src/Component/Reflection/CallableReflection.php → src/Component/src/Reflection/CallableReflection.php

@@ -11,7 +11,7 @@
 
 declare(strict_types=1);
 
-namespace Sylius\Component\Resource\Reflection;
+namespace Sylius\Resource\Reflection;
 
 final class CallableReflection
 {

src/Component/Reflection/ClassInfoTrait.php → src/Component/src/Reflection/ClassInfoTrait.php

@@ -11,7 +11,7 @@
 
 declare(strict_types=1);
 
-namespace Sylius\Component\Resource\Reflection;
+namespace Sylius\Resource\Reflection;
 
 /**
  * Retrieves information about a class.

src/Component/src/Reflection/ClassReflection.php

@@ -0,0 +1,75 @@
+<?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\Reflection;
+
+use Symfony\Component\Finder\Finder;
+
+final class ClassReflection
+{
+    public static function getResourcesByPaths(array $paths): iterable
+    {
+        foreach ($paths as $resourceDirectory) {
+            $resources = self::getResourcesByPath($resourceDirectory);
+
+            foreach ($resources as $className) {
+                yield $className;
+            }
+        }
+    }
+
+    public static function getResourcesByPath(string $path): iterable
+    {
+        $finder = new Finder();
+        $finder->files()->in($path)->name('*.php')->sortByName(true);
+
+        foreach ($finder as $file) {
+            $fileContent = file_get_contents((string) $file->getRealPath());
+            if (false === $fileContent) {
+                throw new \RuntimeException(sprintf('Unable to read "%s" file', $file->getRealPath()));
+            }
+
+            preg_match('/namespace (.+);/', $fileContent, $matches);
+
+            $namespace = $matches[1] ?? null;
+
+            if (!preg_match('/class +([^{ ]+)/', $fileContent, $matches)) {
+                // no class found
+                continue;
+            }
+
+            $className = trim($matches[1]);
+
+            if (null !== $namespace) {
+                yield $namespace . '\\' . $className;
+            } else {
+                yield $className;
+            }
+        }
+    }
+
+    /**
+     * @psalm-param class-string $className
+     *
+     * @return \ReflectionAttribute[]
+     */
+    public static function getClassAttributes(string $className, ?string $attributeName = null): array
+    {
+        $reflectionClass = new \ReflectionClass($className);
+
+        /** @psalm-suppress ArgumentTypeCoercion */
+        return $reflectionClass->getAttributes($attributeName);
+    }
+}
+
+class_alias(ClassReflection::class, \Sylius\Component\Resource\Reflection\ClassReflection::class);

src/Component/Reflection/Filter/FunctionArgumentsFilter.php → src/Component/src/Reflection/Filter/FunctionArgumentsFilter.php

@@ -11,7 +11,7 @@
 
 declare(strict_types=1);
 
-namespace Sylius\Component\Resource\Reflection\Filter;
+namespace Sylius\Resource\Reflection\Filter;
 
 final class FunctionArgumentsFilter
 {

src/Component/src/Symfony/Request/RepositoryArgumentResolver.php

@@ -13,7 +13,7 @@
 
 namespace Sylius\Resource\Symfony\Request;
 
-use Sylius\Component\Resource\Reflection\Filter\FunctionArgumentsFilter;
+use Sylius\Resource\Reflection\Filter\FunctionArgumentsFilter;
 use Symfony\Component\HttpFoundation\Request;
 
 final class RepositoryArgumentResolver

src/Component/src/Symfony/Request/State/Provider.php

@@ -15,12 +15,12 @@
 
 use Pagerfanta\Pagerfanta;
 use Psr\Container\ContainerInterface;
-use Sylius\Component\Resource\Reflection\CallableReflection;
 use Sylius\Resource\Context\Context;
 use Sylius\Resource\Context\Option\RequestOption;
 use Sylius\Resource\Metadata\BulkOperationInterface;
 use Sylius\Resource\Metadata\CollectionOperationInterface;
 use Sylius\Resource\Metadata\Operation;
+use Sylius\Resource\Reflection\CallableReflection;
 use Sylius\Resource\State\ProviderInterface;
 use Sylius\Resource\Symfony\ExpressionLanguage\ArgumentParserInterface;
 use Sylius\Resource\Symfony\Request\RepositoryArgumentResolver;

src/Component/spec/Reflection/CallableReflectionSpec.php → src/Component/tests/spec/Reflection/CallableReflectionSpec.php

@@ -11,11 +11,11 @@
 
 declare(strict_types=1);
 
-namespace spec\Sylius\Component\Resource\Reflection;
+namespace spec\Sylius\Resource\Reflection;
 
 use PhpSpec\ObjectBehavior;
-use Sylius\Component\Resource\Reflection\CallableReflection;
 use Sylius\Component\Resource\Tests\Dummy\RepositoryWithCallables;
+use Sylius\Resource\Reflection\CallableReflection;
 
 class CallableReflectionSpec extends ObjectBehavior
 {

src/Component/spec/Reflection/Filter/FunctionArgumentsFilterSpec.php → src/Component/tests/spec/Reflection/Filter/FunctionArgumentsFilterSpec.php

@@ -11,12 +11,12 @@
 
 declare(strict_types=1);
 
-namespace spec\Sylius\Component\Resource\Reflection\Filter;
+namespace spec\Sylius\Resource\Reflection\Filter;
 
 use PhpSpec\ObjectBehavior;
-use Sylius\Component\Resource\Reflection\CallableReflection;
-use Sylius\Component\Resource\Reflection\Filter\FunctionArgumentsFilter;
 use Sylius\Component\Resource\Tests\Dummy\RepositoryWithCallables;
+use Sylius\Resource\Reflection\CallableReflection;
+use Sylius\Resource\Reflection\Filter\FunctionArgumentsFilter;
 
 final class FunctionArgumentsFilterSpec extends ObjectBehavior
 {

src/Component/tests/spec/Symfony/Request/RepositoryArgumentResolverSpec.php

@@ -14,8 +14,8 @@
 namespace spec\Sylius\Resource\Symfony\Request;
 
 use PhpSpec\ObjectBehavior;
-use Sylius\Component\Resource\Reflection\CallableReflection;
 use Sylius\Component\Resource\Tests\Dummy\RepositoryWithCallables;
+use Sylius\Resource\Reflection\CallableReflection;
 use Sylius\Resource\Symfony\Request\RepositoryArgumentResolver;
 use Symfony\Component\HttpFoundation\InputBag;
 use Symfony\Component\HttpFoundation\ParameterBag;