feat: Introduce source type for featured groups; add category association and implement FeaturedGroupService for item sourcing

app/Domains/Catalog/Controllers/CatalogController.php

@@ -2,34 +2,28 @@
 
 namespace App\Domains\Catalog\Controllers;
 
-use App\Domains\Catalog\Enums\GroupLayout;
 use App\Domains\Catalog\Models\CatalogItem;
 use App\Domains\Catalog\Models\Category;
 use App\Domains\Catalog\Models\FeaturedGroup;
-use App\Domains\Catalog\Models\FeaturedItem;
 use App\Domains\Catalog\Requests\CatalogItemDetailRequest;
 use App\Domains\Catalog\Requests\CategoryPageRequest;
 use App\Domains\Catalog\Requests\FeaturedGroupPageRequest;
 use App\Domains\Catalog\Requests\SearchCatalogItemsRequest;
 use App\Domains\Catalog\Requests\StoreCatalogItemRequest;
 use App\Domains\Catalog\Resources\CatalogFeaturedGroupResource;
-use App\Domains\Catalog\Resources\CatalogFeaturedItemResource;
 use App\Domains\Catalog\Resources\CatalogItemDetailResource;
 use App\Domains\Catalog\Resources\CatalogItemResource;
 use App\Domains\Catalog\Resources\CatalogSearchItemResource;
 use App\Domains\Catalog\Services\CatalogService;
+use App\Domains\Catalog\Services\FeaturedGroupService;
 use App\Domains\Tenant\Models\Tenant;
 use App\Http\Controllers\Controller;
-use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
-use Illuminate\Pagination\LengthAwarePaginator;
 
 class CatalogController extends Controller
 {
-    private const ITEMS_PER_PAGE = 12;
-
-    public function index(Tenant $tenant): JsonResponse
+    public function index(Tenant $tenant, FeaturedGroupService $featuredGroupService): JsonResponse
     {
         $featuredGroups = FeaturedGroup::query()
             ->where('tenant_code', $tenant->codigo)
@@ -39,7 +33,7 @@ class CatalogController extends Controller
         return response()->json($featuredGroups->map(
             fn (FeaturedGroup $featuredGroup): array => (new CatalogFeaturedGroupResource(
                 $featuredGroup,
-                $this->featuredItemsResponse($featuredGroup, 1),
+                $featuredGroupService->itemsResponse($featuredGroup, 1),
             ))->resolve()
         ));
     }
@@ -89,12 +83,13 @@ class CatalogController extends Controller
         FeaturedGroupPageRequest $request,
         Tenant $tenant,
         FeaturedGroup $featuredGroup,
+        FeaturedGroupService $featuredGroupService,
     ): JsonResponse {
         abort_unless($featuredGroup->tenant_code === $tenant->codigo, 404);
 
         $page = (int) $request->validated('page', 1);
 
-        return response()->json($this->featuredItemsResponse($featuredGroup, $page));
+        return response()->json($featuredGroupService->itemsResponse($featuredGroup, $page));
     }
 
     public function show(
@@ -129,59 +124,4 @@ class CatalogController extends Controller
             ->response()
             ->setStatusCode(201);
     }
