From 5031159fef1c5621f5c8bb0ccbc8e8efb9b70972 Mon Sep 17 00:00:00 2001
From: Daniel Beitler <dan@dablabs.com>
Date: Wed, 19 Aug 2020 21:58:57 -0400
Subject: [PATCH] UPS Shipment Tracking: Change "Delivered On" title

---
 .../DataProviders/Tracking/ChangeTitle.php    | 34 ++++++++
 .../Tracking/ChangeTitleTest.php              | 81 +++++++++++++++++++
 app/code/Magento/Ups/etc/di.xml               |  3 +
 3 files changed, 118 insertions(+)
 create mode 100644 app/code/Magento/Ups/Plugin/Block/DataProviders/Tracking/ChangeTitle.php
 create mode 100644 app/code/Magento/Ups/Test/Unit/Plugin/Block/DataProviders/Tracking/ChangeTitleTest.php

diff --git a/app/code/Magento/Ups/Plugin/Block/DataProviders/Tracking/ChangeTitle.php b/app/code/Magento/Ups/Plugin/Block/DataProviders/Tracking/ChangeTitle.php
new file mode 100644
index 0000000000000..973b199217271
--- /dev/null
+++ b/app/code/Magento/Ups/Plugin/Block/DataProviders/Tracking/ChangeTitle.php
@@ -0,0 +1,34 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Ups\Plugin\Block\DataProviders\Tracking;
+
+use Magento\Ups\Model\Carrier;
+use Magento\Shipping\Model\Tracking\Result\Status;
+use Magento\Shipping\Block\DataProviders\Tracking\DeliveryDateTitle as Subject;
+
+/**
+ * Plugin to change the "Delivery on" title to a customized value for UPS
+ */
+class ChangeTitle
+{
+    /**
+     * Modify title only when UPS is used as carrier
+     *
+     * @param Subject $subject
+     * @param \Magento\Framework\Phrase|string $result
+     * @param Status $trackingStatus
+     * @return \Magento\Framework\Phrase|string
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function afterGetTitle(Subject $subject, $result, Status $trackingStatus)
+    {
+        if ($trackingStatus->getCarrier() === Carrier::CODE) {
+            $result = __('Status Updated On:');
+        }
+        return $result;
+    }
+}
diff --git a/app/code/Magento/Ups/Test/Unit/Plugin/Block/DataProviders/Tracking/ChangeTitleTest.php b/app/code/Magento/Ups/Test/Unit/Plugin/Block/DataProviders/Tracking/ChangeTitleTest.php
new file mode 100644
index 0000000000000..fa608584be964
--- /dev/null
+++ b/app/code/Magento/Ups/Test/Unit/Plugin/Block/DataProviders/Tracking/ChangeTitleTest.php
@@ -0,0 +1,81 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\Ups\Test\Unit\Plugin\Block\DataProviders\Tracking;
+
+use Magento\Ups\Model\Carrier;
+use Magento\Ups\Plugin\Block\DataProviders\Tracking\ChangeTitle;
+use Magento\Framework\Phrase;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\Shipping\Block\DataProviders\Tracking\DeliveryDateTitle;
+use Magento\Shipping\Model\Tracking\Result\Status;
+use Magento\Ups\Model\Carrier as UpsCarrier;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Unit Test for @see ChangeTitle
+ */
+class ChangeTitleTest extends TestCase
+{
+    /**
+     * @var ChangeTitle|MockObject
+     */
+    private $plugin;
+
+    /**
+     * @inheritDoc
+     */
+    protected function setUp(): void
+    {
+        $objectManagerHelper = new ObjectManager($this);
+        $this->plugin = $objectManagerHelper->getObject(ChangeTitle::class);
+    }
+
+    /**
+     * Check if DeliveryDateTitle was changed if the carrier is UPS
+     *
+     * @param string $carrierCode
+     * @param string $originalResult
+     * @param Phrase|string $finalResult
+     * @dataProvider testAfterGetTitleDataProvider
+     */
+    public function testAfterGetTitle(string $carrierCode, string $originalResult, $finalResult)
+    {
+        /** @var DeliveryDateTitle|MockObject $subjectMock */
+        $subjectMock = $this->getMockBuilder(DeliveryDateTitle::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        /** @var Status|MockObject $trackingStatusMock */
+        $trackingStatusMock = $this->getMockBuilder(Status::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['getCarrier'])
+            ->getMock();
+        $trackingStatusMock->expects($this::once())
+            ->method('getCarrier')
+            ->willReturn($carrierCode);
+
+        $actual = $this->plugin->afterGetTitle($subjectMock, $originalResult, $trackingStatusMock);
+
+        $this->assertEquals($finalResult, $actual);
+    }
+
+    /**
+     * Data provider
+     *
+     * @return array
+     */
+    public function testAfterGetTitleDataProvider(): array
+    {
+        return [
+            [Carrier::CODE, 'Original Title', __('Status Updated On:')],
+            ['not-fedex', 'Original Title', 'Original Title'],
+        ];
+    }
+}
diff --git a/app/code/Magento/Ups/etc/di.xml b/app/code/Magento/Ups/etc/di.xml
index a04a5eb48bdab..08d751fc3e2c8 100644
--- a/app/code/Magento/Ups/etc/di.xml
+++ b/app/code/Magento/Ups/etc/di.xml
@@ -28,4 +28,7 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\Shipping\Block\DataProviders\Tracking\DeliveryDateTitle">
+        <plugin name="ups_update_delivery_date_title" type="Magento\Ups\Plugin\Block\DataProviders\Tracking\ChangeTitle"/>
+    </type>
 </config>