Level 5

moneyphp · Nov 23, 2024 · c157108 · c157108
1 parent b2a5d8d
commit c157108
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 15 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,5 +1,5 @@
 parameters:
-	level: 4
+	level: 5
 	paths:
 		- src
 		- tests

diff --git a/resources/generate-teller-factory.php b/resources/generate-teller-factory.php
@@ -40,7 +40,7 @@ trait TellerFactory
      * </code>
      *
      * @param non-empty-string $method
-     * @param array{0?: int}   $arguments
+     * @param array{0?: Money::ROUND_*}   $arguments
      */
     public static function __callStatic(string $method, array $arguments): Teller
     {

diff --git a/src/Converter.php b/src/Converter.php
@@ -17,6 +17,9 @@ public function __construct(private readonly Currencies $currencies, private rea
     {
     }
 
+    /**
+     * @param Money::ROUND_* $roundingMode
+     */
     public function convert(Money $money, Currency $counterCurrency, int $roundingMode = Money::ROUND_HALF_UP): Money
     {
         return $this->convertAgainstCurrencyPair(
@@ -29,7 +32,10 @@ public function convert(Money $money, Currency $counterCurrency, int $roundingMo
         );
     }
 
-    /** @return array{0: Money, 1: CurrencyPair} */
+    /**
+     * @param Money::ROUND_* $roundingMode
+     * @return array{0: Money, 1: CurrencyPair}
+     */
     public function convertAndReturnWithCurrencyPair(Money $money, Currency $counterCurrency, int $roundingMode = Money::ROUND_HALF_UP): array
     {
         $pair = $this->exchange->quote(
@@ -40,6 +46,9 @@ public function convertAndReturnWithCurrencyPair(Money $money, Currency $counter
         return [$this->convertAgainstCurrencyPair($money, $pair, $roundingMode), $pair];
     }
 
+    /**
+     * @param Money::ROUND_* $roundingMode
+     */
     public function convertAgainstCurrencyPair(Money $money, CurrencyPair $currencyPair, int $roundingMode = Money::ROUND_HALF_UP): Money
     {
         if (! $money->getCurrency()->equals($currencyPair->getBaseCurrency())) {

diff --git a/src/MoneyFactory.php b/src/MoneyFactory.php
@@ -560,7 +560,7 @@
  * @method static Money ZMW(numeric-string|int $amount)
  * @method static Money ZRX(numeric-string|int $amount)
  * @method static Money ZWL(numeric-string|int $amount)
- * @phpstan-immutable
+ * @psalm-immutable
  */
 trait MoneyFactory
 {
@@ -571,12 +571,13 @@ trait MoneyFactory
      * $fiveDollar = Money::USD(500);
      * </code>
      *
-     * @phpstan-param non-empty-string          $method
-     * @phpstan-param array{numeric-string|int} $arguments
+     * @param array $arguments
+     * @psalm-param non-empty-string          $method
+     * @psalm-param array{numeric-string|int} $arguments
      *
      * @throws InvalidArgumentException If amount is not integer(ish).
      *
-     * @phpstan-pure
+     * @psalm-pure
      */
     public static function __callStatic(string $method, array $arguments): Money
     {

diff --git a/src/Teller.php b/src/Teller.php
@@ -10,6 +10,9 @@ final class Teller
 {
     use TellerFactory;
 
+    /**
+     * @param Money::ROUND_* $roundingMode
+     */
     public function __construct(
         private readonly Currency $currency,
         private readonly MoneyParser $parser,
@@ -101,9 +104,9 @@ public function lessThanOrEqual(mixed $amount, mixed $other): bool
     /**
      * Adds a series of monetary amounts to each other in sequence.
      *
-     * @param mixed   $amount a monetary amount
-     * @param mixed   $other  another monetary amount
-     * @param mixed[] $others subsequent other monetary amounts
+     * @param mixed $amount a monetary amount
+     * @param mixed $other  another monetary amount
+     * @param mixed $others subsequent other monetary amounts
      *
      * @return string the calculated monetary amount
      */
@@ -120,9 +123,9 @@ public function add(mixed $amount, mixed $other, mixed ...$others): string
     /**
      * Subtracts a series of monetary amounts from each other in sequence.
      *
-     * @param mixed   $amount a monetary amount
-     * @param mixed   $other  another monetary amount
-     * @param mixed[] $others subsequent monetary amounts
+     * @param mixed $amount a monetary amount
+     * @param mixed $other  another monetary amount
+     * @param mixed $others subsequent monetary amounts
      */
     public function subtract(mixed $amount, mixed $other, mixed ...$others): string
     {

diff --git a/src/TellerFactory.php b/src/TellerFactory.php
@@ -576,7 +576,7 @@ trait TellerFactory
      * </code>
      *
      * @param non-empty-string $method
-     * @param array{0?: int}   $arguments
+     * @param array{0?: Money::ROUND_*}   $arguments
      */
     public static function __callStatic(string $method, array $arguments): Teller
     {

diff --git a/tests/Locale.php b/tests/Locale.php
@@ -12,6 +12,7 @@ trait Locale
 {
     public static function runLocaleAware(int $category, string $locale, Closure $callback): void
     {
+        // @phpstan-ignore argument.type (I dont get this error)
         $currentLocale = setlocale($category, 0);
         try {
             setlocale($category, $locale);

diff --git a/tests/MoneyTest.php b/tests/MoneyTest.php
@@ -418,7 +418,7 @@ public function itCalculatesAvg(array $values, Money $avg): void
      * @phpstan-param int $amount
      * @phpstan-param non-negative-int $unit
      * @phpstan-param int $expected
-     * @phpstan-param int $roundingMode
+     * @phpstan-param Money::ROUND_* $roundingMode
      *
      * @test
      * @dataProvider roundToUnitExamples