Merge pull request #11 from arueckauer/chore/dependencies-upgrade-and…

…-code-cleanup Chore: dependencies upgrade and code cleanup
arueckauer · Nov 22, 2023 · 4d01656 · 4d01656
2 parents 773e53c + 830198c
commit 4d01656
Show file tree

Hide file tree

Showing 35 changed files with 392 additions and 249 deletions.
diff --git a/composer.json b/composer.json
@@ -1,15 +1,14 @@
 {
     "name": "arueckauer/okta-client",
-    "type": "library",
     "description": "PHP client for Core Okta API",
+    "license": "BSD-3-Clause",
+    "type": "library",
     "keywords": [
         "okta",
         "okta-api",
         "okta-client",
         "client"
     ],
-    "homepage": "https://github.com/arueckauer/okta-client",
-    "license": "BSD-3-Clause",
     "authors": [
         {
             "name": "Andi Rückauer",
@@ -18,46 +17,53 @@
             "role": "Project Lead"
         }
     ],
+    "homepage": "https://github.com/arueckauer/okta-client",
     "require": {
         "php": "~8.1.0",
         "ext-json": "*",
-        "guzzlehttp/guzzle": "~7.5.0",
-        "laminas/laminas-config-aggregator": "^1.7",
-        "laminas/laminas-servicemanager": "^3.10",
-        "symfony/console": "^5.3"
+        "guzzlehttp/guzzle": "^7.5",
+        "laminas/laminas-config-aggregator": "^1.14",
+        "laminas/laminas-servicemanager": "^3.22",
+        "symfony/console": "^6.3"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "^2.3",
-        "phpunit/phpunit": "^9.5",
+        "ergebnis/composer-normalize": "^2.39",
+        "laminas/laminas-coding-standard": "^2.5",
+        "phpunit/phpunit": "^10.4",
+        "rector/rector": "^0.18.10",
         "roave/security-advisories": "dev-latest",
-        "vimeo/psalm": "^4.11"
-    },
-    "config": {
-        "allow-plugins": {
-            "dealerdirect/phpcodesniffer-composer-installer": true
-        },
-        "sort-packages": true
-    },
-    "extra": {
-        "laminas": {
-            "config-provider": [
-                "OktaClient\\ConfigProvider"
-            ]
-        }
+        "vimeo/psalm": "^5.15"
     },
+    "minimum-stability": "stable",
+    "prefer-stable": true,
     "autoload": {
         "psr-4": {
             "OktaClient\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "OktaClientTest\\": "test"
+            "OktaClientTest\\": "test/unit"
         }
     },
-    "minimum-stability": "stable",
-    "prefer-stable": true,
     "bin": [
         "bin/okta-client"
-    ]
+    ],
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "ergebnis/composer-normalize": true
+        },
+        "audit": {
+            "abandoned": "report"
+        },
+        "sort-packages": true
+    },
+    "extra": {
+        "laminas": {
+            "config-provider": [
+                "OktaClient\\ConfigProvider"
+            ]
+        }
+    }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -2,27 +2,23 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
          bootstrap="vendor/autoload.php"
-         cacheResultFile=".phpunit.cache/test-results"
          executionOrder="depends,defects"
-         forceCoversAnnotation="true"
-         beStrictAboutCoversAnnotation="true"
          beStrictAboutOutputDuringTests="true"
-         beStrictAboutTodoAnnotatedTests="true"
-         convertDeprecationsToExceptions="true"
          failOnRisky="true"
          failOnWarning="true"
-         verbose="true"
-         colors="true">
-    <testsuites>
-        <testsuite name="default">
-            <directory>test</directory>
-        </testsuite>
-    </testsuites>
-
-    <coverage cacheDirectory=".phpunit.cache/code-coverage"
-              processUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">src</directory>
-        </include>
-    </coverage>
+         colors="true"
+         cacheDirectory=".phpunit.cache"
+         requireCoverageMetadata="true"
+         beStrictAboutCoverageMetadata="true">
+  <testsuites>
+    <testsuite name="default">
+      <directory>test</directory>
+    </testsuite>
+  </testsuites>
+  <coverage/>
+  <source>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.10.0@916b098b008f6de4543892b1e0651c1c3b92cbfa">
+<files psalm-version="5.15.0@5c774aca4746caf3d239d9c8cadb9f882ca29352">
   <file src="src/Request/GenericFactory.php">
-    <InvalidStringClass occurrences="1">
+    <InvalidStringClass>
       <code>new $requestedName($client)</code>
     </InvalidStringClass>
   </file>

diff --git a/psalm.xml b/psalm.xml
@@ -6,9 +6,12 @@
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
     errorBaseline="psalm-baseline.xml"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
 >
     <projectFiles>
         <directory name="src" />
+        <directory name="test" />
         <ignoreFiles>
             <directory name="vendor" />
         </ignoreFiles>

