Allow to override Book class

aguingand · aguingand · commit 6d8c967488ab · 2024-12-13T15:35:06.000+01:00
diff --git a/config/titelive-client.php b/config/titelive-client.php
@@ -16,4 +16,5 @@
             ],
         ],
     ],
+    'book_model_class' => \Code16\LaravelTiteliveClient\Models\Book::class,
 ];
diff --git a/database/factories/BookFactory.php b/database/factories/BookFactory.php
@@ -2,13 +2,11 @@
 
 namespace Code16\LaravelTiteliveClient\Database\Factories;
 
-use Code16\LaravelTiteliveClient\Book;
+
 use Illuminate\Database\Eloquent\Factories\Factory;
 
 class BookFactory extends Factory
 {
-    protected $model = Book::class;
-
     private static int $VISUAL_INDEX = 0;
 
     private static array $VISUALS = [
@@ -75,6 +73,11 @@ class BookFactory extends Factory
         '613/9782075150613',
     ];
 
+    public function modelName()
+    {
+        return config('titelive-client.book_model_class');
+    }
+
     public function definition()
     {
         return [
diff --git a/src/Api/Clients/BookCache.php b/src/Api/Clients/BookCache.php
@@ -2,7 +2,7 @@
 
 namespace Code16\LaravelTiteliveClient\Api\Clients;
 
-use Code16\LaravelTiteliveClient\Book;
+use Code16\LaravelTiteliveClient\Models\Book;
 
 interface BookCache
 {
diff --git a/src/Api/Clients/BookCacheMockForDev.php b/src/Api/Clients/BookCacheMockForDev.php
@@ -2,7 +2,7 @@
 
 namespace Code16\LaravelTiteliveClient\Api\Clients;
 
-use Code16\LaravelTiteliveClient\Book;
+use Code16\LaravelTiteliveClient\Models\Book;
 
 class BookCacheMockForDev implements BookCache
 {
diff --git a/src/Api/Clients/BookDirectoryClient.php b/src/Api/Clients/BookDirectoryClient.php
@@ -2,7 +2,7 @@
 
 namespace Code16\LaravelTiteliveClient\Api\Clients;
 
-use Code16\LaravelTiteliveClient\Book;
+use Code16\LaravelTiteliveClient\Models\Book;
 use Illuminate\Support\Collection;
 
 interface BookDirectoryClient
diff --git a/src/Api/Clients/BookDirectoryMockClientForDev.php b/src/Api/Clients/BookDirectoryMockClientForDev.php
@@ -2,11 +2,14 @@
 
 namespace Code16\LaravelTiteliveClient\Api\Clients;
 
-use Code16\LaravelTiteliveClient\Book;
+use Code16\LaravelTiteliveClient\Concerns\UsesBookModel;
+use Code16\LaravelTiteliveClient\Models\Book;
 use Illuminate\Support\Collection;
 
 class BookDirectoryMockClientForDev implements BookDirectoryClient
 {
+    use UsesBookModel;
+
     private array $params = [];
 
     public function getParams(): array
diff --git a/src/Api/Clients/RandomBasedOnRefreshDateBookCache.php b/src/Api/Clients/RandomBasedOnRefreshDateBookCache.php
@@ -4,7 +4,7 @@
 
 use Carbon\Carbon;
 use Code16\LaravelTiteliveClient\Api\FindBook;
-use Code16\LaravelTiteliveClient\Book;
+use Code16\LaravelTiteliveClient\Models\Book;
 
 /**
  * This cache strategy is based on a simple rule:
diff --git a/src/Api/Clients/TiteLive/TiteLiveClient.php b/src/Api/Clients/TiteLive/TiteLiveClient.php
@@ -5,7 +5,8 @@
 use Cache;
 use Carbon\Carbon;
 use Code16\LaravelTiteliveClient\Api\Clients\BookDirectoryClient;
-use Code16\LaravelTiteliveClient\Book;
+use Code16\LaravelTiteliveClient\Concerns\UsesBookModel;
+use Code16\LaravelTiteliveClient\Models\Book;
 use GuzzleHttp\Cookie\SetCookie;
 use Illuminate\Http\Client\RequestException;
 use Illuminate\Support\Arr;
@@ -16,6 +17,8 @@
 
 class TiteLiveClient implements BookDirectoryClient
 {
+    use UsesBookModel;
+
     protected string $endpoint;
 
     protected string $login_endpoint;
@@ -282,7 +285,7 @@ private function mapBookFromApiResult(array $book, array $edition): ?Book
             return null;
         }
 
-        return new Book([
+        return static::bookModelClass()::make([
             'id' => $edition['gencod'],
             'title' => $book['titre'],
             'description' => $edition['resume'] ?? null,
diff --git a/src/Api/SuggestBooksFromAuthors.php b/src/Api/SuggestBooksFromAuthors.php
@@ -3,7 +3,7 @@
 namespace Code16\LaravelTiteliveClient\Api;
 
 use Code16\LaravelTiteliveClient\Api\Clients\BookDirectoryClient;
-use Code16\LaravelTiteliveClient\Book;
+use Code16\LaravelTiteliveClient\Models\Book;
 use Illuminate\Support\Collection;
 
 class SuggestBooksFromAuthors extends CacheableAction
diff --git a/src/Api/SuggestOtherEditions.php b/src/Api/SuggestOtherEditions.php
@@ -3,7 +3,7 @@
 namespace Code16\LaravelTiteliveClient\Api;
 
 use Code16\LaravelTiteliveClient\Api\Clients\BookDirectoryClient;
-use Code16\LaravelTiteliveClient\Book;
+use Code16\LaravelTiteliveClient\Models\Book;
 use Illuminate\Support\Collection;
 
 class SuggestOtherEditions extends CacheableAction
diff --git a/src/Book.php b/src/Book.php
@@ -2,97 +2,10 @@
 
 namespace Code16\LaravelTiteliveClient;
 
-use Code16\LaravelTiteliveClient\Database\Factories\BookFactory;
-use Code16\LaravelTiteliveClient\Enum\BookAvailability;
-use Illuminate\Database\Eloquent\Casts\Attribute;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
-use Illuminate\Database\Eloquent\Model;
-use Illuminate\Support\Str;
-use JsonSerializable;
-
-class Book extends Model implements JsonSerializable
+/**
+ * @deprecated create a Book model in project extending
+ * @see \Code16\LaravelTiteliveClient\Models\Book & update config with `book_model_class`
+ */
+class Book extends \Code16\LaravelTiteliveClient\Models\Book
 {
-    use HasFactory;
-
-    protected $guarded = [];
-
-    protected $casts = [
-        'id' => 'string',
-        'published_date' => 'date',
-        'availability' => BookAvailability::class,
-    ];
-
-    protected static ?string $fallbackVisualUrl = null;
-
-    protected static function newFactory()
-    {
-        return new BookFactory;
-    }
-
-    protected function url(): Attribute
-    {
-        return Attribute::make(
-            get: fn () => route('book.show', [
-                'id' => $this->id,
-                'slug' => Str::slug($this->title),
-            ])
-        );
-    }
-
-    protected function shortDetails(): Attribute
-    {
-        return Attribute::make(
-            get: fn () => collect([
-                collect($this->authors)->join(', '),
-                $this->editor,
-            ])
-                ->filter()
-                ->join(' — ')
-        );
-    }
-
-    public function hasStock(): bool
-    {
-        return $this->stock > 0;
-    }
-
-    public function canBeOrdered(): bool
-    {
-        if (config('titelive-client.shopping_closed')) {
-            return false;
-        }
-
-        return $this->availability != BookAvailability::Forthcoming
-            && ($this->hasStock() || $this->availability == BookAvailability::AvailableOnDemand);
-    }
-
-    public function visual(string $size, ?string $fallbackUrl = null): ?string
-    {
-        $url = $this->visuals[$size] ?? null;
-
-        if (preg_match('/no_image\.png/', $url)) {
-            return $fallbackUrl ?: static::$fallbackVisualUrl ?: asset('/img/book-placeholder.png');
-        }
-
-        return $url;
-    }
-
-    public static function setFallbackVisualUrl(string $url): void
-    {
-        static::$fallbackVisualUrl = $url;
-    }
-
-    public function jsonSerialize(): array
-    {
-        return (new BookJsonResource($this))->jsonSerialize();
-    }
-
-    public function resolveRouteBinding($value, $field = null)
-    {
-        if (is_array($value)) {
-            return new static($value);
-        }
-
-        return null;
-    }
 }
diff --git a/src/BookJsonResource.php b/src/BookJsonResource.php
@@ -2,6 +2,7 @@
 
 namespace Code16\LaravelTiteliveClient;
 
+use Code16\LaravelTiteliveClient\Models\Book;
 use Illuminate\Http\Resources\Json\JsonResource;
 
 /**
diff --git a/src/Concerns/UsesBookModel.php b/src/Concerns/UsesBookModel.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace Code16\LaravelTiteliveClient\Concerns;
+
+use Code16\LaravelTiteliveClient\Models\Book;
+
+/**
+ * @internal
+ */
+trait UsesBookModel
+{
+    /**
+     * @return class-string<Book>
+     */
+    public static function bookModelClass(): string
+    {
+        return config('titelive-client.book_model_class');
+    }
+}
diff --git a/src/Models/Book.php b/src/Models/Book.php
@@ -0,0 +1,100 @@
+<?php
+/** @noinspection LaravelUnknownEloquentFactoryInspection */
+
+namespace Code16\LaravelTiteliveClient\Models;
+
+use Code16\LaravelTiteliveClient\BookJsonResource;
+use Code16\LaravelTiteliveClient\Database\Factories\BookFactory;
+use Code16\LaravelTiteliveClient\Enum\BookAvailability;
+use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Str;
+use JsonSerializable;
+
+class Book extends Model implements JsonSerializable
+{
+    use HasFactory;
+
+    protected $guarded = [];
+
+    protected $casts = [
+        'id' => 'string',
+        'published_date' => 'date',
+        'availability' => BookAvailability::class,
+    ];
+
+    protected static ?string $fallbackVisualUrl = null;
+
+    protected static function newFactory()
+    {
+        return new BookFactory;
+    }
+
+    protected function url(): Attribute
+    {
+        return Attribute::make(
+            get: fn () => route('book.show', [
+                'id' => $this->id,
+                'slug' => Str::slug($this->title),
+            ])
+        );
+    }
+
+    protected function shortDetails(): Attribute
+    {
+        return Attribute::make(
+            get: fn () => collect([
+                collect($this->authors)->join(', '),
+                $this->editor,
+            ])
+                ->filter()
+                ->join(' — ')
+        );
+    }
+
+    public function hasStock(): bool
+    {
+        return $this->stock > 0;
+    }
+
+    public function canBeOrdered(): bool
+    {
+        if (config('titelive-client.shopping_closed')) {
+            return false;
+        }
+
+        return $this->availability != BookAvailability::Forthcoming
+            && ($this->hasStock() || $this->availability == BookAvailability::AvailableOnDemand);
+    }
+
+    public function visual(string $size, ?string $fallbackUrl = null): ?string
+    {
+        $url = $this->visuals[$size] ?? null;
+
+        if (preg_match('/no_image\.png/', $url)) {
+            return $fallbackUrl ?: static::$fallbackVisualUrl ?: asset('/img/book-placeholder.png');
+        }
+
+        return $url;
+    }
+
+    public static function setFallbackVisualUrl(string $url): void
+    {
+        static::$fallbackVisualUrl = $url;
+    }
+
+    public function jsonSerialize(): array
+    {
+        return (new BookJsonResource($this))->jsonSerialize();
+    }
+
+    public function resolveRouteBinding($value, $field = null)
+    {
+        if (is_array($value)) {
+            return new static($value);
+        }
+
+        return null;
+    }
+}
diff --git a/src/Utils/HasBookAttribute.php b/src/Utils/HasBookAttribute.php
@@ -4,14 +4,16 @@
 
 use Code16\LaravelTiteliveClient\Api\Clients\BookCache;
 use Code16\LaravelTiteliveClient\Api\Clients\TiteLive\TiteLiveBookNotFoundException;
-use Code16\LaravelTiteliveClient\Book;
+use Code16\LaravelTiteliveClient\Concerns\UsesBookModel;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 
 /**
  * @mixin \Illuminate\Database\Eloquent\Model
  */
 trait HasBookAttribute
 {
+    use UsesBookModel;
+
     public function refreshBook(bool $force = false): self
     {
         try {
@@ -31,7 +33,7 @@ public function book(): Attribute
     {
         return Attribute::make(
             get: fn () => $this->attributes['book'] ?? null
-                ? new Book($this->fromJson($this->attributes['book']))
+                ? static::bookModelClass()::make($this->fromJson($this->attributes['book']))
                 : null
         );
     }
diff --git a/src/Utils/HasBooksAttribute.php b/src/Utils/HasBooksAttribute.php
diff --git a/tests/Api/Clients/TiteliveClientTest.php b/tests/Api/Clients/TiteliveClientTest.php
diff --git a/tests/Api/SuggestBooksFromAuthorsTest.php b/tests/Api/SuggestBooksFromAuthorsTest.php
diff --git a/tests/Api/SuggestOtherEditionsTest.php b/tests/Api/SuggestOtherEditionsTest.php
diff --git a/tests/Utils/BookDirectoryFakeClient.php b/tests/Utils/BookDirectoryFakeClient.php

-Original file line number
+Diff line change
             ],
         ],
     ],
 +    'book_model_class' => \Code16\LaravelTiteliveClient\Models\Book::class,
 ];
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Code16\LaravelTiteliveClient\Api\Clients;`
`4`	`4`
`5`		`-use Code16\LaravelTiteliveClient\Book;`
	`5`	`+use Code16\LaravelTiteliveClient\Models\Book;`
`6`	`6`
`7`	`7`	`interface BookCache`
`8`	`8`	`{`