Add LocaleNotAvailable

ICanBoogie · Aug 9, 2024 · 7848e85 · 7848e85
1 parent bc89ac9
commit 7848e85
Show file tree

Hide file tree

Showing 12 changed files with 92 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,16 +10,16 @@
 
 ### New features
 
-- `LocaleId` is an enum of available locales.
+- `LocaleId` is a representation of an available locale.
+- `LocaleNotAvailable` is thrown when a requested locale ID is not available.
 - Added the `Warmable` interface to features that can warm the CLDR cache.
 
 ### Backward Incompatible Changes
 
-- `Units::LENGTH_*` constants have been replaced by the `UnitLength` enum.
-- `LocalizedListFormatter:TYPE_*` constants have been replaced by the `ListType` enum.
-- `DateTimeFormatter::WIDTH_*` constants have been replaced by the `DateTimeFormatLength` enum.
-- Most functions require a `LocaleId` instead of a locale id string.
-- `$clrd->locales['fr']` as been replaced with `$clrd->locale_for('fr')`.
+- `Units::LENGTH_*` constants are replaced by the `UnitLength` enum.
+- `LocalizedListFormatter:TYPE_*` constants are replaced by the `ListType` enum.
+- `DateTimeFormatter::WIDTH_*` constants are replaced by the `DateTimeFormatLength` enum.
+- `$clrd->locales['fr']` is replaced by `$clrd->locale_for('fr')`.
 
 ### Deprecated Features
 
@@ -29,6 +29,7 @@ None
 
 - Use CLDR 45.0.0.
 - Some code is now generated from CLDR data, such as `Units` getters and methods, or `LocaleId`.
+- JSON data is stored as PHP instead of JSON to leverage opcache.
 
 
 

