add option to index specific keys for a model (#19)

* add option to index specific keys for a model

* remove

* ignore vscode

.gitignore

@@ -10,3 +10,4 @@ node_modules
 .php-cs-fixer.cache
 pnpm-lock.yaml
 .phpunit.cache
+.vscode

database/migrations/2024_06_17_102630_create_search_terms_table.php

@@ -0,0 +1,33 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+ /**
+ * Run the migrations.
+ *
+ * @return void
+ */
+ public function up()
+ {
+ Schema::create('search_terms', function (Blueprint $table) {
+ $table->id();
+ $table->morphs('model');
+ $table->string('locale')->default('sv');
+ $table->string('path')->nullable();
+ $table->text('search_string')->nullable();
+ $table->timestamps();
+ });
+ }
+
+ /**
+ * Reverse the migrations.
+ */
+ public function down(): void
+ {
+ Schema::dropIfExists('search_terms');
+ }
+};

src/Concerns/HasPaths.php

@@ -86,10 +86,15 @@ public function getPathsAttribute(): Collection
  return;
  }
 
- return  $carry.'/'.$subItem->getSlugString($locale);
+ return $carry.'/'.$subItem->getSlugString($locale);
  }, '').'/'.$item->getSlugString($locale);
  })->unique();
- $slugGroups->push([$locale => $localizedSlugs]);
+
+ if (! $localizedSlugs->count()) {
+ $slugGroups->push([$locale => $this->slugs->where('locale', $locale)->pluck('slug')]);
+ } else {
+ $slugGroups->push([$locale => $localizedSlugs]);
+ }
  }
 
  return $slugGroups;
@@ -109,7 +114,7 @@ public function getLocalizedPathsAttribute(): Collection
  return;
  }
 
- return  $carry.'/'.$subItem->getSlugString();
+ return $carry.'/'.$subItem->getSlugString();
  }, '').'/'.$item->getSlugString();
  })->unique();
  $slugGroups->push($localizedSlugs);

src/EventServiceProvider.php

@@ -5,6 +5,7 @@
 use Ikoncept\Fabriq\Listeners\BustPageCacheListener;
 use Ikoncept\Fabriq\Listeners\CallCacheBustingWebhook;
 use Ikoncept\Fabriq\Listeners\FlushTagCacheListener;
+use Ikoncept\Fabriq\Listeners\UpdateSearchTerms;
 use Ikoncept\Fabriq\Listeners\UpdateSlugListener;
 use Illuminate\Auth\Events\Registered;
 use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
@@ -27,6 +28,7 @@ class EventServiceProvider extends ServiceProvider
  DefinitionsPublished::class => [
  BustPageCacheListener::class,
  CallCacheBustingWebhook::class,
+ UpdateSearchTerms::class,
  ],
  TranslatedRevisionDeleted::class => [
  FlushTagCacheListener::class,

src/Listeners/UpdateSearchTerms.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Ikoncept\Fabriq\Listeners;
+
+use Ikoncept\Fabriq\Models\SearchTerm;
+use Illuminate\Support\Collection;
+use Infab\TranslatableRevisions\Events\DefinitionsPublished;
+
+class UpdateSearchTerms
+{
+ /**
+ * Create the event listener.
+ *
+ * @return void
+ */
+ public function __construct()
+ {
+
+ }
+
+ /**
+ * Handle the event.
+ *
+ * @param object $event
+ * @return void
+ */
+ public function handle(DefinitionsPublished $event)
+ {
+ if (! $event->model->getRevisionOptions()->isIndexable) {
+ return;
+ }
+
+ $event->model->paths->each(function ($path) use ($event) {
+ $locale = collect($path)->keys()->first();
+
+ $indexableKeys = $this->array_value_recursive($event->definitions[$locale], $event->model->getRevisionOptions()->indexableKeys);
+
+ $data = [
+ 'model_id' => $event->model->id,
+ 'model_type' => get_class($event->model),
+ 'locale' => $locale,
+ 'path' => collect($path)->flatten()->first(),
+ 'search_string' => implode(' ', $indexableKeys),
+ ];
+
+ SearchTerm::updateOrCreate([
+ 'model_id' => $data['model_id'],
+ 'model_type' => $data['model_type'],
+ 'locale' => $data['locale'],
+ ], $data);
+ });
+ }
+
+ protected function array_value_recursive(Collection $collection, ?array $keys = null, bool $unique = true): array
+ {
+ $arr = $collection->toArray();
+ array_walk_recursive($arr, function ($v, $k) use ($keys, &$val) {
+ if (in_array($k, $keys)) {
+ $val[] = strip_tags($v);
+ }
+ });
+
+ return $unique ? array_unique($val ?? []) : $val ?? [];
+ }
+}

src/Models/Page.php

@@ -114,7 +114,8 @@ public function getRevisionOptions(): RevisionOptions
  'buttons' => 'getButtons',
  'smartBlock' => 'getSmartBlock',
  ])
