feat: generate unique avatar on contact creation (monicahq/chandler#64)

app/Helpers/AvatarHelper.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace App\Helpers;
+
+use App\Models\Avatar;
+use App\Models\Contact;
+use App\Models\MultiAvatar;
+use Faker\Factory as Faker;
+
+class AvatarHelper
+{
+    /**
+     * Generate a new random avatar.
+     *
+     * The Multiavatar library takes a name to generate a unique avatar.
+     * However, contacts can be created in Monica without a name. When this case
+     * happens, we'll generate a fake name for the contact, and generate an avatar
+     * based on that name.
+     *
+     * @param  Contact  $contact
+     * @return Avatar
+     */
+    public static function generateRandomAvatar(Contact $contact): Avatar
+    {
+        $multiavatar = new MultiAvatar();
+
+        if (is_null($contact->first_name)) {
+            $name = Faker::create()->name();
+        } else {
+            $name = $contact->first_name.' '.$contact->last_name;
+        }
+
+        $svgCode = $multiavatar($name, null, null);
+
+        $avatar = Avatar::create([
+            'contact_id' => $contact->id,
+            'type' => Avatar::TYPE_GENERATED,
+            'svg' => $svgCode,
+        ]);
+
+        return $avatar;
+    }
+
+    /**
+     * Get the avatar of a contact.
+     *
+     * @param  Contact  $contact
+     * @return string
+     */
+    public static function getSVG(Contact $contact): string
+    {
+        $avatar = $contact->avatar;
+
+        return $avatar->svg;
+    }
+}

app/Helpers/NameHelper.php

@@ -10,6 +10,11 @@ class NameHelper
     /**
      * Format the name of the contact according to the user preferences.
      *
+     * Users can format the name however they want, using variables like
+     * %first_name%, %last_name%, %middle_name%, %nickname%, %maiden_name%, and
+     * so on). We need to parse this string and replace the variables with the
+     * appropriate values.
+     *
      * @param  User  $user
      * @param  Contact  $contact
      * @return string

app/Models/Avatar.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+
+class Avatar extends Model
+{
+    use HasFactory;
+
+    protected $table = 'avatars';
+
+    /**
+     * Possible type.
+     */
+    const TYPE_GENERATED = 'generated';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'contact_id',
+        'type',
+        'svg',
+    ];
+
+    /**
+     * Get the contact associated with the contact log.
+     *
+     * @return BelongsTo
+     */
+    public function contact()
+    {
+        return $this->belongsTo(Contact::class);
+    }
+}

app/Models/Contact.php

@@ -33,6 +33,7 @@ class Contact extends Model
         'last_updated_at',
         'company_id',
         'job_position',
+        'avatar_id',
     ];
 
     /**
@@ -235,6 +236,26 @@ public function company(): BelongsTo
         return $this->belongsTo(Company::class);
     }
 
+    /**
+     * Get the current avatar associated with the contact.
+     *
+     * @return BelongsTo
+     */
+    public function avatar(): BelongsTo
+    {
+        return $this->belongsTo(Avatar::class);
+    }
+
+    /**
+     * Get the avatars associated with the contact.
+     *
+     * @return HasMany
+     */
+    public function avatars()
+    {
+        return $this->hasMany(Avatar::class);
+    }
+
     /**
      * Get the name of the contact, according to the user preference.
      *