Merge pull request #12 from spaze/spaze/phpstan-level-max

Get to PHPStan level max + bleedingEdge

.gitattributes

@@ -4,5 +4,6 @@
 /.scrutinizer.yml export-ignore
 /.travis.yml export-ignore
 /composer.lock export-ignore
+/phpstan.neon export-ignore
 /phpunit.xml.dist export-ignore
 /tests export-ignore

README.md

@@ -162,4 +162,4 @@ This library is licensed under the MIT license. Please see [License file](LICENS
 
 <a name="contributing"></a>
 ## Contributing
-Run PHPUnit tests with `composer test`, see `scripts` in `composer.json`. Tests are also run on GitHub with Actions on each push.
+Run PHPUnit tests and static analysis with `composer test`, see `scripts` in `composer.json`. Tests are also run on GitHub with Actions on each push.

composer.json

@@ -15,8 +15,9 @@
 		}
 	],
 	"require": {
-	  "php": ">=7.3",
-	  "ext-soap": "*"
+		"php": ">=7.3",
+		"ext-soap": "*",
+		"phpstan/phpstan": "^0.12.42"
 	},
 	"require-dev": {
 		"phpunit/php-timer": "1.0.*",
@@ -29,8 +30,10 @@
 	},
 	"minimum-stability": "stable",
 	"scripts": {
+		"phpstan-dev": "vendor/bin/phpstan --ansi analyse --configuration phpstan.neon",
 		"phpunit-dev": "php vendor/phpunit/phpunit/phpunit --colors=always --verbose",
 		"test": [
+			"@phpstan-dev",
 			"@phpunit-dev"
 		]
 	}

phpstan.neon

@@ -0,0 +1,12 @@
+parameters:
+	paths:
+		- src
+	level: max
+	ignoreErrors:
+		-
+			message: '#^Call to an undefined method SoapClient::checkVatApprox\(\)\.$#'
+			path: src/VatCalculator.php
+			count: 1
+
+includes:
+	- vendor/phpstan/phpstan/conf/bleedingEdge.neon

src/Exceptions/NoVatRulesForCountryException.php

@@ -0,0 +1,10 @@
+<?php
+declare(strict_types = 1);
+
+namespace Spaze\VatCalculator\Exceptions;
+
+use Exception;
+
+class NoVatRulesForCountryException extends Exception
+{
+}

src/VatCalculator.php

@@ -124,13 +124,7 @@ public function getTaxRateForLocation(string $countryCode, ?string $postalCode,
 	 */
 	public function isValidVatNumber(string $vatNumber): bool
 	{
-		$details = $this->getVatDetails($vatNumber);
-
-		if ($details) {
-			return $details->isValid();
-		} else {
-			return false;
-		}
+		return $this->getVatDetails($vatNumber)->isValid();
 	}
 
 

src/VatRates.php

@@ -5,6 +5,7 @@
 
 use DateTimeImmutable;
 use DateTimeInterface;
+use Spaze\VatCalculator\Exceptions\NoVatRulesForCountryException;
 
 class VatRates
 {
@@ -23,7 +24,7 @@ class VatRates
 	 *
 	 * Taken from: http://ec.europa.eu/taxation_customs/resources/documents/taxation/vat/how_vat_works/rates/vat_rates_en.pdf
 	 *
-	 * @var array<string, array>
+	 * @var array<string, array{rate: float, rates?: array, exceptions?: array, since?: array}>
 	 */
 	private $taxRules = [
 		'AT' => [ // Austria
@@ -189,7 +190,7 @@ class VatRates
 	 * Non-EU countries with their own VAT requirements, countries in this list
 	 * need to be added manually by `addRateForCountry()` for the rate to be applied.
 	 *
-	 * @var array<string, array>
+	 * @var array<string, array{rate: float, rates?: array, exceptions?: array, since?: array}>
 	 */
 	private $optionalTaxRules = [
 		'CH' => [ // Switzerland
@@ -368,10 +369,17 @@ public function __construct()
 	}
 
 
+	/**
+	 * @param string $country
+	 * @throws NoVatRulesForCountryException
+	 */
 	public function addRateForCountry(string $country): void
 	{
 		$country = strtoupper($country);
-		$this->taxRules[$country] = $this->optionalTaxRules[$country] ?? null;
+		if (!isset($this->optionalTaxRules[$country])) {
+			throw new NoVatRulesForCountryException("No optional tax rules specified for {$country}");
+		}
+		$this->taxRules[$country] = $this->optionalTaxRules[$country];
 	}
 
 
@@ -400,21 +408,29 @@ public function getTaxRateForLocation(string $countryCode, ?string $postalCode,
 				if (!preg_match($postalCodeException['postalCode'], $postalCode)) {
 					continue;
 				}
-				if (isset($postalCodeException['name'])) {
+				if (isset($postalCodeException['name'], $this->taxRules[$postalCodeException['code']]['exceptions'])) {
 					return $this->taxRules[$postalCodeException['code']]['exceptions'][$postalCodeException['name']];
 				}
 				return $this->getRules($postalCodeException['code'], $date)['rate'];
 			}
 		}
 
+		$rules = $this->getRules($countryCode, $date);
 		if ($type !== VatRates::GENERAL) {
-			return isset($this->taxRules[$countryCode]['rates'][$type]) ? $this->taxRules[$countryCode]['rates'][$type] : 0;
+			if (isset($rules['rates'])) {
+				return $rules['rates'][$type];
+			}
 		}
 
-		return $this->getRules($countryCode, $date)['rate'];
+		return $rules['rate'];
 	}
 
 
+	/**
+	 * @param string $countryCode
+	 * @param DateTimeInterface|null $date
+	 * @return array{rate: float, rates?: array, exceptions?: array, since?: array}
+	 */
 	private function getRules(string $countryCode, ?DateTimeInterface $date = null): array
 	{
 		if (!isset($this->taxRules[$countryCode])) {

tests/VatRatesTest.php

@@ -6,6 +6,7 @@
 use DateTimeImmutable;
 use PHPUnit_Framework_TestCase;
 use ReflectionClass;
+use Spaze\VatCalculator\Exceptions\NoVatRulesForCountryException;
 
 class VatRatesTest extends PHPUnit_Framework_TestCase
 {
@@ -36,6 +37,7 @@ public function testAddRateUnknownCountry(): void
 		$country = 'yEs';
 		$this->assertFalse($this->vatRates->shouldCollectVat($country));
 		$this->assertEquals(0, $this->vatRates->getTaxRateForLocation($country, null));
+		$this->setExpectedException(NoVatRulesForCountryException::class);
 		$this->vatRates->addRateForCountry($country);
 		$this->assertFalse($this->vatRates->shouldCollectVat($country));
 		$this->assertEquals(0, $this->vatRates->getTaxRateForLocation($country, null));