Narrow localized() return types

ICanBoogie · Aug 9, 2024 · bc4c8a9 · bc4c8a9
1 parent 59911f0
commit bc4c8a9
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 34 deletions.
diff --git a/lib/CurrencyFormatter.php b/lib/CurrencyFormatter.php
@@ -3,20 +3,29 @@
 namespace ICanBoogie\CLDR;
 
 use ICanBoogie\CLDR\Numbers\Symbols;
-
 use function str_replace;
 
 /**
  * A currency formatter.
  *
  * @implements Localizable<CurrencyFormatter, LocalizedCurrencyFormatter>
  */
-final class CurrencyFormatter extends NumberFormatter implements Localizable
+final class CurrencyFormatter implements Formatter, Localizable
 {
 	public const DEFAULT_CURRENCY_SYMBOL = '¤';
 
+	public function __construct(
+		private readonly NumberFormatter $number_formatter,
+	) {
+	}
+
 	/**
-	 * @inheritDoc
+	 * Formats a number with the specified pattern.
+	 *
+	 * @param float|int|numeric-string $number
+	 *     The number to format.
+	 * @param string|NumberPattern $pattern
+	 *     The pattern used to format the number.
 	 */
 	public function format(
 		float|int|string $number,
@@ -27,14 +36,11 @@ public function format(
 		return str_replace(
 			self::DEFAULT_CURRENCY_SYMBOL,
 			$currencySymbol,
-			parent::format($number, $pattern, $symbols)
+			$this->number_formatter->format($number, $pattern, $symbols)
 		);
 	}
 
-	/**
-	 * @return LocalizedCurrencyFormatter
-	 */
-	public function localized(Locale $locale): LocalizedObject
+	public function localized(Locale $locale): LocalizedCurrencyFormatter
 	{
 		return new LocalizedCurrencyFormatter($this, $locale);
 	}

diff --git a/lib/ListFormatter.php b/lib/ListFormatter.php
@@ -71,10 +71,7 @@ private function format_pattern(string $pattern, string $v0, string $v1): string
 		]);
 	}
 
-	/**
-	 * @return LocalizedListFormatter
-	 */
-	public function localized(Locale $locale): LocalizedObject
+	public function localized(Locale $locale): LocalizedListFormatter
 	{
 		return new LocalizedListFormatter($this, $locale);
 	}

diff --git a/lib/Locale.php b/lib/Locale.php
@@ -187,10 +187,7 @@ private function get_units(): Units
 		return $this->units ??= new Units($this);
 	}
 
-	/**
-	 * @return LocalizedLocale
-	 */
-	public function localized(Locale|LocaleId|string $locale): LocalizedObject
+	public function localized(Locale|LocaleId|string $locale): LocalizedLocale
 	{
 		if (!$locale instanceof self) {
 			$locale = $this->repository->locale_for($locale);
@@ -238,7 +235,7 @@ public function format_currency(
 	}
 
 	/**
-	 * Formats a variable-length lists of scalars.
+	 * Formats variable-length lists of scalars.
 	 *
 	 * @param scalar[] $list
 	 *

diff --git a/lib/NumberFormatter.php b/lib/NumberFormatter.php
@@ -9,7 +9,7 @@
  *
  * @implements Localizable<NumberFormatter, LocalizedNumberFormatter>
  */
-class NumberFormatter implements Formatter, Localizable
+final class NumberFormatter implements Formatter, Localizable
 {
 	/**
 	 * Formats a number with the specified pattern.
@@ -56,12 +56,7 @@ public function format(
 		]);
 	}
 
-	/**
-	 * Localizes the instance.
-	 *
-	 * @return LocalizedNumberFormatter
-	 */
-	public function localized(Locale $locale): LocalizedObject
+	public function localized(Locale $locale): LocalizedNumberFormatter
 	{
 		return new LocalizedNumberFormatter($this, $locale);
 	}

diff --git a/lib/Repository.php b/lib/Repository.php
@@ -63,7 +63,7 @@ private function get_number_formatter(): NumberFormatter
 
 	private function get_currency_formatter(): CurrencyFormatter
 	{
-		return $this->currency_formatter ??= new CurrencyFormatter();
+		return $this->currency_formatter ??= new CurrencyFormatter($this->get_number_formatter());
 	}
 
 	private ListFormatter $list_formatter;

diff --git a/lib/Territory.php b/lib/Territory.php
@@ -212,10 +212,7 @@ public function name_as(string|LocaleId $locale_id): string
 		return $this->localized($locale_id)->name;
 	}
 
-	/**
-	 * @return LocalizedTerritory
-	 */
-	public function localized(Locale|LocaleId|string $locale): LocalizedObject
+	public function localized(Locale|LocaleId|string $locale): LocalizedTerritory
 	{
 		if (!$locale instanceof Locale) {
 			$locale = $this->repository->locale_for($locale);

diff --git a/tests/LocalizedCurrencyFormatterTest.php b/tests/LocalizedCurrencyFormatterTest.php
@@ -4,6 +4,7 @@
 
 use ICanBoogie\CLDR\CurrencyFormatter;
 use ICanBoogie\CLDR\LocalizedCurrencyFormatter;
+use ICanBoogie\CLDR\NumberFormatter;
 use ICanBoogie\CLDR\Spaces;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
@@ -12,11 +13,11 @@ final class LocalizedCurrencyFormatterTest extends TestCase
 {
 	use StringHelpers;
 
-	private CurrencyFormatter $formatter;
+	private CurrencyFormatter $sut;
 
 	protected function setUp(): void
 	{
-		$this->formatter = new CurrencyFormatter();
+		$this->sut = new CurrencyFormatter(new NumberFormatter());
 	}
 
 	#[DataProvider('provide_test_format')]
@@ -27,7 +28,7 @@ public function test_format(
 		string $expected
 	): void {
 		$formatter = new LocalizedCurrencyFormatter(
-			$this->formatter,
+			$this->sut,
 			locale_for($locale_id),
 		);
 
@@ -65,7 +66,7 @@ public function test_format_accounting(
 		string $expected
 	): void {
 		$formatter = new LocalizedCurrencyFormatter(
-			$this->formatter,
+			$this->sut,
 			locale_for($locale_id),
 		);
 
@@ -98,7 +99,7 @@ public static function provide_test_format_accounting(): array
 	public function test_should_format_with_custom_pattern(): void
 	{
 		$sut = new LocalizedCurrencyFormatter(
-			$this->formatter,
+			$this->sut,
 			locale_for('fr'),
 		);