Merge pull request #9 from daun/develop

Release

.github/workflows/ci.yml

@@ -2,6 +2,8 @@ name: CI
 
 on:
   push:
+    branches:
+      - main
   pull_request:
 
 jobs:

composer.json

@@ -23,7 +23,7 @@
     "require": {
         "php": "^8.1",
         "statamic/cms": "^4.0 || ^5.0",
-        "loupe/loupe": "^0.8.0"
+        "loupe/loupe": "^0.9.0"
     },
     "require-dev": {
         "larastan/larastan": "^2.9",
@@ -68,8 +68,7 @@
         "format": "./vendor/bin/pint",
         "lint": "./vendor/bin/pint --test",
         "test": "./vendor/bin/pest",
-        "test:ci": "./vendor/bin/pest",
-        "test:ci:coverate": "./vendor/bin/pest --coverage-clover coverage.xml",
+        "test:ci": "./vendor/bin/pest --coverage-clover coverage.xml",
         "test:coverage": "./vendor/bin/pest --coverage"
     }
 }

src/Loupe/Factory.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Daun\StatamicLoupe\Loupe;
+
+use Loupe\Loupe\Configuration;
+use Loupe\Loupe\LoupeFactory;
+
+/**
+ * Wrapper around LoupeFactory to allow mocking the create() method
+ */
+class Factory
+{
+    public function __construct(protected LoupeFactory $factory) {}
+
+    public function create(string $path, Configuration $config)
+    {
+        return $this->factory->create($path, $config);
+    }
+}

src/Loupe/Index.php

@@ -3,6 +3,8 @@
 namespace Daun\StatamicLoupe\Loupe;
 
 use Daun\StatamicLoupe\Search\Snippets;
+use Exception;
+use Illuminate\Filesystem\Filesystem;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 use Loupe\Loupe\Config\TypoTolerance;
@@ -16,7 +18,9 @@
 
 class Index extends BaseIndex
 {
-    protected Loupe $client;
+    protected ?Loupe $client = null;
+
+    protected ?Configuration $configuration = null;
 
     protected array $defaults = [
         'fields' => ['title'],
@@ -37,19 +41,38 @@ class Index extends BaseIndex
     protected ?array $snippetAttributes = null;
 
     public function __construct(
-        protected Manager $manager,
+        protected Factory $factory,
+        protected Filesystem $filesystem,
         string $name,
-        array $config,
+        array $config = [],
         ?string $locale = null
     ) {
         $config = [...$this->defaults, ...$config];
         parent::__construct($name, $config, $locale);
+    }
+
+    public function base(): string
+    {
+        return Str::finish($this->config['path'] ?? storage_path('statamic/loupe'), '/');
+    }
 
-        $this->client = $this->manager->get($this->name, $this->configuration());
+    public function dir(): string
+    {
+        return $this->base().$this->name;
+    }
+
+    public function path(): string
+    {
+        return $this->base().$this->name.'/loupe.db';
     }
 
     public function client(): Loupe
     {
+        if (! $this->client) {
+            $this->createIndex();
+            $this->client = $this->factory->create($this->dir(), $this->configuration());
+        }
+
         return $this->client;
     }
 
@@ -71,7 +94,7 @@ public function lookup($query)
                 $this->config['highlight_tags'][1]
             );
 
-        $result = $this->client->search($parameters);
+        $result = $this->client()->search($parameters);
 
         return collect($result->getHits())
             ->map(fn ($hit) => [
@@ -81,11 +104,13 @@ public function lookup($query)
             ]);
     }
 
