feat: add simple JavaabuTranslatable check w/Tests

Author: athphane

.gitignore

@@ -6,3 +6,4 @@ coverage
 .idea
 .php-cs-fixer.cache
 clover.xml
+coverage.xml

src/Views/Components/Select.php

@@ -153,7 +153,7 @@ public function getOptionsFromQueryBuilder(BuilderContract $query): array
                            $model->hasGetMutator($id_field);
         }
 
-        if ($is_accessor) {
+        if ($is_accessor || $this->isJavaabuTranslatableModel($model)) {
             return $query->get()
                          ->pluck($name_field, $id_field)
                          ->all();
@@ -162,6 +162,11 @@ public function getOptionsFromQueryBuilder(BuilderContract $query): array
         return $query->pluck($name_field, $id_field)->all();
     }
 
+    public function isJavaabuTranslatableModel($model): bool
+    {
+        return method_exists($model, 'isTranslatable');
+    }
+
     public function isSelected($key): bool
     {
         return in_array($key, Arr::wrap($this->selectedKey));

tests/Feature/Select2Test.php

@@ -3,12 +3,15 @@
 namespace Javaabu\Forms\Tests\Feature;
 
 use Illuminate\Support\Facades\Route;
+use Illuminate\Foundation\Testing\RefreshDatabase;
 use Javaabu\Forms\Tests\TestCase;
 use Javaabu\Forms\Tests\TestSupport\Enums\ArticleStatuses;
 use Javaabu\Forms\Tests\TestSupport\Models\Article;
 
 class Select2Test extends TestCase
 {
+    use RefreshDatabase;
+
     /** @test */
     public function it_can_render_a_select_2_basic_element_whose_value_comes_from_an_enum_cast()
     {
@@ -174,4 +177,30 @@ public function it_can_render_a_select2_element_with_custom_form_group_class_boo
             ->seeElement('option[value="2"]:selected')
             ->seeElement('option[value="3"]');
     }
+
+    /** @test */
+    public function it_only_loads_selected_options_for_ajax_selects()
+    {
+        $article1 = Article::create(['title' => 'Article 1']);
+        $article2 = Article::create(['title' => 'Article 2']);
+        $article3 = Article::create(['title' => 'Article 3']);
+
+        $model = [
+            'article' => $article2->id,
+        ];
+
+        $options = Article::query();
+
+        Route::get('select2-ajax-query', function () use ($model, $options) {
+            return view('select2-ajax-query')
+                ->with('model', $model)
+                ->with('options', $options);
+        })->middleware('web');
+
+        $this->visit('/select2-ajax-query')
+            ->seeElement('select.select2-ajax[name="article"]')
+            ->dontSeeElement('option[value="' . $article1->id . '"]')
+            ->seeElement('option[value="' . $article2->id . '"]:selected')
+            ->dontSeeElement('option[value="' . $article3->id . '"]');
+    }
 }

tests/Feature/SelectTest.php

@@ -2,10 +2,15 @@
 
 namespace Javaabu\Forms\Tests\Feature;
 
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Route;
 use Javaabu\Forms\Tests\TestCase;
+use Javaabu\Forms\Tests\TestSupport\Models\Category;
 
 class SelectTest extends TestCase
 {
+    use RefreshDatabase;
+
     /** @test */
     public function it_shows_the_slot_if_the_options_are_empty()
     {
@@ -40,4 +45,48 @@ public function it_adds_a_sync_field_for_multi_selects()
             ->seeElement('option[value="b"]')
             ->seeElement('option[value="c"]');
     }
+
+    /** @test */
+    public function it_can_exclude_the_sync_field_for_multi_selects()
+    {
+        $this->registerTestRoute('select-sync-field');
+
+        $this->visit('/select-sync-field')
+            ->dontSeeElement('input[type="hidden"][name="sync_exclude_sync"]')
+            ->dontSeeElement('input[type="hidden"][name="sync_disabled_sync"]')
+            ->seeElement('input[type="hidden"][name="custom_sync_name"][value="1"]');
+    }
+
+    /** @test */
+    public function it_includes_old_values_for_tags()
+    {
+        $this->registerTestRoute('select-tags');
+
+        $this->session(['_old_input' => ['tags' => ['a', 'b', 'c']]]);
+
+        $this->visit('/select-tags')
+            ->seeElement('option[value="a"]:selected')
+            ->seeElement('option[value="b"]:selected')
+            ->seeElement('option[value="c"]:selected');
+    }
+
+    /** @test */
+    public function it_can_load_options_from_a_translatable_model()
+    {
+        $category1 = Category::create(['name' => 'Category 1']);
+        $category2 = Category::create(['name' => 'Category 2']);
+
+        $options = Category::query();
+
+        Route::get('select-translatable', function () use ($options) {
+            return view('select-translatable')
+                ->with('options', $options);
+        })->middleware('web');
+
+        $this->visit('/select-translatable')
+            ->seeElement('option[value="' . $category1->id . '"]')
+            ->see('Category 1')
+            ->seeElement('option[value="' . $category2->id . '"]')
+            ->see('Category 2');
+    }
 }

tests/TestSupport/Models/Category.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Javaabu\Forms\Tests\TestSupport\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Category extends Model
+{
+    protected $fillable = ['name'];
+
+    public function isTranslatable($attribute): bool
+    {
+        return $attribute == 'name';
+    }
+}

tests/TestSupport/database/2024_12_24_123546_create_categories_table.php

@@ -0,0 +1,31 @@
+<?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('categories', function (Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->string('name');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('categories');
+    }
+};

tests/TestSupport/views/select-sync-field.blade.php

@@ -0,0 +1,13 @@
+<x-forms::form>
+    <x-forms::select name="exclude_sync[]" multiple exclude-sync-field>
+        <option value="a">A</option>
+    </x-forms::select>
+
+    <x-forms::select name="disabled_sync[]" multiple disabled>
+        <option value="a">A</option>
+    </x-forms::select>
+
+    <x-forms::select name="custom_sync[]" multiple sync-field-name="custom_sync_name">
+        <option value="a">A</option>
+    </x-forms::select>
+</x-forms::form>

tests/TestSupport/views/select-tags.blade.php

@@ -0,0 +1,3 @@
+<x-forms::form>
+    <x-forms::select name="tags[]" :options="['a' => 'A']" tags multiple />
+</x-forms::form>

tests/TestSupport/views/select-translatable.blade.php

@@ -0,0 +1,3 @@
+<x-forms::form>
+    <x-forms::select name="category" :options="$options" />
+</x-forms::form>

tests/TestSupport/views/select2-ajax-query.blade.php

@@ -0,0 +1,3 @@
+<x-forms::form :model="$model">
+    <x-forms::select2 name="article" :options="$options" is-ajax name-field="title" />
+</x-forms::form>