Merge pull request #5 from macbookandrew/feature/create-index

Add index:create and index:delete commands

.github/workflows/lint.yml

@@ -5,20 +5,23 @@ on:
   push:
     branches:
       - main
+    paths:
+      - '**.php'
   pull_request:
     branches:
       - main
+    paths:
+      - '**.php'
 
 jobs:
-  php-cs-fixer:
+  laravel-pint:
+    name: PHP Linting (Pint)
+
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-        with:
-          # Make sure the actual branch is checked out when running on pull requests.
-          ref: ${{ github.head_ref }}
 
       - name: Laravel Pint
         uses: aglipanci/laravel-pint-action@0.1.0

.github/workflows/tests.yml

@@ -1,12 +1,17 @@
 name: Tests
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
+    paths:
+      - '**.php'
   pull_request:
     branches:
       - main
+    paths:
+      - '**.php'
   schedule:
     - cron: '0 1 * * 1' # Run at 01:00 on Mondays.
 
@@ -34,9 +39,6 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-        with:
-          # Make sure the actual branch is checked out when running on pull requests.
-          ref: ${{ github.head_ref }}
 
       - name: Install SQLite 3
         run: |

README.md

@@ -53,7 +53,7 @@ use Laravel\Scout\Searchable;
 class Article extends Model implements MeiliSettings
 {
     use Searchable;
-    
+
     /**
      * {@inheritdoc}
      */
@@ -67,6 +67,18 @@ A full list of available index settings can be found [here](https://docs.meilise
 
 ### Commands
 The following commands are available:
+
+#### `meili:index:create` - Create a new MeiliSearch index
+**Arguments:**
+- `index` : Index name
+
+**Options:**
+- `--force` : Force the operation to run
+
+#### `meili:index:delete` - Delete a MeiliSearch index
+**Arguments:**
+- `index` : Index name
+
 #### `meili:index:details` - Get details for a MeiliSearch index
 **Arguments:**
 - `index` : Index name

src/Actions/CreateIndex.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dwarf\MeiliTools\Actions;
+
+use Dwarf\MeiliTools\Contracts\Actions\CreatesIndex;
+use Dwarf\MeiliTools\Helpers;
+use Laravel\Scout\EngineManager;
+
+/**
+ * Create index.
+ */
+class CreateIndex implements CreatesIndex
+{
+    use Concerns\ExtractsIndexInformation;
+
+    /**
+     * Scout engine manager.
+     *
+     * @var \Laravel\Scout\EngineManager
+     */
+    protected EngineManager $manager;
+
+    /**
+     * Constructor.
+     *
+     * @param \Laravel\Scout\EngineManager $manager Scout engine manager.
+     */
+    public function __construct(EngineManager $manager)
+    {
+        $this->manager = $manager;
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @throws \Dwarf\MeiliTools\Exceptions\MeiliToolsException When not using the MeiliSearch Scout driver.
+     * @throws \MeiliSearch\Exceptions\CommunicationException   When connection to MeiliSearch fails.
+     */
+    public function __invoke(string $index, array $options = []): array
+    {
+        Helpers::throwUnlessMeiliSearch();
+        $engine = $this->manager->engine();
+        $task = $engine->createIndex($index, $options);
+        $engine->waitForTask($task['taskUid']);
+
+        return $this->getIndexData($engine->getIndex($index));
+    }
+}

src/Actions/DeleteIndex.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dwarf\MeiliTools\Actions;
+
+use Dwarf\MeiliTools\Contracts\Actions\DeletesIndex;
+use Dwarf\MeiliTools\Helpers;
+use Laravel\Scout\EngineManager;
+
+/**
+ * Delete index.
+ */
+class DeleteIndex implements DeletesIndex
+{
+    /**
+     * Scout engine manager.
+     *
+     * @var \Laravel\Scout\EngineManager
+     */
+    protected EngineManager $manager;
+
+    /**
+     * Constructor.
+     *
+     * @param \Laravel\Scout\EngineManager $manager Scout engine manager.
+     */
+    public function __construct(EngineManager $manager)
+    {
+        $this->manager = $manager;
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @throws \Dwarf\MeiliTools\Exceptions\MeiliToolsException When not using the MeiliSearch Scout driver.
+     * @throws \MeiliSearch\Exceptions\CommunicationException   When connection to MeiliSearch fails.
+     * @throws \MeiliSearch\Exceptions\ApiException             When index is not found.
+     */
+    public function __invoke(string $index): void
+    {
+        Helpers::throwUnlessMeiliSearch();
+
+        $engine = $this->manager->engine();
+        $task = $engine->deleteIndex($index);
+        $engine->waitForTask($task['taskUid']);
+    }
+}

src/Console/Commands/IndexCreate.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dwarf\MeiliTools\Console\Commands;
+
+use Dwarf\MeiliTools\Contracts\Actions\CreatesIndex;
+use Illuminate\Console\Command;
+
+class IndexCreate extends Command
+{
+    use Concerns\RequiresIndex;
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'meili:index:create {index? : Index name}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a MeiliSearch index';
+
+    /**
+     * Execute the console command.
+     *
+     * @param \Dwarf\MeiliTools\Contracts\Actions\CreatesIndex $createIndex
+     *
+     * @return int
+     */
+    public function handle(CreatesIndex $createIndex)
+    {
+        $createIndex($this->getIndex());
+
+        return Command::SUCCESS;
+    }
+}

src/Console/Commands/IndexDelete.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dwarf\MeiliTools\Console\Commands;
+
+use Dwarf\MeiliTools\Contracts\Actions\DeletesIndex;
+use Illuminate\Console\Command;
+use Illuminate\Console\ConfirmableTrait;
+
+class IndexDelete extends Command
+{
+    use Concerns\RequiresIndex;
+    use ConfirmableTrait;
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'meili:index:delete
+                            {index? : Index name}
+                            {--force : Force the operation to run}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Delete a MeiliSearch index';
+
+    /**
+     * Execute the console command.
+     *
+     * @param \Dwarf\MeiliTools\Contracts\Actions\DeletesIndex $deleteIndex
+     *
+     * @return int
+     */
+    public function handle(DeletesIndex $deleteIndex)
+    {
+        // Confirm execution.
+        $index = $this->getIndex();
+        if (!$this->confirmToProceed("Index '{$index}' is about to be deleted", fn () => true)) {
+            return Command::FAILURE;
+        }
+
+        $deleteIndex($index);
+
+        return Command::SUCCESS;
+    }
+}

src/Console/Commands/ModelsSynchronize.php

@@ -43,7 +43,7 @@ public function handle(ListsClasses $listClasses, SynchronizesModels $synchroniz
     {
         // Confirm execution if not pretending and in production.
         if (!$this->option('pretend') && !$this->confirmToProceed()) {
-            return Command::SUCCESS;
+            return Command::FAILURE;
         }
 
         $paths = config('meilitools.paths');

src/Contracts/Actions/CreatesIndex.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dwarf\MeiliTools\Contracts\Actions;
+
+/**
+ * Creates index.
+ */
+interface CreatesIndex
+{
+    /**
+     * Create index.
+     *
+     * @param string $index   Index name.
+     * @param array  $options Index options.
+     *
+     * @return array
+     */
+    public function __invoke(string $index, array $options = []): array;
+}

src/Contracts/Actions/DeletesIndex.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dwarf\MeiliTools\Contracts\Actions;
+
+/**
+ * Deletes index.
+ */
+interface DeletesIndex
+{
+    /**
+     * Delete index.
+     *
+     * @param string $index Index name.
+     *
+     * @return void
+     */
+    public function __invoke(string $index): void;
+}

src/Contracts/Actions/EnsuresIndexExists.php

@@ -12,7 +12,8 @@ interface EnsuresIndexExists
     /**
      * Ensure that the given index exists.
      *
-     * @param string $index Index name.
+     * @param string $index   Index name.
+     * @param array  $options Index options.
      *
      * @return void
      */

src/MeiliToolsServiceProvider.php

@@ -4,6 +4,8 @@
 
 namespace Dwarf\MeiliTools;
 
+use Dwarf\MeiliTools\Actions\CreateIndex;
+use Dwarf\MeiliTools\Actions\DeleteIndex;
 use Dwarf\MeiliTools\Actions\DetailIndex;
 use Dwarf\MeiliTools\Actions\DetailModel;
 use Dwarf\MeiliTools\Actions\EnsureIndexExists;
@@ -17,6 +19,8 @@
 use Dwarf\MeiliTools\Actions\ValidateIndexSettings;
 use Dwarf\MeiliTools\Actions\ViewIndex;
 use Dwarf\MeiliTools\Actions\ViewModel;
+use Dwarf\MeiliTools\Console\Commands\IndexCreate;
+use Dwarf\MeiliTools\Console\Commands\IndexDelete;
 use Dwarf\MeiliTools\Console\Commands\IndexDetails;
 use Dwarf\MeiliTools\Console\Commands\IndexesList;
 use Dwarf\MeiliTools\Console\Commands\IndexReset;
@@ -26,6 +30,8 @@
 use Dwarf\MeiliTools\Console\Commands\ModelsSynchronize;
 use Dwarf\MeiliTools\Console\Commands\ModelSynchronize;
 use Dwarf\MeiliTools\Console\Commands\ModelView;
+use Dwarf\MeiliTools\Contracts\Actions\CreatesIndex;
+use Dwarf\MeiliTools\Contracts\Actions\DeletesIndex;
 use Dwarf\MeiliTools\Contracts\Actions\DetailsIndex;
 use Dwarf\MeiliTools\Contracts\Actions\DetailsModel;
 use Dwarf\MeiliTools\Contracts\Actions\EnsuresIndexExists;
@@ -52,6 +58,8 @@ class MeiliToolsServiceProvider extends ServiceProvider
      */
     public array $bindings = [
         ArrayAssocRule::class         => ArrayAssoc::class,
+        CreatesIndex::class           => CreateIndex::class,
+        DeletesIndex::class           => DeleteIndex::class,
         DetailsIndex::class           => DetailIndex::class,
         DetailsModel::class           => DetailModel::class,
         EnsuresIndexExists::class     => EnsureIndexExists::class,
@@ -93,6 +101,8 @@ public function boot(): void
     {
         if ($this->app->runningInConsole()) {
             $this->commands([
+                IndexCreate::class,
+                IndexDelete::class,
                 IndexDetails::class,
                 IndexReset::class,
                 IndexView::class,