modified Version Service to work better.

Author: lesstif

README.md

@@ -2450,9 +2450,11 @@ try {
 
     $version->setName('1.0.0')
             ->setDescription('Generated by script')
-            ->setReleased(true)
-            ->setReleaseDate(new \DateTime())
-            ->setProjectId($project->id);
+            ->setReleased(false)
+            ->setStartDateAsDateTime(new \DateTime())
+            ->setReleaseDateAsDateTime((new \DateTime())->add(date_interval_create_from_date_string('2 weeks 3 days')))
+            ->setProjectId($project->id)
+            ;
 
     $res = $versionService->create($version);
 
@@ -2485,9 +2487,9 @@ try {
     $ver->setName($ver->name . ' Updated name')
         ->setDescription($ver->description . ' Updated description')
         ->setReleased(false)
-        ->setReleaseDate(
-            (new \DateTime())->add(date_interval_create_from_date_string('1 months 3 days'))
-        );
+        ->setStartDateAsDateTime(new \DateTime())
+        ->setReleaseDateAsDateTime((new \DateTime())->add(date_interval_create_from_date_string('1 months 3 days')))
+        ;
 
     $res = $versionService->update($ver);
 

src/Issue/Version.php

@@ -20,14 +20,17 @@ class Version implements \JsonSerializable
 
     public bool $released;
 
-    public DateTimeInterface|string $releaseDate;
+    public string $releaseDate;
 
     public bool $overdue;
 
     public ?string $userReleaseDate;
 
     public string $projectId;
 
+    public ?string $startDate;
+    public ?string $userStartDate;
+
     public function __construct($name = null)
     {
         $this->name = $name;
@@ -74,7 +77,14 @@ public function setReleased(bool $released): static
         return $this;
     }
 
-    public function setReleaseDate(DateTimeInterface $releaseDate): static
+    public function setReleaseDateAsDateTime(DateTimeInterface $releaseDate, string $format='Y-m-d'): static
+    {
+        $this->releaseDate = $releaseDate->format($format);
+
+        return $this;
+    }
+
+    public function setReleaseDateAsString(string $releaseDate): static
     {
         $this->releaseDate = $releaseDate;
 
@@ -87,4 +97,32 @@ public function setUserReleaseDate(string $userReleaseDate): static
 
         return $this;
     }
+
+    public function setStartDateAsDateTime(\DateTimeInterface $startDate, string $format='Y-m-d'): static
+    {
+        $this->startDate = $startDate->format($format);
+
+        return $this;
+    }
+
+    public function setStartDateAsString(?string $startDate): static
+    {
+        $this->startDate = $startDate;
+
+        return $this;
+    }
+
+    public function setUserStartDateAsDateTime(\DateTimeInterface $userStartDate, string $format='Y-m-d'): static
+    {
+        $this->userStartDate = $userStartDate->format($format);
+
+        return $this;
+    }
+
+    public function setUserStartDateAsString(?string $userStartDate): static
+    {
+        $this->userStartDate = $userStartDate;
+
+        return $this;
+    }
 }

src/Version/VersionService.php

@@ -17,11 +17,6 @@ class VersionService extends \JiraCloud\JiraClient
      */
     public function create(Version $version): Version
     {
-        // to convert DateTimeInterface to string for payload
-        if ($version->releaseDate instanceof \DateTimeInterface) {
-            $version->releaseDate = $version->releaseDate->format('Y-m-d');
-        }
-
         $data = json_encode($version);
 
         $this->log->info("Create Version=\n".$data);
@@ -85,12 +80,9 @@ public function update(Version $version): Version
             throw new JiraException($version->id.' is not a valid version id.');
         }
 
-        if ($version->releaseDate instanceof \DateTimeInterface) {
-            $version->releaseDate = $version->releaseDate->format('Y-m-d');
-        }
-
         //Only one of 'releaseDate' and 'userReleaseDate' can be specified when editing a version."
         $version->userReleaseDate = null;
+        $version->userStartDate = null;
 
         $data = json_encode($version);
         $ret = $this->exec($this->uri.'/'.$version->id, $data, 'PUT');

tests/VersionTest.php

@@ -11,7 +11,7 @@
 
 class VersionTest extends TestCase
 {
-    private $project = 'TEST';
+    private string $project = 'TEST';
 
     /**
      * @test
@@ -30,22 +30,23 @@ public function create_version() :string
 
             $version = new Version();
 
-            $version->setName($versionName)
+            $version->setProjectId($project->id)
+                    ->setName($versionName)
                     ->setDescription('Generated by script')
-                    ->setReleased(true)
-                    ->setReleaseDate(new \DateTime())
-                    ->setProjectId($project->id);
+                    ->setReleased(false)
+                    ->setStartDateAsDateTime(new \DateTime())
+                    ->setReleaseDateAsDateTime((new \DateTime())->add(date_interval_create_from_date_string('2 weeks 3 days')))
+                ;
 
             $res = $versionService->create($version);
 
             $this->assertEquals($res->name, $versionName);
 
             return $versionName;
         } catch (JiraException $e) {
-            print("Error Occurred! " . $e->getMessage());
+            $this->fail("Error Occurred! " . $e->getMessage());
         }
 
-        return $versionName;
     }
 
     /**
@@ -68,16 +69,18 @@ public function update_project_version(string $versionName) : string
             $ver->setName($newVersionName)
                 ->setDescription($ver->description . ' Updated description')
                 ->setReleased(false)
-                ->setReleaseDate(
-                    (new \DateTime())->add(date_interval_create_from_date_string('1 months 3 days'))
-                    );
+                ->setStartDateAsDateTime(new \DateTime())
+                ->setReleaseDateAsDateTime(
+                        (new \DateTime())->add(date_interval_create_from_date_string('1 months 3 days'))
+                    )
+                ;
 
             $res = $versionService->update($ver);
 
             $this->assertEquals($res->name, $ver->name);
 
         } catch (JiraException $e) {
-            print("Error Occurred! " . $e->getMessage());
+            $this->fail("Error Occurred! " . $e->getMessage());
         }
 
         return $newVersionName;
@@ -97,9 +100,9 @@ public function delete_project_version(string $newVersionName)
 
             $res = $versionService->delete($ver);
 
-            $this->assertEquals($res, true);
+            $this->assertEquals(true, $res);
         } catch (JiraException $e) {
-            print("Error Occurred! " . $e->getMessage());
+            $this->fail("Error Occurred! " . $e->getMessage());
         }
     }
 }