Merge pull request #90 from UseMuffin/endpoint-locator

Make EndpointLocator implement LocatorInterface.

Author: ADmad

composer.json

@@ -39,10 +39,10 @@
         "irc": "irc://irc.freenode.org/muffin"
     },
     "require": {
-        "cakephp/orm": "^4.0"
+        "cakephp/orm": "^4.1@RC"
     },
     "require-dev": {
-        "cakephp/cakephp": "^4.0",
+        "cakephp/cakephp": "^4.0.1@RC",
         "cakephp/cakephp-codesniffer": "^4.0",
         "phpunit/phpunit": "~8.5.0"
     },

config/bootstrap.php

@@ -6,51 +6,28 @@
 use Cake\Core\App;
 use Cake\Datasource\ConnectionManager;
 use Cake\Datasource\Exception\MissingDatasourceConfigException;
+use Cake\Datasource\Locator\AbstractLocator;
+use Cake\Datasource\RepositoryInterface;
 use Cake\Utility\Inflector;
 use Muffin\Webservice\Datasource\Connection;
-use RuntimeException;
 
 /**
  * Class EndpointLocator
- *
- * Should implement the LocatorInterface
- *
- * @see \Cake\ORM\Locator\LocatorInterface
- * @see https://github.com/cakephp/cakephp/issues/12014
  */
-class EndpointLocator
+class EndpointLocator extends AbstractLocator
 {
-    /**
-     * Configuration for aliases.
-     *
-     * @var array
-     */
-    protected $_config = [];
-
-    /**
-     * Instances that belong to the locator.
-     *
-     * @var \Muffin\Webservice\Model\Endpoint[]
-     */
-    protected $_instances = [];
-
-    /**
-     * Contains a list of options that were passed to get() method.
-     *
-     * @var array
-     */
-    protected $_options = [];
-
     /**
      * Set an Endpoint instance to the locator.
      *
      * @param string $alias The alias to set.
      * @param \Muffin\Webservice\Model\Endpoint $object The table to set.
      * @return \Muffin\Webservice\Model\Endpoint
+     * @psalm-suppress MoreSpecificImplementedParamType
+     * @psalm-suppress MoreSpecificReturnType
      */
-    public function set(string $alias, Endpoint $object)
+    public function set(string $alias, RepositoryInterface $object): Endpoint
     {
-        return $this->_instances[$alias] = $object;
+        return $this->instances[$alias] = $object;
     }
 
     /**
@@ -63,17 +40,19 @@ public function set(string $alias, Endpoint $object)
      */
     public function get(string $alias, array $options = []): Endpoint
     {
-        if (isset($this->_instances[$alias])) {
-            if (!empty($options) && $this->_options[$alias] !== $options) {
-                throw new RuntimeException(sprintf(
-                    'You cannot configure "%s", it already exists in the locator.',
-                    $alias
-                ));
-            }
-
-            return $this->_instances[$alias];
-        }
+        /** @var \Muffin\Webservice\Model\Endpoint */
+        return parent::get($alias, $options);
+    }
 
+    /**
+     * Wrapper for creating endpoint instances
+     *
+     * @param string $alias Endpoint alias.
+     * @param array $options The alias to check for.
+     * @return \Muffin\Webservice\Model\Endpoint
+     */
+    protected function createInstance(string $alias, array $options)
+    {
         [, $classAlias] = pluginSplit($alias);
         $options = ['alias' => $classAlias] + $options;
 
@@ -107,10 +86,11 @@ public function get(string $alias, array $options = []): Endpoint
         }
 
         $options['registryAlias'] = $alias;
-        $this->_instances[$alias] = $this->_create($options);
-        $this->_options[$alias] = $options;
 
-        return $this->_instances[$alias];
+        /** @psalm-var class-string<\Muffin\Webservice\Model\Endpoint> $className */
+        $className = $options['className'];
+
+        return new $className($options);
     }
 
     /**
@@ -132,108 +112,4 @@ protected function getConnection(string $connectionName): Connection
             throw new MissingDatasourceConfigException($message, $e->getCode(), $e->getPrevious());
         }
     }
-
-    /**
-     * Check to see if an instance exists in the locator.
-     *
-     * @param string $alias The alias to check for.
-     * @return bool
-     */
-    public function exists(string $alias): bool
-    {
-        return isset($this->_instances[$alias]);
-    }
-
-    /**
-     * Returns configuration for an alias or the full configuration array for all aliases.
-     *
-     * @param string|null $alias Endpoint alias
-     * @return array
-     */
-    public function getConfig(?string $alias = null): array
-    {
-        if ($alias === null) {
-            return $this->_config;
-        }
-
-        return $this->_config[$alias] ?? [];
-    }
-
-    /**
-     * Stores a list of options to be used when instantiating an object with a matching alias.
-     *
-     * If configuring many aliases, use an array keyed by the alias.
-     *
-     * ```
-     * $locator->setConfig([
-     *     'Example' => ['registryAlias' => 'example'],
-     *     'Posts' => ['registryAlias' => 'posts'],
-     * ]);
-     * ```
-     *
-     * @param string|array $alias The alias to set configuration for, or an array of configuration keyed by alias
-     * @param null|array $config Array of configuration options
-     * @return $this
-     * @throws \RuntimeException
-     */
-    public function setConfig($alias, $config = null)
-    {
-        if (!is_string($alias)) {
-            $this->_config = $alias;
-
-            return $this;
-        }
-
-        if (isset($this->_instances[$alias])) {
-            throw new RuntimeException(sprintf(
-                'You cannot configure "%s", it has already been constructed.',
-                $alias
-            ));
-        }
-
-        $this->_config[$alias] = $config;
-
-        return $this;
-    }
-
-    /**
-     * Clear the endpoint locator of all instances
-     *
-     * @return void
-     */
-    public function clear(): void
-    {
-        $this->_instances = [];
-        $this->_options = [];
-        $this->_config = [];
-    }
-
-    /**
-     * Remove a specific endpoint instance from the locator by alias
-     *
-     * @param string $alias String alias of the endpoint
-     * @return void
-     */
-    public function remove($alias): void
-    {
-        unset(
-            $this->_instances[$alias],
-            $this->_options[$alias],
-            $this->_config[$alias]
-        );
-    }
-
-    /**
-     * Wrapper for creating endpoint instances
-     *
-     * @param array $options The alias to check for.
-     * @return \Muffin\Webservice\Model\Endpoint
-     */
-    protected function _create(array $options): Endpoint
-    {
-        /** @psalm-var class-string<\Muffin\Webservice\Model\Endpoint> $className */
-        $className = $options['className'];
-
-        return new $className($options);
-    }
 }

