lunax/snipe_it
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions

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

Browse source 
Improved wording in asset checkout emails
This commit is contained in:
snipe 2025-04-03 15:37:30 +01:00 • committed by GitHub
commit 7c1438c370
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 131 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
app/Mail/CheckoutAssetMail.php
View file

@ -74,7 +74,7 @@ class CheckoutAssetMail extends Mailable
{
$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 @@ class CheckoutAssetMail extends Mailable
'accept_url' => $accept_url,
'last_checkout' => $this->last_checkout,
'expected_checkin' => $this->expected_checkin,
'introduction_line' => $this->introductionLine(),
],
);
}
@ -120,4 +121,27 @@ class CheckoutAssetMail extends Mailable
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;
}
}

10
database/factories/AssetFactory.php
View file

@ -4,6 +4,7 @@ namespace Database\Factories;
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 @@ class AssetFactory extends Factory
});
}
public function doesNotRequireAcceptance()
{
return $this->state(function () {
return [
'model_id' => AssetModel::factory()->doesNotRequireAcceptance(),
];
});
}
public function deleted()
{
return $this->state(function () {

9
database/factories/AssetModelFactory.php
View file

@ -448,4 +448,13 @@ class AssetModelFactory extends Factory
];
});
}
public function doesNotRequireAcceptance()
{
return $this->state(function () {
return [
'category_id' => Category::factory()->doesNotRequireAcceptance(),
];
});
}
}

7
database/factories/CategoryFactory.php
View file

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

4
resources/lang/en-US/mail.php
View file

@ -66,6 +66,8 @@ return [
'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 @@ return [
'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',

4
resources/views/mail/markdown/checkout-asset.blade.php
View file

@ -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

75
tests/Unit/Mail/CheckoutAssetMailTest.php Normal file
View file

@ -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);
}
}