Add year filter

app/Enum/MediaTypeName.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Enum;
+
+enum MediaTypeName: string
+{
+    case Album = 'album';
+    case Book = 'book';
+    case Movie = 'movie';
+    case TvShow = 'tv show';
+    case VideoGame = 'video game';
+
+    /**
+     * Get the display value for the enum case.
+     */
+    public function displayName(): string
+    {
+        return match ($this) {
+            self::Album => 'Album',
+            self::Book => 'Book',
+            self::Movie => 'Movie',
+            self::TvShow => 'TV Show',
+            self::VideoGame => 'Video Game',
+        };
+    }
+
+    /**
+     * @return string[]
+     */
+    public static function displayNames(): array
+    {
+        return array_map(fn ($case) => $case->displayName(), self::cases());
+    }
+}

app/Livewire/Media/Logbook.php

@@ -2,19 +2,53 @@
 
 namespace App\Livewire\Media;
 
+use App\Enum\MediaTypeName;
 use App\Queries\Media\LogbookQuery;
 use Illuminate\Support\Collection;
+use Livewire\Attributes\Computed;
+use Livewire\Attributes\Url;
 use Livewire\Component;
 
 class Logbook extends Component
 {
-    public Collection $items;
+    #[Url(except: '')]
+    public string $year = '';
 
-    public function mount()
+    /**
+     * @return int[]
+     */
+    #[Computed]
+    public function years(): array
     {
-        $this->items = (new LogbookQuery)->execute();
+        return (new LogbookQuery)->years();
     }
 
+    /**
+     * @returns {
+     *   'year': ?int,
+     *   'type': ?MediaTypeName
+     * }
+     */
+    private function getQueryFilters(): array
+    {
+
+        return [
+            'year' => empty($this->year) ? null : (int) $this->year,
+        ];
+    }
+
+    #[Computed]
+    public function items(): Collection
+    {
+        $filters = $this->getQueryFilters();
+
+        return (new LogbookQuery(
+            $filters['year'],
+        ))->execute();
+    }
+
+    public function mount() {}
+
     public function render()
     {
         return view('livewire.media.logbook');

app/Models/MediaType.php

@@ -2,6 +2,7 @@
 
 namespace App\Models;
 
+use App\Enum\MediaTypeName;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
@@ -12,6 +13,10 @@ class MediaType extends Model
 
     protected $fillable = ['name'];
 
+    protected $casts = [
+        'name' => MediaTypeName::class,
+    ];
+
     public function media(): HasMany
     {
         return $this->hasMany(Media::class);

app/Queries/Media/LogbookQuery.php

@@ -8,20 +8,17 @@
 
 class LogbookQuery
 {
-    /**
-     * Create a new class instance.
-     */
-    public function __construct()
-    {
-        //
-    }
+    public function __construct(
+        public ?int $year = null,
+        public ?MediaEventTypeName $type = null
+    ) {}
 
     /**
      * Get the logbook items.
      */
     public function execute(): Collection
     {
-        return DB::table('media_events')
+        $query = DB::table('media_events')
             ->join('media_event_types', 'media_events.media_event_type_id', '=', 'media_event_types.id')
             ->join('media', 'media_events.media_id', '=', 'media.id')
             ->join('media_types', 'media.media_type_id', '=', 'media_types.id')
@@ -32,11 +29,37 @@ public function execute(): Collection
                 'creators.name as creator',
                 'media_types.name as type',
                 'media_events.occurred_at as finished_at',
+                DB::raw('extract(year from media_events.occurred_at) as finished_at_year'),
                 'media.note as note'
             )
 
             ->orderBy('media_events.occurred_at', 'desc')
+            ->where('media_event_types.name', MediaEventTypeName::FINISHED);
+
+        if ($this->year !== null) {
+            $query->whereYear('media_events.occurred_at', $this->year);
+        }
+
+        if ($this->type !== null) {
+            // TODO: MediaType filter currently untested
+            $query->where('media_types.name', $this->type);
+        }
+
+        return $query->get();
+    }
+
+    /**
+     * @returns int[]
+     */
+    public function years(): array
+    {
+        return DB::table('media_event_types')
+            ->join('media_events', 'media_events.media_event_type_id', 'media_event_types.id')
             ->where('media_event_types.name', MediaEventTypeName::FINISHED)
-            ->get();
+            ->selectRaw('distinct extract(year from media_events.occurred_at) as year')
+            ->orderBy('year', 'desc')
+            ->get()
+            ->pluck('year')
+            ->toArray();
     }
 }

app/View/Components/Media/Item.php

@@ -2,6 +2,7 @@
 
 namespace App\View\Components\Media;
 
+use App\Enum\MediaTypeName;
 use Closure;
 use Illuminate\Contracts\View\View;
 use Illuminate\View\Component;
@@ -14,11 +15,11 @@ public function __construct(public readonly stdClass $item) {}
     public function icon(): string
     {
         return match ($this->item->type) {
-            'book' => '📕',
-            'movie' => '🍿',
-            'album' => '📀',
-            'tv show' => '📺',
-            'video game' => '🎮',
+            MediaTypeName::Book => '📕',
+            MediaTypeName::Movie => '🍿',
+            MediaTypeName::Album => '📀',
+            MediaTypeName::TvShow => '📺',
+            MediaTypeName::VideoGame => '🎮',
             default => '',
         };
     }

database/factories/MediaFactory.php

@@ -2,6 +2,7 @@
 
 namespace Database\Factories;
 
+use App\Enum\MediaTypeName;
 use App\Models\Creator;
 use App\Models\MediaType;
 use Illuminate\Database\Eloquent\Factories\Factory;
@@ -37,28 +38,28 @@ public function definition(): array
     public function book(): MediaFactory
     {
         return $this->state([
-            'media_type_id' => MediaType::where('name', 'book')->first()->id,
+            'media_type_id' => MediaType::where('name', MediaTypeName::Book)->first()->id,
         ]);
     }
 
     public function album(): MediaFactory
     {
         return $this->state([
-            'media_type_id' => MediaType::where('name', 'album')->first()->id,
+            'media_type_id' => MediaType::where('name', MediaTypeName::Album)->first()->id,
         ]);
     }
 
     public function game(): MediaFactory
     {
         return $this->state([
-            'media_type_id' => MediaType::where('name', 'video game')->first()->id,
+            'media_type_id' => MediaType::where('name', MediaTypeName::VideoGame)->first()->id,
         ]);
     }
 
     public function movie(): MediaFactory
     {
         return $this->state([
-            'media_type_id' => MediaType::where('name', 'movie')->first()->id,
+            'media_type_id' => MediaType::where('name', MediaTypeName::Movie)->first()->id,
         ]);
     }
 }

database/factories/MediaTypeFactory.php

@@ -2,6 +2,7 @@
 
 namespace Database\Factories;
 
+use App\Enum\MediaTypeName;
 use Illuminate\Database\Eloquent\Factories\Factory;
 
 /**
@@ -17,7 +18,7 @@ class MediaTypeFactory extends Factory
     public function definition(): array
     {
         return [
-            'name' => $this->faker->word,
+            'name' => $this->faker->randomElement(MediaTypeName::cases()),
         ];
     }
 }

resources/views/components/media/shell.blade.php

@@ -1,6 +1,20 @@
 <div>
     <x-type.page-title>{{ $title }}</x-type.page-title>
 
+    @if ($showFilters)
+        <form class="form-control flex flex-row space-x-2 m-2">
+            <select
+                wire:model.live="year"
+                class="select select-sm select-ghost"
+            >
+                <option value="">All Years</option>
+                @foreach ($this->years as $year)
+                    <option value="{{ $year }}">{{ $year }}</option>
+                @endforeach
+            </select>
+        </form>
+    @endif
+
     @can("view-backlog")
         <ul class="tabs tabs-boxed mt-2 max-w-96" role="tablist">
             <a

resources/views/livewire/media/backlog.blade.php

@@ -2,4 +2,5 @@
     title="Media Backlog"
     :items="$items"
     :itemComponent="'media.backlog-item'"
+    :showFilters="false"
 />

resources/views/livewire/media/logbook.blade.php

@@ -1,5 +1,6 @@
 <x-media.shell
     title="Media Log"
-    :items="$items"
+    :items="$this->items"
     :itemComponent="'media.logbook-item'"
+    :showFilters="true"
 />

tests/Feature/Enum/MediaTypeNameTest.php

@@ -0,0 +1,14 @@
+<?php
+
+use App\Enum\MediaTypeName;
+
+test('displayNames', function () {
+    /** @var TestCase $this */
+    expect(MediaTypeName::displayNames())->toEqual([
+        'Album',
+        'Book',
+        'Movie',
+        'TV Show',
+        'Video Game',
+    ]);
+});

