Add use_parent_as_substitute column

.env.dist

@@ -30,9 +30,6 @@ SCOUT_DRIVER=meilisearch
 MEILISEARCH_HOST=
 MEILISEARCH_KEY=
 
-# [Experimental] Use parent ingredient as substitutes GH#95
-PARENT_INGREDIENT_SUBSTITUTE=false
-
 # Mail
 # MAIL_MAILER=
 # MAIL_HOST=

CHANGELOG.md

@@ -1,6 +1,14 @@
 # v3.7.0
 ## New
 - Added `missing_ingredients` cocktails filter
+- Added `use_parent_as_substitute` setting to bar memberships
+    - With this you can toggle using parent ingredient of a specific ingredient as a substitute in your shelf
+    - Before, this was available via experimental `PARENT_INGREDIENT_SUBSTITUTE` env variable
+
+## Changes
+- Removed `PARENT_INGREDIENT_SUBSTITUTE` env variable
+- Update login error message depending on mail confirmation config
+- Update min log level to "warning"
 
 # v3.6.0
 ## New

app/Http/Controllers/ProfileController.php

@@ -35,6 +35,7 @@ public function update(UpdateUserRequest $request): JsonResource
             $barMembership = $currentUser->getBarMembership((int) $barId);
             if ($barMembership) {
                 $barMembership->is_shelf_public = (bool) $request->post('is_shelf_public');
+                $barMembership->use_parent_as_substitute = (bool) $request->post('use_parent_as_substitute');
                 $barMembership->save();
             }
         }

app/Http/Controllers/ShelfController.php