-
-    /** @return array<array-key, mixed> */
-    private function featuredItemsResponse(FeaturedGroup $featuredGroup, int $page): array
-    {
-        if ($featuredGroup->group_layout !== GroupLayout::Paginated) {
-            $featuredItems = $this->featuredItemsQuery($featuredGroup)->get();
-
-            $featuredItems->each(
-                fn ($featuredItem) => $featuredItem->setRelation('featuredGroup', $featuredGroup)
-            );
-
-            return CatalogFeaturedItemResource::collection($featuredItems)->resolve();
-        }
-
-        $paginator = $this->paginateFeaturedItems($featuredGroup, $page);
-
-        $paginator->getCollection()->each(
-            fn ($featuredItem) => $featuredItem->setRelation('featuredGroup', $featuredGroup)
-        );
-
-        return CatalogFeaturedItemResource::collection($paginator)
-            ->response()
-            ->getData(true);
-    }
-
-    private function paginateFeaturedItems(
-        FeaturedGroup $featuredGroup,
-        int $page,
-    ): LengthAwarePaginator {
-        $paginator = $this->featuredItemsQuery($featuredGroup)->paginate(
-            perPage: self::ITEMS_PER_PAGE,
-            pageName: 'page',
-            page: $page,
-        );
-
-        return $paginator->withPath(route('catalog.featured-groups.items.index', [
-            'tenant' => $featuredGroup->tenant_code,
-            'featuredGroup' => $featuredGroup->id,
-        ]));
-    }
-
-    /** @return HasMany<FeaturedItem, FeaturedGroup> */
-    private function featuredItemsQuery(FeaturedGroup $featuredGroup): HasMany
-    {
-        return $featuredGroup->featuredItems()->with([
-            'catalogItem.inventory',
-            'catalogItem.attachments',
-            'catalogItem.variants.inventory',
-            'catalogItem.variants.attachments',
-            'catalogItem.variants.eventDate',
-            'catalogItem.variants.definitions.itemAttribute.attribute',
-            'catalogItem.bundleComponents.catalogItem',
-            'catalogItem.bundleComponents.variant.catalogItem',
-        ]);
-    }
 }

app/Domains/Catalog/Enums/FeaturedGroupSource.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Domains\Catalog\Enums;
+
+enum FeaturedGroupSource: string
+{
+    case Manual = 'manual';
+    case Category = 'category';
+    case All = 'all';
+
+    /**
+     * @return list<string>
+     */
+    public static function values(): array
+    {
+        return array_column(self::cases(), 'value');
+    }
+}

app/Domains/Catalog/Models/FeaturedGroup.php

@@ -2,6 +2,7 @@
 
 namespace App\Domains\Catalog\Models;
 
+use App\Domains\Catalog\Enums\FeaturedGroupSource;
 use App\Domains\Catalog\Enums\GroupLayout;
 use App\Domains\Catalog\Enums\ProductLayout;
 use App\Domains\Tenant\Models\Tenant;
@@ -13,6 +14,8 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
 
 #[Fillable([
     'tenant_code',
+    'source_type',
+    'category_id',
     'product_layout',
     'group_layout',
     'group_name',
@@ -26,9 +29,15 @@ class FeaturedGroup extends Model
 
     protected $table = 'featured_groups';
 
