Merge pull request #16446 from marcusmoore/feature/improve-checkout-asset-mail-wording

Improved wording in asset checkout emails

Author: snipe

app/Mail/CheckoutAssetMail.php

@@ -74,7 +74,7 @@ public function content(): Content
     {
         $this->item->load('assetstatus');
         $eula = method_exists($this->item, 'getEula') ? $this->item->getEula() : '';
-        $req_accept = method_exists($this->item, 'requireAcceptance') ? $this->item->requireAcceptance() : 0;
+        $req_accept = $this->requiresAcceptance();
         $fields = [];
 
         // Check if the item has custom fields associated with it
@@ -98,6 +98,7 @@ public function content(): Content
                 'accept_url'    => $accept_url,
                 'last_checkout' => $this->last_checkout,
                 'expected_checkin'  => $this->expected_checkin,
+                'introduction_line' => $this->introductionLine(),
             ],
         );
     }
@@ -120,4 +121,27 @@ private function getSubject(): string
 
         return trans('mail.unaccepted_asset_reminder');
     }
+
+    private function introductionLine(): string
+    {
+        if ($this->firstTimeSending && $this->requiresAcceptance()) {
+            return trans('mail.new_item_checked_with_acceptance');
+        }
+
+        if ($this->firstTimeSending && !$this->requiresAcceptance()) {
+            return trans('mail.new_item_checked');
+        }
+
+        if (!$this->firstTimeSending && $this->requiresAcceptance()) {
+            return trans('mail.recent_item_checked');
+        }
+
+        // we shouldn't get here but let's send a default message just in case
+        return trans('new_item_checked');
+    }
+
+    private function requiresAcceptance(): int|bool
+    {
+        return method_exists($this->item, 'requireAcceptance') ? $this->item->requireAcceptance() : 0;
+    }
 }

database/factories/AssetFactory.php

@@ -4,6 +4,7 @@
 
 use App\Models\Asset;
 use App\Models\AssetModel;
+use App\Models\Category;
 use App\Models\CustomField;
 use App\Models\Location;
 use App\Models\Statuslabel;
@@ -333,6 +334,15 @@ public function requiresAcceptance()
         });
     }
 
+    public function doesNotRequireAcceptance()
+    {
+        return $this->state(function () {
+            return [
+                'model_id' => AssetModel::factory()->doesNotRequireAcceptance(),
+            ];
+        });
+    }
+
     public function deleted()
     {
         return $this->state(function () {

database/factories/AssetModelFactory.php

@@ -448,4 +448,13 @@ public function hasMultipleCustomFields(array $fields = null)
             ];
         });
     }
+
+    public function doesNotRequireAcceptance()
+    {
+        return $this->state(function () {
+            return [
+                'category_id' => Category::factory()->doesNotRequireAcceptance(),
+            ];
+        });
+    }
 }

database/factories/CategoryFactory.php

@@ -207,4 +207,11 @@ public function forConsumables()
             'category_type' => 'consumable',
         ]);
     }
+
+    public function doesNotRequireAcceptance()
+    {
+        return $this->state([
+            'require_acceptance' => false,
+        ]);
+    }
 }

resources/lang/en-US/mail.php

@@ -66,6 +66,8 @@
     'min_QTY' => 'Min QTY',
     'name' => 'Name',
     'new_item_checked' => 'A new item has been checked out under your name, details are below.',
+    'new_item_checked_with_acceptance' => 'A new item has been checked out under your name that requires acceptance, details are below.',
+    'recent_item_checked' => 'An item was recently checked out under your name that requires acceptance, details are below.',
     'notes' => 'Notes',
     'password' => 'Password',
     'password_reset' => 'Password Reset',
@@ -88,7 +90,7 @@
     'upcoming-audits' => 'There is :count asset that is coming up for audit within :threshold days.|There are :count assets that are coming up for audit within :threshold days.',
     'user' => 'User',
     'username' => 'Username',
-    'unaccepted_asset_reminder' => 'You have Unaccepted Assets.',
+    'unaccepted_asset_reminder' => 'Reminder: You have Unaccepted Assets.',
     'welcome' => 'Welcome :name',
     'welcome_to' => 'Welcome to :web!',
     'your_assets' => 'View Your Assets',

resources/views/mail/markdown/checkout-asset.blade.php

@@ -1,7 +1,7 @@
 @component('mail::message')
 # {{ trans('mail.hello') }} {{ $target->present()->fullName() }},
 
-{{ trans('mail.new_item_checked') }}
+{{ $introduction_line }}
 
 @if (($snipeSettings->show_images_in_email =='1') && $item->getImageUrl())
 <center><img src="{{ $item->getImageUrl() }}" alt="Asset" style="max-width: 570px;"></center>
@@ -76,4 +76,4 @@
 
 {{ $snipeSettings->site_name }}
 
-@endcomponent
+@endcomponent

tests/Unit/Mail/CheckoutAssetMailTest.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Tests\Unit\Mail;
+
+use App\Mail\CheckoutAssetMail;
+use App\Models\Asset;
+use App\Models\CheckoutAcceptance;
+use App\Models\User;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Tests\TestCase;
+
+class CheckoutAssetMailTest extends TestCase
+{
+    public static function data()
+    {
+        yield 'Asset requiring acceptance' => [
+            function () {
+                $asset = Asset::factory()->requiresAcceptance()->create();
+                return [
+                    'asset' => $asset,
+                    'acceptance' => CheckoutAcceptance::factory()->for($asset, 'checkoutable')->create(),
+                    'first_time_sending' => true,
+                    'expected_subject' => 'Asset checked out',
+                    'expected_opening' => 'A new item has been checked out under your name that requires acceptance, details are below.'
+                ];
+            }
+        ];
+
+        yield 'Asset not requiring acceptance' => [
+            function () {
+                return [
+                    'asset' => Asset::factory()->doesNotRequireAcceptance()->create(),
+                    'acceptance' => null,
+                    'first_time_sending' => true,
+                    'expected_subject' => 'Asset checked out',
+                    'expected_opening' => 'A new item has been checked out under your name, details are below.'
+                ];
+            }
+        ];
+
+        yield 'Reminder' => [
+            function () {
+                return [
+                    'asset' => Asset::factory()->requiresAcceptance()->create(),
+                    'acceptance' => CheckoutAcceptance::factory()->create(),
+                    'first_time_sending' => false,
+                    'expected_subject' => 'Reminder: You have Unaccepted Assets.',
+                    'expected_opening' => 'An item was recently checked out under your name that requires acceptance, details are below.'
+                ];
+            }
+        ];
+    }
+
+    #[DataProvider('data')]
+    public function testSubjectLineAndOpening($data)
+    {
+        [
+            'asset' => $asset,
+            'acceptance' => $acceptance,
+            'first_time_sending' => $firstTimeSending,
+            'expected_subject' => $expectedSubject,
+            'expected_opening' => $expectedOpening,
+        ] = $data();
+
+        (new CheckoutAssetMail(
+            $asset,
+            User::factory()->create(),
+            User::factory()->create(),
+            $acceptance,
+            'A note goes here',
+            $firstTimeSending,
+        ))->assertHasSubject($expectedSubject)
+            ->assertSeeInText($expectedOpening);
+    }
+}