feat: create Group::fromHttpClient()

Art4 · Art4 · commit 3aebdc83cd12 · 2026-01-04T15:31:54.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - New method `Redmine\Api\Attachment::fromHttpClient()` for creating the class.
 - New method `Redmine\Api\CustomField::fromHttpClient()` for creating the class.
+- New method `Redmine\Api\Group::fromHttpClient()` for creating the class.
 - New method `Redmine\Api\Issue::fromHttpClient()` for creating the class.
 - Add support for PHP 8.5
 - Add support for Redmine 6.1.
@@ -25,6 +26,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Extending `Redmine\Api\Attachment` is deprecated and will be set to final in future, create a wrapper class instead.
 - `Redmine\Api\CustomField::__construct()` is deprecated and will be set to private in future, use `\Redmine\Api\CustomField::fromHttpClient()` instead.
 - Extending `Redmine\Api\CustomField` is deprecated and will be set to final in future, create a wrapper class instead.
+- `Redmine\Api\Group::__construct()` is deprecated and will be set to private in future, use `\Redmine\Api\Group::fromHttpClient()` instead.
+- Extending `Redmine\Api\Group` is deprecated and will be set to final in future, create a wrapper class instead.
 - `Redmine\Api\Issue::__construct()` is deprecated and will be set to private in future, use `\Redmine\Api\Issue::fromHttpClient()` instead.
 - Extending `Redmine\Api\Issue` is deprecated and will be set to final in future, create a wrapper class instead.
 
diff --git a/src/Redmine/Api/Group.php b/src/Redmine/Api/Group.php
@@ -2,10 +2,12 @@
 
 namespace Redmine\Api;
 
+use Redmine\Client\Client;
 use Redmine\Exception;
 use Redmine\Exception\MissingParameterException;
 use Redmine\Exception\SerializerException;
 use Redmine\Exception\UnexpectedResponseException;
+use Redmine\Http\HttpClient;
 use Redmine\Http\HttpFactory;
 use Redmine\Serializer\JsonSerializer;
 use Redmine\Serializer\PathSerializer;
