From 2883c6d0a71db174ee8df7548178a8fbee486e25 Mon Sep 17 00:00:00 2001
From: ArthurHoaro <arthur@hoa.ro>
Date: Sun, 15 Nov 2020 12:05:08 +0100
Subject: [PATCH] Daily RSS - Remove relative description (today, yesterday)

It is not useful for the RSS feed, as every new entry will be 'yesterday', and it requires an update the next day.
---
 .../controller/visitor/DailyController.php    |  2 +-
 application/helper/DailyPageHelper.php        | 18 ++++++++-----
 tests/helper/DailyPageHelperTest.php          | 27 +++++++++++++++++++
 3 files changed, 39 insertions(+), 8 deletions(-)

diff --git a/application/front/controller/visitor/DailyController.php b/application/front/controller/visitor/DailyController.php
index 846cfe22..5ae89299 100644
--- a/application/front/controller/visitor/DailyController.php
+++ b/application/front/controller/visitor/DailyController.php
@@ -131,7 +131,7 @@ class DailyController extends ShaarliVisitorController
             $dataPerDay[$day] = [
                 'date' => $endDateTime,
                 'date_rss' => $endDateTime->format(DateTime::RSS),
-                'date_human' => DailyPageHelper::getDescriptionByType($type, $dayDateTime),
+                'date_human' => DailyPageHelper::getDescriptionByType($type, $dayDateTime, false),
                 'absolute_url' => $indexUrl . 'daily?' . $type . '=' . $day,
                 'links' => [],
             ];
diff --git a/application/helper/DailyPageHelper.php b/application/helper/DailyPageHelper.php
index 5fabc907..9bdb7ba5 100644
--- a/application/helper/DailyPageHelper.php
+++ b/application/helper/DailyPageHelper.php
@@ -154,16 +154,20 @@ class DailyPageHelper
      * Get localized description of the time period depending on given datetime and type.
      * Example: for a month period, it returns `October, 2020`.
      *
-     * @param string             $type      month/week/day
-     * @param \DateTimeImmutable $requested DateTime extracted from request input
-     *                                      (should come from extractRequestedDateTime)
+     * @param string             $type            month/week/day
+     * @param \DateTimeImmutable $requested       DateTime extracted from request input
+     *                                            (should come from extractRequestedDateTime)
+     * @param bool               $includeRelative Include relative date description (today, yesterday, etc.)
      *
      * @return string Localized time period description
      *
      * @throws \Exception Type not supported.
      */
-    public static function getDescriptionByType(string $type, \DateTimeImmutable $requested): string
-    {
+    public static function getDescriptionByType(
+        string $type,
+        \DateTimeImmutable $requested,
+        bool $includeRelative = true
+    ): string {
         switch ($type) {
             case static::MONTH:
                 return $requested->format('F') . ', ' . $requested->format('Y');
@@ -172,9 +176,9 @@ class DailyPageHelper
                 return t('Week') . ' ' . $requested->format('W') . ' (' . format_date($requested, false) . ')';
             case static::DAY:
                 $out = '';
-                if ($requested->format('Ymd') === date('Ymd')) {
+                if ($includeRelative && $requested->format('Ymd') === date('Ymd')) {
                     $out = t('Today') . ' - ';
-                } elseif ($requested->format('Ymd') === date('Ymd', strtotime('-1 days'))) {
+                } elseif ($includeRelative && $requested->format('Ymd') === date('Ymd', strtotime('-1 days'))) {
                     $out = t('Yesterday') . ' - ';
                 }
                 return $out . format_date($requested, false);
diff --git a/tests/helper/DailyPageHelperTest.php b/tests/helper/DailyPageHelperTest.php
index 5255b7b1..6238e648 100644
--- a/tests/helper/DailyPageHelperTest.php
+++ b/tests/helper/DailyPageHelperTest.php
@@ -121,6 +121,19 @@ class DailyPageHelperTest extends TestCase
         static::assertEquals($expectedDescription, $description);
     }
 
+    /**
+     * @dataProvider getDescriptionsByTypeNotIncludeRelative
+     */
+    public function testGeDescriptionsByTypeNotIncludeRelative(
+        string $type,
+        \DateTimeImmutable $dateTime,
+        string $expectedDescription
+    ): void {
+        $description = DailyPageHelper::getDescriptionByType($type, $dateTime, false);
+
+        static::assertEquals($expectedDescription, $description);
+    }
+
     public function getDescriptionByTypeExceptionUnknownType(): void
     {
         $this->expectException(\Exception::class);
@@ -248,6 +261,20 @@ class DailyPageHelperTest extends TestCase
         ];
     }
 
+    /**
+     * Data provider for testGeDescriptionsByTypeNotIncludeRelative() test method.
+     */
+    public function getDescriptionsByTypeNotIncludeRelative(): array
+    {
+        return [
+            [DailyPageHelper::DAY, $date = new \DateTimeImmutable(), $date->format('F j, Y')],
+            [DailyPageHelper::DAY, $date = new \DateTimeImmutable('-1 day'), $date->format('F j, Y')],
+            [DailyPageHelper::DAY, new \DateTimeImmutable('2020-10-09 04:05:06'), 'October 9, 2020'],
+            [DailyPageHelper::WEEK, new \DateTimeImmutable('2020-10-09 04:05:06'), 'Week 41 (October 5, 2020)'],
+            [DailyPageHelper::MONTH, new \DateTimeImmutable('2020-10-09 04:05:06'), 'October, 2020'],
+        ];
+    }
+
     /**
      * Data provider for testGetDescriptionsByType() test method.
      */
-- 
2.41.0