Introduce ISO-15924 Scripts (#67)

PrinsFrank · web-flow · commit 77bbb17b5648 · 2023-10-08T20:32:40.000+02:00
diff --git a/.editorconfig b/.editorconfig
@@ -9,7 +9,7 @@ end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
-max_line_length = 200
+max_line_length = 300
 eclint_block_comment_start = /*
 eclint_block_comment = *
 eclint_block_comment_end = */
diff --git a/.github/workflows/update-spec-scripts.yml b/.github/workflows/update-spec-scripts.yml
@@ -0,0 +1,33 @@
+name: Daily Scripts spec update
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '55 17 * * *'
+
+jobs:
+  update-specs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: composer install
+      - name: Run standard update command
+        run: composer update-spec -- --type=script
+      - name: Run CSFixer
+        run: composer cs:fix
+      - name: Create Pull Request
+        id: cpr
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: Automatic Scripts spec update from upstream changes
+          delete-branch: true
+          title: 'Automatic Scripts spec update'
+          branch: update-spec/scripts
+          body: |
+            This PR makes sure the content of this package is updated with upstream changes in the specs.
+          labels: |
+            spec-update
+            automated pr
+          reviewers: prinsfrank
diff --git a/dev/DataSource/Country/CountryAlpha2Source.php b/dev/DataSource/Country/CountryAlpha2Source.php
@@ -37,7 +37,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         return $value;
     }
diff --git a/dev/DataSource/Country/CountryAlpha3Source.php b/dev/DataSource/Country/CountryAlpha3Source.php
@@ -37,7 +37,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         return $value;
     }
diff --git a/dev/DataSource/Country/CountryNameSource.php b/dev/DataSource/Country/CountryNameSource.php
@@ -37,7 +37,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         return $value;
     }
diff --git a/dev/DataSource/Country/CountryNumericSource.php b/dev/DataSource/Country/CountryNumericSource.php
@@ -37,7 +37,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         return $value;
     }
diff --git a/dev/DataSource/Currency/CurrencyAlpha3Source.php b/dev/DataSource/Currency/CurrencyAlpha3Source.php
@@ -35,7 +35,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         return $value;
     }
diff --git a/dev/DataSource/Currency/CurrencyNameSource.php b/dev/DataSource/Currency/CurrencyNameSource.php
@@ -36,7 +36,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         return $value;
     }
diff --git a/dev/DataSource/Currency/CurrencyNumericSource.php b/dev/DataSource/Currency/CurrencyNumericSource.php
@@ -35,7 +35,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         return $value;
     }
diff --git a/dev/DataSource/DataSource.php b/dev/DataSource/DataSource.php
@@ -7,7 +7,7 @@ interface DataSource
 {
     public static function transformName(string $key): ?string;
 
-    public static function transformValue(string $value): string|int|null;
+    public static function transformValue(string $value, ?string $key): string|int|null;
 
     /** @return class-string<\BackedEnum> */
     public static function getSpecFQN(): string;
diff --git a/dev/DataSource/Http/HttpMethodSource.php b/dev/DataSource/Http/HttpMethodSource.php
@@ -25,7 +25,7 @@ static function ($matches) {
         );
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         return $value;
     }
diff --git a/dev/DataSource/Http/HttpStatusCodeSource.php b/dev/DataSource/Http/HttpStatusCodeSource.php
@@ -30,7 +30,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         if (str_contains($value, '-')) {
             return null; // Don't include reserved ranges in spec
diff --git a/dev/DataSource/Language/LanguageAlpha2Source.php b/dev/DataSource/Language/LanguageAlpha2Source.php
@@ -35,7 +35,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         return strtolower(str_replace(' ', '', trim($value)));
     }