+    protected $attributes = [
+        'source_type' => FeaturedGroupSource::Manual->value,
+    ];
+
     protected function casts(): array
     {
         return [
+            'source_type' => FeaturedGroupSource::class,
+            'category_id' => 'integer',
             'product_layout' => ProductLayout::class,
             'group_layout' => GroupLayout::class,
             'group_order' => 'integer',
@@ -41,6 +50,12 @@ class FeaturedGroup extends Model
         return $this->belongsTo(Tenant::class, 'tenant_code', 'codigo');
     }
 
+    /** @return BelongsTo<Category, $this> */
+    public function category(): BelongsTo
+    {
+        return $this->belongsTo(Category::class);
+    }
+
     /** @return HasMany<FeaturedItem, $this> */
     public function featuredItems(): HasMany
     {

app/Domains/Catalog/Resources/CatalogFeaturedItemResource.php

@@ -5,20 +5,22 @@ namespace App\Domains\Catalog\Resources;
 use App\Domains\Catalog\Enums\InventoryPolicy;
 use App\Domains\Catalog\Enums\ProductLayout;
 use App\Domains\Catalog\Models\CatalogItem;
-use App\Domains\Catalog\Models\FeaturedItem;
+use App\Domains\Catalog\Models\FeaturedGroup;
 use App\Domains\Catalog\Models\Variant;
 use Illuminate\Http\Request;
 use Illuminate\Http\Resources\Json\JsonResource;
 
-/** @mixin FeaturedItem */
+/** @mixin CatalogItem */
 class CatalogFeaturedItemResource extends JsonResource
 {
     /** @return array<string, mixed> */
     public function toArray(Request $request): array
     {
-        $catalogItem = $this->catalogItem;
+        $catalogItem = $this->resource;
+        /** @var FeaturedGroup $featuredGroup */
+        $featuredGroup = $catalogItem->getRelation('featuredGroup');
 
-        if ($this->featuredGroup->product_layout === ProductLayout::ColumnWithImage) {
+        if ($featuredGroup->product_layout === ProductLayout::ColumnWithImage) {
             return $this->columnWithImageData($catalogItem);
         }
 

app/Domains/Catalog/Services/FeaturedGroupService.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace App\Domains\Catalog\Services;
+
+use App\Domains\Catalog\Enums\FeaturedGroupSource;
+use App\Domains\Catalog\Enums\GroupLayout;
+use App\Domains\Catalog\Models\CatalogItem;
+use App\Domains\Catalog\Models\FeaturedGroup;
+use App\Domains\Catalog\Resources\CatalogFeaturedItemResource;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Pagination\LengthAwarePaginator;
+
+class FeaturedGroupService
+{
+    private const ITEMS_PER_PAGE = 12;
+
+    /** @return array<array-key, mixed> */
+    public function itemsResponse(FeaturedGroup $featuredGroup, int $page): array
+    {
+        if ($featuredGroup->group_layout !== GroupLayout::Paginated) {
+            $items = $this->itemsQuery($featuredGroup)->get();
+            $this->attachGroup($items, $featuredGroup);
+
+            return CatalogFeaturedItemResource::collection($items)->resolve();
+        }
+
+        $paginator = $this->paginateItems($featuredGroup, $page);
+        $this->attachGroup($paginator->getCollection(), $featuredGroup);
+
+        return CatalogFeaturedItemResource::collection($paginator)
+            ->response()
+            ->getData(true);
+    }
+
+    /** @return Builder<CatalogItem> */
+    private function itemsQuery(FeaturedGroup $featuredGroup): Builder
+    {
+        $query = CatalogItem::query()
+            ->where('catalog_items.tenant_code', $featuredGroup->tenant_code)
+            ->with([
+                'inventory',
+                'attachments',
+                'variants.inventory',
+                'variants.attachments',
+                'variants.eventDate',
+                'variants.definitions.itemAttribute.attribute',
+                'bundleComponents.catalogItem',
+                'bundleComponents.variant.catalogItem',
+            ]);
+
+        return match ($featuredGroup->source_type) {
+            FeaturedGroupSource::Manual => $query
+                ->select('catalog_items.*')
+                ->join('featured_items', 'featured_items.catalog_item_id', '=', 'catalog_items.id')
+                ->where('featured_items.featured_group_id', $featuredGroup->id)
+                ->orderBy('featured_items.order')
+                ->orderBy('featured_items.id'),
+            FeaturedGroupSource::Category => $query
+                ->where('catalog_items.category_id', $featuredGroup->category_id)
+                ->orderBy('catalog_items.id'),
+            FeaturedGroupSource::All => $query->orderBy('catalog_items.id'),
+        };
+    }
+
+    private function paginateItems(
+        FeaturedGroup $featuredGroup,
+        int $page,
+    ): LengthAwarePaginator {
+        $paginator = $this->itemsQuery($featuredGroup)->paginate(
+            perPage: self::ITEMS_PER_PAGE,
+            pageName: 'page',
+            page: $page,
+        );
+
+        return $paginator->withPath(route('catalog.featured-groups.items.index', [
+            'tenant' => $featuredGroup->tenant_code,
+            'featuredGroup' => $featuredGroup->id,
+        ]));
+    }
+
+    private function attachGroup(iterable $items, FeaturedGroup $featuredGroup): void
+    {
+        foreach ($items as $item) {
+            $item->setRelation('featuredGroup', $featuredGroup);
+        }
+    }
+}