добавление функционала по поиску

laravelsu · Mar 19, 2024 · c94d00d · c94d00d
1 parent ba29924
commit c94d00d
Show file tree

Hide file tree

Showing 13 changed files with 194 additions and 21 deletions.
diff --git a/.env.example b/.env.example
@@ -71,3 +71,5 @@ QUIZ_STATUS=false
 TELEGRAM_BOT_TOKEN=
 TELEGRAM_CHAT_ID=
 TELEGRAM_CHANNEL_ID=
+
+SCOUT_DRIVER=
diff --git a/app/Docs.php b/app/Docs.php
@@ -361,20 +361,25 @@ public function update()
     /**
      * Разбивает markdown файл на разделы по заголовкам.
      *
-     * @return Массив разделов с заголовками и содержимым
+     * @return Collection разделов с заголовками и содержимым
      */
-    public function getSections()
+    public function getSections(): Collection
     {
+
         // Разбиваем HTML содержимое на разделы по заголовкам
         preg_match_all('/<h(\d)>(.+)<\/h\d>(.*)/sU', $this->content(), $matches, PREG_SET_ORDER);
 
         // Массив для хранения разделов
         $sections = collect();
         $prevEnd = 0;
 
+        $titlePage = null;
         foreach ($matches as $index => $match) {
             $sectionTitle = $match[2];
 
+            if ($match[1] == '1') {
+                $titlePage = $sectionTitle;
+            }
             // Получаем начальную и конечную позицию текущего заголовка в тексте
             $startPos = strpos($this->content(), $match[0], $prevEnd);
 
@@ -388,12 +393,13 @@ public function getSections()
             }
 
             $sections->push([
-                'title'   => $sectionTitle,
-                'slug'    => Str::of($sectionTitle)->slug()->toString(),
-                'content' => $sectionContent,
-                'file'    => $this->file,
-                'version' => $this->version,
-                'id'      => Str::uuid(),
+                'title_page' => $titlePage,
+                'title'     => $sectionTitle,
+                'slug'      => Str::of($sectionTitle)->slug()->toString(),
+                'content'   => $sectionContent,
+                'file'      => $this->file,
+                'version'   => $this->version,
+                'id'        => Str::uuid(),
             ]);
         }
 
@@ -402,7 +408,7 @@ public function getSections()
 
     public function updateSections()
     {
-        // DocumentationSection::where('file', $this->file)->where('version', $this->version)->delete();
-        // DocumentationSection::insert($this->getSections()->toArray());
+        DocumentationSection::where('file', $this->file)->where('version', $this->version)->delete();
+        DocumentationSection::insert($this->getSections()->toArray());
     }
 }
diff --git a/app/Http/Controllers/DocsController.php b/app/Http/Controllers/DocsController.php
@@ -4,6 +4,8 @@
 
 use App\Docs;
 use App\Models\Document;
+use App\Models\DocumentationSection;
+use Illuminate\Http\Request;
 
 class DocsController extends Controller
 {
@@ -58,4 +60,19 @@ public function status(string $version = Docs::DEFAULT_VERSION)
             'documents' => $documents,
         ]);
     }
+
+    public function search(string $versionOfDocs, Request $request)
+    {
+
+        if (empty($request->text)) {
+            return turbo_stream()->replace('found_candidates', view('docs._search_lines', [
+                'searchOffer' => [],
+            ]));
+        }
+        $searchOffers = DocumentationSection::search($request->text)->where('version', $versionOfDocs)->get();
+
+        return turbo_stream()->replace('found_candidates', view('docs._search_lines', [
+            'searchOffer' => $searchOffers,
+        ]));
+    }
 }
diff --git a/app/Models/DocumentationSection.php b/app/Models/DocumentationSection.php
@@ -0,0 +1,59 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Concerns\HasUuids;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Str;
+use Laravel\Scout\Searchable;
+
+class DocumentationSection extends Model
+{
+    use HasFactory;
+    use HasUuids;
+    use Searchable;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'id',
+        'title',
+        'slug',
+        'version',
+        'file',
+        'content',
+    ];
+
+    protected function shortContent(): Attribute
+    {
+
+        return Attribute::make(
+            get: fn (mixed $value, array $attributes) =>
+
+            Str::limit(
+                nl2br(strip_tags($attributes['content'])),
+                90
+            ),
+        );
+    }
+
+    protected function fileForUrl(): Attribute
+    {
+        return Attribute::make(
+            get: fn (mixed $value, array $attributes) => str_replace('.md', '', $attributes['file']),
+        );
+    }
+
+    public function toSearchableArray()
+    {
+        return [
+            'title'   => $this->title,
+            'content' => $this->content,
+        ];
+    }
+}
diff --git a/composer.json b/composer.json
@@ -29,7 +29,7 @@
         "laravel-notification-channels/webpush": "^7.1",
         "laravel/framework": "^10.31",
         "laravel/sanctum": "^3.2",
-        "laravel/scout": "^10.5",
+        "laravel/scout": "^10.8",
         "laravel/socialite": "^5.9",
         "laravel/telescope": "^4.17",
         "laravel/tinker": "^2.8",

