Merge branch 'release/0.0.18'

- Adding loader for doctrine.yaml to bring in MATCH AGAINST function

.editorconfig

@@ -0,0 +1,14 @@
+# This is the top-most .editorconfig file; do not search in parent directories.
+root = true
+
+# All files.
+[*]
+end_of_line = LF
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[Makefile]
+indent_style = tab

.gitignore

@@ -1,2 +1,3 @@
 /vendor
 composer.lock
+.phpunit.result.cache

Containerfile

@@ -4,4 +4,4 @@ WORKDIR /code
 COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
 COPY ./ /code
 
-RUN composer install
+RUN composer install

Makefile

@@ -1,8 +1,16 @@
 PHP = docker compose run php
 
+.PHONY: composer_install composer_update static_analysis tests
 
 composer_install:
 	@$(PHP) composer install
 
+composer_update:
+	@$(PHP) composer update
+
 static_analysis:
-	@$(PHP) vendor/bin/psalm
+	@$(PHP) vendor/bin/psalm
+
+tests:
+	@$(PHP) rm -rf var/cache
+	@$(PHP) vendor/bin/phpunit

composer.json

@@ -9,11 +9,21 @@
         "doctrine/orm": "^2.12",
         "symfony/framework-bundle": "*"
     },
+    "require-dev": {
+        "vimeo/psalm": "^4.24",
+        "psalm/plugin-symfony": "^3.1",
+        "phpunit/phpunit": "^9.5"
+    },
     "autoload": {
         "psr-4": {
             "Pcm\\SearchBundle\\": "src/"
         }
-    },  
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Pcm\\SearchBundle\\": "tests/"
+        }
+    },
     "authors": [
         {
             "name": "Matt Feeny",
@@ -23,9 +33,5 @@
             "name": "Bradley Goode",
             "email": "bg@pcmsystems.co.uk"
         }
-    ],
-    "require-dev": {
-        "vimeo/psalm": "^4.24",
-        "psalm/plugin-symfony": "^3.1"
-    }
+    ]
 }

config/services.yaml

@@ -0,0 +1,25 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+
+    pcm_search.command.index:
+        class: Pcm\SearchBundle\Command\SearchIndexCommand
+        tags:
+            - { name: 'console.command', command: 'pcm:search:reindex' }
+
+    pcm_search.searchable_subscriber:
+        class: Pcm\SearchBundle\EventSubscriber\SearchableSubscriber
+        public: true
+        tags:
+            - { name: doctrine.event_subscriber }
+
+    pcm_search.search_service:
+        alias: Pcm\SearchBundle\Service\SearchService
+        public: true
+
+    Pcm\SearchBundle\Service\SearchService: ~
+
+    Pcm\SearchBundle\Repository\SearchIndexRepository:
+        autowire: true
+        tags: ['doctrine.repository_service']

phpunit.xml.dist

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="false" colors="true" bootstrap="./vendor/autoload.php">
+    <coverage>
+        <include>
+            <directory>./src</directory>
+        </include>
+    </coverage>
+    <php>
+        <ini name="error_reporting" value="-1"/>
+        <ini name="intl.default_locale" value="en"/>
+        <ini name="intl.error_level" value="0"/>
+        <ini name="memory_limit" value="-1"/>
+    </php>
+    <testsuites>
+        <testsuite name="Test suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/DependencyInjection/PcmSearchExtension.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pcm\SearchBundle\DependencyInjection;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+
+class PcmSearchExtension extends Extension implements PrependExtensionInterface
+{
+    public function prepend(ContainerBuilder $container)
+    {
+        $container->loadFromExtension(
+            'doctrine',
+            [
+                'orm' => [
+                    'dql' => [
+                        'string_functions' => [
+                            'match' => 'DoctrineExtensions\Query\Mysql\MatchAgainst'
+                        ]
+                    ]
+                ]
+            ]
+        );
+    }
+
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $loader = new YamlFileLoader(
+            $container,
+            new FileLocator(__DIR__.'/../../config')
+        );
+        $loader->load('services.yaml');
+    }
+}

src/PcmSearchBundle.php

