Create TimeEntryActivity::listNames()

Author: Art4

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - New method `Redmine\Api\IssueStatus::listNames()` for listing the ids and names of all issue statuses.
 - 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.
 
 ### Deprecated
 

src/Redmine/Api/TimeEntryActivity.php

@@ -17,6 +17,8 @@ class TimeEntryActivity extends AbstractApi
 {
     private $timeEntryActivities = [];
 
+    private $timeEntryActivityNames = null;
+
     /**
      * List time entry activities.
      *
@@ -35,6 +37,29 @@ final public function list(array $params = []): array
         }
     }
 
+    /**
+     * Returns an array of all time entry activities with id/name pairs.
+     *
+     * @return array<int,string> list of time entry activities (id => name)
+     */
+    final public function listNames(): array
+    {
+        if ($this->timeEntryActivityNames !== null) {
+            return $this->timeEntryActivityNames;
+        }
+
+        $this->timeEntryActivityNames = [];
+        $list = $this->list();
+
+        if (array_key_exists('time_entry_activities', $list)) {
+            foreach ($list['time_entry_activities'] as $activity) {
+                $this->timeEntryActivityNames[(int) $activity['id']] = $activity['name'];
+            }
+        }
+
+        return $this->timeEntryActivityNames;
+    }
+
     /**
      * List time entry activities.
      *

tests/Behat/Bootstrap/TimeEntryActivityContextTrait.php

@@ -40,4 +40,18 @@ public function iListAllTimeEntryActivities()
             $api->getLastResponse(),
         );
     }
+
+    /**
+     * @When I list all time entry activity names
+     */
+    public function iListAllTimeEntryActivityNames()
+    {
+        /** @var TimeEntryActivity */
+        $api = $this->getNativeCurlClient()->getApi('time_entry_activity');
+
+        $this->registerClientResponse(
+            $api->listNames(),
+            $api->getLastResponse(),
+        );
+    }
 }

tests/Behat/features/time_entry_activity.feature

@@ -16,7 +16,6 @@ Feature: Interacting with the REST API for time entry activities
         And the returned data "time_entry_activities" property is an array
         And the returned data "time_entry_activities" property contains "0" items
 
-    @wip
     Scenario: Listing of multiple time entry activities
         Given I have a "NativeCurlClient" client
         And I have a time entry activiy with name "Development"
@@ -59,3 +58,17 @@ Feature: Interacting with the REST API for time entry activities
             | is_default        | false                |
             | active            | true                 |
 
+    Scenario: Listing of multiple time entry activity names
+        Given I have a "NativeCurlClient" client
+        And I have a time entry activiy with name "Development"
+        And I have a time entry activiy with name "Support"
+        When I list all time entry activity names
+        Then the response has the status code "200"
+        And the response has the content type "application/json"
+        And the returned data is an array
+        And the returned data contains "2" items
+        And the returned data contains the following data
+            | property          | value                |
+            | 1                 | Development          |
+            | 2                 | Support              |
+

tests/Unit/Api/TimeEntryActivity/ListNamesTest.php

@@ -0,0 +1,108 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Redmine\Tests\Unit\Api\TimeEntryActivity;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Redmine\Api\TimeEntryActivity;
+use Redmine\Tests\Fixtures\AssertingHttpClient;
+
+#[CoversClass(TimeEntryActivity::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 TimeEntryActivity($client);
+
+        // Perform the tests
+        $this->assertSame($expectedResponse, $api->listNames());
+    }
+
+    public static function getListNamesData(): array
+    {
+        return [
+            'test without time entry activities' => [
+                '/enumerations/time_entry_activities.json',
+                201,
+                <<<JSON
+                {
+                    "time_entry_activities": []
+                }
+                JSON,
+                [],
+            ],
+            'test with multiple time entry activities' => [
+                '/enumerations/time_entry_activities.json',
+                201,
+                <<<JSON
+                {
+                    "time_entry_activities": [
+                        {"id": 7, "name": "TimeEntryActivity 3"},
+                        {"id": 8, "name": "TimeEntryActivity 2"},
+                        {"id": 9, "name": "TimeEntryActivity 1"}
+                    ]
+                }
+                JSON,
+                [
+                    7 => "TimeEntryActivity 3",
+                    8 => "TimeEntryActivity 2",
+                    9 => "TimeEntryActivity 1",
+                ],
+            ],
+        ];
+    }
+
+    public function testListNamesCallsHttpClientOnlyOnce()
+    {
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                '/enumerations/time_entry_activities.json',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                <<<JSON
+                {
+                    "time_entry_activities": [
+                        {
+                            "id": 1,
+                            "name": "TimeEntryActivity 1"
+                        }
+                    ]
+                }
+                JSON,
+            ],
+        );
+
+        // Create the object under test
+        $api = new TimeEntryActivity($client);
+
+        // Perform the tests
+        $this->assertSame([1 => 'TimeEntryActivity 1'], $api->listNames());
+        $this->assertSame([1 => 'TimeEntryActivity 1'], $api->listNames());
+        $this->assertSame([1 => 'TimeEntryActivity 1'], $api->listNames());
+    }
+}