feat: sort extracted messages by key (#41)

Skillshare · Feb 1, 2022 · af5d303 · af5d303
1 parent f7884b7
commit af5d303
Show file tree

Hide file tree

Showing 17 changed files with 101 additions and 82 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,7 +14,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 
-- Nothing.
+- Sort extracted messages descending by key, using a natural, case-insensitive sorting algorithm.
 
 ### Deprecated
 

diff --git a/src/Format/Writer/ChromeWriter.php b/src/Format/Writer/ChromeWriter.php
@@ -27,6 +27,11 @@
 use FormatPHP\Format\WriterInterface;
 use FormatPHP\Format\WriterOptions;
 
+use function ksort;
+
+use const SORT_FLAG_CASE;
+use const SORT_NATURAL;
+
 /**
  * Chrome formatter for FormatPHP
  *
@@ -65,6 +70,8 @@ public function __invoke(DescriptorCollection $collection, WriterOptions $option
             $format[(string) $item->getId()] = $message;
         }
 
+        ksort($format, SORT_NATURAL | SORT_FLAG_CASE);
+
         return $format;
     }
 }
diff --git a/src/Format/Writer/FormatPHPWriter.php b/src/Format/Writer/FormatPHPWriter.php
@@ -31,6 +31,9 @@
 use function array_merge;
 use function ksort;
 
+use const SORT_FLAG_CASE;
+use const SORT_NATURAL;
+
 /**
  * Default formatter for FormatPHP
  *
@@ -96,6 +99,8 @@ public function __invoke(DescriptorCollection $collection, WriterOptions $option
             $format[(string) $item->getId()] = $message;
         }
 
+        ksort($format, SORT_NATURAL | SORT_FLAG_CASE);
+
         return $format;
     }
 }
diff --git a/src/Format/Writer/SimpleWriter.php b/src/Format/Writer/SimpleWriter.php
@@ -27,6 +27,11 @@
 use FormatPHP\Format\WriterInterface;
 use FormatPHP\Format\WriterOptions;
 
+use function ksort;
+
+use const SORT_FLAG_CASE;
+use const SORT_NATURAL;
+
 /**
  * A simple formatter for FormatPHP, producing message key-value pairs
  *
@@ -52,6 +57,8 @@ public function __invoke(DescriptorCollection $collection, WriterOptions $option
             $simple[(string) $item->getId()] = $item->getDefaultMessage();
         }
 
+        ksort($simple, SORT_NATURAL | SORT_FLAG_CASE);
+
         return $simple;
     }
 }
diff --git a/...ole/Command/__snapshots__/ExtractCommandTest__testExecuteWithValidationHasNoErrors__1.txt b/...ole/Command/__snapshots__/ExtractCommandTest__testExecuteWithValidationHasNoErrors__1.txt
@@ -7,14 +7,14 @@
         "defaultMessage": "You have {numPhotos, plural, =0 {no photos.} =1 {one photo.} other {# photos.} }",
         "description": "A description with multiple lines and extra whitespace."
     },
+    "Q+U0TW": {
+        "defaultMessage": "Welcome!"
+    },
     "Soex4s": {
         "defaultMessage": "This is a default message",
         "description": "A simple description of a fixture for testing purposes."
     },
     "xgMWoP": {
         "defaultMessage": "This is a default message"
-    },
-    "Q+U0TW": {
-        "defaultMessage": "Welcome!"
     }
 }
diff --git a/tests/Console/Command/__snapshots__/PseudoLocaleCommandTest__testExecute__1.txt b/tests/Console/Command/__snapshots__/PseudoLocaleCommandTest__testExecute__1.txt
@@ -5,12 +5,12 @@
     "how.many.pets": {
         "defaultMessage": "Ļâśṭ ṭíṁè Ḭ ćḫèćǩèḋ, {gender, select, male{<italicized>ḫè</italicized> ḫâḋ} female{<italicized>śḫè</italicized> ḫâḋ} other{<italicized>ṭḫèẏ</italicized> ḫâḋ}} {petCount, plural, =0{<bold>ńŏ</bold> ṗèṭś} =1{<bold>â</bold> ṗèṭ} other{<bold>#</bold> ṗèṭś}}."
     },
-    "start.with.tag": {
-        "defaultMessage": "<foo>{argument}</foo>"
-    },
     "start.with.argument": {
         "defaultMessage": "{argument}"
     },
+    "start.with.tag": {
+        "defaultMessage": "<foo>{argument}</foo>"
+    },
     "value.with.non-ascii.characters": {
         "defaultMessage": "Ẅè’ḋ ńèèḋ ṭŏ ṭëśṭ śøṁè ńŏń-áśćíí ćḫâŕâćṭèŕś, ṭŏŏ…"
     }

diff --git a/tests/Extractor/MessageExtractorTest.php b/tests/Extractor/MessageExtractorTest.php
@@ -79,6 +79,9 @@ public function testProcessBasic(): void
                     'defaultMessage' => 'This is a default message',
                     'description' => 'A simple description of a fixture for testing purposes.',
                 ],
+                'goodbye' => [
+                    'defaultMessage' => 'Goodbye!',
+                ],
                 'OpKKos' => [
                     'defaultMessage' => 'Hello!',
                 ],
@@ -87,22 +90,19 @@ public function testProcessBasic(): void
                         'You have {numPhotos, plural, =0 {no photos.} =1 {one photo.} other {# photos.} }',
                     'description' => 'A description with multiple lines and extra whitespace.',
                 ],
-                'welcome' => [
+                'Q+U0TW' => [
                     'defaultMessage' => 'Welcome!',
                 ],
-                'goodbye' => [
-                    'defaultMessage' => 'Goodbye!',
-                ],
                 'Soex4s' => [
                     'defaultMessage' => 'This is a default message',
                     'description' => 'A simple description of a fixture for testing purposes.',
                 ],
+                'welcome' => [
+                    'defaultMessage' => 'Welcome!',
+                ],
                 'xgMWoP' => [
                     'defaultMessage' => 'This is a default message',
                 ],
-                'Q+U0TW' => [
-                    'defaultMessage' => 'Welcome!',
-                ],
             ],
             $messages,
         );
@@ -140,16 +140,16 @@ public function testProcessWithFormatPhpFormatterName(): void
                         'You have {numPhotos, plural, =0 {no photos.} =1 {one photo.} other {# photos.} }',
                     'description' => 'A description with multiple lines and extra whitespace.',
                 ],
+                'Q+U0TW' => [
+                    'defaultMessage' => 'Welcome!',
+                ],
                 'Soex4s' => [
                     'defaultMessage' => 'This is a default message',
                     'description' => 'A simple description of a fixture for testing purposes.',
                 ],
                 'xgMWoP' => [
                     'defaultMessage' => 'This is a default message',
                 ],
-                'Q+U0TW' => [
-                    'defaultMessage' => 'Welcome!',
-                ],
             ],
             $messages,
         );
@@ -180,9 +180,9 @@ public function testProcessWithSimpleFormatterName(): void
             [
                 'aTestId' => 'This is a default message',
                 'photos.count' => 'You have {numPhotos, plural, =0 {no photos.} =1 {one photo.} other {# photos.} }',
+                'Q+U0TW' => 'Welcome!',
                 'Soex4s' => 'This is a default message',
                 'xgMWoP' => 'This is a default message',
-                'Q+U0TW' => 'Welcome!',
             ],
             $messages,
         );
@@ -230,16 +230,16 @@ public function testProcessWithSmartlingFormatterName(): void
                     'description' => 'A description with multiple lines and extra whitespace.',
                     'message' => 'You have {numPhotos, plural, =0 {no photos.} =1 {one photo.} other {# photos.} }',
                 ],
+                'Q+U0TW' => [
+                    'message' => 'Welcome!',
+                ],
                 'Soex4s' => [
                     'description' => 'A simple description of a fixture for testing purposes.',
                     'message' => 'This is a default message',
                 ],
                 'xgMWoP' => [
                     'message' => 'This is a default message',
                 ],
-                'Q+U0TW' => [
-                    'message' => 'Welcome!',
-                ],
             ],
             $messages,
         );
@@ -276,16 +276,16 @@ public function testProcessWithCrowdinFormatterName(): void
                     'description' => 'A description with multiple lines and extra whitespace.',
                     'message' => 'You have {numPhotos, plural, =0 {no photos.} =1 {one photo.} other {# photos.} }',
                 ],
+                'Q+U0TW' => [
+                    'message' => 'Welcome!',
+                ],
                 'Soex4s' => [
                     'description' => 'A simple description of a fixture for testing purposes.',
                     'message' => 'This is a default message',
                 ],
                 'xgMWoP' => [
                     'message' => 'This is a default message',
                 ],
-                'Q+U0TW' => [
-                    'message' => 'Welcome!',
-                ],
             ],
             $messages,
         );
@@ -322,16 +322,16 @@ public function testProcessWithChromeFormatterName(): void
                     'description' => 'A description with multiple lines and extra whitespace.',
                     'message' => 'You have {numPhotos, plural, =0 {no photos.} =1 {one photo.} other {# photos.} }',
                 ],
+                'Q+U0TW' => [
+                    'message' => 'Welcome!',
+                ],
                 'Soex4s' => [
                     'description' => 'A simple description of a fixture for testing purposes.',
                     'message' => 'This is a default message',
                 ],
                 'xgMWoP' => [
                     'message' => 'This is a default message',
                 ],
-                'Q+U0TW' => [
-                    'message' => 'Welcome!',
-                ],
             ],
             $messages,
         );
@@ -623,32 +623,32 @@ public function testProcessWithCustomParser(): void
                     'defaultMessage' => 'This is a default message',
                     'description' => 'A simple description of a fixture for testing purposes.',
                 ],
+                'customGoodbye' => [
+                    'defaultMessage' => 'Custom Goodbye!',
+                ],
+                'customWelcome' => [
+                    'defaultMessage' => 'Custom Welcome!',
+                ],
+                'goodbye' => [
+                    'defaultMessage' => 'Goodbye!',
+                ],
                 'photos.count' => [
                     'defaultMessage' =>
                         'You have {numPhotos, plural, =0 {no photos.} =1 {one photo.} other {# photos.} }',
                     'description' => 'A description with multiple lines and extra whitespace.',
                 ],
-                'welcome' => [
+                'Q+U0TW' => [
                     'defaultMessage' => 'Welcome!',
                 ],
-                'goodbye' => [
-                    'defaultMessage' => 'Goodbye!',
-                ],
                 'Soex4s' => [
                     'defaultMessage' => 'This is a default message',
                     'description' => 'A simple description of a fixture for testing purposes.',
                 ],
-                'xgMWoP' => [
-                    'defaultMessage' => 'This is a default message',
-                ],
-                'Q+U0TW' => [
+                'welcome' => [
                     'defaultMessage' => 'Welcome!',
                 ],
-                'customWelcome' => [
-                    'defaultMessage' => 'Custom Welcome!',
-                ],
-                'customGoodbye' => [
-                    'defaultMessage' => 'Custom Goodbye!',
+                'xgMWoP' => [
+                    'defaultMessage' => 'This is a default message',
                 ],
             ],
             $messages,
@@ -715,32 +715,32 @@ public function testProcessWithCustomParserAsClosure(): void
                     'defaultMessage' => 'This is a default message',
                     'description' => 'A simple description of a fixture for testing purposes.',
                 ],
+                'customGoodbye' => [
+                    'defaultMessage' => 'Custom Goodbye!',
+                ],
+                'customWelcome' => [
+                    'defaultMessage' => 'Custom Welcome!',
+                ],
+                'goodbye' => [
+                    'defaultMessage' => 'Goodbye!',
+                ],
                 'photos.count' => [
                     'defaultMessage' =>
                         'You have {numPhotos, plural, =0 {no photos.} =1 {one photo.} other {# photos.} }',
                     'description' => 'A description with multiple lines and extra whitespace.',
                 ],
-                'welcome' => [
+                'Q+U0TW' => [
                     'defaultMessage' => 'Welcome!',
                 ],
-                'goodbye' => [
-                    'defaultMessage' => 'Goodbye!',
-                ],
                 'Soex4s' => [
                     'defaultMessage' => 'This is a default message',
                     'description' => 'A simple description of a fixture for testing purposes.',
                 ],
-                'xgMWoP' => [
-                    'defaultMessage' => 'This is a default message',
-                ],
-                'Q+U0TW' => [
+                'welcome' => [
                     'defaultMessage' => 'Welcome!',
                 ],
-                'customWelcome' => [
-                    'defaultMessage' => 'Custom Welcome!',
-                ],
-                'customGoodbye' => [
-                    'defaultMessage' => 'Custom Goodbye!',
+                'xgMWoP' => [
+                    'defaultMessage' => 'This is a default message',
                 ],
             ],
             $messages,
@@ -810,6 +810,9 @@ public function testProcessFlatten(): void
                     'defaultMessage' => 'This is a default message',
                     'description' => 'A simple description of a fixture for testing purposes.',
                 ],
+                'goodbye' => [
+                    'defaultMessage' => 'Goodbye!',
+                ],
                 'OpKKos' => [
                     'defaultMessage' => 'Hello!',
                 ],
@@ -818,22 +821,19 @@ public function testProcessFlatten(): void
                         . '=1{You have one photo.} other{You have # photos.}}',
                     'description' => 'A description with multiple lines and extra whitespace.',
                 ],
-                'welcome' => [
+                'Q+U0TW' => [
                     'defaultMessage' => 'Welcome!',
                 ],
-                'goodbye' => [
-                    'defaultMessage' => 'Goodbye!',
-                ],
                 'Soex4s' => [
                     'defaultMessage' => 'This is a default message',
                     'description' => 'A simple description of a fixture for testing purposes.',
                 ],
+                'welcome' => [
+                    'defaultMessage' => 'Welcome!',
+                ],
                 'xgMWoP' => [
                     'defaultMessage' => 'This is a default message',
                 ],
-                'Q+U0TW' => [
-                    'defaultMessage' => 'Welcome!',
-                ],
             ],
             $messages,
         );

diff --git a/tests/Format/Writer/ChromeWriterTest.php b/tests/Format/Writer/ChromeWriterTest.php
@@ -25,9 +25,9 @@ public function testFormatter(): void
 
         $this->assertSame(
             [
-                'foo' => ['message' => ''],
                 'bar' => ['message' => 'some message'],
                 'baz' => ['description' => 'a description', 'message' => 'another message'],
+                'foo' => ['message' => ''],
             ],
             $formatter($collection, $options),
         );

diff --git a/tests/Format/Writer/CrowdinWriterTest.php b/tests/Format/Writer/CrowdinWriterTest.php
@@ -25,9 +25,9 @@ public function testFormatter(): void
 
         $this->assertSame(
             [
-                'foo' => ['message' => ''],
                 'bar' => ['message' => 'some message'],
                 'baz' => ['description' => 'a description', 'message' => 'another message'],
+                'foo' => ['message' => ''],
             ],
             $formatter($collection, $options),
         );

diff --git a/tests/Format/Writer/FormatPHPWriterTest.php b/tests/Format/Writer/FormatPHPWriterTest.php
@@ -25,9 +25,9 @@ public function testFormatterBasic(): void
 
         $this->assertSame(
             [
-                'foo' => ['defaultMessage' => ''],
                 'bar' => ['defaultMessage' => 'some message'],
                 'baz' => ['defaultMessage' => 'another message', 'description' => 'a description'],
+                'foo' => ['defaultMessage' => ''],
             ],
             $formatter($collection, $options),
         );