Merge pull request #233 from art-institute-of-chicago/feature/feature…

…d-tours-json

Add featured tours to JSON

app/Models/Transformers/FeaturedTourTransformer.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Models\Transformers;
+
+use A17\Twill\Models\Contracts\TwillModelContract;
+use League\Fractal\TransformerAbstract;
+
+class FeaturedTourTransformer extends TransformerAbstract
+{
+    public function transform(TwillModelContract $tour)
+    {
+        return [
+            (string) $tour->id,
+        ];
+    }
+}

app/Repositories/Serializers/DashboardSerializer.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Repositories\Serializers;
+
+/**
+ * Due to legacy constraints, the dashboard serializer is essentially a wrapper
+ * around the featured tour serializer with an additional unused
+ * `featured_exhibitions` key.
+ */
+class DashboardSerializer
+{
+    public function serialize($featuredTours)
+    {
+        $featuredTourSerializer = new FeaturedTourSerializer();
+        return [
+            'dashboard' =>
+                array_merge(
+                    $featuredTourSerializer->serialize($featuredTours),
+                    ['featured_exhibitions' => []],  // Legacy from Drupal
+                )
+        ];
+    }
+}

app/Repositories/Serializers/FeaturedTourSerializer.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace App\Repositories\Serializers;
+
+use App\Models\Transformers\FeaturedTourTransformer;
+use League\Fractal\Manager;
+use League\Fractal\Resource;
+
+class FeaturedTourSerializer
+{
+    protected ?Manager $manager = null;
+
+    public function __construct()
+    {
+        $this->manager = new Manager();
+        $this->manager->setSerializer(new FlatArraySerializer());
+    }
+
+    public function serialize($tours)
+    {
+        $tours = collect($tours)->sortBy('position');
+        $resource = new Resource\Collection($tours, new FeaturedTourTransformer(), 'featured_tours');
+        return $this->manager->createData($resource)->toArray();
+    }
+}

app/Repositories/Serializers/FlatArraySerializer.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Repositories\Serializers;
+
+use League\Fractal\Serializer\ArraySerializer;
+
+class FlatArraySerializer extends ArraySerializer
+{
+    public function collection($resourceKey, array $data): array
+    {
+        return [$resourceKey => collect($data)->flatten()];
+    }
+}

database/factories/TourFactory.php

@@ -10,12 +10,13 @@ public function definition(): array
     {
         return [
             'active' => true, // Simulates an active translation
-            'title' => fake()->words(5, asText: true),
             'description' => fake()->words(100, asText: true),
-            'intro' => fake()->words(100, asText: true),
             'duration' => fake()->numberBetween(10, 60),
+            'featured' => fake()->boolean(),
+            'intro' => fake()->words(100, asText: true),
             'position' => fake()->unique()->numberBetween(0, 20),
             'published' => fake()->boolean(),
+            'title' => fake()->words(5, asText: true),
         ];
     }
 }

routes/api.php

@@ -4,10 +4,11 @@
 use App\Repositories\Api\GalleryRepository;
 use App\Repositories\Api\SoundRepository;
 use App\Repositories\Serializers\AudioSerializer;
-use App\Repositories\TourRepository;
+use App\Repositories\Serializers\DashboardSerializer;
 use App\Repositories\Serializers\GallerySerializer;
 use App\Repositories\Serializers\ObjectSerializer;
 use App\Repositories\Serializers\TourSerializer;
+use App\Repositories\TourRepository;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Route;
@@ -33,6 +34,13 @@
     return $serializer->serialize($audios);
 });
 
+Route::get('/dashboard', function () {
+    $tourRepository = App::make(TourRepository::class);
+    $featuredTours = $tourRepository->getBaseModel()->newQuery()->visible()->published()->featured()->get();
+    $dashboardSerializer = new DashboardSerializer();
+    return $dashboardSerializer->serialize($featuredTours);
+});
+
 Route::get('/galleries', function () {
     $repository = App::make(GalleryRepository::class);
     $galleries = $repository->getBaseModel()->newQuery()->get();

tests/Feature/DashboardSerializerTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Tests\Feature;
+
+use App\Models\Tour;
+use App\Repositories\Serializers\DashboardSerializer;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Tests\TestCase;
+
+class DashboardSerializerTest extends TestCase
+{
+    use RefreshDatabase;
+
+    public function test_serialize(): void
+    {
+        $serializer = new DashboardSerializer();
+        $featuredTours = Tour::factory(['featured' => true])->count(2)->create();
+        $serialized = $serializer->serialize($featuredTours);
+
+        $this->assertArrayHasKey('dashboard', $serialized);
+        $this->assertArrayHasKey('featured_tours', $serialized['dashboard']);
+        $this->assertNotEmpty($serialized['dashboard']['featured_tours']);
+        $this->assertArrayHasKey('featured_exhibitions', $serialized['dashboard']);
+        $this->assertEmpty($serialized['dashboard']['featured_exhibitions']);
+    }
+}

tests/Feature/FeaturedTourSerializerTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Tests\Feature;
+
+use App\Models\Tour;
+use App\Repositories\Serializers\FeaturedTourSerializer;
+use Illuminate\Database\Eloquent\Factories\Sequence;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Tests\TestCase;
+
+class FeaturedTourSerializerTest extends TestCase
+{
+    use RefreshDatabase;
+
+    public function test_serialize(): void
+    {
+        $serializer = new FeaturedTourSerializer();
+        Tour::factory()->count(3)->sequence(['featured' => true], ['featured' => false])->create();
+        $featuredTours = Tour::featured()->get();
+        $serialized = $serializer->serialize($featuredTours);
+
+        $this->assertArrayHasKey('featured_tours', $serialized);
+        $this->assertCount($featuredTours->count(), $serialized['featured_tours']);
+        foreach ($serialized['featured_tours'] as $id) {
+            $this->assertIsString($id);
+            $this->assertContains((int) $id, $featuredTours->pluck('id'));
+        }
+    }
+}

tests/Unit/FlatArraySerializerTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Tests\Unit;
+
+use App\Repositories\Serializers\FlatArraySerializer;
+use PHPUnit\Framework\TestCase;
+
+class FlatArraySerializerTest extends TestCase
+{
+    public function test_collection_returns_a_flattened_array(): void
+    {
+        $data = [
+            [
+                [
+                    '123',
+                ],
+            ],
+            [
+                [
+                    '456',
+                ],
+            ],
+            [
+                [
+                    '789',
+                ],
+            ],
+        ];
+        $serializer = new FlatArraySerializer();
+        $collection = $serializer->collection('test', $data);
+        $this->assertArrayHasKey('test', $collection, 'The collection is serialized with the correct key');
+        foreach ($data as $datum) {
+            foreach ($datum as $record) {
+                $id = current($record);
+                $this->assertContains(
+                    $id,
+                    $collection['test'],
+                    'The serialized collection is flattened array of ids',
+                );
+            }
+        }
+    }
+}