@@ -21,6 +23,11 @@
  */
 class Group extends AbstractApi
 {
+    final public static function fromHttpClient(HttpClient $httpClient): self
+    {
+        return new self($httpClient, true);
+    }
+
     /**
      * @var null|array<mixed>
      */
@@ -31,6 +38,32 @@ class Group extends AbstractApi
      */
     private ?array $groupNames = null;
 
+    /**
+     * @deprecated v2.9.0 Use fromHttpClient() instead.
+     * @see Issue::fromHttpClient()
+     *
+     * @param Client|HttpClient $client
+     */
+    public function __construct($client/*, bool $privatelyCalled = false*/)
+    {
+        $privatelyCalled = (func_num_args() > 1) ? func_get_arg(1) : false;
+
+        if ($privatelyCalled === true) {
+            parent::__construct($client);
+
+            return;
+        }
+
+        if (static::class !== self::class) {
+            $className = (new \ReflectionClass($this))->isAnonymous() ? '' : ' in `' . static::class . '`';
+            @trigger_error('Class `' . self::class . '` will declared as final in v3.0.0, stop extending it' . $className . '.', E_USER_DEPRECATED);
+        } else {
+            @trigger_error('Method `' . __METHOD__ . '()` is deprecated since v2.9.0 and will declared as private in v3.0.0, use `' . self::class . '::fromHttpClient()` instead.', E_USER_DEPRECATED);
+        }
+
+        parent::__construct($client);
+    }
+
     /**
      * List groups.
      *
diff --git a/tests/Unit/Api/CustomField/FromHttpClientTest.php b/tests/Unit/Api/CustomField/FromHttpClientTest.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Redmine\Tests\Unit\Api\CustomField;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use Redmine\Api\CustomField;
+use Redmine\Http\HttpClient;
+
+#[CoversClass(CustomField::class)]
+class FromHttpClientTest extends TestCase
+{
+    public function testReturnsCorrectObject(): void
+    {
+        $httpClient = $this->createStub(HttpClient::class);
+
+        $api = CustomField::fromHttpClient($httpClient);
+
+        $this->assertInstanceOf(CustomField::class, $api);
+    }
+}
diff --git a/tests/Unit/Api/Group/AddUserTest.php b/tests/Unit/Api/Group/AddUserTest.php
@@ -32,7 +32,7 @@ public function testAddUserReturnsCorrectResponse(int $groupId, int $userId, str
         );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         // Perform the tests
         $return = $api->addUser($groupId, $userId);
@@ -74,7 +74,7 @@ public function testAddUserReturnsEmptyString(): void
         );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         // Perform the tests
         $return = $api->addUser(1, 2);
diff --git a/tests/Unit/Api/Group/CreateTest.php b/tests/Unit/Api/Group/CreateTest.php
@@ -36,7 +36,7 @@ public function testCreateReturnsCorrectResponse(array $parameters, string $expe
         );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         // Perform the tests
         $return = $api->create($parameters);
@@ -123,7 +123,7 @@ public function testCreateReturnsEmptyString(): void
         );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         // Perform the tests
         $return = $api->create(['name' => 'Group Name']);
@@ -140,7 +140,7 @@ public function testCreateThrowsExceptionIfNameIsMissing(): void
         $client = $this->createMock(HttpClient::class);
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         $this->expectException(MissingParameterException::class);
         $this->expectExceptionMessage('Theses parameters are mandatory: `name`');
diff --git a/tests/Unit/Api/Group/FromHttpClientTest.php b/tests/Unit/Api/Group/FromHttpClientTest.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Redmine\Tests\Unit\Api\Group;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use Redmine\Api\Group;
+use Redmine\Http\HttpClient;
+
+#[CoversClass(Group::class)]
+class FromHttpClientTest extends TestCase
+{
+    public function testReturnsCorrectObject(): void
+    {
+        $httpClient = $this->createStub(HttpClient::class);
+
+        $api = Group::fromHttpClient($httpClient);
+
+        $this->assertInstanceOf(Group::class, $api);
+    }
+}
diff --git a/tests/Unit/Api/Group/ListNamesTest.php b/tests/Unit/Api/Group/ListNamesTest.php
@@ -33,7 +33,7 @@ public function testListNamesReturnsCorrectResponse(string $expectedPath, int $r
         );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame($expectedResponse, $api->listNames());
@@ -98,7 +98,7 @@ public function testListNamesCallsHttpClientOnlyOnce(): void
         );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame([1 => 'Group 1'], $api->listNames());
diff --git a/tests/Unit/Api/Group/ListTest.php b/tests/Unit/Api/Group/ListTest.php
@@ -5,8 +5,8 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 use Redmine\Api\Group;
-use Redmine\Client\Client;
 use Redmine\Exception\UnexpectedResponseException;
+use Redmine\Tests\Fixtures\AssertingHttpClient;
 
 #[CoversClass(Group::class)]
 class ListTest extends TestCase
@@ -17,21 +17,21 @@ public function testListWithoutParametersReturnsResponse(): void
         $response = '["API Response"]';
         $expectedReturn = ['API Response'];
 
-        // Create the used mock objects
-        $client = $this->createMock(Client::class);
-        $client->expects($this->once())
-            ->method('requestGet')
-            ->with('/groups.json')
-            ->willReturn(true);
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseBody')
-            ->willReturn($response);
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseContentType')
-            ->willReturn('application/json');
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                '/groups.json',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                $response,
+            ],
+        );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame($expectedReturn, $api->list());
@@ -44,43 +44,43 @@ public function testListeWithParametersReturnsResponse(): void
         $response = '["API Response"]';
         $expectedReturn = ['API Response'];
 
-        // Create the used mock objects
-        $client = $this->createMock(Client::class);
-        $client->expects($this->once())
-            ->method('requestGet')
-            ->with('/groups.json?limit=25&offset=0&0=not-used')
-            ->willReturn(true);
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseBody')
-            ->willReturn($response);
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseContentType')
-            ->willReturn('application/json');
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                '/groups.json?limit=25&offset=0&0=not-used',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                $response,
+            ],
+        );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame($expectedReturn, $api->list($parameters));
     }
 
     public function testListThrowsException(): void
     {
-        // Create the used mock objects
-        $client = $this->createMock(Client::class);
-        $client->expects($this->exactly(1))
-            ->method('requestGet')
-            ->with('/groups.json')
-            ->willReturn(true);
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseBody')
-            ->willReturn('');
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseContentType')
-            ->willReturn('application/json');
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                '/groups.json',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                '',
+            ],
+        );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         $this->expectException(UnexpectedResponseException::class);
         $this->expectExceptionMessage('The Redmine server replied with an unexpected response.');
diff --git a/tests/Unit/Api/Group/RemoveTest.php b/tests/Unit/Api/Group/RemoveTest.php
@@ -27,7 +27,7 @@ public function testRemoveReturnsString(): void
             ],
         );
 
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         $this->assertSame('', $api->remove(5));
     }
diff --git a/tests/Unit/Api/Group/RemoveUserTest.php b/tests/Unit/Api/Group/RemoveUserTest.php
@@ -27,7 +27,7 @@ public function testRemoveUserReturnsString(): void
             ],
         );
 
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         $this->assertSame('', $api->removeUser(5, 10));
     }
diff --git a/tests/Unit/Api/Group/ShowTest.php b/tests/Unit/Api/Group/ShowTest.php
@@ -31,7 +31,7 @@ public function testShowReturnsCorrectResponse($groupId, array $params, string $
         );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame($expectedReturn, $api->show($groupId, $params));
diff --git a/tests/Unit/Api/Group/UpdateTest.php b/tests/Unit/Api/Group/UpdateTest.php
@@ -33,7 +33,7 @@ public function testUpdateReturnsCorrectResponse(int $id, array $parameters, str
         );
 
         // Create the object under test
-        $api = new Group($client);
+        $api = Group::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame('', $api->update($id, $parameters));
diff --git a/tests/Unit/Api/GroupTest.php b/tests/Unit/Api/GroupTest.php

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public function testRemoveReturnsString(): void`
`27`	`27`	`],`
`28`	`28`	`);`
`29`	`29`
`30`		`- $api = new Group($client);`
	`30`	`+ $api = Group::fromHttpClient($client);`
`31`	`31`
`32`	`32`	`$this->assertSame('', $api->remove(5));`
`33`	`33`	`}`