Fix qlty review findings

Author: otherguy

.editorconfig

@@ -13,7 +13,13 @@ trim_trailing_whitespace = true
 charset = utf-8
 
 [*.md]
-indent_size = 4
+indent_size = 1
+
+[*.php]
+indent_size = 1
+
+[*.toml]
+indent_size = 2
 
 [*.{yml,yaml,json,neon}]
 indent_size = 2

.github/workflows/ci.yml

@@ -21,18 +21,20 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5
+        with:
+          persist-credentials: false
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f
         with:
           php-version: ${{ matrix.php }}
           extensions: json, mbstring
           coverage: ${{ matrix.php == '8.3' && 'xdebug' || 'none' }}
           tools: composer:v2
 
       - name: Cache Composer dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830
         with:
           path: ~/.composer/cache
           key: composer-${{ matrix.php }}-${{ hashFiles('composer.json') }}

.qlty/.gitignore

@@ -0,0 +1,7 @@
+*
+!configs
+!configs/**
+!hooks
+!hooks/**
+!qlty.toml
+!.gitignore

.qlty/qlty.toml

@@ -0,0 +1,95 @@
+# This file was automatically generated by `qlty init`.
+# You can modify it to suit your needs.
+# We recommend you to commit this file to your repository.
+#
+# This configuration is used by both Qlty CLI and Qlty Cloud.
+#
+#     Qlty CLI -- Code quality toolkit for developers
+#     Qlty Cloud -- Fully automated Code Health Platform
+#
+# Try Qlty Cloud: https://qlty.sh
+#
+# For a guide to configuration, visit https://qlty.sh/d/config
+# Or for a full reference, visit https://qlty.sh/d/qlty-toml
+config_version = "0"
+
+exclude_patterns = [
+  "rector.php",
+  "*_min.*",
+  "*-min.*",
+  "*.min.*",
+  "**/.yarn/**",
+  "**/*.d.ts",
+  "**/assets/**",
+  "**/bower_components/**",
+  "**/build/**",
+  "**/cache/**",
+  "**/config/**",
+  "**/db/**",
+  "**/deps/**",
+  "**/dist/**",
+  "**/extern/**",
+  "**/external/**",
+  "**/generated/**",
+  "**/Godeps/**",
+  "**/gradlew/**",
+  "**/mvnw/**",
+  "**/node_modules/**",
+  "**/protos/**",
+  "**/seed/**",
+  "**/target/**",
+  "**/templates/**",
+  "**/testdata/**",
+  "**/vendor/**",
+]
+
+test_patterns = [
+  "**/test/**",
+  "**/spec/**",
+  "**/*.test.*",
+  "**/*.spec.*",
+  "**/*_test.*",
+  "**/*_spec.*",
+  "**/test_*.*",
+  "**/spec_*.*",
+]
+
+[smells]
+mode = "comment"
+
+[[source]]
+name = "default"
+default = true
+
+
+[[plugin]]
+name = "actionlint"
+
+[[plugin]]
+name = "editorconfig-checker"
+mode = "comment"
+
+[[plugin]]
+name = "osv-scanner"
+
+[[plugin]]
+name = "php-codesniffer"
+mode = "comment"
+
+[[plugin]]
+name = "phpstan"
+mode = "comment"
+
+[[plugin]]
+name = "radarlint-php"
+mode = "comment"
+
+[[plugin]]
+name = "ripgrep"
+mode = "comment"
+
+[[plugin]]
+name = "trufflehog"
+
+[[plugin]]
+name = "zizmor"

