Renaming some index registry methods and introducing an interface

Author: loevgaard

src/Config/IndexRegistry.php

@@ -7,11 +7,9 @@
 use Setono\SyliusMeilisearchPlugin\Exception\NonExistingIndexException;
 
 /**
- * todo introduce interface
- *
  * @implements \IteratorAggregate<string, Index>
  */
-final class IndexRegistry implements \IteratorAggregate
+final class IndexRegistry implements \IteratorAggregate, IndexRegistryInterface
 {
     /**
      * An array of indexes, indexed by the name of the index
@@ -28,6 +26,7 @@ public function add(Index $index): void
         foreach ($this->indexes as $existingIndex) {
             foreach ($index->resources as $resource) {
                 if ($existingIndex->hasResource($resource)) {
+                    // todo why is this a problem?
                     throw new \InvalidArgumentException(sprintf(
                         'The resource "%s" is already defined on the index "%s"',
                         $resource->name,
@@ -43,7 +42,7 @@ public function add(Index $index): void
     /**
      * @throws NonExistingIndexException if no index exists with the given name
      */
-    public function getByName(string $name): Index
+    public function get(string $name): Index
     {
         if (!isset($this->indexes[$name])) {
             throw NonExistingIndexException::fromName($name, array_keys($this->indexes));
@@ -59,16 +58,13 @@ public function getByName(string $name): Index
      *
      * @throws \InvalidArgumentException if the given resource is not configured on any index
      */
-    public function getByResourceClass($class): Index
+    public function getByResource(object|string $class): Index
     {
         if (is_object($class)) {
-            $class = get_class($class);
+            $class = $class::class;
         }
 
         foreach ($this->indexes as $index) {
-            // todo the old if here was
-            // if (is_a($resource->resourceClass, $class, true) || is_a($class, $resource->resourceClass, true)) {
-            // what was the reason for that?
             if ($index->hasResourceWithClass($class)) {
                 return $index;
             }

src/Config/IndexRegistryInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Config;
+
+use Setono\SyliusMeilisearchPlugin\Exception\NonExistingIndexException;
+
+interface IndexRegistryInterface extends \Traversable
+{
+    /**
+     * @throws \InvalidArgumentException if one of the resources on the $index has already been configured on another index
+     */
+    public function add(Index $index): void;
+
+    /**
+     * @throws NonExistingIndexException if no index exists with the given name
+     */
+    public function get(string $name): Index;
+
+    /**
+     * This method returns the index where the $class is configured
+     *
+     * @param object|class-string $class
+     *
+     * @throws \InvalidArgumentException if the given resource is not configured on any index
+     */
+    public function getByResource(object|string $class): Index;
+}

src/Config/IndexableResource.php

@@ -48,10 +48,10 @@ public function __construct(string $name, string $class)
      *
      * @param object|class-string $class
      */
-    public function is($class): bool
+    public function is(object|string $class): bool
     {
         if (is_object($class)) {
-            $class = get_class($class);
+            $class = $class::class;
         }
 
         return is_a($this->class, $class, true);

src/Controller/Action/SearchAction.php

@@ -64,7 +64,7 @@ public function __invoke(string $slug): Response
         }
 
         try {
-            $indexableResource = $this->indexRegistry->getByResourceClass(ProductInterface::class);
+            $indexableResource = $this->indexRegistry->getByResource(ProductInterface::class);
         } catch (\InvalidArgumentException $e) {
             throw new NotFoundHttpException($e->getMessage(), $e);
         }

src/Exception/NonExistingIndexException.php

@@ -9,11 +9,11 @@ final class NonExistingIndexException extends \InvalidArgumentException
     /**
      * @param list<string>|null $availableIndexes
      */
-    public static function fromName(string $name, array $availableIndexes = null): self
+    public static function fromName(string $name, array $availableIndexes = []): self
     {
         $message = sprintf('No index exists with the name "%s".', $name);
 
-        if (null !== $availableIndexes && [] !== $availableIndexes) {
+        if ([] !== $availableIndexes) {
             $message .= sprintf(' Available indexes are: [%s]', implode(', ', $availableIndexes));
         }
 

src/Indexer/DefaultIndexer.php

@@ -90,7 +90,7 @@ public function __construct(
     public function index(Index|string $index): void
     {
         if (is_string($index)) {
-            $index = $this->indexRegistry->getByName($index);
+            $index = $this->indexRegistry->get($index);
         }
 
         foreach ($index->resources as $resource) {
@@ -101,7 +101,7 @@ public function index(Index|string $index): void
     public function indexResource(Index|string $index, string $resource): void
     {
         if (is_string($index)) {
-            $index = $this->indexRegistry->getByName($index);
+            $index = $this->indexRegistry->get($index);
         }
 
         $indexableResource = $index->getResource($resource);
@@ -117,7 +117,7 @@ public function indexEntitiesWithIds(array $ids, string $type): void
             return;
         }
 
-        $index = $this->indexRegistry->getByResourceClass($type);
+        $index = $this->indexRegistry->getByResource($type);
 
         foreach ($this->indexScopeProvider->getAll($index) as $indexScope) {
             $algoliaIndex = $this->prepareIndex(
@@ -144,7 +144,7 @@ public function removeEntitiesWithIds(array $ids, string $type): void
             return;
         }
 
-        $index = $this->indexRegistry->getByResourceClass($type);
+        $index = $this->indexRegistry->getByResource($type);
 
         foreach ($this->indexScopeProvider->getAll($index) as $indexScope) {
             $algoliaIndex = $this->prepareIndex(

src/Javascript/Autocomplete/SourcesResolver.php

@@ -34,7 +34,7 @@ public function getSources(): array
     {
         $sources = [];
         foreach ($this->searchIndexes as $searchIndex) {
-            $index = $this->indexRegistry->getByName($searchIndex);
+            $index = $this->indexRegistry->get($searchIndex);
             $sources[] = new Source($searchIndex, $this->indexNameResolver->resolve($index));
         }
 

src/Message/Handler/IndexEntitiesHandler.php

@@ -22,7 +22,7 @@ public function __invoke(IndexEntities $message): void
     {
         try {
             $this->indexRegistry
-                ->getByResourceClass($message->resource->class)
+                ->getByResource($message->resource->class)
                 ->indexer
                 ->indexEntitiesWithIds($message->ids, $message->resource->class)
             ;

src/Message/Handler/IndexEntityHandler.php

@@ -22,7 +22,7 @@ public function __invoke(IndexEntity $message): void
     {
         try {
             $this->indexRegistry
-                ->getByResourceClass($message->entityClass)
+                ->getByResource($message->entityClass)
                 ->indexer
                 ->indexEntityWithId($message->entityId, $message->entityClass)
             ;

src/Message/Handler/IndexHandler.php

@@ -21,7 +21,7 @@ public function __construct(IndexRegistry $indexRegistry)
     public function __invoke(Index $message): void
     {
         try {
-            $this->indexRegistry->getByName($message->index)->indexer->index($message->index);
+            $this->indexRegistry->get($message->index)->indexer->index($message->index);
         } catch (NonExistingIndexException $e) {
             throw new UnrecoverableMessageHandlingException($e->getMessage(), 0, $e);
         }