Project::close() returns bool instead of string

kbsali · Jan 18, 2024 · 64c98a1 · 64c98a1
1 parent 54edbf0
commit 64c98a1
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 15 deletions.
diff --git a/src/Redmine/Api/Project.php b/src/Redmine/Api/Project.php
@@ -202,9 +202,11 @@ public function update($id, array $params)
      *
      * @param string|int $projectIdentifier project id or identifier
      *
-     * @return string empty string
+     * @throws InvalidArgumentException if $projectIdentifier is not provided as int or string
+     *
+     * @return bool true if the request was successful
      */
-    public function close($projectIdentifier): string
+    public function close($projectIdentifier): bool
     {
         if (! is_int($projectIdentifier) && ! is_string($projectIdentifier)) {
             throw new InvalidArgumentException(sprintf(
@@ -213,10 +215,14 @@ public function close($projectIdentifier): string
             ));
         }
 
-        return $this->put(
+        $this->put(
             '/projects/' . strval($projectIdentifier) . '/close.xml',
             ''
         );
+
+        $lastResponse = $this->getLastResponse();
+
+        return ($lastResponse->getStatusCode() === 204);
     }
 
     /**

diff --git a/tests/End2End/Project/ClosingProjectTest.php b/tests/End2End/Project/ClosingProjectTest.php
@@ -20,7 +20,6 @@ public function testInteractionWithProject(RedmineVersion $redmineVersion): void
 
         /** @var Project */
         $api = $client->getApi('project');
-        $now = new DateTimeImmutable();
 
         // Create project
         $projectName = 'test project';
@@ -41,8 +40,7 @@ public function testInteractionWithProject(RedmineVersion $redmineVersion): void
         $this->assertSame('1', $projectData['status'], $projectDataJson);
 
         // Close project
-        $result = $api->close($projectIdentifier);
-        $this->assertSame('', $result);
+        $this->assertTrue($api->close($projectIdentifier));
 
         // Read single project
         $projectDetails = $api->show($projectIdentifier);

diff --git a/tests/Unit/Api/Project/CloseTest.php b/tests/Unit/Api/Project/CloseTest.php
@@ -24,19 +24,17 @@ public function testCloseReturnsResponse()
                 $this->assertSame('/projects/5/close.xml', $path);
                 $this->assertSame('', $body);
 
-                return $this->createConfiguredMock(
-                    Response::class,
-                    [
-                        'getContentType' => 'application/xml',
-                        'getBody' => '',
-                    ]
-                );
+                return $this->createConfiguredMock(Response::class, [
+                    'getStatusCode' => 204,
+                    'getContentType' => 'application/xml',
+                    'getBody' => '',
+                ]);
             })
         ;
 
         $api = new Project($client);
 
-        $this->assertSame('', $api->close(5));
+        $this->assertTrue($api->close(5));
     }
 
     public function testCloseWithoutIntOrStringThrowsInvalidArgumentException()
@@ -48,7 +46,7 @@ public function testCloseWithoutIntOrStringThrowsInvalidArgumentException()
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Redmine\Api\Project::close(): Argument #1 ($projectIdentifier) must be of type int or string');
 
-        // Perform the tests
+        // provide a wrong project identifier
         $api->close(true);
     }
 }