Merge #250

250: Start fixing PHPMD issues r=brunoocasali a=brunoocasali

Fix part of the phpmd issues (most of the simpler ones) like long variable names, too many lines in the same method, and useless else conditions.



Co-authored-by: Bruno Casali <brunoocasali@gmail.com>

Author: meili-bors[bot]

src/Collection.php

@@ -4,6 +4,12 @@
 
 namespace Meilisearch\Bundle;
 
+/**
+ * This class was extracted from illuminate.
+ * This will suppress all the PMD warnings in this class.
+ *
+ * @SuppressWarnings(PHPMD)
+ */
 final class Collection implements \ArrayAccess, \Countable, \IteratorAggregate
 {
     /**

src/Command/MeilisearchClearCommand.php

@@ -38,12 +38,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         foreach ($indexToClear as $index) {
             $indexName = $index['name'];
             $className = $index['class'];
+            $msg = "Cleared <info>$indexName</info> index of <comment>$className</comment>";
             $array = $this->searchService->clear($className);
+
             if ('failed' === $array['status']) {
-                $output->writeln('<error>Index <info>'.$indexName.'</info>  couldn\'t be cleared</error>');
-            } else {
-                $output->writeln('Cleared <info>'.$indexName.'</info> index of <comment>'.$className.'</comment>');
+                $msg = "<error>Index <info>$indexName</info>  couldn\'t be cleared</error>";
             }
+
+            $output->writeln($msg);
         }
 
         if (0 === count($indexToClear)) {

src/Command/MeilisearchCreateCommand.php

@@ -42,10 +42,8 @@ protected function configure(): void
             ->addOption('indices', 'i', InputOption::VALUE_OPTIONAL, 'Comma-separated list of index names');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output): int
+    private function entitiesToIndex($indexes)
     {
-        $indexes = $this->getEntitiesFromArgs($input, $output);
-
         foreach ($indexes as $key => $index) {
             $entityClassName = $index['class'];
             if (is_subclass_of($entityClassName, Aggregator::class)) {
@@ -61,7 +59,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         }
 
-        $entitiesToIndex = array_unique($indexes->all(), SORT_REGULAR);
+        return array_unique($indexes->all(), SORT_REGULAR);
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $indexes = $this->getEntitiesFromArgs($input, $output);
+        $entitiesToIndex = $this->entitiesToIndex($indexes);
 
         /** @var array $index */
         foreach ($entitiesToIndex as $index) {

src/Command/MeilisearchImportCommand.php

@@ -110,7 +110,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $repository = $manager->getRepository($entityClassName);
             $classMetadata = $manager->getClassMetadata($entityClassName);
             $entityIdentifiers = $classMetadata->getIdentifierFieldNames();
-            $sortByIdentifiersParam = array_combine($entityIdentifiers, array_fill(0, count($entityIdentifiers), 'ASC'));
+            $sortByAttrs = array_combine($entityIdentifiers, array_fill(0, count($entityIdentifiers), 'ASC'));
 
             $output->writeln('<info>Importing for index '.$entityClassName.'</info>');
 
@@ -129,7 +129,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             do {
                 $entities = $repository->findBy(
                     [],
-                    $sortByIdentifiersParam,
+                    $sortByAttrs,
                     $batchSize,
                     $batchSize * $page
                 );

src/DependencyInjection/MeilisearchExtension.php

@@ -38,19 +38,19 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->setParameter('meili_api_key', $config['api_key'] ?? null);
         $container->setParameter('meili_symfony_version', MeilisearchBundle::qualifiedVersion());
 
-        if (\count($doctrineSubscribedEvents = $config['doctrineSubscribedEvents']) > 0) {
-            $container->getDefinition('search.search_indexer_subscriber')->setArgument(1, $doctrineSubscribedEvents);
+        if (\count($doctrineEvents = $config['doctrineSubscribedEvents']) > 0) {
+            $container->getDefinition('search.search_indexer_subscriber')->setArgument(1, $doctrineEvents);
         } else {
             $container->removeDefinition('search.search_indexer_subscriber');
         }
 
         $engineDefinition = new Definition(Engine::class, [new Reference('search.client')]);
 
-        $searchServiceDefinition = (new Definition(
+        $searchDefinition = (new Definition(
             MeilisearchService::class,
             [new Reference($config['serializer']), $engineDefinition, $config]
         ));
 
-        $container->setDefinition('search.service', $searchServiceDefinition->setPublic(true));
+        $container->setDefinition('search.service', $searchDefinition->setPublic(true));
     }
 }

src/Services/MeilisearchService.php

@@ -30,7 +30,7 @@ final class MeilisearchService implements SearchService
     private array $searchableEntities;
     private array $entitiesAggregators;
     private array $aggregators;
-    private array $classToSerializerGroupMapping;
+    private array $classToSerializerGroup;
     private array $indexIfMapping;
 
     public function __construct(NormalizerInterface $normalizer, Engine $engine, array $configuration)
@@ -42,7 +42,7 @@ public function __construct(NormalizerInterface $normalizer, Engine $engine, arr
 
         $this->setSearchableEntities();
         $this->setAggregatorsAndEntitiesAggregators();
-        $this->setClassToSerializerGroupMapping();
+        $this->setClassToSerializerGroup();
         $this->setIndexIfMapping();
     }
 
@@ -84,26 +84,26 @@ public function index(ObjectManager $objectManager, $searchable): array
         $searchable = is_array($searchable) ? $searchable : [$searchable];
         $searchable = array_merge($searchable, $this->getAggregatorsFromEntities($objectManager, $searchable));
 
-        $searchableToBeIndexed = array_filter(
+        $dataToIndex = array_filter(
             $searchable,
             fn ($entity) => $this->isSearchable($entity)
         );
 
-        $searchableToBeRemoved = [];
-        foreach ($searchableToBeIndexed as $key => $entity) {
+        $dataToRemove = [];
+        foreach ($dataToIndex as $key => $entity) {
             if (!$this->shouldBeIndexed($entity)) {
-                unset($searchableToBeIndexed[$key]);
-                $searchableToBeRemoved[] = $entity;
+                unset($dataToIndex[$key]);
+                $dataToRemove[] = $entity;
             }
         }
 
-        if (count($searchableToBeRemoved) > 0) {
-            $this->remove($objectManager, $searchableToBeRemoved);
+        if (count($dataToRemove) > 0) {
+            $this->remove($objectManager, $dataToRemove);
         }
 
         return $this->makeSearchServiceResponseFrom(
             $objectManager,
-            $searchableToBeIndexed,
+            $dataToIndex,
             fn ($chunk) => $this->engine->index($chunk)
         );
     }
@@ -165,17 +165,17 @@ public function search(
                 throw new ObjectIdNotFoundException(sprintf('There is no "%s" key in the result.', self::RESULT_KEY_OBJECTID));
             }
 
+            $documentId = $hit[self::RESULT_KEY_OBJECTID];
+            $entityClass = $className;
+
             if (in_array($className, $this->aggregators, true)) {
                 $objectId = $hit[self::RESULT_KEY_OBJECTID];
                 $entityClass = $className::getEntityClassFromObjectId($objectId);
-                $id = $className::getEntityIdFromObjectId($objectId);
-            } else {
-                $id = $hit[self::RESULT_KEY_OBJECTID];
-                $entityClass = $className;
+                $documentId = $className::getEntityIdFromObjectId($objectId);
             }
 
             $repo = $objectManager->getRepository($entityClass);
-            $entity = $repo->find($id);
+            $entity = $repo->find($documentId);
 
             if (null !== $entity) {
                 $results[] = $entity;
@@ -251,15 +251,15 @@ private function setAggregatorsAndEntitiesAggregators(): void
         $this->aggregators = array_unique($this->aggregators);
     }
 
-    private function setClassToSerializerGroupMapping(): void
+    private function setClassToSerializerGroup(): void
     {
         $mapping = [];
 
         /** @var array $indexDetails */
         foreach ($this->configuration->get('indices') as $indexDetails) {
             $mapping[$indexDetails['class']] = $indexDetails['enable_serializer_groups'];
         }
-        $this->classToSerializerGroupMapping = $mapping;
+        $this->classToSerializerGroup = $mapping;
     }
 
     private function setIndexIfMapping(): void
@@ -332,7 +332,7 @@ private function makeSearchServiceResponseFrom(
 
     private function canUseSerializerGroup(string $className): bool
     {
-        return $this->classToSerializerGroupMapping[$className];
+        return $this->classToSerializerGroup[$className];
     }
 
     private function assertIsSearchable(string $className): void