Merge pull request #3 from rodrigopedra/main

Allow to customize label and value array keys

Author: rubenvanassche

config/options.php

@@ -0,0 +1,15 @@
+<?php
+
+return [
+
+    /*
+     * By default the when serializing an option to an array
+     * the key `label` is used for the instance's label
+     * and the key `value` for the instance's value
+     *
+     * You can customize these keys here.
+     */
+    'label_key' => 'label',
+    'value_key' => 'value',
+
+];

src/Options.php

@@ -5,13 +5,11 @@
 use Closure;
 use Exception;
 use Illuminate\Contracts\Support\Arrayable;
-use Illuminate\Contracts\Support\Htmlable;
 use Illuminate\Contracts\Support\Jsonable;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
-use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use Illuminate\Validation\Rule;
 use Illuminate\Validation\Rules\In;

src/OptionsServiceProvider.php

@@ -9,6 +9,7 @@ class OptionsServiceProvider extends PackageServiceProvider
 {
     public function configurePackage(Package $package): void
     {
-        $package->name('options');
+        $package->name('options')
+            ->hasConfigFile();
     }
 }

src/Providers/ArrayProvider.php

@@ -25,14 +25,14 @@ public function provide(): Collection
         }
 
         return $items->map(fn ($label, $value) => [
-            'label' => $label,
-            'value' => $value,
+            config('options.label_key') => $label,
+            config('options.value_key') => $value,
         ]);
     }
 
     public function map(mixed $item): SelectOption
     {
-        ['label' => $label, 'value' => $value] = $item;
+        [config('options.label_key') => $label, config('options.value_key') => $value] = $item;
 
         return new SelectOption($label, $value);
     }

src/SelectOption.php

@@ -19,8 +19,8 @@ public static function create(string $label, string | int $value, array $extra =
     public function toArray(): array
     {
         return array_merge([
-            'label' => $this->label,
-            'value' => $this->value,
+            config('options.label_key') => $this->label,
+            config('options.value_key') => $this->value,
         ], $this->extra);
     }
 

tests/OptionsTest.php

@@ -211,3 +211,20 @@
         ->toHaveCount(2)
         ->toEqual([new In(['frodo', 'sam', 'merry', 'pippin']), 'nullable']);
 });
+
+it('can use custom keys', function () {
+    config([
+        'options.label_key' => 'name',
+        'options.value_key' => 'id',
+    ]);
+
+    $options = Options::forProvider(new NativeEnumProvider(StringEnum::class))
+        ->toArray();
+
+    expect($options)->toBeArray()->toBe([
+        ['name' => 'Frodo', 'id' => 'frodo'],
+        ['name' => 'Sam', 'id' => 'sam'],
+        ['name' => 'Merry', 'id' => 'merry'],
+        ['name' => 'Pippin', 'id' => 'pippin'],
+    ]);
+});

tests/Providers/ArrayProviderTest.php

@@ -34,3 +34,20 @@
         ['label' => 'Pippin', 'value' => 'Pippin'],
     ]);
 });
+
+it('can map options from an array with custom keys', function () {
+    config([
+        'options.label_key' => 'name',
+        'options.value_key' => 'id',
+    ]);
+
+    $option = (new ArrayProvider([]))->map([
+        'name' => 'Frodo',
+        'id' => 'frodo',
+    ]);
+
+    expect($option->toArray())->toBeArray()->toBe([
+        'name' => 'Frodo',
+        'id' => 'frodo',
+    ]);
+});

tests/Providers/EmptyProviderTest.php

@@ -1,7 +1,6 @@
 <?php
 
 use Spatie\LaravelOptions\Options;
-use Spatie\LaravelOptions\Providers\ArrayProvider;
 use Spatie\LaravelOptions\Providers\EmptyProvider;
 
 it('can have empty options', function () {