feat(onboarding): add onboarding steps and completion checks for menus

Author: sampoyigi

resources/lang/en/default.php

@@ -633,5 +633,8 @@
         'text_delivery_order_count' => 'Number of Delivery Orders',
         'text_canceled_order_total' => 'Total Canceled Orders',
         'text_canceled_order_count' => 'Number of Canceled Orders',
+        'text_onboarding_menus' => 'Build your menu',
+
+        'help_onboarding_menus' => 'Add your dishes, organize them into categories, and set prices. This is what your hungry customers will browse and order from.',
     ],
 ];

resources/models/inventory.php

@@ -27,7 +27,8 @@
     'stockable_type_name' => [
         'label' => 'lang:igniter.cart::default.stocks.column_stockable_type',
         'type' => 'text',
-        'searchable' => true,
+        'select' => 'stockable_type',
+        'searchable' => false,
     ],
     'stockable_name' => [
         'label' => 'lang:igniter.cart::default.stocks.column_stockable_name',

src/Extension.php

@@ -472,4 +472,18 @@ protected function registerMiddlewares(): void
             $this->app['router']->pushMiddlewareToGroup('igniter', CartMiddleware::class);
         }
     }
+
+    public function registerOnboardingSteps(): array
+    {
+        return [
+            'igniter.cart::menus' => [
+                'label' => 'igniter.cart::default.dashboard.text_onboarding_menus',
+                'description' => 'igniter.cart::default.dashboard.help_onboarding_menus',
+                'icon' => 'fa-cutlery',
+                'url' => admin_url('menus'),
+                'priority' => 30,
+                'complete' => Menu::onboardingIsComplete(...),
+            ],
+        ];
+    }
 }

src/FormWidgets/StockEditor.php

@@ -95,6 +95,8 @@ public function onSaveRecord(): array
 
         flash()->success(sprintf(lang('igniter::admin.alert_success'), lang('igniter.cart::default.stocks.text_form_name').' updated'))->now();
 
+        $this->model->refresh();
+
         $this->prepareVars();
 
         return [

src/Models/Menu.php

@@ -145,6 +145,11 @@ public static function getDropdownOptions()
         return self::whereIsEnabled()->pluck('menu_name', 'menu_id');
     }
 
+    public static function onboardingIsComplete(): bool
+    {
+        return self::whereIsEnabled()->count() > 0;
+    }
+
     //
     // Helpers
     //

tests/ExtensionTest.php

@@ -174,6 +174,13 @@
     expect(collect($items['core'])->firstWhere('code', 'order'))->not->toBeNull();
 });
 
+it('registers onboarding steps', function(): void {
+    $steps = $this->extension->registerOnboardingSteps();
+
+    expect($steps)->toHaveKey('igniter.cart::menus')
+        ->and($steps['igniter.cart::menus']['label'])->toBe('igniter.cart::default.dashboard.text_onboarding_payments');
+});
+
 it('restores cart session on login correctly', function(): void {
     CartSettings::set('abandoned_cart', 1);
     $customer = Customer::factory()->create();

tests/Models/MenuTest.php

@@ -26,6 +26,22 @@
     expect($options->isNotEmpty())->toBeTrue();
 });
 
+it('returns true if onboarding is complete', function(): void {
+    Menu::factory()->create(['menu_status' => 1]);
+
+    $result = Menu::onboardingIsComplete();
+
+    expect($result)->toBeTrue();
+});
+
+it('returns false if onboarding is not complete', function(): void {
+    Menu::query()->update(['status' => 0]);
+
+    $result = Menu::onboardingIsComplete();
+
+    expect($result)->toBeFalse();
+});
+
 it('returns menu_price_from attribute', function(): void {
     $menu = Menu::factory()->create(['menu_price' => 10.00]);