feat: support for cycle/annotated v4.x

Author: lotyp

composer.json

@@ -17,7 +17,7 @@
     "require": {
         "php": "^8.2",
         "ext-pdo": "*",
-        "cycle/annotated": "^3.5",
+        "cycle/annotated": "^4.1",
         "cycle/database": "^2.8",
         "cycle/entity-behavior": "^1.3",
         "cycle/migrations": "^4.2",

composer.lock

@@ -50,8 +50,24 @@
          * Should class locator cache the results?
          */
         'cache' => [
-            'directory' => null,
-            'enabled' => false,
+            'enabled' => env('CYCLE_TOKENIZER_CACHE_TARGETS', true),
+            'directory' => storage_path('framework/cache/cycle/tokenizer'),
+        ],
+
+        /*
+         * What kind of classes should be loaded?
+         */
+        'load' => [
+            'classes' => env('CYCLE_TOKENIZER_LOAD_CLASSES', true),
+            'enums' => env('CYCLE_TOKENIZER_LOAD_ENUMS', false),
+            'interfaces' => env('CYCLE_TOKENIZER_LOAD_INTERFACES', false),
+        ],
+    ],
+
+    'attributes' => [
+        'cache' => [
+            'enabled' => env('CYCLE_ATTRIBUTES_CACHE', true),
+            'store' => env('CYCLE_ATTRIBUTES_CACHE_DRIVER', 'file'),
         ],
     ],
 
@@ -163,7 +179,7 @@
          */
         'cache' => [
             'enabled' => env('CYCLE_SCHEMA_CACHE', true),
-            'store' => env('CACHE_DRIVER', 'file'),
+            'store' => env('CYCLE_SCHEMA_CACHE_DRIVER', 'file'),
         ],
 
         /*

config/cycle.php

@@ -4,6 +4,7 @@
 
 namespace WayOfDev\Cycle\Bridge\Laravel\Providers;
 
+use Cycle\ORM\ORM as CycleORM;
 use Cycle\ORM\ORMInterface;
 use Illuminate\Contracts\Config\Repository as IlluminateConfig;
 use Illuminate\Support\ServiceProvider;
@@ -34,6 +35,7 @@ public function boot(): void
         $warmup = $config->get('cycle.warmup');
 
         if (true === $warmup) {
+            /** @var CycleORM $orm */
             $orm = $this->app->get(ORMInterface::class);
             $orm->prepareServices();
         }