@@ -3,7 +3,7 @@ namespace Pcm\SearchBundle;
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
-class SearchBundle extends Bundle
+class PcmSearchBundle extends Bundle
 {
     public function getPath(): string
     {

src/Repository/SearchIndexRepository.php

@@ -0,0 +1,124 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pcm\SearchBundle\Repository;
+
+use Pcm\SearchBundle\Entity\SearchIndex;
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Doctrine\ORM\Query;
+use Doctrine\Persistence\ManagerRegistry;
+
+class SearchIndexRepository extends ServiceEntityRepository
+{
+    /**
+     * @param ManagerRegistry $registry
+     */
+    public function __construct(ManagerRegistry $registry)
+    {
+        parent::__construct($registry, SearchIndex::class);
+    }
+
+    /**
+     * Saves a SearchIndex entity
+     *
+     * @param SearchIndex $entity
+     * @param boolean $flush
+     * @return void
+     */
+    public function add(SearchIndex $entity, bool $flush = false): void
+    {
+        $this->getEntityManager()->persist($entity);
+
+        if ($flush) {
+            $this->getEntityManager()->flush();
+        }
+    }
+
+    /**
+     * Removes a SearchIndex entity
+     *
+     * @param SearchIndex $entity
+     * @param boolean $flush
+     * @return void
+     */
+    public function remove(SearchIndex $entity, bool $flush = false): void
+    {
+        $this->getEntityManager()->remove($entity);
+
+        if ($flush) {
+            $this->getEntityManager()->flush();
+        }
+    }
+
+    /**
+     * Returns a Query object ready to be paginated or used to present results.
+     *
+     * @param string $query
+     * @param integer $minScore
+     * @return Query
+     */
+    public function findAllPagination(string $query, int $minScore = 0): Query
+    {
+        $qb = $this->createQueryBuilder('r')
+            ->addSelect('MATCH(r.data) AGAINST(:searchText boolean) AS score')
+            ->where(
+                sprintf(
+                    'MATCH(r.data) AGAINST(:searchText boolean) > %f',
+                    $minScore
+                )
+            )->orderBy('score', 'DESC')
+            ->setParameter(
+                'searchText',
+                $this->convertSearchTerm($query)
+            );
+        return $qb->getQuery();
+    }
+
+    /**
+     * Takes a string $query and explodes into individual words. Each word
+     * is then prefixed with + and ends with *, making the full text search
+     * operate as wildcard on all words
+     *
+     * @param string $query
+     * @return string
+     */
+    private function convertSearchTerm(string $query): string
+    {
+        $extractedWords = [];
+        $sanitisedString = preg_replace('/[^\w^\d]/', ' ', $query);
+        $words = mb_split('\s', preg_replace(['/([^\w+])/','/(\s+)/'], ' ', $sanitisedString));
+
+        foreach ($words as $word) {
+            if (strlen($word)< 1) {
+                //
+                continue;
+            }
+            $word = strtoupper($word);
+            $extractedWords[$word] = $word;
+        }
+
+        array_walk(
+            $extractedWords,
+            function(&$word) {
+                // require every word but allow matching just the start
+                $word = '+' . $word . '*';
+            }
+        );
+
+        return implode(' ', $extractedWords);
+    }
+
+    /**
+     * Clears the index table of all results
+     * @return void
+     */
+    public function clearIndex(): void
+    {
+        $this
+            ->createQueryBuilder('s')
+            ->delete()
+            ->getQuery()
+            ->execute();
+    }
+}

src/Service/SearchService.php

@@ -14,7 +14,14 @@ class SearchService
 {
     public function __construct(private EntityManagerInterface $em) {}
 
-    public function index($entity)
+    /**
+     * Given an $entity that implements SearchableInterface, this method
+     * creates or updates a SearchIndex $entity
+     *
+     * @param SearchableInterface $entity
+     * @return void
+     */
+    public function index(SearchableInterface $entity)
     {
         $searchIndex = $this->createSearchResult($entity);
 
@@ -22,7 +29,14 @@ class SearchService
         $this->em->flush();
     }
 
-    public function unIndex($entity)
+    /**
+     * Given an $entity that implements SearchableInterface, this method removes
+     * the item from the search index
+     *
+     * @param SearchableInterface $entity
+     * @return void
+     */
+    public function unIndex(SearchableInterface $entity)
     {
         $class = get_class($entity);
 
@@ -37,6 +51,14 @@ class SearchService
         }
     }
 
+    /**
+     * Given an entity that implements SearchableInterface, this method first checks
+     * if the relevant SearchIndex entity exists. If it doesn't, it's created. The
+     * title and index data are set based on the methods in the $entity
+     *
+     * @param SearchableInterface $entity
+     * @return SearchIndex
+     */
     public function createSearchResult(SearchableInterface $entity): SearchIndex
     {
         $values = [];
@@ -76,7 +98,8 @@ class SearchService
     }
 
     /**
-     * Finds all searchable Doctrine entities.
+     * Finds all searchable Doctrine entities the implement SearchableInterface
+     * @return array
      */
     public function getSearchableClasses(): array
     {