@@ -37,7 +37,8 @@ public function cocktails(CocktailRepository $cocktailRepo, Request $request): J
 
         $cocktailIds = $cocktailRepo->getCocktailsByIngredients(
             $barMembership->userIngredients->pluck('ingredient_id')->toArray(),
-            $limit
+            $limit,
+            $barMembership->use_parent_as_substitute,
         );
 
         return response()->json([

app/Http/Controllers/StatsController.php

@@ -58,7 +58,8 @@ public function index(CocktailRepository $cocktailRepo, Request $request): JsonR
         $stats['total_ingredients'] = Ingredient::where('bar_id', $bar->id)->count();
         $stats['total_favorited_cocktails'] = CocktailFavorite::where('bar_membership_id', $barMembership->id)->count();
         $stats['total_shelf_cocktails'] = $cocktailRepo->getCocktailsByIngredients(
-            $barMembership->userIngredients->pluck('ingredient_id')->toArray()
+            $barMembership->userIngredients->pluck('ingredient_id')->toArray(),
+            useParentIngredientAsSubstitute: $barMembership->use_parent_as_substitute,
         )->count();
         $stats['total_shelf_ingredients'] = UserIngredient::where('bar_membership_id', $barMembership->id)->count();
         $stats['most_popular_ingredients'] = $popularIngredientIds;

app/Http/Filters/CocktailQueryFilter.php

@@ -22,6 +22,8 @@ public function __construct(CocktailRepository $cocktailRepo)
 
         $barMembership = $this->request->user()->getBarMembership(bar()->id);
 
+        $useParentIngredientAsSubstitute = $barMembership->use_parent_as_substitute;
+
         $this
             ->allowedFilters([
                 AllowedFilter::exact('id'),
@@ -50,14 +52,15 @@ public function __construct(CocktailRepository $cocktailRepo)
                         $query->userFavorites($barMembership->id);
                     }
                 }),
-                AllowedFilter::callback('on_shelf', function ($query, $value) use ($cocktailRepo) {
+                AllowedFilter::callback('on_shelf', function ($query, $value) use ($cocktailRepo, $useParentIngredientAsSubstitute) {
                     if ($value === true) {
                         $query->whereIn('cocktails.id', $cocktailRepo->getCocktailsByIngredients(
-                            $this->request->user()->getShelfIngredients(bar()->id)->pluck('ingredient_id')->toArray()
+                            $this->request->user()->getShelfIngredients(bar()->id)->pluck('ingredient_id')->toArray(),
+                            useParentIngredientAsSubstitute: $useParentIngredientAsSubstitute,
                         ));
                     }
                 }),
-                AllowedFilter::callback('user_shelves', function ($query, $value) use ($cocktailRepo) {
+                AllowedFilter::callback('user_shelves', function ($query, $value) use ($cocktailRepo, $useParentIngredientAsSubstitute) {
                     if (!is_array($value)) {
                         $value = [$value];
                     }
@@ -71,15 +74,19 @@ public function __construct(CocktailRepository $cocktailRepo)
                         ->get();
 
                     $query->whereIn('cocktails.id', $cocktailRepo->getCocktailsByIngredients(
-                        $ingredients->pluck('ingredient_id')->toArray()
+                        $ingredients->pluck('ingredient_id')->toArray(),
+                        useParentIngredientAsSubstitute: $useParentIngredientAsSubstitute,
                     ));
                 }),
-                AllowedFilter::callback('shelf_ingredients', function ($query, $value) use ($cocktailRepo) {
+                AllowedFilter::callback('shelf_ingredients', function ($query, $value) use ($cocktailRepo, $useParentIngredientAsSubstitute) {
                     if (!is_array($value)) {
                         $value = [$value];
                     }
 
-                    $query->whereIn('cocktails.id', $cocktailRepo->getCocktailsByIngredients($value));
+                    $query->whereIn('cocktails.id', $cocktailRepo->getCocktailsByIngredients(
+                        $value,
+                        useParentIngredientAsSubstitute: $useParentIngredientAsSubstitute
+                    ));
                 }),
                 AllowedFilter::callback('is_public', function ($query, $value) {
                     if ($value === true) {

app/Models/BarMembership.php

@@ -13,6 +13,7 @@ class BarMembership extends Model
 {
     protected $casts = [
         'is_shelf_public' => 'boolean',
+        'use_parent_as_substitute' => 'boolean',
     ];
 
     /**

app/Repository/CocktailRepository.php

@@ -20,15 +20,15 @@ public function __construct(private DatabaseManager $db)
      * @param array<int> $ingredientIds
      * @return \Illuminate\Support\Collection<string, mixed>
      */
-    public function getCocktailsByIngredients(array $ingredientIds, ?int $limit = null): Collection
+    public function getCocktailsByIngredients(array $ingredientIds, ?int $limit = null, bool $useParentIngredientAsSubstitute = false): Collection
     {
         $query = $this->db->table('cocktails AS c')
             ->select('c.id')
             ->join('cocktail_ingredients AS ci', 'ci.cocktail_id', '=', 'c.id')
             ->leftJoin('cocktail_ingredient_substitutes AS cis', 'cis.cocktail_ingredient_id', '=', 'ci.id')
             ->where('optional', false);
 
-        if (config('bar-assistant.parent_ingredient_as_substitute')) {
+        if ($useParentIngredientAsSubstitute) {
             $query->join('ingredients AS i', function ($join) {
                 $join->on('i.id', '=', 'ci.ingredient_id')->orOn('i.id', '=', 'i.parent_ingredient_id');
             })

config/bar-assistant.php

@@ -28,22 +28,6 @@
         true
     ),
 
-    /*
-    |--------------------------------------------------------------------------
-    | [Experimental] Use parent ingredient as substitutes GH#95
-    |--------------------------------------------------------------------------
-    |
-    | This option will modify how ingredients for cocktails you can make are
-    | shown. Enabling this option will use ingredients parent ingredient
-    | as a possible substitute.
-    |
-    */
-
-    'parent_ingredient_as_substitute' => env(
-        'PARENT_INGREDIENT_SUBSTITUTE',
-        false
-    ),
-
     /*
     |--------------------------------------------------------------------------
     | Max bars per user

database/migrations/2024_01_01_145353_add_parent_sub_column.php

@@ -0,0 +1,28 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('bar_memberships', function (Blueprint $table) {
+            $table->boolean('use_parent_as_substitute')->default(false);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('bar_memberships', function (Blueprint $table) {
+            $table->dropColumn('use_parent_as_substitute');
+        });
+    }
+};

docs/open-api-spec.yml

@@ -3040,6 +3040,9 @@ components:
         is_shelf_public:
           type: boolean
           example: false
+        use_parent_as_substitute:
+          type: boolean
+          example: false
     UserRequest:
       type: object
       required: