Merge pull request #394 from koriym/import-app-module

ImportAppModule

Author: koriym

composer.json

@@ -56,6 +56,9 @@
             ],
             "FakeVendor\\HelloWorld\\": [
                 "tests/Fake/fake-app/src/"
+            ],
+            "Import\\HelloWorld\\": [
+                "tests/Fake/import-app/src"
             ]
         },
         "files": [

phpstan.neon

@@ -3,7 +3,7 @@ parameters:
   paths:
     - src
     - tests
-  excludes_analyse:
+  excludePaths:
     - tests/hash.php
     - tests/tmp/*
     - tests/Fake/*

src/Compiler/FilePutContents.php

@@ -16,7 +16,7 @@ class FilePutContents
      *
      * @var ArrayObject<int, string>
      */
-    private ArrayObject $overwritten;
+    private ArrayObject $overwritten; // @phpstan-ignore-line
 
     /**
      * @param ArrayObject<int, string> $overwritten

src/Module/Import/ImportApp.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BEAR\Package\Module\Import;
+
+use ReflectionClass;
+
+use function assert;
+use function dirname;
+use function is_dir;
+use function sprintf;
+
+final class ImportApp
+{
+    public string $host;
+    public string $appName;
+    public string $context;
+    public string $appDir;
+
+    public function __construct(string $host, string $appName, string $context)
+    {
+        $this->host = $host;
+        $this->appName = $appName;
+        $this->context = $context;
+        /** @var class-string $appModuleClass */
+        $appModuleClass = sprintf('%s\\Module\\AppModule', $this->appName);
+        $appModuleClassName = (string) (new ReflectionClass($appModuleClass))->getFileName();
+        $appDir = dirname($appModuleClassName, 3);
+        assert(is_dir($appDir));
+        $this->appDir = $appDir;
+    }
+}

src/Module/ImportAppModule.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BEAR\Package\Module;
+
+use BEAR\Package\Module\Import\ImportApp;
+use BEAR\Resource\Annotation\ImportAppConfig;
+use BEAR\Resource\Module\SchemeCollectionProvider;
+use BEAR\Resource\SchemeCollectionInterface;
+use Ray\Di\AbstractModule;
+use Ray\Di\Exception\NotFound;
+
+final class ImportAppModule extends AbstractModule
+{
+    /**
+     * Import scheme config
+     *
+     * @var array<ImportApp>
+     */
+    private array $importApps = [];
+
+    /**
+     * @param array<ImportApp> $importApps
+     */
+    public function __construct(array $importApps)
+    {
+        foreach ($importApps as $importApp) {
+            // create import config
+            $this->importApps[] = $importApp;
+        }
+
+        parent::__construct();
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @throws NotFound
+     */
+    protected function configure(): void
+    {
+        $this->bind()->annotatedWith(ImportAppConfig::class)->toInstance($this->importApps);
+        $this->bind(SchemeCollectionInterface::class)->annotatedWith('original')->toProvider(SchemeCollectionProvider::class);
+        $this->bind(SchemeCollectionInterface::class)->toProvider(ImportSchemeCollectionProvider::class);
+    }
+}

src/Module/ImportSchemeCollectionProvider.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BEAR\Package\Module;
+
+use BEAR\Package\Injector;
+use BEAR\Package\Module\Import\ImportApp;
+use BEAR\Resource\AppAdapter;
+use BEAR\Resource\SchemeCollectionInterface;
+use Ray\Di\Di\Named;
+use Ray\Di\ProviderInterface;
+
+final class ImportSchemeCollectionProvider implements ProviderInterface
+{
+    /** @var ImportApp[] */
+    private array $importAppConfig;
+    private SchemeCollectionInterface $schemeCollection;
+
+    /**
+     * @param ImportApp[] $importAppConfig
+     *
+     * @Named("importAppConfig=BEAR\Resource\Annotation\ImportAppConfig,schemeCollection=original")
+     */
+    #[Named('importAppConfig=BEAR\Resource\Annotation\ImportAppConfig,schemeCollection=original')]
+    public function __construct(array $importAppConfig, SchemeCollectionInterface $schemeCollection)
+    {
+        $this->importAppConfig = $importAppConfig;
+        $this->schemeCollection = $schemeCollection;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get(): SchemeCollectionInterface
+    {
+        foreach ($this->importAppConfig as $app) {
+            $injector = Injector::getInstance($app->appName, $app->context, $app->appDir);
+            $adapter = new AppAdapter($injector, $app->appName);
+            $this->schemeCollection
+                ->scheme('page')->host($app->host)->toAdapter($adapter)
+                ->scheme('app')->host($app->host)->toAdapter($adapter);
+        }
+
+        return $this->schemeCollection;
+    }
+}

tests/Fake/fake-app/src/Resource/Page/Index.php

@@ -8,6 +8,8 @@
 
 class Index extends ResourceObject
 {
+    /** @var array{greeting: string} */
+    public $body;
     public function onGet($name = 'BEAR.Sunday')
     {
         $this->body = [

tests/Fake/import-app/src/Module/App.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Import\HelloWorld\Module;
+
+use BEAR\Sunday\Extension\Application\AppInterface;
+
+class App implements AppInterface
+{
+}

tests/Fake/import-app/src/Module/AppModule.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Import\HelloWorld\Module;
+
+use BEAR\Resource\Annotation\AppName;
+use BEAR\Sunday\Extension\Application\AppInterface;
+use BEAR\Sunday\Module\SundayModule;
+use Ray\Compiler\Annotation\Compile;
+use Ray\Di\AbstractModule;
+
+class AppModule extends AbstractModule
+{
+    protected function configure(): void
+    {
+        $this->bind(AppInterface::class)->to(App::class);
+        $this->bind()->annotatedWith(Compile::class)->toInstance(true);
+        $this->install(new SundayModule());
+    }
+}

tests/Fake/import-app/src/Resource/Page/Index.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Import\HelloWorld\Resource\Page;
+
+use BEAR\Resource\ResourceObject;
+
+class Index extends ResourceObject
+{
+    /** @var array{greeting: string} */
+    public $body;
+
+    /** @return static */
+    public function onGet(string $name = 'World'): ResourceObject
+    {
+        $this->body = [
+            'greeting' => 'Konichiwa ' . $name,
+        ];
+
+        return $this;
+    }
+}

tests/Module/ImportAppModuleTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BEAR\Package\Module;
+
+use BEAR\Package\Module\Import\ImportApp;
+use BEAR\Resource\Module\ResourceModule;
+use BEAR\Resource\ResourceInterface;
+use FakeVendor\HelloWorld\Resource\Page\Index;
+use Import\HelloWorld\Resource\Page\Index as ImportIndex;
+use PHPUnit\Framework\TestCase;
+use Ray\Di\Injector;
+
+use function assert;
+
+class ImportAppModuleTest extends TestCase
+{
+    public function testModule(): void
+    {
+        $module = new ResourceModule('FakeVendor\HelloWorld');
+        $module->override(new ImportAppModule([new ImportApp('foo', 'Import\HelloWorld', 'app')]));
+        $injector = new Injector($module);
+        $resource = $injector->getInstance(ResourceInterface::class);
+        assert($resource instanceof ResourceInterface);
+        $ro = $resource->get('page://self/index', ['name' => 'BEAR']);
+        assert($ro instanceof Index);
+        $this->assertSame('Hello BEAR', $ro->body['greeting']);
+        // import
+        $ro = $resource->get('page://foo/index', ['name' => 'Sunday']);
+        assert($ro instanceof ImportIndex);
+        $this->assertSame('Konichiwa Sunday', $ro->body['greeting']);
+    }
+}