ready for 4.0

Author: forxer

CHANGELOG.md

@@ -1,6 +1,15 @@
 CHANGELOG
 =========
 
+4.0.0 (2024-05-26)
+------------------
+
+- Added support for Laravel 11.0
+- Removed support for PHP prior to 8.2
+- Removed support for Laravel prior to 10.0
+- Removed support for `forxer/gravatar` prior to 5.0
+
+
 3.0.0 (2023-03-22)
 ------------------
 
@@ -23,7 +32,7 @@ CHANGELOG
 
 - Removed support for PHP prior to 8.0
 - Removed support for Laravel prior to 8.0
-- Use at least `forxer/gravatar` 4.0
+- Removed support for `forxer/gravatar` prior to 4.0
 - Renamed `forxer\LaravelGravatar\` namespace to `LaravelGravatar\`
 
 

README.md

@@ -25,6 +25,7 @@ Index
 - [Installation](#installation)
 - [Usage](#usage)
     - [Retrieve instances](#retrieve-instances)
+    - [Retrieve the Gravatar URL](#retrieve-the-gravatar-url)
     - [Show directly in your views](#show-directly-in-your-views)
 - [Mandatory parameter](#mandatory-parameter)
 - [Optional parameters](#optional-parameters)
@@ -41,10 +42,11 @@ Index
 Requirements
 ------------
 
-- PHP 8.0 or newer
-- Laravel 8.0 or newer
+- PHP 8.2 or newer
+- Laravel 10.0 or newer
+
+If you want to use it with a version earlier than PHP 8.2 and/or a version earlier than Laravel 10, please use [version 2](https://github.com/forxer/laravel-gravatar/tree/2.x) or [version 1](https://github.com/forxer/laravel-gravatar/tree/1.x).
 
-If you want to use it with a version earlier than PHP 8 and/or a version earlier than Laravel 8, please use [version 1](https://github.com/forxer/laravel-gravatar/tree/1.x).
 
 Installation
 ------------
@@ -76,7 +78,7 @@ Whatever method you use, you could use the `url()` method to retrieve it. Or dis
 
 ### Retrieve instances
 
-With the helper
+With the helper:
 
 ```php
 $gravatar = gravatar();
@@ -130,8 +132,22 @@ class UserController
 }
 ```
 
+### Retrieve the Gravatar URL
+
+Simply use the `url()` method.
+
+```php
+$gravatar = gravatar('email@example.com');
+$gravatarUrl = $gravatar->url();
+
+$gravatar = Gravatar::avatar('email@example.com');
+$gravatarUrl = $gravatar->url();
+```
+
 ### Show directly in your views
 
+As classes implement the `toString()` method you can use instances directly.
+
 ```blade
 <img src="{{ gravatar('email@example.com') }}">
 
