Refactor for v2

Author: riasvdv

README.md

@@ -26,12 +26,12 @@ composer require spatie/laravel-onboard
 
 ## Usage
 
-Add the `Spatie\Onboard\GetsOnboarded` trait to your app's `User` model.
+Add the `Spatie\Onboard\Concerns\GetsOnboarded` trait and `Spatie\Onboard\Concerns\Onboardable` interface to any model or class in your app, for example the `User` model:
 
 ```php
-class User extends Model
+class User extends Model implements \Spatie\Onboard\Concerns\Onboardable
 {
-    use \Spatie\Onboard\GetsOnboarded;
+    use \Spatie\Onboard\Concerns\GetsOnboarded;
     ...
 ```
 
@@ -41,25 +41,30 @@ Configure your steps in your `App\Providers\AppServiceProvider.php`
 
 ```php
 use App\User;
-use Spatie\Onboard\OnboardFacade;
+use Spatie\Onboard\Facades\Onboard;
 
 class AppServiceProvider extends ServiceProvider
 {
     // ...
 
     public function boot()
     {
-	    OnboardFacade::addStep('Complete Profile')
+	    Onboard::addStep('Complete Profile')
 	    	->link('/profile')
 	    	->cta('Complete')
-	    	->completeIf(function (User $user) {
+	    	/**
+             * The completeIf will pass the class that you've added the
+             * interface & trait to. You can use Laravel's dependency
+             * injection here to inject anything else as well.
+             */
+	    	->completeIf(function (User $model) {
 	    		return $user->profile->isComplete();
 	    	});
 
-	    OnboardFacade::addStep('Create Your First Post')
+	    Onboard::addStep('Create Your First Post')
 	    	->link('/post/create')
 	    	->cta('Create Post')
-	    	->completeIf(function (User $user) {
+	    	->completeIf(function (User $model) {
 	    		return $user->posts->count() > 0;
 	    	});
 ```
@@ -68,10 +73,9 @@ class AppServiceProvider extends ServiceProvider
 
 Now you can access these steps along with their state wherever you like. Here is an example blade template:
 
-```php
+```blade
 @if (auth()->user()->onboarding()->inProgress())
 	<div>
-
 		@foreach (auth()->user()->onboarding()->steps as $step)
 			<span>
 				@if($step->complete())
@@ -94,10 +98,13 @@ Now you can access these steps along with their state wherever you like. Here is
 Check out all the available features below:
 
 ```php
+/** @var \Spatie\Onboard\OnboardingManager $onboarding **/
 $onboarding = Auth::user()->onboarding();
 
 $onboarding->inProgress();
 
+$onboarding->percentageCompleted();
+
 $onboarding->finished();
 
 $onboarding->steps()->each(function($step) {
@@ -113,7 +120,7 @@ Definining custom attributes and accessing them:
 
 ```php
 // Defining the attributes
