Add Tracker::listNames()

Author: Art4

CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - New method `Redmine\Api\Project::listNames()` for listing the ids and names of all projects.
 - New method `Redmine\Api\Role::listNames()` for listing the ids and names of all roles.
 - New method `Redmine\Api\TimeEntryActivity::listNames()` for listing the ids and names of all time entry activities.
+- New method `Redmine\Api\Tracker::listNames()` for listing the ids and names of all trackers.
 
 ### Deprecated
 

src/Redmine/Api/Tracker.php

@@ -17,6 +17,8 @@ class Tracker extends AbstractApi
 {
     private $trackers = [];
 
+    private $trackerNames = null;
+
     /**
      * List trackers.
      *
@@ -37,6 +39,29 @@ final public function list(array $params = []): array
         }
     }
 
+    /**
+     * Returns an array of all trackers with id/name pairs.
+     *
+     * @return array<int,string> list of trackers (id => name)
+     */
+    final public function listNames(): array
+    {
+        if ($this->trackerNames !== null) {
+            return $this->trackerNames;
+        }
+
+        $this->trackerNames = [];
+        $list = $this->list();
+
+        if (array_key_exists('trackers', $list)) {
+            foreach ($list['trackers'] as $role) {
+                $this->trackerNames[(int) $role['id']] = $role['name'];
+            }
+        }
+
+        return $this->trackerNames;
+    }
+
     /**
      * List trackers.
      *

tests/Behat/Bootstrap/TrackerContextTrait.php

@@ -40,4 +40,18 @@ public function iListAllTrackers()
             $api->getLastResponse(),
         );
     }
+
+    /**
+     * @When I list all tracker names
+     */
+    public function iListAllTrackerNames()
+    {
+        /** @var Tracker */
+        $api = $this->getNativeCurlClient()->getApi('tracker');
+
+        $this->registerClientResponse(
+            $api->listNames(),
+            $api->getLastResponse(),
+        );
+    }
 }

tests/Behat/features/tracker.feature

@@ -78,3 +78,17 @@ Feature: Interacting with the REST API for trackers
             | 6                 | estimated_hours      |
             | 7                 | done_ratio           |
             | 8                 | description          |
+
+    Scenario: Listing of multiple tracker names
+        Given I have a "NativeCurlClient" client
+        And I have an issue status with the name "New"
+        And I have a tracker with the name "Feature" and default status id "1"
+        And I have a tracker with the name "Defect" and default status id "1"
+        When I list all tracker names
+        Then the response has the status code "200"
+        And the response has the content type "application/json"
+        And the returned data contains "2" items
+        And the returned data contains the following data
+            | property          | value                |
+            | 1                 | Feature              |
+            | 2                 | Defect               |

tests/Unit/Api/Tracker/ListNamesTest.php

@@ -0,0 +1,108 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Redmine\Tests\Unit\Api\Tracker;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Redmine\Api\Tracker;
+use Redmine\Tests\Fixtures\AssertingHttpClient;
+
+#[CoversClass(Tracker::class)]
+class ListNamesTest extends TestCase
+{
+    /**
+     * @dataProvider getListNamesData
+     */
+    #[DataProvider('getListNamesData')]
+    public function testListNamesReturnsCorrectResponse($expectedPath, $responseCode, $response, $expectedResponse)
+    {
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                $expectedPath,
+                'application/json',
+                '',
+                $responseCode,
+                'application/json',
+                $response,
+            ],
+        );
+
+        // Create the object under test
+        $api = new Tracker($client);
+
+        // Perform the tests
+        $this->assertSame($expectedResponse, $api->listNames());
+    }
+
+    public static function getListNamesData(): array
+    {
+        return [
+            'test without trackers' => [
+                '/trackers.json',
+                201,
+                <<<JSON
+                {
+                    "trackers": []
+                }
+                JSON,
+                [],
+            ],
+            'test with multiple trackers' => [
+                '/trackers.json',
+                201,
+                <<<JSON
+                {
+                    "trackers": [
+                        {"id": 7, "name": "Tracker 3"},
+                        {"id": 8, "name": "Tracker 2"},
+                        {"id": 9, "name": "Tracker 1"}
+                    ]
+                }
+                JSON,
+                [
+                    7 => "Tracker 3",
+                    8 => "Tracker 2",
+                    9 => "Tracker 1",
+                ],
+            ],
+        ];
+    }
+
+    public function testListNamesCallsHttpClientOnlyOnce()
+    {
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                '/trackers.json',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                <<<JSON
+                {
+                    "trackers": [
+                        {
+                            "id": 1,
+                            "name": "Tracker 1"
+                        }
+                    ]
+                }
+                JSON,
+            ],
+        );
+
+        // Create the object under test
+        $api = new Tracker($client);
+
+        // Perform the tests
+        $this->assertSame([1 => 'Tracker 1'], $api->listNames());
+        $this->assertSame([1 => 'Tracker 1'], $api->listNames());
+        $this->assertSame([1 => 'Tracker 1'], $api->listNames());
+    }
+}