diff --git a/rector.php b/rector.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\Set\PHPUnitSetList;
+use Rector\Set\ValueObject\LevelSetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/src',
+        __DIR__ . '/test',
+    ]);
+
+    $rectorConfig->sets([
+        LevelSetList::UP_TO_PHP_81,
+        PHPUnitSetList::PHPUNIT_100,
+    ]);
+};
diff --git a/src/Client.php b/src/Client.php
@@ -14,13 +14,10 @@
 
 class Client
 {
-    private HttpClient $client;
-    private string $apiKey;
-
-    public function __construct(HttpClient $client, string $apiKey)
-    {
-        $this->client = $client;
-        $this->apiKey = $apiKey;
+    public function __construct(
+        private readonly HttpClient $client,
+        private readonly string $apiKey,
+    ) {
     }
 
     /**

diff --git a/src/ClientFactory.php b/src/ClientFactory.php
@@ -5,13 +5,19 @@
 namespace OktaClient;
 
 use GuzzleHttp\Client as HttpClient;
+use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
+use Psr\Container\NotFoundExceptionInterface;
 
 use function assert;
 use function is_array;
 
 class ClientFactory
 {
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
     public function __invoke(ContainerInterface $container): Client
     {
         $config = $container->get('config')[Client::class] ?? [];

diff --git a/src/ConfigProvider.php b/src/ConfigProvider.php
@@ -4,6 +4,13 @@
 
 namespace OktaClient;
 
+/**
+ * @psalm-type _Configuration = array{
+ *     dependencies: array{
+ *         factories: array<class-string, class-string>
+ *     }
+ * }
+ */
 class ConfigProvider
 {
     public function __invoke(): array

diff --git a/src/Dto/GroupMember.php b/src/Dto/GroupMember.php
@@ -6,21 +6,23 @@
 
 class GroupMember
 {
-    public string $id        = '';
-    public string $status    = '';
-    public string $firstName = '';
-    public string $lastName  = '';
-    public string $email     = '';
+    public function __construct(
+        public readonly string $id,
+        public readonly string $status,
+        public readonly string $firstName,
+        public readonly string $lastName,
+        public readonly string $email
+    ) {
+    }
 
     public static function fromArray(array $input): self
     {
-        $self            = new self();
-        $self->id        = (string) ($input['id'] ?? '');
-        $self->status    = (string) ($input['status'] ?? '');
-        $self->firstName = (string) ($input['profile']['firstName'] ?? '');
-        $self->lastName  = (string) ($input['profile']['lastName'] ?? '');
-        $self->email     = (string) ($input['profile']['email'] ?? '');
-
-        return $self;
+        return new self(
+            (string) ($input['id'] ?? ''),
+            (string) ($input['status'] ?? ''),
+            (string) ($input['profile']['firstName'] ?? ''),
+            (string) ($input['profile']['lastName'] ?? ''),
+            (string) ($input['profile']['email'] ?? ''),
+        );
     }
 }
diff --git a/src/Dto/GroupMemberCollection.php b/src/Dto/GroupMemberCollection.php
@@ -4,6 +4,7 @@
 
 namespace OktaClient\Dto;
 
+use JsonException;
 use Psr\Http\Message\ResponseInterface;
 
 use function json_decode;
@@ -20,11 +21,14 @@ public function __construct(GroupMember ...$data)
         $this->data = $data;
     }
 
+    /**
+     * @throws JsonException
+     */
     public static function fromResponse(ResponseInterface $response): self
     {
         /** @var array $payload */
         $payload = json_decode(
-            (string) $response->getBody(),
+            $response->getBody()->getContents(),
             true,
             512,
             JSON_THROW_ON_ERROR

diff --git a/src/Dto/UserGroup.php b/src/Dto/UserGroup.php
@@ -6,17 +6,19 @@
 
 class UserGroup
 {
-    public string $id          = '';
-    public string $type        = '';
-    public string $profileName = '';
+    public function __construct(
+        public readonly string $id,
+        public readonly string $type,
+        public readonly string $profileName
+    ) {
+    }
 
     public static function fromArray(array $input): self
     {
-        $self              = new self();
-        $self->id          = isset($input['id']) ? (string) $input['id'] : '';
-        $self->type        = isset($input['type']) ? (string) $input['type'] : '';
-        $self->profileName = isset($input['profile']['name']) ? (string) $input['profile']['name'] : '';
-
-        return $self;
+        return new self(
+            isset($input['id']) ? (string) $input['id'] : '',
+            isset($input['type']) ? (string) $input['type'] : '',
+            isset($input['profile']['name']) ? (string) $input['profile']['name'] : '',
+        );
     }
 }
diff --git a/src/Dto/UserGroupCollection.php b/src/Dto/UserGroupCollection.php
@@ -30,7 +30,7 @@ public static function fromResponse(ResponseInterface $response): self
 
         /** @var array $payload */
         $payload = json_decode(
-            (string) $response->getBody(),
+            $response->getBody()->getContents(),
             true,
             512,
             JSON_THROW_ON_ERROR

diff --git a/src/Group/GetMembers.php b/src/Group/GetMembers.php
@@ -11,11 +11,9 @@
 
 class GetMembers
 {
-    private ListGroupMembers $listGroupMembers;
-
-    public function __construct(ListGroupMembers $listGroupMembers)
-    {
-        $this->listGroupMembers = $listGroupMembers;
+    public function __construct(
+        private readonly ListGroupMembers $listGroupMembers,
+    ) {
     }
 
     /**

diff --git a/src/Group/GetMembersFactory.php b/src/Group/GetMembersFactory.php
@@ -5,12 +5,18 @@
 namespace OktaClient\Group;
 
 use OktaClient\Request\ListGroupMembers;
+use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
+use Psr\Container\NotFoundExceptionInterface;
 
 use function assert;
 
 class GetMembersFactory
 {
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
     public function __invoke(ContainerInterface $container): GetMembers
     {
         $listGroupMembers = $container->get(ListGroupMembers::class);