feat(composer): update phpstan

Author: h4kuna

.github/workflows/tests.yml

@@ -38,7 +38,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ['8.0', '8.1', '8.2', '8.3', '8.4']
+        php: ['8.0', '8.1', '8.2', '8.3'] # exclude 8.4
     name: PHP Lowest Dependencies ${{ matrix.php }}
     steps:
       - uses: actions/checkout@v3

composer.json

@@ -48,7 +48,7 @@
   },
   "scripts": {
     "coverage": "vendor/bin/tester --coverage coverage.html --coverage-src src/ --colors 1 -s -C tests/src",
-    "qa": "composer stan && composer tests",
+    "qa": ["@tests", "@stan"],
     "stan": "vendor/bin/phpstan analyse",
     "tests": "vendor/bin/tester --colors 1 -s -C tests/src"
   },

phpstan.neon

@@ -10,10 +10,7 @@ parameters:
 			message: "#^Variable property access on \\$this\\(h4kuna\\\\Ares\\\\Ares\\\\Core\\\\Data\\)\\.$#"
 			count: 3
 			path: src/Ares/Core/Data.php
-		-
-			message: "#^If condition is always false\\.$#"
-			count: 1
-			path: src/aliases.php
+		- '/Method h4kuna\\Ares\\Tests\\.*? throws checked exception .*? but it.s missing from the PHPDoc @throws tag\./'
 
 	exceptions: #see https://www.youtube.com/watch?v=UQsP1U0sVZM
 		check:

src/Adis/Client.php

@@ -5,51 +5,61 @@
 use h4kuna\Ares\Adis\Soap\Envelope;
 use h4kuna\Ares\Exception\ServerResponseException;
 use h4kuna\Ares\Http\TransportProvider;
+use h4kuna\Ares\Tool\Arrays;
+use h4kuna\Ares\Tool\Integer;
+use h4kuna\Ares\Tool\Strings;
 use h4kuna\Ares\Tool\Xml;