phpcs.xml.dist

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<ruleset name="php-currency-api">
+    <description>PSR-12 checks for qlty/php-codesniffer.</description>
+
+    <file>src</file>
+    <file>examples</file>
+    <file>rector.php</file>
+
+    <exclude-pattern>build/*</exclude-pattern>
+    <exclude-pattern>tests/*</exclude-pattern>
+    <exclude-pattern>vendor/*</exclude-pattern>
+
+    <rule ref="PSR12">
+        <exclude name="Generic.Files.LineLength"/>
+    </rule>
+</ruleset>

phpstan.neon

@@ -20,6 +20,3 @@ parameters:
     -
       identifier: offsetAccess.nonOffsetAccessible
       path: src/Drivers/*.php
-    -
-      identifier: argument.type
-      path: src/Drivers/*.php

rector.php

@@ -8,14 +8,14 @@
 use Rector\Set\ValueObject\SetList;
 
 return RectorConfig::configure()
-  ->withPaths([
-    __DIR__ . '/src',
-    __DIR__ . '/tests',
-  ])
-  ->withSets([
-    LevelSetList::UP_TO_PHP_83,
-    SetList::CODE_QUALITY,
-    SetList::TYPE_DECLARATION,
-    PHPUnitSetList::PHPUNIT_100,
-  ])
-  ->withImportNames(removeUnusedImports: true);
+    ->withPaths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withSets([
+        LevelSetList::UP_TO_PHP_83,
+        SetList::CODE_QUALITY,
+        SetList::TYPE_DECLARATION,
+        PHPUnitSetList::PHPUNIT_100,
+    ])
+    ->withImportNames(removeUnusedImports: true);

src/DriverFactory.php

@@ -16,9 +16,9 @@
 use Otherguy\Currency\Drivers\MockCurrencyDriver;
 use Otherguy\Currency\Drivers\OpenExchangeRates;
 use Otherguy\Currency\Exceptions\DriverNotFoundException;
+use Otherguy\Currency\Exceptions\MissingDependencyException;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
-use RuntimeException;
 
 class DriverFactory
 {
@@ -35,14 +35,14 @@ class DriverFactory
     public function __construct(?array $drivers = null)
     {
         $this->drivers = $drivers ?? [
-          'mock'              => MockCurrencyDriver::class,
-          'fixerio'           => FixerIo::class,
-          'currencylayer'     => CurrencyLayer::class,
-          'openexchangerates' => OpenExchangeRates::class,
-          'exchangeratesapi'  => ExchangeRatesApi::class,
-          'frankfurter'       => Frankfurter::class,
-          'currencyapi'       => CurrencyApi::class,
-          'fastforex'         => FastForex::class,
+            'mock'              => MockCurrencyDriver::class,
+            'fixerio'           => FixerIo::class,
+            'currencylayer'     => CurrencyLayer::class,
+            'openexchangerates' => OpenExchangeRates::class,
+            'exchangeratesapi'  => ExchangeRatesApi::class,
+            'frankfurter'       => Frankfurter::class,
+            'currencyapi'       => CurrencyApi::class,
+            'fastforex'         => FastForex::class,
         ];
     }
 
@@ -124,24 +124,57 @@ public static function setDefault(?self $instance): void
     private function defaultClient(): ClientInterface
     {
         if (!class_exists(GuzzleClient::class)) {
-            throw new RuntimeException(
-                'No PSR-18 HTTP client supplied and guzzlehttp/guzzle is not installed. '
-                . 'Either install guzzlehttp/guzzle, or pass a ClientInterface to DriverFactory::make().',
+            throw new MissingDependencyException(
+                'No PSR-18 HTTP client supplied and guzzlehttp/guzzle is '
+                . 'not installed. Either install guzzlehttp/guzzle, or pass '
+                . 'a ClientInterface to DriverFactory::make().',
             );
         }
 
-        return new GuzzleClient();
+        $client = $this->buildDefaultClient();
+        if (!$client instanceof ClientInterface) {
+            throw new MissingDependencyException(
+                'The installed guzzlehttp/guzzle package does not provide a PSR-18 '
+                . 'ClientInterface implementation.',
+            );
+        }
+
+        return $client;
     }
 
     private function defaultRequestFactory(): RequestFactoryInterface
     {
         if (!class_exists(GuzzleRequestFactory::class)) {
-            throw new RuntimeException(
-                'No PSR-17 RequestFactory supplied and http-interop/http-factory-guzzle is not installed. '
-                . 'Either install http-interop/http-factory-guzzle, or pass a RequestFactoryInterface to DriverFactory::make().',
+            throw new MissingDependencyException(
+                'No PSR-17 RequestFactory supplied and '
+                . 'http-interop/http-factory-guzzle is not installed. '
+                . 'Either install http-interop/http-factory-guzzle, or pass '
+                . 'a RequestFactoryInterface to DriverFactory::make().',
             );
         }
 
-        return new GuzzleRequestFactory();
+        $requestFactory = $this->buildDefaultRequestFactory();
+        if (!$requestFactory instanceof RequestFactoryInterface) {
+            throw new MissingDependencyException(
+                'The installed http-interop/http-factory-guzzle package does not '
+                . 'provide a PSR-17 RequestFactoryInterface implementation.',
+            );
+        }
+
+        return $requestFactory;
+    }
+
+    private function buildDefaultClient(): object
+    {
+        $class = GuzzleClient::class;
+
+        return new $class();
+    }
+
+    private function buildDefaultRequestFactory(): object
+    {
+        $class = GuzzleRequestFactory::class;
+
+        return new $class();
     }
 }

src/Drivers/BaseCurrencyDriver.php

@@ -4,6 +4,7 @@
 
 namespace Otherguy\Currency\Drivers;
 
+use Brick\Math\BigDecimal;
 use DateTimeInterface;
 use JsonException;
 use Otherguy\Currency\Currency;
@@ -178,4 +179,64 @@ protected function apiRequest(string $endpoint, array $params = []): array
 
         return $data;
     }
+
+    /**
+     * @param array<array-key, mixed> $response
+     */
+    protected function responseString(array $response, string $key, string $provider): string
+    {
+        $value = $response[$key] ?? null;
+        if (!is_scalar($value)) {
+            throw new ApiException("{$provider} response did not contain {$key}.");
+        }
+
+        return (string) $value;
+    }
+
+    /**
+     * @param array<array-key, mixed> $response
+     */
+    protected function optionalResponseString(array $response, string $key): ?string
+    {
+        $value = $response[$key] ?? null;
+
+        return is_scalar($value) ? (string) $value : null;
+    }
+
+    /**
+     * @param array<array-key, mixed> $response
+     */
+    protected function responseInt(array $response, string $key, string $provider): int
+    {
+        $value = $response[$key] ?? null;
+        if (!is_scalar($value)) {
+            throw new ApiException("{$provider} response did not contain {$key}.");
+        }
+
+        return (int) $value;
+    }
+
+    /**
+     * @param array<array-key, mixed> $response
+     *
+     * @return array<string, BigDecimal|float|int|string>
+     */
+    protected function responseRates(array $response, string $key, string $provider): array
+    {
+        $rates = $response[$key] ?? null;
+        if (!is_array($rates)) {
+            throw new ApiException("{$provider} response did not contain {$key}.");
+        }
+
+        $normalised = [];
+        foreach ($rates as $currency => $rate) {
+            if (!$rate instanceof BigDecimal && !is_float($rate) && !is_int($rate) && !is_string($rate)) {
+                throw new ApiException("{$provider} response did not contain a numeric rate for {$currency}.");
+            }
+
+            $normalised[(string) $currency] = $rate;
+        }
+
+        return $normalised;
+    }
 }