diff --git a/dev/DataSource/Language/LanguageAlpha3BibliographicSource.php b/dev/DataSource/Language/LanguageAlpha3BibliographicSource.php
@@ -35,7 +35,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         $bibliographicMarkerPos = strpos($value, '(B)');
         if ($bibliographicMarkerPos === false) {
diff --git a/dev/DataSource/Language/LanguageAlpha3CommonSource.php b/dev/DataSource/Language/LanguageAlpha3CommonSource.php
@@ -35,7 +35,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         if (str_contains($value, '(T)') || str_contains($value, '(B)') || str_contains($value, '-')) {
             return null;
diff --git a/dev/DataSource/Language/LanguageAlpha3TerminologySource.php b/dev/DataSource/Language/LanguageAlpha3TerminologySource.php
@@ -35,7 +35,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         $terminologyMarkerPos = strpos($value, '(T)');
         if ($terminologyMarkerPos === false) {
diff --git a/dev/DataSource/Language/LanguageNameSource.php b/dev/DataSource/Language/LanguageNameSource.php
@@ -36,7 +36,7 @@ public static function transformName(string $key): ?string
         return $key;
     }
 
-    public static function transformValue(string $value): string|int|null
+    public static function transformValue(string $value, ?string $key): string|int|null
     {
         if (str_contains($value, 'Reserved')) {
             return null;
diff --git a/dev/DataSource/Script/ScriptAliasSource.php b/dev/DataSource/Script/ScriptAliasSource.php
@@ -0,0 +1,67 @@
+<?php
+declare(strict_types=1);
+
+namespace PrinsFrank\Standards\Dev\DataSource\Script;
+
+use PrinsFrank\Standards\Dev\DataSource\HtmlDataSource;
+use PrinsFrank\Standards\Scripts\ScriptAlias;
+use PrinsFrank\Standards\Scripts\ScriptName;
+use Symfony\Component\Panther\Client;
+use Symfony\Component\Panther\DomCrawler\Crawler;
+
+class ScriptAliasSource implements HtmlDataSource
+{
+    public static function url(): string
+    {
+        return 'https://www.unicode.org/iso15924/iso15924-codes.html';
+    }
+
+    public static function xPathIdentifierKey(): string
+    {
+        return self::xPathIdentifierName();
+    }
+
+    public static function xPathIdentifierName(): string
+    {
+        return '//table[@class="simple"]/tbody/tr/td[3]';
+    }
+
+    public static function xPathIdentifierValue(): string
+    {
+        return '//table[@class="simple"]/tbody/tr/td[5]';
+    }
+
+    public static function transformName(string $key): ?string
+    {
+        return preg_replace('/_+/', '_', str_replace('+', '_', preg_replace('/\p{No}/u', '', $key) ?? ''));
+    }
+
+    public static function transformValue(string $value, ?string $key): string|int|null
+    {
+        $value = str_replace(' ', '', trim($value));
+        if ($value === '' || $key === 'Khutsuri_Asomtavruli_and_Nuskhuri') {
+            return null;
+        }
+
+        return $value;
+    }
+
+    public static function getSpecFQN(): string
+    {
+        return ScriptAlias::class;
+    }
+
+    public static function getKeyEnumFQN(): string
+    {
+        return ScriptName::class;
+    }
+
+    public static function afterPageLoad(Client $client, Crawler $crawler): void
+    {
+    }
+
+    public static function sort(): bool
+    {
+        return true;
+    }
+}
diff --git a/dev/DataSource/Script/ScriptCodeSource.php b/dev/DataSource/Script/ScriptCodeSource.php
@@ -0,0 +1,62 @@
+<?php
+declare(strict_types=1);
+
+namespace PrinsFrank\Standards\Dev\DataSource\Script;
+
+use PrinsFrank\Standards\Dev\DataSource\HtmlDataSource;
+use PrinsFrank\Standards\Scripts\ScriptCode;
+use PrinsFrank\Standards\Scripts\ScriptName;
+use Symfony\Component\Panther\Client;
+use Symfony\Component\Panther\DomCrawler\Crawler;
+
+class ScriptCodeSource implements HtmlDataSource
+{
+    public static function url(): string
+    {
+        return 'https://www.unicode.org/iso15924/iso15924-codes.html';
+    }
+
+    public static function xPathIdentifierKey(): string
+    {
+        return self::xPathIdentifierName();
+    }
+
+    public static function xPathIdentifierName(): string
+    {
+        return '//table[@class="simple"]/tbody/tr/td[3]';
+    }
+
+    public static function xPathIdentifierValue(): string
+    {
+        return '//table[@class="simple"]/tbody/tr/td[2]';
+    }
+
+    public static function transformName(string $key): ?string
+    {
+        return preg_replace('/_+/', '_', str_replace('+', '_', preg_replace('/\p{No}/u', '', $key) ?? ''));
+    }
+
+    public static function transformValue(string $value, ?string $key): string|int|null
+    {
+        return str_replace(' ', '', trim($value));
+    }
+
+    public static function getSpecFQN(): string
+    {
+        return ScriptCode::class;
+    }
+
+    public static function getKeyEnumFQN(): string
+    {
+        return ScriptName::class;
+    }
+
+    public static function afterPageLoad(Client $client, Crawler $crawler): void
+    {
+    }
+
+    public static function sort(): bool
+    {
+        return true;
+    }
+}
diff --git a/dev/DataSource/Script/ScriptNameSource.php b/dev/DataSource/Script/ScriptNameSource.php
@@ -0,0 +1,61 @@
+<?php
+declare(strict_types=1);
+
+namespace PrinsFrank\Standards\Dev\DataSource\Script;
+
+use PrinsFrank\Standards\Dev\DataSource\HtmlDataSource;
+use PrinsFrank\Standards\Scripts\ScriptName;
+use Symfony\Component\Panther\Client;
+use Symfony\Component\Panther\DomCrawler\Crawler;
+
+class ScriptNameSource implements HtmlDataSource
+{
+    public static function url(): string
+    {
+        return 'https://www.unicode.org/iso15924/iso15924-codes.html';
+    }
+
+    public static function xPathIdentifierKey(): string
+    {
+        return '//table[@class="simple"]/tbody/tr/td[1]';
+    }
+
+    public static function xPathIdentifierName(): string
+    {
+        return '//table[@class="simple"]/tbody/tr/td[3]';
+    }
+
+    public static function xPathIdentifierValue(): string
+    {
+        return '//table[@class="simple"]/tbody/tr/td[3]';
+    }
+
+    public static function transformName(string $key): ?string
+    {
+        return preg_replace('/_+/', '_', str_replace('+', '_', preg_replace('/\p{No}/u', '', $key) ?? ''));
+    }
+
+    public static function transformValue(string $value, ?string $key): string|int|null
+    {
+        return str_replace(' ', '', trim($value));
+    }
+
+    public static function getSpecFQN(): string
+    {
+        return ScriptName::class;
+    }
+
+    public static function getKeyEnumFQN(): string
+    {
+        return self::getSpecFQN();
+    }
+
+    public static function afterPageLoad(Client $client, Crawler $crawler): void
+    {
+    }
+
+    public static function sort(): bool
+    {
+        return true;
+    }
+}
diff --git a/dev/DataSource/Script/ScriptNumberSource.php b/dev/DataSource/Script/ScriptNumberSource.php
diff --git a/dev/DataSource/SpecType.php b/dev/DataSource/SpecType.php
diff --git a/dev/DataSourceExtractor/HtmlDataSourceExtractor.php b/dev/DataSourceExtractor/HtmlDataSourceExtractor.php
diff --git a/dev/DataSourceExtractor/XmlDataSourceExtractor.php b/dev/DataSourceExtractor/XmlDataSourceExtractor.php
diff --git a/dev/DataTarget/EnumFile.php b/dev/DataTarget/EnumFile.php
diff --git a/dev/SpecUpdater.php b/dev/SpecUpdater.php
diff --git a/src/Scripts/ScriptAlias.php b/src/Scripts/ScriptAlias.php
diff --git a/src/Scripts/ScriptCode.php b/src/Scripts/ScriptCode.php
diff --git a/src/Scripts/ScriptName.php b/src/Scripts/ScriptName.php
diff --git a/src/Scripts/ScriptNumber.php b/src/Scripts/ScriptNumber.php

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public static function transformName(string $key): ?string`
`37`	`37`	`return $key;`
`38`	`38`	`}`
`39`	`39`
`40`		`- public static function transformValue(string $value): string\|int\|null`
	`40`	`+ public static function transformValue(string $value, ?string $key): string\|int\|null`
`41`	`41`	`{`
`42`	`42`	`return $value;`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public static function transformName(string $key): ?string`
`35`	`35`	`return $key;`
`36`	`36`	`}`
`37`	`37`
`38`		`- public static function transformValue(string $value): string\|int\|null`
	`38`	`+ public static function transformValue(string $value, ?string $key): string\|int\|null`
`39`	`39`	`{`
`40`	`40`	`return $value;`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public static function transformName(string $key): ?string`
`36`	`36`	`return $key;`
`37`	`37`	`}`
`38`	`38`
`39`		`- public static function transformValue(string $value): string\|int\|null`
	`39`	`+ public static function transformValue(string $value, ?string $key): string\|int\|null`
`40`	`40`	`{`
`41`	`41`	`return $value;`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ interface DataSource`
`7`	`7`	`{`
`8`	`8`	`public static function transformName(string $key): ?string;`
`9`	`9`
`10`		`- public static function transformValue(string $value): string\|int\|null;`
	`10`	`+ public static function transformValue(string $value, ?string $key): string\|int\|null;`
`11`	`11`
`12`	`12`	`/** @return class-string<\BackedEnum> */`
`13`	`13`	`public static function getSpecFQN(): string;`