-    protected function configuration(): Configuration
+    public function configuration(): Configuration
     {
-        return Configuration::create()
+        return $this->configuration ??= Configuration::create()
             ->withPrimaryKey('id')
-            ->withSearchableAttributes(Arr::except($this->config['fields'], ['id']))
+            ->withSearchableAttributes(
+                collect($this->config['fields'])->keyBy(fn ($f) => $f)->except(['id'])->values()->all()
+            )
             ->withMaxQueryTokens($this->config['max_query_tokens'])
             ->withMinTokenLengthForPrefixSearch($this->config['min_token_length_for_prefix_search'])
             ->withLanguages($this->config['stemming_languages'])
@@ -100,22 +125,22 @@ protected function configuration(): Configuration
 
     public function delete($document)
     {
-        $this->client->deleteDocument($document->getSearchReference());
+        $this->client()->deleteDocument($document->getSearchReference());
     }
 
     public function exists()
     {
-        return $this->manager->indexExists($this->name);
+        return $this->filesystem->exists($this->path());
     }
 
     protected function insertDocuments(Documents $documents)
     {
         // After upgrading Loupe, a reindex might be required
-        if ($this->client->needsReindex()) {
-            $this->resetIndex();
+        if ($this->client()->needsReindex()) {
+            $this->truncateIndex();
         }
 
-        $this->client->addDocuments($documents->all());
+        $this->client()->addDocuments($documents->all());
     }
 
     public function insertMultiple($documents)
@@ -138,7 +163,7 @@ public function insertMultiple($documents)
 
     public function update()
     {
-        $this->resetIndex();
+        $this->truncateIndex();
 
         $this->searchables()->lazy()->each(fn ($searchables) => $this->insertMultiple($searchables));
 
@@ -147,18 +172,31 @@ public function update()
 
     protected function deleteIndex()
     {
-        $this->manager->dropIndex($this->name);
+        $this->filesystem->cleanDirectory($this->path());
     }
 
     protected function createIndex()
     {
-        $this->manager->createIndex($this->name);
+        $dir = $this->dir();
+        $db = $this->path();
+
+        if (! $this->filesystem->exists($db)) {
+            $this->filesystem->ensureDirectoryExists($dir);
+            $this->filesystem->put($db, '');
+        }
+
+        if (! $this->filesystem->isFile($db)) {
+            throw new Exception(sprintf('The Loupe index "%s" does not exist and cannot be created.', $db));
+        }
+
+        if (! $this->filesystem->isWritable($db)) {
+            throw new Exception(sprintf('The Loupe index "%s" is not writable.', $db));
+        }
     }
 
-    protected function resetIndex()
+    protected function truncateIndex()
     {
-        $this->deleteIndex();
-        $this->createIndex();
+        $this->client()->deleteAllDocuments();
     }
 
     public function extraAugmentedResultData(Result $result)
@@ -167,13 +205,19 @@ public function extraAugmentedResultData(Result $result)
 
         return [
             'search_score' => $raw['_rankingScore'] ?? null,
-            'search_highlights' => Arr::only($raw['_formatted'] ?? [], $this->config['highlight_attributes']),
-            'search_snippets' => $this->createSnippets($raw['_formatted'] ?? [], $this->config['snippet_attributes']),
+            'search_highlights' => $this->getHighlights($raw['_formatted'] ?? []),
+            'search_snippets' => $this->getSnippets($raw['_formatted'] ?? []),
         ];
     }
 
-    protected function createSnippets(array $highlights, array $attributes): array
+    protected function getHighlights(array $fields): array
+    {
+        return Arr::only($fields, $this->config['highlight_attributes'] ?? []);
+    }
+
+    protected function getSnippets(array $fields): array
     {
+        $attributes = $this->config['snippet_attributes'] ?? [];
         if (empty($attributes)) {
             return [];
         }
@@ -186,11 +230,11 @@ protected function createSnippets(array $highlights, array $attributes): array
         [$start, $end] = $this->config['highlight_tags'];
 
         return collect($this->snippetAttributes)
-            ->map(function ($words, $attr) use ($highlights, $start, $end) {
+            ->map(function ($words, $attr) use ($fields, $start, $end) {
                 try {
-                    return (new Snippets($start, $end, $words))->generate($highlights[$attr]);
+                    return (new Snippets($start, $end, $words))->generate($fields[$attr]);
                 } catch (\Exception $e) {
-                    return Str::limit($highlights[$attr], limit: 200, preserveWords: true);
+                    return Str::limit($fields[$attr], limit: 200, preserveWords: true);
                 }
             })
             ->all();

src/ServiceProvider.php

@@ -2,7 +2,6 @@
 
 namespace Daun\StatamicLoupe;
 
-use Daun\StatamicLoupe\Loupe\Manager;
 use Illuminate\Foundation\Application;
 use Statamic\Facades\Search;
 use Statamic\Providers\AddonServiceProvider;
@@ -13,9 +12,8 @@ public function bootAddon(): void
     {
         Search::extend('loupe', function (Application $app, array $config, string $name, ?string $locale = null) {
             return $app->makeWith(Loupe\Index::class, [
-                'manager' => new Manager($config['path'] ?? storage_path('statamic/loupe')),
-                'config' => $config,
                 'name' => $name,
+                'config' => $config,
                 'locale' => $locale,
             ]);
         });