src/Model/EndpointLocator.php

@@ -4,6 +4,9 @@
 namespace Muffin\Webservice;
 
 use Cake\Core\BasePlugin;
+use Cake\Core\PluginApplicationInterface;
+use Cake\Datasource\FactoryLocator;
+use Muffin\Webservice\Model\EndpointLocator;
 
 class Plugin extends BasePlugin
 {
@@ -27,4 +30,12 @@ class Plugin extends BasePlugin
      * @var bool
      */
     protected $consoleEnabled = false;
+
+    /**
+     * @inheritDoc
+     */
+    public function bootstrap(PluginApplicationInterface $app): void
+    {
+        FactoryLocator::add('Endpoint', new EndpointLocator());
+    }
 }

src/Plugin.php

@@ -13,6 +13,11 @@
 
 class BootstrapTest extends TestCase
 {
+    public function setUp(): void
+    {
+        $this->loadPlugins(['Muffin/Webservice']);
+    }
+
     /**
      * Test that the plugins bootstrap is correctly registering the Endpoint
      * repository type with the factory locator
@@ -38,7 +43,6 @@ public function testFactoryLocatorAddition()
     {
         $result = FactoryLocator::get('Endpoint');
 
-        $this->assertInstanceOf(EndpointLocator::class, $result[0]);
-        $this->assertSame('get', $result[1]);
+        $this->assertInstanceOf(EndpointLocator::class, $result);
     }
 }

tests/TestCase/BootstrapTest.php

@@ -29,45 +29,6 @@ public function tearDown(): void
         unset($this->Locator);
     }
 
-    public function testConfig()
-    {
-        $this->assertSame([], $this->Locator->getConfig());
-
-        $configTest = ['foo' => 'bar'];
-        $this->Locator->setConfig('test', $configTest);
-        $this->assertSame($configTest, $this->Locator->getConfig('test'));
-
-        $configExample = ['example' => true];
-        $this->Locator->setConfig('example', $configExample);
-        $this->assertSame($configExample, $this->Locator->getConfig('example'));
-    }
-
-    public function testSetConfigForExistingObject()
-    {
-        $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('You cannot configure "Test", it has already been constructed.');
-
-        $this->Locator->get('Test', [
-            'registryAlias' => 'Test',
-            'connection' => 'test',
-        ]);
-
-        $this->Locator->setConfig('Test', ['foo' => 'bar']);
-    }
-
-    public function testSetConfigUsingAliasArray()
-    {
-        $multiAliasConfig = [
-            'Test' => ['foo' => 'bar'],
-            'Example' => ['foo' => 'bar'],
-        ];
-
-        $result = $this->Locator->setConfig($multiAliasConfig);
-        $this->assertInstanceOf(EndpointLocator::class, $result);
-
-        $this->assertSame($multiAliasConfig, $this->Locator->getConfig());
-    }
-
     public function testRemoveUsingExists()
     {
         /** @var \PHPUnit\Framework\MockObject\MockObject|\Muffin\Webservice\Model\Endpoint $first */
@@ -132,7 +93,7 @@ public function testGetException()
     public function testGetWithExistingObject()
     {
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('You cannot configure "First", it already exists in the locator.');
+        $this->expectExceptionMessage('You cannot configure "First", it already exists in the registry.');
 
         $result = $this->Locator->get('First', [
             'className' => Endpoint::class,

tests/TestCase/Model/EndpointLocatorTest.php

@@ -15,7 +15,6 @@
 
 use Cake\Cache\Cache;
 use Cake\Core\Configure;
-use Cake\Core\Plugin;
 use Cake\Datasource\ConnectionManager;
 use Cake\Log\Log;
 use Muffin\Webservice\Datasource\Connection;
@@ -104,6 +103,3 @@
         'file' => 'error',
     ],
 ]);
-
-Plugin::getCollection()->add(new \Muffin\Webservice\Plugin());
-require Plugin::getCollection()->get('Muffin/Webservice')->getConfigPath() . 'bootstrap.php';