Merge pull request #48 from h4kuna/update-phpstan

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

README.md

@@ -41,15 +41,15 @@ try {
     $response = $ares->loadBasic('87744473');
     /* @var $response Ares\Ares\Core\Data */
     var_dump($response);
-} catch (Ares\Exceptions\IdentificationNumberNotFoundException $e) {
+} catch (Ares\Exception\IdentificationNumberNotFoundException $e) {
     // log identification number, why is bad? Or make nothing.
-} catch (Ares\Exceptions\AdisResponseException $e) {
+} catch (Ares\Exception\AdisResponseException $e) {
     // if validation by adis failed, but data from ares returned
     /* @var $response Ares\Ares\Core\Data */
     $response = $e->data;
     $response->adis === null; // true
     var_dump($e->getMessage());
-} catch (Ares\Exceptions\ServerResponseException $e) {
+} catch (Ares\Exception\ServerResponseException $e) {
     // no response from server or broken json
 }
 ```
@@ -65,7 +65,7 @@ try {
     foreach ($ares->loadBasicMulti($numbers) as $name => $r) {
         var_dump($name, $r->company);
     }
-} catch (Ares\Exceptions\ServerResponseException $e) {
+} catch (Ares\Exception\ServerResponseException $e) {
     // no response from server or broken json
 }
 ```
@@ -114,7 +114,7 @@ use h4kuna\Ares;
 try {
     $response = $ares->loadDataBox('87744473');
     var_dump($response->ISDS);
-} catch (h4kuna\Ares\Exceptions\ServerResponseException $e) {
+} catch (h4kuna\Ares\Exception\ServerResponseException $e) {
     // catch error
 }
 ```
@@ -130,7 +130,7 @@ use h4kuna\Ares;
 try {
     $response = $ares->checkVatVies($vatNumber);
     var_dump($response->valid); // true / false
-} catch (Ares\Exceptions\ServerResponseException $e) {
+} catch (Ares\Exception\ServerResponseException $e) {
     // invalid VAT
 }
 ```

bin/endpoints

@@ -13,12 +13,12 @@ try {
 	/* @var $response Ares\Ares\Core\Data */
 	$response->original = null;
 	dump($response);
-} catch (Ares\Exceptions\IdentificationNumberNotFoundException $e) {
+} catch (Ares\Exception\IdentificationNumberNotFoundException $e) {
 	dumpe($e->getMessage());
 	// log identification number, why is bad? Or make nothing.
-} catch (Ares\Exceptions\AdisResponseException $e) {
+} catch (Ares\Exception\AdisResponseException $e) {
 	dumpe($e->getMessage(), $e->data);
-} catch (Ares\Exceptions\ServerResponseException $e) {
+} catch (Ares\Exception\ServerResponseException $e) {
 	// no response from server or broken json
 	dumpe($e->getMessage());
 }
@@ -32,9 +32,9 @@ foreach ($response->sources as $name => $exists) {
 	try {
 		$result = $ares->getAresClient()->useEndpoint($name, $IN);
 		dump($result);
-	} catch (Ares\Exceptions\IdentificationNumberNotFoundException $e) {
+	} catch (Ares\Exception\IdentificationNumberNotFoundException $e) {
 		// log identification number, why is bad? Or make nothing.
-	} catch (Ares\Exceptions\ServerResponseException $e) {
+	} catch (Ares\Exception\ServerResponseException $e) {
 		// no response from server or broken json
 	}
 }

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,15 @@ 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:
+			missingCheckedExceptionInThrows: true
+			tooWideThrowType: true
+		implicitThrows: false
+		checkedExceptionClasses:
+			- h4kuna\Ares\Exception\RuntimeException
 
 includes:
 	- vendor/phpstan/phpstan-strict-rules/rules.neon

src/Adis/Client.php

@@ -3,53 +3,63 @@
 namespace h4kuna\Ares\Adis;
 
 use h4kuna\Ares\Adis\Soap\Envelope;
-use h4kuna\Ares\Exceptions\ServerResponseException;
+use h4kuna\Ares\Exception\ServerResponseException;
 use h4kuna\Ares\Http\TransportProvider;
-use h4kuna\Ares\Tools\Xml;
+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

@@ -6,8 +6,9 @@
 use h4kuna\Ares\Adis\StatusBusinessSubjects\StatusBusinessSubjectsTransformer;
 use h4kuna\Ares\Adis\StatusBusinessSubjects\Subject;
 use h4kuna\Ares\Ares\Helper;
-use h4kuna\Ares\Exceptions\InvalidStateException;
-use h4kuna\Ares\Tools\Batch;
+use h4kuna\Ares\Exception\LogicException;
+use h4kuna\Ares\Exception\ServerResponseException;
+use h4kuna\Ares\Tool\Batch;
 
 final class ContentProvider
 {
@@ -16,19 +17,24 @@ public function __construct(private Client $client, private StatusBusinessSubjec
 	}
 
 
+	/**
+	 * @throws ServerResponseException
+	 */
 	public function statusBusinessSubject(string $tin): Subject
 	{
 		foreach ($this->statusBusinessSubjects([$tin => $tin]) as $subject) {
 			return $subject;
 		}
 
-		throw new InvalidStateException('ADIS must return anything.');
+		throw new LogicException('ADIS must return anything.');
 	}
 
 
 	/**
 	 * @param array<string, string> $tin
 	 * @return Generator<string, Subject>
+	 *
+	 * @throws ServerResponseException
 	 */
 	public function statusBusinessSubjects(array $tin): Generator
 	{

src/Ares.php

@@ -5,9 +5,10 @@
 use Generator;
 use h4kuna\Ares\Ares\Core;
 use h4kuna\Ares\Ares\Core\Data;
-use h4kuna\Ares\Exceptions\AdisResponseException;
-use h4kuna\Ares\Exceptions\IdentificationNumberNotFoundException;
-use h4kuna\Ares\Exceptions\ServerResponseException;
+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

@@ -2,12 +2,10 @@
 
 namespace h4kuna\Ares\Ares;
 
-use h4kuna\Ares\Exceptions\IdentificationNumberNotFoundException;
-use h4kuna\Ares\Exceptions\ResultException;
-use h4kuna\Ares\Exceptions\ServerResponseException;
+use h4kuna\Ares\Exception\IdentificationNumberNotFoundException;
+use h4kuna\Ares\Exception\ResultException;
+use h4kuna\Ares\Exception\ServerResponseException;
 use h4kuna\Ares\Http\TransportProvider;
-use Nette\Utils\Json;
-use Nette\Utils\JsonException;
 use Psr\Http\Message\ResponseInterface;
 use stdClass;
 
@@ -16,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
 	{
@@ -33,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
 	{
@@ -51,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);