feat: create News::fromHttpClient()

Author: Art4

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - New method `Redmine\Api\IssueStatus::fromHttpClient()` for creating the class.
 - New method `Redmine\Api\Membership::fromHttpClient()` for creating the class.
 - New method `Redmine\Api\News::fromHttpClient()` for creating the class.
+- New method `Redmine\Api\Project::fromHttpClient()` for creating the class.
 - Add support for PHP 8.5
 - Add support for Redmine 6.1.
 
@@ -48,6 +49,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Extending `Redmine\Api\Membership` is deprecated and will be set to final in future, create a wrapper class instead.
 - `Redmine\Api\News::__construct()` is deprecated and will be set to private in future, use `\Redmine\Api\News::fromHttpClient()` instead.
 - Extending `Redmine\Api\News` is deprecated and will be set to final in future, create a wrapper class instead.
+- `Redmine\Api\Project::__construct()` is deprecated and will be set to private in future, use `\Redmine\Api\Project::fromHttpClient()` instead.
+- Extending `Redmine\Api\Project` is deprecated and will be set to final in future, create a wrapper class instead.
 
 ### Removed
 

src/Redmine/Api/Project.php

@@ -3,10 +3,12 @@
 namespace Redmine\Api;
 
 use InvalidArgumentException;
+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;
@@ -22,6 +24,11 @@
  */
 class Project extends AbstractApi
 {
+    final public static function fromHttpClient(HttpClient $httpClient): self
+    {
+        return new self($httpClient, true);
+    }
+
     /**
      * @var null|array<mixed>
      */
@@ -32,6 +39,32 @@ class Project extends AbstractApi
      */
     private ?array $projectNames = null;
 
+    /**
+     * @deprecated v2.9.0 Use fromHttpClient() instead.
+     * @see Project::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 projects.
      *

tests/Unit/Api/Project/FromHttpClientTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Redmine\Tests\Unit\Api\Project;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use Redmine\Api\Project;
+use Redmine\Http\HttpClient;
+
+#[CoversClass(Project::class)]
+class FromHttpClientTest extends TestCase
+{
+    public function testReturnsCorrectObject(): void
+    {
+        $httpClient = $this->createStub(HttpClient::class);
+
+        $api = Project::fromHttpClient($httpClient);
+
+        $this->assertInstanceOf(Project::class, $api);
+    }
+}

tests/Unit/Api/ProjectTest.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\TestCase;
 use Redmine\Api\Project;
 use Redmine\Client\Client;
+use Redmine\Http\HttpClient;
 use Redmine\Tests\Fixtures\MockClient;
 use ReflectionMethod;
 use SimpleXMLElement;
@@ -17,6 +18,44 @@
 #[CoversClass(Project::class)]
 class ProjectTest extends TestCase
 {
+    public function testExtendingTheClassTriggersDeprecationWarning(): void
+    {
+        // PHPUnit 10 compatible way to test trigger_error().
+        set_error_handler(
+            function ($errno, $errstr): bool {
+                $this->assertSame(
+                    'Class `Redmine\Api\Project` will declared as final in v3.0.0, stop extending it.',
+                    $errstr,
+                );
+
+                restore_error_handler();
+                return true;
+            },
+            E_USER_DEPRECATED,
+        );
+
+        new class ($this->createStub(HttpClient::class)) extends Project {};
+    }
+
+    public function testConstructorTriggersDeprecationWarning(): void
+    {
+        // PHPUnit 10 compatible way to test trigger_error().
+        set_error_handler(
+            function ($errno, $errstr): bool {
+                $this->assertSame(
+                    'Method `Redmine\Api\Project::__construct()` is deprecated since v2.9.0 and will declared as private in v3.0.0, use `Redmine\Api\Project::fromHttpClient()` instead.',
+                    $errstr,
+                );
+
+                restore_error_handler();
+                return true;
+            },
+            E_USER_DEPRECATED,
+        );
+
+        new Project($this->createStub(HttpClient::class));
+    }
+
     /**
      * Test all().
      */