tests/Feature/Livewire/Media/LogbookTest.php

@@ -33,7 +33,8 @@ public function empty_state()
     {
         Livewire::test(Logbook::class)
             ->assertStatus(200)
-            ->assertSeeText('No items');
+            ->assertSeeText('No items')
+            ->assertSet('years', []);
     }
 
     /** @test */
@@ -42,6 +43,7 @@ public function displays_logbook()
         $this->createBook('The Hobbit', 'J.R.R. Tolkien', '2023-02-07');
         $this->createBook('The Da Vinci Code', 'Dan Brown', '2022-06-17');
         $this->createBook('The Alchemist', 'Paulo Coelho', '2021-12-25');
+
         Livewire::test(Logbook::class)
             ->assertStatus(200)
             ->assertSeeHtmlInOrder([
@@ -58,7 +60,13 @@ public function displays_logbook()
                 '2021 December 25',
                 'The Alchemist',
                 'Paulo Coelho',
-            ]);
+            ])
+            ->assertSet('years', [2023, 2022, 2021]);
+
+        Livewire::withQueryParams(['year' => 2022])
+            ->test(Logbook::class)
+            ->assertSee('The Da Vinci Code')
+            ->assertDontSee(['The Hobbit', 'The Alchemist']);
     }
 
     /** @test */

tests/Feature/Models/MediaTypeTest.php

@@ -1,24 +1,22 @@
 <?php
 
+use App\Enum\MediaTypeName;
 use App\Models\MediaType;
 use Tests\TestCase;
 
 test('factory works', function () {
     /** @var TestCase $this */
-    $mediaType = MediaType::factory()->create();
+    $mediaType = MediaType::factory()->make();
     $this->assertNotNull($mediaType);
     $this->assertNotEmpty($mediaType->name);
 });
 
 test('media type seeded with data', function () {
     /** @var TestCase $this */
-    $mediaTypes = MediaType::all('name')->toArray();
-    $this->assertCount(5, $mediaTypes);
+    $mediaTypeNames = MediaType::orderBy('name', 'asc')->pluck('name')->toArray();
+    $this->assertCount(5, $mediaTypeNames);
 
-    $mediaTypeNames = array_column($mediaTypes, 'name');
-
-    $expectedNames = ['tv show', 'book', 'movie', 'album', 'video game'];
-    foreach ($expectedNames as $expectedName) {
+    foreach (MediaTypeName::cases() as $expectedName) {
         expect(in_array($expectedName, $mediaTypeNames))->toBeTrue();
     }
 });