-OnboardFacade::addStep('Step w/ custom attributes')
+Onboard::addStep('Step w/ custom attributes')
 	->attributes([
 		'name' => 'Waldo',
 		'shirt_color' => 'Red & White',
@@ -126,7 +133,7 @@ $step->shirt_color;
 
 ### Example middleware
 
-If you want to ensure that your user is redirected to the next unfinished onboarding step, whenever they access your web application, you can use the following middleware as a starting point:
+If you want to ensure that your User is redirected to the next unfinished onboarding step, whenever they access your web application, you can use the following middleware as a starting point:
 
 ```php
 <?php

UPGRADING.md

@@ -0,0 +1,9 @@
+## Upgrading
+### Upgrading from v1 to v2
+
+* Support for PHP 7.4 has been dropped
+* Support for Laravel 7 and 8 has been dropped
+* The `\Spatie\Onboard\OnboardFacade` has been moved to `\Spatie\Onboard\Facades\Onboard`
+* The `\Spatie\Onboard\GetsOnboarded` trait has been moved to `\Spatie\Onboard\Concerns\GetsOnboarded`
+* You should add the new `\Spatie\Onboard\Concerns\Onboardable` interface to your `User` model
+* The `$user` parameter in the `completeIf` callbacks has been renamed to `$model`

composer.json

@@ -16,9 +16,10 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0|^8.1",
+        "php": "^8.0|^8.1",
+        "illuminate/contracts": "^7.0|^8.0|^9.0",
         "spatie/laravel-package-tools": "^1.9.2",
-        "illuminate/contracts": "^7.0|^8.0|^9.0"
+        "spatie/once": "^3.1"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.8",

src/Concerns/GetsOnboarded.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Spatie\Onboard\Concerns;
+
+use Illuminate\Support\Facades\App;
+use Spatie\Onboard\OnboardingManager;
+
+trait GetsOnboarded
+{
+    public function onboarding(): OnboardingManager
+    {
+        return App::make(OnboardingManager::class, ['model' => $this]);
+    }
+}

src/Concerns/Onboardable.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Spatie\Onboard\Concerns;
+
+use Spatie\Onboard\OnboardingManager;
+
+interface Onboardable
+{
+    public function onboarding(): OnboardingManager;
+}

src/Facades/Onboard.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Spatie\Onboard\Facades;
+
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Facade;
+use Spatie\Onboard\Concerns\Onboardable;
+use Spatie\Onboard\OnboardingStep;
+use Spatie\Onboard\OnboardingSteps;
+
+/**
+ * @method OnboardingStep addStep(string $title)
+ * @method Collection<OnboardingStep> steps(Onboardable $model)
+ */
+class Onboard extends Facade
+{
+    protected static function getFacadeAccessor(): string
+    {
+        return OnboardingSteps::class;
+    }
+}

src/GetsOnboarded.php

@@ -12,6 +12,6 @@ public function configurePackage(Package $package): void
         $package
             ->name('laravel-onboard');
 
-        $this->app->singleton(OnboardingSteps::class);
+        $this->app->scoped(OnboardingSteps::class);
     }
 }

src/OnboardFacade.php

@@ -2,75 +2,47 @@
 
 namespace Spatie\Onboard;
 
-/**
- * The gateway into the package. This class exposes the overall
- * state of the onboarding instance. It will typically be
- * accessed like so: $user->onboarding()
- */
+use Illuminate\Support\Collection;
+
 class OnboardingManager
 {
-    /**
-     * All defined onboarding steps.
-     *
-     * @var \Illuminate\Support\Collection
-     */
-    public $steps;
+    /** @var Collection<OnboardingStep> */
+    public Collection $steps;
 
-    /**
-     * Create the Onboarding Manager (should always be a singleton).
-     *
-     * @param mixed $user The parent app's user model.
-     * @param \Spatie\Onboard\OnboardingSteps $onboardingSteps
-     */
-    public function __construct($user, OnboardingSteps $onboardingSteps)
+    public function __construct($model, OnboardingSteps $onboardingSteps)
     {
-        $this->steps = $onboardingSteps->steps($user);
+        $this->steps = $onboardingSteps->steps($model);
     }
 
-    /**
-     * An accessor for the $steps property
-     *
-     * @return \Illuminate\Support\Collection
-     */
-    public function steps()
+    /** @return Collection<OnboardingStep> */
+    public function steps(): Collection
     {
         return $this->steps;
     }
 
-    /**
-     * Determine if the users's onboarding is still in progress.
-     *
-     * @return bool
-     */
-    public function inProgress()
+    public function inProgress(): bool
     {
         return ! $this->finished();
     }
 
-    /**
-     * Determine if the users's onboarding is complete.
-     *
-     * @return bool
-     */
-    public function finished()
+    public function finished(): bool
     {
-        return collect($this->steps)->filter(function ($step) {
-            // Leave only incomplete steps.
-            return $step->incomplete();
-        })
-            // Report onboarding is finished if no incomplete steps remain.
+        return $this->steps
+            ->filter(fn (OnboardingStep $step) => $step->incomplete())
             ->isEmpty();
     }
 
-    /**
-     * Get the next unfinished onboarding step, or null if already all steps are completed.
-     *
-     * @return null|OnboardingStep
-     */
-    public function nextUnfinishedStep()
+    public function nextUnfinishedStep(): ?OnboardingStep
     {
-        return collect($this->steps)->first(function ($step) {
-            return $step->incomplete();
-        });
+        return $this->steps->first(fn (OnboardingStep $step) => $step->incomplete());
+    }
+
+    public function percentageCompleted(): float
+    {
+        $totalCompleteSteps = $this->steps
+            ->filter(fn (OnboardingStep $step) => $step->complete())
+            ->count();
+
+        return $totalCompleteSteps / $this->steps->count() * 100;
     }
 }