@@ -51,7 +53,8 @@ public function register(): void
 
         $registrators = [
             Registrators\RegisterConfigs::class,
-            Registrators\RegisterClassesInterface::class,
+            Registrators\RegisterTokenizer::class,
+            Registrators\RegisterAttributes::class,
             Registrators\RegisterAnnotated::class,
             Registrators\RegisterDatabase::class,
             Registrators\RegisterSchema::class,

src/Bridge/Laravel/Providers/CycleServiceProvider.php

@@ -9,6 +9,7 @@ interface Registrator
     public const CFG_KEY = 'cycle';
     public const CFG_KEY_DATABASE = 'cycle.database';
     public const CFG_KEY_TOKENIZER = 'cycle.tokenizer';
+    public const CFG_KEY_ATTRIBUTES = 'cycle.attributes';
     public const CFG_KEY_MIGRATIONS = 'cycle.migrations';
     public const CFG_KEY_SCHEMA = 'cycle.schema';
     public const CFG_KEY_WARMUP = 'cycle.warmup';

src/Bridge/Laravel/Providers/Registrator.php

@@ -6,31 +6,40 @@
 
 use Cycle\Annotated;
 use Illuminate\Contracts\Foundation\Application;
-use Spiral\Attributes\Factory;
 use Spiral\Attributes\ReaderInterface;
 use Spiral\Tokenizer\ClassesInterface;
 
 /**
- * @see https://github.com/spiral/cycle-bridge/blob/2.0/src/Bootloader/AnnotatedBootloader.php
+ * @see https://github.com/spiral/cycle-bridge/blob/2.x/src/Bootloader/AnnotatedBootloader.php
  */
 final class RegisterAnnotated
 {
     public function __invoke(Application $app): void
     {
-        $app->bind(ReaderInterface::class, function () {
-            return (new Factory())->create();
+        $app->singleton(Annotated\Locator\EmbeddingLocatorInterface::class, function ($app) {
+            return new Annotated\Locator\TokenizerEmbeddingLocator(
+                $app->get(ClassesInterface::class),
+                $app->get(ReaderInterface::class)
+            );
+        });
+
+        $app->singleton(Annotated\Locator\EntityLocatorInterface::class, function ($app) {
+            return new Annotated\Locator\TokenizerEntityLocator(
+                $app->get(ClassesInterface::class),
+                $app->get(ReaderInterface::class)
+            );
         });
 
         $app->bind(Annotated\Embeddings::class, function ($app) {
             return new Annotated\Embeddings(
-                $app->get(ClassesInterface::class),
+                $app->get(Annotated\Locator\EmbeddingLocatorInterface::class),
                 $app->get(ReaderInterface::class)
             );
         });
 
         $app->bind(Annotated\Entities::class, function ($app) {
             return new Annotated\Entities(
-                $app->get(ClassesInterface::class),
+                $app->get(Annotated\Locator\EntityLocatorInterface::class),
                 $app->get(ReaderInterface::class)
             );
         });

src/Bridge/Laravel/Providers/Registrators/RegisterAnnotated.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WayOfDev\Cycle\Bridge\Laravel\Providers\Registrators;
+
+use Illuminate\Contracts\Cache\Factory as CacheFactory;
+use Illuminate\Contracts\Foundation\Application;
+use Spiral\Attributes\AttributeReader;
+use Spiral\Attributes\Internal\Instantiator\InstantiatorInterface;
+use Spiral\Attributes\Internal\Instantiator\NamedArgumentsInstantiator;
+use Spiral\Attributes\Psr16CachedReader;
+use Spiral\Attributes\ReaderInterface;
+
+/**
+ * @see https://github.com/spiral/framework/blob/master/src/Framework/Bootloader/Attributes/AttributesBootloader.php
+ */
+final class RegisterAttributes
+{
+    public function __invoke(Application $app): void
+    {
+        $app->singleton(InstantiatorInterface::class, function () {
+            return new NamedArgumentsInstantiator();
+        });
+
+        $app->singleton(ReaderInterface::class, function (Application $app): ReaderInterface {
+            $reader = new AttributeReader($app->get(InstantiatorInterface::class));
+
+            /** @var bool $cacheEnabled */
+            $cacheEnabled = config('cycle.attributes.cache.enabled', false);
+
+            if ($cacheEnabled) {
+                /** @var CacheFactory $cacheFactory */
+                $cacheFactory = $app->get(CacheFactory::class);
+                $cacheStore = config('cycle.attributes.cache.store', 'file');
+                $reader = new Psr16CachedReader($reader, $cacheFactory->store($cacheStore));
+            }
+
+            return $reader;
+        });
+    }
+}

src/Bridge/Laravel/Providers/Registrators/RegisterAttributes.php

@@ -17,7 +17,7 @@
 /**
  * @see https://github.com/spiral/tokenizer/blob/master/src/Bootloader/TokenizerBootloader.php
  */
-final class RegisterClassesInterface
+final class RegisterTokenizer
 {
     public function __invoke(Application $app): void
     {

src/Bridge/Laravel/Providers/Registrators/RegisterClassesInterface.php renamed to src/Bridge/Laravel/Providers/Registrators/RegisterTokenizer.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WayOfDev\Tests\Bridge\Laravel\Providers\Registrators;
+
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
+use Spiral\Attributes\AttributeReader;
+use Spiral\Attributes\Internal\Instantiator\InstantiatorInterface;
+use Spiral\Attributes\Psr16CachedReader;
+use Spiral\Attributes\ReaderInterface;
+use WayOfDev\Tests\TestCase;
+
+class RegisterAttributesTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_registers_instantiator_interface_as_singleton(): void
+    {
+        try {
+            $instantiator1 = $this->app->get(InstantiatorInterface::class);
+            $instantiator2 = $this->app->get(InstantiatorInterface::class);
+        } catch (NotFoundExceptionInterface|ContainerExceptionInterface $e) {
+            $this::fail($e->getMessage());
+        }
+
+        $this::assertInstanceOf(
+            InstantiatorInterface::class,
+            $instantiator1
+        );
+
+        $this::assertSame($instantiator1, $instantiator2);
+    }
+
+    /**
+     * @test
+     */
+    public function it_uses_cached_reader(): void
+    {
+        try {
+            $reader = $this->app->get(ReaderInterface::class);
+        } catch (NotFoundExceptionInterface|ContainerExceptionInterface $e) {
+            $this::fail($e->getMessage());
+        }
+
+        $this::assertInstanceOf(Psr16CachedReader::class, $reader);
+    }
+
+    /**
+     * @test
+     */
+    public function it_uses_attribute_reader_if_cache_disabled(): void
+    {
+        config()->set('cycle.attributes.cache.enabled', false);
+
+        try {
+            $reader = $this->app->get(ReaderInterface::class);
+        } catch (NotFoundExceptionInterface|ContainerExceptionInterface $e) {
+            $this::fail($e->getMessage());
+        }
+
+        $this::assertInstanceOf(AttributeReader::class, $reader);
+    }
+}

tests/src/Bridge/Laravel/Providers/Registrators/RegisterAttributesTest.php

@@ -13,7 +13,7 @@
 use Spiral\Tokenizer\Tokenizer;
 use WayOfDev\Tests\TestCase;
 
-class RegisterClassesInterfaceTest extends TestCase
+class RegisterTokenizerTest extends TestCase
 {
     /**
      * @test