diff --git a/composer.lock b/composer.lock
diff --git a/database/migrations/2024_03_17_133145_create_documentation_sections_table.php b/database/migrations/2024_03_17_133145_create_documentation_sections_table.php
@@ -0,0 +1,34 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Support\Str;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('documentation_sections', function (Blueprint $table) {
+            $table->uuid('id')->primary();
+            $table->string('title_page')->comment('Заголовок всей страницы');
+            $table->string('title');
+            $table->string('slug');
+            $table->string('version');
+            $table->string('file');
+            $table->text('content');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('documentation_sections');
+    }
+};
diff --git a/package-lock.json b/package-lock.json
diff --git a/public/build/manifest.json b/public/build/manifest.json
@@ -17,7 +17,7 @@
     "isEntry": true
   },
   "resources/js/app.js": {
-    "file": "assets/app-BUWIDZ8f.js",
+    "file": "assets/app-CnjHucs5.js",
     "src": "resources/js/app.js",
     "isEntry": true,
     "css": [

diff --git a/resources/js/controllers/search-docs_controller.js b/resources/js/controllers/search-docs_controller.js
@@ -0,0 +1,14 @@
+import { Controller } from '@hotwired/stimulus';
+
+export default class extends Controller {
+    static targets = [ "text", "spinner"]
+    /**
+     * Port for laravel.com
+     */
+    connect() {}
+    search(event) {
+        this.spinnerTarget.classList.remove('d-none');
+        event.target.form.requestSubmit();
+        setTimeout(() =>  this.spinnerTarget.classList.add('d-none'), 500)
+    }
+}
diff --git a/resources/views/docs/_search_lines.blade.php b/resources/views/docs/_search_lines.blade.php
@@ -0,0 +1,17 @@
+<ul class="list-group" id="found_candidates">
+    @foreach($searchOffer as $offer)
+{{--        <li class="list-group-item fs-6 text fw-bold" style="font-size: 14px !important;">{{ $offer->title_page }}</li>--}}
+
+                <a href="{{ route('docs', ['version' => $offer->version, 'page' => "{$offer->file_for_url}#{$offer->slug}" ]) }}" class="list-group-item list-group-item-action" aria-current="true">
+                        <div class="d-flex w-100 justify-content-between">
+                                <p class="mb-1 fw-bold font-monospace">{{ $offer->title_page }}</p>
+{{--                                <small>3 days ago</small>--}}
+                        </div>
+{{--                        @dd(Str::of($offer->content)->limit(20)->__toString())--}}
+                        <p class="mb-1">{{ $offer->title }}</p>
+                        <small>{!! $offer->short_content !!}</small>
+
+                </a>
+    @endforeach
+</ul>
+
diff --git a/resources/views/docs/docs.blade.php b/resources/views/docs/docs.blade.php
@@ -7,12 +7,32 @@
         <div class="row gap-2 justify-content-center align-items-start position-relative mb-5">
             <div class="col-3 col-xl-2 order-md-first order-last position-sticky top-0 py-md-3 z-1 d-none d-lg-block doc-navigation">
 
-                <div class="mb-md-4 ms-md-4 d-flex align-items-stretch flex-column offcanvas-md offcanvas-start" id="docs-menu">
+                <div class="mb-md-4 ms-md-4 d-flex align-items-stretch flex-column offcanvas-md offcanvas-start" id="docs-menu"
+                 data-controller="search-docs"
+                 >
+                            <div>
+                                <div class="mb-3">
+                                    <span data-search-docs-target="spinner" class="spinner-border spinner-border-sm d-none" role="status" aria-hidden="true"></span>
+                                    <form action="{{ route('docs.search', ['versionOfDocs' => $docs->version]) }}" method="post" id="search-form">
+                                        @csrf
+                                        <input class="form-control form-control-md"
+                                               data-action="input->search-docs#search"
+                                               name="text"
+                                               data-search-docs-target="text"
+                                               type="text" placeholder="Поиск по документации..." aria-label=".form-control-lg example">
+                                    </form>
+{{--                                    <template>--}}
+                                        <div class="mt-2" >
+                                          @include('docs._search_lines', ['searchOffer' => []])
+{{--                                        <ul class="list-group">--}}
+{{--                                            <li class="list-group-item">Курс по Laravel (Laravel Bootcamp)</li>--}}
+{{--                                            <li class="list-group-item">Значения атрибутов по умолчанию</li>--}}
+{{--                                        </ul>--}}
+                                        </div>
+{{--                                    </template>--}}
+                                </div>
+                            </div>
 
-                    {{--
-                    <input class="form-control form-control-lg" type="text" placeholder="Поиск по документации..."
-                        aria-label=".form-control-lg example">
---}}
 
                     <div class="d-flex align-items-center p-4 p-sm-0">
                         <select class="form-select form-select-sm rounded-3" onchange="Turbo.visit(this.value);">
@@ -80,7 +100,7 @@ class="{{ active(url($link['href']), 'active', 'link-body-emphasis') }} d-inline
             </div>
             <div class="px-0 px-md-2 px-xl-3 col-md-10 col-lg-8 col-xl-7 col-xxl-6 order-md-1 order-first">
 
-                <main class="bg-body-tertiary p-4 p-xl-5 rounded documentations position-relative" data-controller="prism">
+                <main class="bg-body-tertiary p-4 p-xl-5 rounded documentations position-relative" §>
                     <h1 class="display-6 fw-bold text-body-emphasis">{{ $docs->title() }}</h1>
                     @if ($docs->isOlderVersion())
                         <blockquote class="docs-blockquote-note position-relative  mt-4" role="alert">

diff --git a/routes/web.php b/routes/web.php
@@ -375,8 +375,10 @@
     ->whereIn('version', Docs::SUPPORT_VERSIONS)
     ->name('docs');
 
+Route::post('/docs/{versionOfDocs}/search', [DocsController::class, 'search'])->name('docs.search');
 Route::get('/docs/{page}', fn (string $page) => redirect()->route('docs', ['version' => Docs::DEFAULT_VERSION, 'page' => $page]));
 
+
 Route::get('nav/docs/{version?}', [DocsController::class, 'navigation'])
     ->whereIn('version', Docs::SUPPORT_VERSIONS)
     ->name('nav.docs');