+use SimpleXMLElement;
 use stdClass;
 
 final class Client
 {
 	public static string $url = 'https://adisrws.mfcr.cz/adistc/axis2/services/rozhraniCRPDPH.rozhraniCRPDPHSOAP';
 
-
-	public function __construct(private TransportProvider $transportProvider,)
-	{
+	public function __construct(
+		private TransportProvider $transportProvider,
+	) {
 	}
 
 
 	/**
 	 * @param array<string, string> $chunk
-	 * @return array<stdClass>
+	 * @return list<stdClass>
+	 *
+	 * @throws ServerResponseException
 	 */
 	public function statusBusinessSubjects(array $chunk): array
 	{
 		$xml = Envelope::StatusNespolehlivySubjektRozsireny(...$chunk);
 		$data = $this->request($xml, 'StatusNespolehlivySubjektRozsirenyResponse');
 		$attributes = '@attributes';
-		assert($data->status instanceof stdClass);
-		if (isset($data->status->$attributes) === false) {
-			throw new ServerResponseException('Broken response xml.');
+
+		if (
+			$data->status instanceof stdClass === false
+			|| isset($data->status->$attributes) === false
+			|| $data->status->$attributes instanceof stdClass === false
+		) {
+			throw ServerResponseException::brokenXml();
 		}
 		$element = $data->status->$attributes;
-		assert($element instanceof stdClass);
-
 		if ($element->statusCode !== '0') {
-			throw new ServerResponseException($element->statusText, (int) $element->statusCode);
+			throw ServerResponseException::badResponse(Strings::fromMixedStrict($element->statusText), (int) Integer::fromMixed($element->statusCode));
 		}
 
-		return is_array($data->statusSubjektu) ? $data->statusSubjektu : [$data->statusSubjektu];
+		return Arrays::fromStdClass($data->statusSubjektu);
 	}
 
-
+	/**
+	 * @throws ServerResponseException
+	 */
 	private function request(string $xml, string $name): stdClass
 	{
 		$request = $this->transportProvider->createXmlRequest(self::$url, $xml);
 		$response = $this->transportProvider->response($request);
 		$xml = @simplexml_load_string($response->getBody()->getContents(), namespace_or_prefix: 'soapenv', is_prefix: true);
 
-		if ($xml === false || isset($xml->Body->children()->$name) === false) {
-			throw new ServerResponseException(sprintf('Missing tag "%s" in response.', $name));
+		if ($xml === false || ($xml->Body->children()->$name instanceof SimpleXMLElement) === false) {
+			throw ServerResponseException::badResponse(sprintf('Missing tag "%s" in response.', $name));
 		}
 
 		return Xml::toJson($xml->Body->children()->$name);

src/Adis/ContentProvider.php

@@ -7,6 +7,7 @@
 use h4kuna\Ares\Adis\StatusBusinessSubjects\Subject;
 use h4kuna\Ares\Ares\Helper;
 use h4kuna\Ares\Exception\LogicException;
+use h4kuna\Ares\Exception\ServerResponseException;
 use h4kuna\Ares\Tool\Batch;
 
 final class ContentProvider
@@ -16,6 +17,9 @@ public function __construct(private Client $client, private StatusBusinessSubjec
 	}
 
 
+	/**
+	 * @throws ServerResponseException
+	 */
 	public function statusBusinessSubject(string $tin): Subject
 	{
 		foreach ($this->statusBusinessSubjects([$tin => $tin]) as $subject) {
@@ -29,6 +33,8 @@ public function statusBusinessSubject(string $tin): Subject
 	/**
 	 * @param array<string, string> $tin
 	 * @return Generator<string, Subject>
+	 *
+	 * @throws ServerResponseException
 	 */
 	public function statusBusinessSubjects(array $tin): Generator
 	{

src/Ares.php

@@ -7,6 +7,7 @@
 use h4kuna\Ares\Ares\Core\Data;
 use h4kuna\Ares\Exception\AdisResponseException;
 use h4kuna\Ares\Exception\IdentificationNumberNotFoundException;
+use h4kuna\Ares\Exception\ResultException;
 use h4kuna\Ares\Exception\ServerResponseException;
 use h4kuna\Ares\Vies\ViesEntity;
 use stdClass;
@@ -21,11 +22,9 @@ public function __construct(
 		public DataBox\ContentProvider $dataBoxContentProvider,
 		public Adis\ContentProvider $adisContentProvider,
 		public Vies\ContentProvider $viesContentProvider,
-	)
-	{
+	) {
 	}
 
-
 	/**
 	 * @deprecated use property
 	 */
@@ -34,43 +33,44 @@ public function getAdis(): Adis\ContentProvider
 		return $this->adisContentProvider;
 	}
 
-
 	public function getAresClient(): Ares\Client
 	{
 		return $this->aresContentProvider->getClient();
 	}
 
-
 	/**
 	 * @template KeyName
 	 * @param array<KeyName, string|int> $identificationNumbers
 	 * @return Generator<(int&KeyName)|(KeyName&string), Data>
+	 *
+	 * @throws ResultException
+	 * @throws ServerResponseException
 	 */
 	public function loadBasicMulti(array $identificationNumbers): Generator
 	{
 		return $this->aresContentProvider->loadByIdentificationNumbers($identificationNumbers);
 	}
 
-
 	/**
-	 * @throws IdentificationNumberNotFoundException
 	 * @throws AdisResponseException
+	 * @throws IdentificationNumberNotFoundException
+	 * @throws ServerResponseException
 	 */
 	public function loadBasic(string $in): Data
 	{
 		return $this->aresContentProvider->load($in);
 	}
 
-
 	/**
 	 * @return array<stdClass>
+	 * @throws ResultException
+	 * @throws ServerResponseException
 	 */
 	public function loadDataBox(string $in): array
 	{
 		return $this->dataBoxContentProvider->load($in);
 	}
 
-
 	/**
 	 * @return object{countryCode: string, vatNumber: string, requestDate: string, valid: bool, requestIdentifier: string, name: string, address: string, traderName: string, traderStreet: string, traderPostalCode: string, traderCity: string, traderCompanyType: string, traderNameMatch: string, traderStreetMatch: string, traderPostalCodeMatch: string, traderCityMatch: string, traderCompanyTypeMatch: string}
 	 *

src/Ares/Client.php

@@ -4,6 +4,7 @@
 
 use h4kuna\Ares\Exception\IdentificationNumberNotFoundException;
 use h4kuna\Ares\Exception\ResultException;
+use h4kuna\Ares\Exception\ServerResponseException;
 use h4kuna\Ares\Http\TransportProvider;
 use Psr\Http\Message\ResponseInterface;
 use stdClass;
@@ -13,14 +14,15 @@ class Client
 
 	public function __construct(
 		private TransportProvider $transportProvider,
-	)
-	{
+	) {
 	}
 
-
 	/**
 	 * @param Sources::SERVICE_*|Sources::CORE|Sources::DIAL $key
 	 * @param array<string, mixed> $data
+	 *
+	 * @throws ResultException
+	 * @throws ServerResponseException
 	 */
 	public function searchEndpoint(string $key, array $data = []): stdClass
 	{
@@ -30,9 +32,10 @@ public function searchEndpoint(string $key, array $data = []): stdClass
 		return $this->responseToStdClass($response);
 	}
 
-
 	/**
 	 * @param Sources::SERVICE_*|Sources::CORE $key
+	 * @throws IdentificationNumberNotFoundException
+	 * @throws ServerResponseException
 	 */
 	public function useEndpoint(string $key, string $in): stdClass
 	{
@@ -48,7 +51,10 @@ public function useEndpoint(string $key, string $in): stdClass
 		return $json;
 	}
 
-
+	/**
+	 * @throws ResultException
+	 * @throws ServerResponseException
+	 */
 	protected function responseToStdClass(ResponseInterface $response): stdClass
 	{
 		$json = $this->transportProvider->toJson($response);

src/Ares/Core/ContentProvider.php

@@ -9,33 +9,33 @@
 use h4kuna\Ares\Ares\Sources;
 use h4kuna\Ares\Exception\AdisResponseException;
 use h4kuna\Ares\Exception\IdentificationNumberNotFoundException;
+use h4kuna\Ares\Exception\ResultException;
 use h4kuna\Ares\Exception\ServerResponseException;
 use h4kuna\Ares\Tool\Batch;
 
 final class ContentProvider
 {
 	private const BATCH = 100; // max identification numbers per request
 
-
 	public function __construct(
 		private JsonToDataTransformer $jsonTransformer,
 		private Client $client,
 		private Adis\ContentProvider $adisContentProvider,
-	)
-	{
+	) {
 	}
 
-
 	public function getClient(): Client
 	{
 		return $this->client;
 	}
 
-
 	/**
 	 * @template KeyName
 	 * @param array<KeyName, string|int> $identificationNumbers
 	 * @return Generator<(int&KeyName)|(KeyName&string), Data>
+	 *
+	 * @throws ResultException
+	 * @throws ServerResponseException
 	 */
 	public function loadByIdentificationNumbers(array $identificationNumbers): Generator
 	{
@@ -74,10 +74,10 @@ public function loadByIdentificationNumbers(array $identificationNumbers): Gener
 		}
 	}
 
-
 	/**
-	 * @throws IdentificationNumberNotFoundException
 	 * @throws AdisResponseException
+	 * @throws IdentificationNumberNotFoundException
+	 * @throws ServerResponseException
 	 */
 	public function load(string $in): Data
 	{
@@ -88,7 +88,7 @@ public function load(string $in): Data
 			try {
 				$adis = $this->adisContentProvider->statusBusinessSubject($data->tin);
 			} catch (ServerResponseException $e) {
-				throw new AdisResponseException($data, previous: $e);
+				throw AdisResponseException::fromServerException($data, $e);
 			}
 
 			$data->setAdis($adis);

src/Ares/Helper.php

@@ -7,6 +7,10 @@
 use h4kuna\Ares\Tool\Strings;
 use Nette\Utils\Strings as NetteStrings;
 
+/**
+ * @phpstan-type addressTypeRaw array{street?: string, zip?: string, city?: string, house_number?: string, country?: string}
+ * @phpstan-type addressType array{street: ?string, zip: ?string, city: ?string, house_number: ?string, country: ?string}
+ */
 final class Helper
 {
 	public static string $baseUrl = 'https://ares.gov.cz/ekonomicke-subjekty-v-be/rest';
@@ -126,25 +130,27 @@ public static function normalizeIN(string $in): string
 
 
 	/**
-	 * @return array{street: ?string, zip: ?string, city: ?string, house_number: ?string, country: ?string}
+	 * @return addressType
 	 */
 	public static function parseAddress(string $address): array
 	{
+		/** @var ?addressTypeRaw $results */
 		$results = NetteStrings::match($address, '~^(?<street>.+) (?<house_number>\d+(?:/\d+)?(\w)?)(?:, (?<district>.+?))?, (?<zip>\d{5}) (?<city>.+?)(, (?<country>.+))?$~');
 
 		if ($results !== null) {
 			return self::prepareAddressData($results);
 		}
 
+		/** @var ?addressTypeRaw $results */
 		$results = NetteStrings::match($address, '~^(?<city>.+), (?<zip>\d{5})(?:, (?<district>.+?))?, (?<street>.+), (?<house_number>\d+(?:/\d+)?(\w)?)$~');
 
 		return self::prepareAddressData($results ?? []);
 	}
 
 
 	/**
-	 * @param array{street?: string, zip?: string, city?: string, house_number?: string, country?: string} $results
-	 * @return array{street: ?string, zip: ?string, city: ?string, house_number: ?string, country: ?string}
+	 * @param addressTypeRaw $results
+	 * @return addressType
 	 */
 	private static function prepareAddressData(array $results): array
 	{

src/DataBox/Client.php

@@ -5,6 +5,7 @@
 use h4kuna\Ares\Exception\ResultException;
 use h4kuna\Ares\Exception\ServerResponseException;
 use h4kuna\Ares\Http\TransportProvider;
+use h4kuna\Ares\Tool\Strings;
 use h4kuna\Ares\Tool\Xml;
 use Psr\Http\Message\StreamInterface;
 use stdClass;
@@ -16,14 +17,15 @@ final class Client
 {
 	public static string $url = 'https://www.mojedatovaschranka.cz/sds/ws/call';
 
-
 	public function __construct(
 		private TransportProvider $requestProvider,
-	)
-	{
+	) {
 	}
 
-
+	/**
+	 * @throws ResultException
+	 * @throws ServerResponseException
+	 */
 	public function request(StreamInterface $body): stdClass
 	{
 		$request = $this->requestProvider->createXmlRequest(self::$url, $body);
@@ -33,9 +35,9 @@ public function request(StreamInterface $body): stdClass
 		$data = Xml::toJson($response);
 
 		if (isset($data->Message)) {
-			throw new ResultException($data->Message);
+			throw ResultException::withMessage(Strings::fromMixedStrict($data->Message));
 		} elseif (isset($data->Osoba) === false) {
-			throw new ServerResponseException('No content');
+			throw ServerResponseException::badResponse('No content');
 		}
 
 		return $data;