Added descriptions to calendar and fixed failing unit tests

Signed-off-by: Mua N. Laurent <[email protected]>

Author: muarachmann

src/DataTypes/Calendar.php

@@ -74,6 +74,13 @@ class Calendar implements DataTypeInterface
      */
     protected $dateTimeFormat = "Y-m-d H:i";
 
+    /**
+     * Event full descriptions/notes.
+     *
+     * @var string
+     */
+    protected $description;
+
     /**
      * Generates the DataType Object and sets all of its properties.
      *
@@ -118,6 +125,9 @@ protected function buildCalendarString()
         if (isset($this->url)) {
             $calendar .= "URL:".$this->url.$this->separator;
         }
+        if (isset($this->description)) {
+            $calendar .= "DESCRIPTION:".$this->description.$this->separator;
+        }
 
         $calendar .= $this->suffix;
 
@@ -154,6 +164,9 @@ protected function setProperties(array $arguments)
             if (isset($arguments['url'])) {
                 $this->setUrl($arguments['url']);
             }
+            if (isset($arguments['description'])) {
+                $this->description = $arguments['description'];
+            }
         }
     }
 
@@ -246,6 +259,6 @@ protected function convertEventDateTimeToString($dateTime)
         } catch (Exception $e) {
             throw new InvalidArgumentException('Invalid date provided');
         }
-        return $date->format('yymdTHms');
+        return $date->format('yymd\THms');
     }
 }

tests/DataTypes/CalendarTest.php

@@ -5,7 +5,6 @@
 
 
 use BaconQrCode\Exception\InvalidArgumentException;
-use DateTime;
 use PHPUnit\Framework\TestCase;
 use SimpleSoftwareIO\QrCode\DataTypes\Calendar;
 
@@ -18,6 +17,13 @@ class CalendarTest extends TestCase
      */
     private $separator;
 
+    /**
+     * The calendar variable
+     *
+     * @var Calendar
+     */
+    private $calendar;
+
     public function setUp(): void
     {
         $this->separator = "\r\n";
@@ -63,7 +69,7 @@ public function test_it_generates_a_proper_format_with_just_the_summary_and_star
 
         $properFormat = "BEGIN:VEVENT".$this->separator.
                         "SUMMARY:My FooBar Event".$this->separator.
-                        "DTSTART:20201008UTC161000".$this->separator.
+                        "DTSTART:20201008T161000".$this->separator.
                         "END:VEVENT";
 
         $this->assertEquals($properFormat, strval($this->calendar));
@@ -81,8 +87,8 @@ public function test_it_generates_a_proper_format_with_summary_start_date_time_a
 
         $properFormat = "BEGIN:VEVENT".$this->separator.
             "SUMMARY:My FooBar Event".$this->separator.
-            "DTSTART:20201008UTC161000".$this->separator.
-            "DTEND:20201008UTC181000".$this->separator.
+            "DTSTART:20201008T161000".$this->separator.
+            "DTEND:20201008T181000".$this->separator.
             "END:VEVENT";
 
         $this->assertEquals($properFormat, strval($this->calendar));
@@ -101,8 +107,8 @@ public function test_it_generates_a_proper_format_with_specified_date_time_forma
 
         $properFormat = "BEGIN:VEVENT".$this->separator.
             "SUMMARY:My FooBar Event".$this->separator.
-            "DTSTART:20201008UTC161000".$this->separator.
-            "DTEND:20201008UTC181000".$this->separator.
+            "DTSTART:20201008T161000".$this->separator.
+            "DTEND:20201008T181000".$this->separator.
             "END:VEVENT";
 
         $this->assertEquals($properFormat, strval($this->calendar));
@@ -133,7 +139,7 @@ public function test_it_generates_a_proper_format_with_summary_start_date_time_a
 
         $properFormat = "BEGIN:VEVENT".$this->separator.
             "SUMMARY:My FooBar Event".$this->separator.
-            "DTSTART:20201008UTC161000".$this->separator.
+            "DTSTART:20201008T161000".$this->separator.
             "LOCATION:Fooon".$this->separator.
             "END:VEVENT";
 
@@ -152,7 +158,7 @@ public function test_it_generates_a_proper_format_with_summary_start_date_time_a
 
         $properFormat = "BEGIN:VEVENT".$this->separator.
             "SUMMARY:My FooBar Event".$this->separator.
-            "DTSTART:20201008UTC161000".$this->separator.
+            "DTSTART:20201008T161000".$this->separator.
             "URL:https://www.google.com".$this->separator.
             "END:VEVENT";
 
@@ -168,16 +174,18 @@ public function test_it_generates_a_proper_format_with_calendar_parameters()
                 'endDateTime' => '2020-10-08 18:00',
                 'location' => 'Foo Location',
                 'url' => 'https://www.google.com',
-                'dateTimeFormat' => 'Y-m-d H:i'
+                'dateTimeFormat' => 'Y-m-d H:i',
+                'description' => 'FooBar\'s Event description can be longer than this.'
             ],
         ]);
 
         $properFormat = "BEGIN:VEVENT".$this->separator.
             "SUMMARY:My FooBar Event".$this->separator.
-            "DTSTART:20201008UTC161000".$this->separator.
-            "DTEND:20201008UTC181000".$this->separator.
+            "DTSTART:20201008T161000".$this->separator.
+            "DTEND:20201008T181000".$this->separator.
             "LOCATION:Foo Location".$this->separator.
             "URL:https://www.google.com".$this->separator.
+            "DESCRIPTION:FooBar's Event description can be longer than this.".$this->separator.
             "END:VEVENT";
 
         $this->assertEquals($properFormat, strval($this->calendar));