Merge pull request #11 from francoism90/master

Add findOrFail

Author: freekmurze

README.md

@@ -19,9 +19,10 @@ The package can retrieve the model for a given prefixed id.
 ```php
 // on a specific model
 User::findByPrefixedId('user_fj39fj3lsmxlsl'); // returns a User model or `null`
+User::findByPrefixedIdOrFail('user_fj39fj3lsmxlsl'); // returns a User model or throws `NoPrefixedModelFound`
 
 // automatically determine the model of a given prefixed id
-$user = PrefixedIds::getModel('user_fj39fj3lsmxlsl') // returns the right model for the id or `null`;
+$user = PrefixedIds::getModelClass('user_fj39fj3lsmxlsl') // returns the right model for the id or `null`;
 ```
 
 ## Support us
@@ -84,6 +85,7 @@ Typically, you would put the code above in a service provider.
 ### Publish the config file
 
 Optionally, You can publish the config file with:
+
 ```bash
 php artisan vendor:publish --provider="Spatie\PrefixedIds\PrefixedIdsServiceProvider" --tag="prefixed-ids-config"
 ```
@@ -115,6 +117,7 @@ You can find the model with a given prefix by calling `findByPrefixedId` on it.
 ```php
 YourModel::findByPrefixedId('your_model_fekjlmsme39dmMS'); // returns an instance of `YourModel`
 YourModel::findByPrefixedId('non-existing-id'); // returns null
+YourModel::findByPrefixedIdOrFail('non-existing-id'); // throws `NoPrefixedModelFound`
 ```
 
 ### Finding across models
@@ -124,6 +127,7 @@ You can call `find` on `Spatie\PrefixedIds\PrefixedIds` to automatically get the
 ```php
 $yourModel = Spatie\PrefixedIds\PrefixedIds::find('your_model_fekjlmsme39dmMS'); // returns an instance of `YourModel` or `null`
 $otherModel = Spatie\PrefixedIds\PrefixedIds::find('other_model_3Fjmmfsmls'); // returns an instance of `OtherModel` or `null`
+$otherModel = Spatie\PrefixedIds\PrefixedIds::findOrFail('other_model_3Fjmmfsmls'); // returns an instance of `OtherModel` or throws `NoPrefixedModelFound`
 ```
 
 ## Using the prefixed ids in your routes

src/Exceptions/NoPrefixedModelFound.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Spatie\PrefixedIds\Exceptions;
+
+use Exception;
+use Facade\IgnitionContracts\BaseSolution;
+use Facade\IgnitionContracts\ProvidesSolution;
+use Facade\IgnitionContracts\Solution;
+
+class NoPrefixedModelFound extends Exception implements ProvidesSolution
+{
+    public static function make(string $prefixedId)
+    {
+        return new static("Could not find a prefixed model `{$prefixedId}`");
+    }
+
+    public function getSolution(): Solution
+    {
+        return BaseSolution::create('Make sure the prefix of the model exists')
+            ->setSolutionDescription("You should make sure your model has a valid `prefixed_id`")
+            ->setDocumentationLinks([
+                'Documentation' => 'https://github.com/spatie/laravel-prefixed-ids#usage',
+            ]);
+    }
+}

src/Models/Concerns/HasPrefixedId.php

@@ -5,6 +5,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Str;
 use Spatie\PrefixedIds\Exceptions\NoPrefixConfiguredForModel;
+use Spatie\PrefixedIds\Exceptions\NoPrefixedModelFound;
 use Spatie\PrefixedIds\PrefixedIds;
 
 trait HasPrefixedId
@@ -32,6 +33,15 @@ public static function findByPrefixedId(string $prefixedId): ?Model
         return static::firstWhere($attributeName, $prefixedId);
     }
 
+    public static function findByPrefixedIdOrFail(string $prefixedId): Model
+    {
+        if (is_null($model = static::findByPrefixedId($prefixedId))) {
+            throw NoPrefixedModelFound::make($prefixedId);
+        }
+
+        return $model;
+    }
+
     protected function getIdPrefix(): string
     {
         $prefix = PrefixedIds::getPrefixForModel(static::class);

src/PrefixedIds.php

@@ -3,6 +3,7 @@
 namespace Spatie\PrefixedIds;
 
 use Illuminate\Database\Eloquent\Model;
+use Spatie\PrefixedIds\Exceptions\NoPrefixedModelFound;
 
 class PrefixedIds
 {
@@ -41,6 +42,15 @@ public static function find(string $prefixedId): ?Model
         return $modelClass::findByPrefixedId($prefixedId);
     }
 
+    public static function findOrFail(string $prefixedId): ?Model
+    {
+        if (! $modelClass = static::getModelClass($prefixedId)) {
+            throw NoPrefixedModelFound::make($prefixedId);
+        }
+
+        return $modelClass::findByPrefixedIdOrFail($prefixedId);
+    }
+
     public static function getModelClass(string $prefixedId): ?string
     {
         foreach (static::$registeredModels as $prefix => $modelClass) {

tests/PrefixedIdsTest.php

@@ -3,6 +3,7 @@
 namespace Spatie\PrefixedIds\Tests;
 
 use Spatie\PrefixedIds\Exceptions\NoPrefixConfiguredForModel;
+use Spatie\PrefixedIds\Exceptions\NoPrefixedModelFound;
 use Spatie\PrefixedIds\PrefixedIds;
 use Spatie\PrefixedIds\Tests\TestClasses\Models\OtherTestModel;
 use Spatie\PrefixedIds\Tests\TestClasses\Models\TestModel;
@@ -78,4 +79,44 @@ public function it_can_find_the_right_model_for_the_given_prefixed_id()
         $nonExistingModel = PrefixedIds::find('non-existing-id');
         $this->assertNull($nonExistingModel);
     }
+
+    /** @test */
+    public function a_model_can_find_or_fail_a_record_with_the_given_prefixed_id()
+    {
+        $testModel = TestModel::create();
+
+        $foundModel = TestModel::findByPrefixedIdOrFail($testModel->prefixed_id);
+        $this->assertEquals($testModel->id, $foundModel->id);
+    }
+
+    /** @test */
+    public function it_throws_exception_on_invalid_prefixed_id()
+    {
+        $this->expectException(NoPrefixedModelFound::class);
+
+        TestModel::findByPrefixedIdOrFail('non_existing');
+    }
+
+    // /** @test */
+    public function it_can_find_or_fail_the_right_model_for_the_given_prefixed_id()
+    {
+        $testModel = TestModel::create();
+        $otherTestModel = OtherTestModel::create();
+
+        $foundModel = PrefixedIds::findOrFail($testModel->prefixed_id);
+        $this->assertInstanceOf(TestModel::class, $foundModel);
+        $this->assertEquals($testModel->id, $foundModel->id);
+
+        $otherFoundModel = PrefixedIds::findOrFail($otherTestModel->prefixed_id);
+        $this->assertInstanceOf(OtherTestModel::class, $otherFoundModel);
+        $this->assertEquals($testModel->id, $otherFoundModel->id);
+    }
+
+    // /** @test */
+    public function it_throws_exception_on_invalid_given_model_prefixed_id()
+    {
+        $this->expectException(NoPrefixedModelFound::class);
+
+        PrefixedIds::findOrFail('non-existing-id');
+    }
 }