@@ -142,6 +158,7 @@ class UserController
 
 [Back to top ^](#gravatar-for-laravel)
 
+
 Mandatory parameter
 -------------------
 
@@ -164,6 +181,7 @@ These previous examples are also valid for the profile.
 
 [Back to top ^](#gravatar-for-laravel)
 
+
 Optional parameters
 -------------------
 
@@ -347,6 +365,7 @@ $avatar = gravatar('email@example.com')
 
 [Back to top ^](#gravatar-for-laravel)
 
+
 Image presets
 -------------
 
@@ -420,15 +439,21 @@ $gravatarImage->preset('small');
 
 [Back to top ^](#gravatar-for-laravel)
 
+
 Casts
 -----
 
 Let's imagine that your user model has a column "gravatar" which represents the email to use. You can cast this attribute to directly obtain an instance of `LaravelGravatar\Image`:
 
 ```php
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Model;
 use LaravelGravatar\Casts\GravatarImage;
 
-class Post extends Model
+class User extends Model
 {
     protected $casts = [
         'gravatar' => GravatarImage::class,
@@ -472,7 +497,7 @@ You can also cast to an instance of `LaravelGravatar\Profile`:
 ```php
 use LaravelGravatar\Casts\GravatarProfile;
 
-class Post extends Model
+class User extends Model
 {
     protected $casts = [
         'gravatar' => GravatarProfile::class,

UPGRADE.md

@@ -1,6 +1,12 @@
 UPGRADE
 =======
 
+From 3.x to 4.x
+---------------
+
+This package now requires at least **PHP 8.2** and **Laravel 10**, your project must correspond to this prerequisites.
+
+
 From 2.x to 3.x
 ---------------
 

composer.json

@@ -21,7 +21,7 @@
     "require": {
         "php": "^8.2",
         "laravel/framework": "^10.0 || ^11.0",
-        "forxer/gravatar": "^4.0"
+        "forxer/gravatar": "^5.0"
     },
     "require-dev": {
         "laravel/pint": "^1.16.0",

rector.php

@@ -7,6 +7,7 @@
 use Rector\CodingStyle\Rector\PostInc\PostIncDecToPreIncDecRector;
 use Rector\Config\RectorConfig;
 use Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector;
+use Rector\Set\ValueObject\LevelSetList;
 use Rector\Set\ValueObject\SetList;
 use RectorLaravel\Rector\FuncCall\RemoveDumpDataDeadCodeRector;
 use RectorLaravel\Rector\PropertyFetch\OptionalToNullsafeOperatorRector;
@@ -62,13 +63,12 @@
 
     $rectorConfig->sets([
         LaravelSetList::LARAVEL_FACADE_ALIASES_TO_FULL_NAMES,
+        LevelSetList::UP_TO_PHP_82,
         SetList::PHP_82,
         SetList::DEAD_CODE,
         SetList::CODE_QUALITY,
-        //SetList::CODING_STYLE,
-        //SetList::NAMING,
+        SetList::CODING_STYLE,
         SetList::TYPE_DECLARATION,
-        //SetList::PRIVATIZATION,
         SetList::EARLY_RETURN,
         SetList::INSTANCEOF,
     ]);

src/Casts/GravatarImage.php

@@ -4,41 +4,24 @@
 
 namespace LaravelGravatar\Casts;
 
-use Gravatar\Image;
-use Illuminate\Contracts\Container\BindingResolutionException;
+use Illuminate\Container\Container;
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Database\Eloquent\Model;
 
 class GravatarImage implements CastsAttributes
 {
-    protected $presetName;
-
-    /**
-     * Constructor.
-     */
-    public function __construct(?string $presetName = null)
-    {
-        $this->presetName = $presetName;
+    public function __construct(
+        protected ?string $presetName = null
+    ) {
     }
 
-    /**
-     * Cast the given value.
-     *
-     * @return Image
-     *
-     * @throws BindingResolutionException
-     */
     public function get(Model $model, string $key, mixed $value, array $attributes)
     {
-        return app()->make('gravatar')->image($value)->setPreset($this->presetName);
+        return Container::getInstance()->make('gravatar')
+            ->image($value)
+            ->setPreset($this->presetName);
     }
 
-    /**
-     * Prepare the given value for storage.
-     *
-     * @param  mixed|null  $value
-     * @return mixed
-     */
     public function set(Model $model, string $key, mixed $value, array $attributes)
     {
         return $value;

src/Image.php

@@ -12,11 +12,6 @@ class Image extends GravatarImage
 {
     protected ?string $presetName = null;
 
-    /**
-     * Construct Image instance
-     *
-     * @return void
-     */
     public function __construct(
         private array $config,
         ?string $email = null,
@@ -33,8 +28,6 @@ public function __construct(
 
     /**
      * Build the avatar URL based on the provided settings.
-     *
-     * @return string The URL to the gravatar.
      */
     public function url(): string
     {
@@ -45,10 +38,8 @@ public function url(): string
 
     /**
      * Get or set the preset name to be used.
-     *
-     * @param  string|null  $email
      */
-    public function preset(?string $presetName = null): Image|string|null
+    public function preset(?string $presetName = null): self|string|null
     {
         if ($presetName === null) {
             return $this->getPreset();
@@ -59,8 +50,6 @@ public function preset(?string $presetName = null): Image|string|null
 
     /**
      * Get the preset name to be used.
-     *
-     * @return int The current avatar size in use.
      */
     public function getPreset(): ?string
     {
@@ -70,7 +59,7 @@ public function getPreset(): ?string
     /**
      * Set the preset name to be used.
      */
-    public function setPreset(?string $presetName): Image
+    public function setPreset(?string $presetName): self
     {
         $this->presetName = $presetName;
 
@@ -90,15 +79,15 @@ private function applyPreset(): Image
 
         $presetValues = $this->presetValues();
 
-        if (empty($presetValues)) {
+        if ($presetValues === []) {
             return $this;
         }
 
         foreach ($presetValues as $k => $v) {
             if (! \in_array($k, $this->allowedSetterPresetKeys())) {
                 throw new InvalidArgumentException(
-                    "Gravatar image could not find method to use \"$k\" key".
-                    'Allowed preset keys are: '.implode(',', $this->allowedSetterPresetKeys()).'.'
+                    sprintf('Gravatar image could not find method to use "%s" key', $k).
+                    sprintf('Allowed preset keys are: "%s".', implode('", "', $this->allowedSetterPresetKeys()))
                 );
             }
 
@@ -129,27 +118,38 @@ private function presetValues(): array
 
         if (empty($this->config['presets']) || ! \is_array($this->config['presets'])) {
             throw new InvalidArgumentException('Unable to retrieve Gravatar presets array configuration.');
-        } elseif (! isset($this->config['presets'][$this->presetName])) {
-            throw new InvalidArgumentException("Unable to retrieve Gravatar preset values, \"{$this->presetName}\" is probably a wrong preset name.");
+        }
+
+        if (! isset($this->config['presets'][$this->presetName])) {
+            throw new InvalidArgumentException(sprintf('Unable to retrieve Gravatar preset values, "%s" is probably a wrong preset name.', $this->presetName));
         }
 
         $presetValues = $this->config['presets'][$this->presetName];
 
         if (empty($presetValues) || ! \is_array($presetValues)) {
-            throw new InvalidArgumentException("Unable to retrieve Gravatar \"{$this->presetName}\" preset values.");
+            throw new InvalidArgumentException(sprintf('Unable to retrieve Gravatar "%s" preset values.', $this->presetName));
         }
 
         return $presetValues;
     }
 
-    private function allowedSetterPresetKeys()
+    private function allowedSetterPresetKeys(): array
     {
         return [
-            'size', 's',
-            'default_image', 'd',
-            'max_rating', 'r',
-            'extension', 'e',
-            'force_default', 'f',
+            'size',
+            's',
+
+            'default_image',
+            'd',
+
+            'max_rating',
+            'r',
+
+            'extension',
+            'e',
+
+            'force_default',
+            'f',
         ];
     }
 }

src/ServiceProvider.php

@@ -8,14 +8,14 @@
 
 class ServiceProvider extends BaseServiceProvider
 {
-    public function register()
+    public function register(): void
     {
         $this->mergeConfigFrom(__DIR__.'/../config/gravatar.php', 'gravatar');
 
-        $this->app->singleton('gravatar', fn ($app) => new Gravatar($app['config']['gravatar']));
+        $this->app->singleton('gravatar', fn ($app): Gravatar => new Gravatar($app['config']['gravatar']));
     }
 
-    public function boot()
+    public function boot(): void
     {
         if ($this->app->runningInConsole()) {
             $this->publishes([

src/helpers.php

@@ -3,18 +3,16 @@
 declare(strict_types=1);
 
 use Gravatar\Image;
+use Illuminate\Container\Container;
 use LaravelGravatar\Gravatar;
 
 if (! function_exists('gravatar')) {
-    /**
-     * Return a gravatar instance.
-     */
     function gravatar(?string $email = null, ?string $presetName = null): Gravatar|Image
     {
         if ($email === null) {
-            return app()->make('gravatar');
+            return Container::getInstance()->make('gravatar');
         }
 
-        return app()->make('gravatar')->image($email, $presetName);
+        return Container::getInstance()->make('gravatar')->image($email, $presetName);
     }
 }