- ->registerCacheTagsToFlush(['fabriq_menu', 'fabriq_pages|slug']);
+ ->registerCacheTagsToFlush(['fabriq_menu', 'fabriq_pages|slug'])
+ ->setIndexable(true, ['page_title', 'header']);
  }
 
  /**

src/Models/SearchTerm.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Ikoncept\Fabriq\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+class SearchTerm extends Model
+{
+ use HasFactory;
+
+ protected $guarded = [];
+}

tests/AdminUserTestCase.php

@@ -71,7 +71,7 @@ protected function getEnvironmentSetUp($app)
  'port' => env('DB_PORT', '3306'),
  'database' => 'fabriq_testing',
  'username' => 'root',
- 'password' => 'password',
+ 'password' => '',
  ]);
  $app['config']->set('filesystems.disks.__test', [
  'driver' => 'local',

tests/SearchTermsFeatureTest.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace Tests\Feature;
+
+use Ikoncept\Fabriq\Database\Seeders\DatabaseSeeder;
+use Ikoncept\Fabriq\Database\Seeders\PageTemplateSeeder;
+use Ikoncept\Fabriq\Tests\AdminUserTestCase;
+use Infab\TranslatableRevisions\Models\RevisionTemplate;
+
+class SearchTermsFeatureTest extends AdminUserTestCase
+{
+ public function setUp(): void
+ {
+ parent::setUp();
+
+ app(DatabaseSeeder::class)->call(PageTemplateSeeder::class);
+ }
+
+ public function test_it_can_include_content_for_a_single_page()
+ {
+ // Arrange
+ $page = \Ikoncept\Fabriq\Models\Page::factory()->create([
+ 'name' => 'En sida som ska publiceras',
+ 'template_id' => RevisionTemplate::all()->first()->id,
+ 'revision' => 1,
+ ]);
+
+ $page->updateContent([
+ 'page_title' => 'The page title for the page',
+ 'page_header' => 'The page title for the page',
+ 'page_content' => '<h1>Wow, a header</h1><p>Ok lets see</p>',
+ 'meta_title' => 'Meta title',
+ 'meta_description' => 'Describing the page',
+ 'meta_og_image' => 'https://placehold.it/40',
+ 'boxes' => [
+ ['header' => 'EN Box 1 title!', 'url' => 'https://google.com'],
+ ['header' => 'EN Box 2 title!', 'url' => 'https://bog.com'],
+ ['header' => 'EN Box 3 title!', 'url' => 'http://flank.se'],
+ ],
+ ], 'en');
+ $page->updateContent([
+ 'page_title' => 'En siee saom skau paublisers',
+ 'page_header' => 'En siee saom skau paublisers',
+ 'page_content' => '<h1>Wow</h1><p>Da ska vi se...</p>',
+ 'meta_title' => 'Meta titel',
+ 'meta_description' => 'En forklaring av sidan',
+ 'meta_og_image' => 'https://placehold.it/40',
+ 'boxes' => [
+ ['header' => 'DK fosta titeln!', 'url' => 'https://google.com'],
+ ['header' => 'DK andra titeln!', 'url' => 'https://bog.com'],
+ ],
+ ], 'dk');
+
+ // Act
+ $response = $this->json('POST', "/pages/{$page->id}/publish");
+
+ // Assert
+ $this->assertDatabaseHas('pages', [
+ 'id' => $page->id,
+ 'revision' => 2,
+ 'published_version' => 1,
+ ]);
+
+ $this->assertDatabaseHas('search_terms', [
+ 'model_id' => $page->id,
+ 'model_type' => config('fabriq.models.page'),
+ 'locale' => 'dk',
+ 'path' => 'en-siee-saom-skau-paublisers',
+ 'search_string' => 'DK fosta titeln! DK andra titeln! En siee saom skau paublisers',
+ ]);
+
+ $this->assertDatabaseHas('search_terms', [
+ 'model_id' => $page->id,
+ 'model_type' => config('fabriq.models.page'),
+ 'locale' => 'en',
+ 'path' => 'the-page-title-for-the-page',
+ 'search_string' => 'EN Box 1 title! EN Box 2 title! EN Box 3 title! The page title for the page',
+ ]);
+
+ $this->assertDatabaseCount('search_terms', 3);
+ }
+}