diff --git a/generator/src/Command/GenerateHasContextTransforms.php b/generator/src/Command/GenerateHasContextTransforms.php
@@ -55,10 +55,16 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     private function render(string $has_by_locale): string
     {
+		$class = __CLASS__;
+
         return <<<PHP
         <?php
 
-        /** CODE GENERATED; DO NOT EDIT. */
+        /**
+         * CODE GENERATED; DO NOT EDIT.
+         *
+         * {@see \\$class}
+         */
 
         namespace ICanBoogie\CLDR\Locale;
 

diff --git a/generator/src/Command/GenerateLocaleId.php b/generator/src/Command/GenerateLocaleId.php
@@ -2,6 +2,7 @@
 
 namespace ICanBoogie\CLDR\Generator\Command;
 
+use ICanBoogie\CLDR\LocaleNotAvailable;
 use ICanBoogie\CLDR\Repository;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
@@ -42,10 +43,16 @@ public function render(
         string $parent_locales,
         string $available_locales,
     ): string {
+		$class = __CLASS__;
+
         return <<<PHP
         <?php
 
-        /** CODE GENERATED; DO NOT EDIT. */
+        /**
+         * CODE GENERATED; DO NOT EDIT.
+         *
+         * {@see \\$class}
+         */
 
         namespace ICanBoogie\CLDR;
 
@@ -66,12 +73,12 @@ public static function is_available(string \$value): bool
             }
 
             /**
-             * @throws InvalidArgumentException if the value is not one of the available locales.
+             * @throws LocaleNotAvailable
              */
             public static function assert_is_available(string \$value): void
             {
                 self::is_available(\$value)
-                    or throw new InvalidArgumentException("Locale is not available: \$value");
+                    or throw new LocaleNotAvailable(\$value);
             }
 
             /**

diff --git a/generator/src/Command/GenerateSequenceCompanion.php b/generator/src/Command/GenerateSequenceCompanion.php
@@ -59,10 +59,16 @@ public function $normalized(float|int|string \$number): self
     private function render(
         string $methods,
     ): string {
+		$class = __CLASS__;
+
         return <<<PHP
         <?php
 
-        /** CODE GENERATED; DO NOT EDIT. */
+        /**
+         * CODE GENERATED; DO NOT EDIT.
+         *
+         * {@see \\$class}
+         */
 
         namespace ICanBoogie\CLDR\Units;
 

diff --git a/generator/src/Command/GenerateUnitsCompanion.php b/generator/src/Command/GenerateUnitsCompanion.php
@@ -62,10 +62,16 @@ private function render(
         string $properties,
         string $methods,
     ): string {
+		$class = __CLASS__;
+
         return <<<PHP
         <?php
 
-        /** CODE GENERATED; DO NOT EDIT. */
+        /**
+         * CODE GENERATED; DO NOT EDIT.
+         *
+         * {@see \\$class}
+         */
 
         namespace ICanBoogie\CLDR\Units;
 

diff --git a/lib/Locale/HasContextTransforms.php b/lib/Locale/HasContextTransforms.php
@@ -1,6 +1,10 @@
 <?php
 
-/** CODE GENERATED; DO NOT EDIT. */
+/**
+ * CODE GENERATED; DO NOT EDIT.
+ *
+ * {@see \ICanBoogie\CLDR\Generator\Command\GenerateHasContextTransforms}
+ */
 
 namespace ICanBoogie\CLDR\Locale;
 

diff --git a/lib/LocaleId.php b/lib/LocaleId.php
@@ -1,6 +1,10 @@
 <?php
 
-/** CODE GENERATED; DO NOT EDIT. */
+/**
+ * CODE GENERATED; DO NOT EDIT.
+ *
+ * {@see \ICanBoogie\CLDR\Generator\Command\GenerateLocaleId}
+ */
 
 namespace ICanBoogie\CLDR;
 
@@ -21,12 +25,12 @@ public static function is_available(string $value): bool
     }
 
     /**
-     * @throws InvalidArgumentException if the value is not one of the available locales.
+     * @throws LocaleNotAvailable
      */
     public static function assert_is_available(string $value): void
     {
         self::is_available($value)
-            or throw new InvalidArgumentException("Locale is not available: $value");
+            or throw new LocaleNotAvailable($value);
     }
 
     /**

diff --git a/lib/LocaleNotAvailable.php b/lib/LocaleNotAvailable.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace ICanBoogie\CLDR;
+
+use InvalidArgumentException;
+use Throwable;
+
+/**
+ * Exception thrown when a requested locale ID is not available.
+ *
+ * @link https://github.com/unicode-org/cldr-json/blob/45.0.0/cldr-json/cldr-core/availableLocales.json
+ */
+final class LocaleNotAvailable extends InvalidArgumentException implements Exception
+{
+	/**
+	 * @param string $locale_id
+	 *     A locale ID.
+	 */
+    public function __construct(
+		public readonly string $locale_id,
+		string $message = null,
+		Throwable $previous = null
+	) {
+		$message ??= "Locale ID is not available: $locale_id";
+
+        parent::__construct($message, previous: $previous);
+    }
+}
diff --git a/lib/Units/SequenceCompanion.php b/lib/Units/SequenceCompanion.php
@@ -1,6 +1,10 @@
 <?php
 
-/** CODE GENERATED; DO NOT EDIT. */
+/**
+ * CODE GENERATED; DO NOT EDIT.
+ *
+ * {@see \ICanBoogie\CLDR\Generator\Command\GenerateSequenceCompanion}
+ */
 
 namespace ICanBoogie\CLDR\Units;
 

diff --git a/lib/Units/UnitsCompanion.php b/lib/Units/UnitsCompanion.php
@@ -1,6 +1,10 @@
 <?php
 
-/** CODE GENERATED; DO NOT EDIT. */
+/**
+ * CODE GENERATED; DO NOT EDIT.
+ *
+ * {@see \ICanBoogie\CLDR\Generator\Command\GenerateUnitsCompanion}
+ */
 
 namespace ICanBoogie\CLDR\Units;
 

diff --git a/tests/LocaleCollectionTest.php b/tests/LocaleCollectionTest.php
@@ -5,8 +5,8 @@
 use BadMethodCallException;
 use ICanBoogie\CLDR\Locale;
 use ICanBoogie\CLDR\LocaleCollection;
+use ICanBoogie\CLDR\LocaleNotAvailable;
 use ICanBoogie\OffsetNotWritable;
-use InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
 
 final class LocaleCollectionTest extends TestCase
@@ -47,8 +47,7 @@ public function test_existing_locale(): void
 	 */
 	public function should_fail_with_undefined_locale(): void
 	{
-		$this->expectExceptionMessage("Locale is not available: madonna");
-		$this->expectException(InvalidArgumentException::class);
+		$this->expectException(LocaleNotAvailable::class);
 		self::$sut['madonna']; // @phpstan-ignore-line
 	}
 }
diff --git a/tests/LocaleIdTest.php b/tests/LocaleIdTest.php
@@ -3,7 +3,7 @@
 namespace Test\ICanBoogie\CLDR;
 
 use ICanBoogie\CLDR\LocaleId;
-use InvalidArgumentException;
+use ICanBoogie\CLDR\LocaleNotAvailable;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
@@ -31,7 +31,7 @@ public static function provide_test_is_locale_available(): array
 
 	public function test_of_fails_on_unavailable_id(): void
 	{
-		$this->expectException(InvalidArgumentException::class);
+		$this->expectException(LocaleNotAvailable::class);
 
 		LocaleId::of('fr-FR');
 	}