fix: ensure zero doesn't break parsing & errors don't interrupt hoisting (#31)

Author: ramsey

CHANGELOG.md

@@ -5,6 +5,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 0.3.1 - 2021-12-17
+
+### Added
+
+- Nothing.
+
+### Changed
+
+- Nothing.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Fixed case where errors occurring during flattening would cause `null` to be passed to a method that does not accept `null`
+- Fixed case where "0" character caused a truthy check to fail, since `0 == false`
+
 ## 0.3.0 - 2021-12-16
 
 ### Added

src/Extractor/MessageExtractor.php

@@ -49,6 +49,7 @@
 use Psr\Log\LoggerInterface;
 use Ramsey\Collection\Exception\CollectionMismatchException;
 
+use function array_filter;
 use function class_exists;
 use function count;
 use function is_a;
@@ -226,18 +227,18 @@ private function loadDescriptorParser(string $parserNameOrScript): DescriptorPar
      */
     private function write(callable $formatter, DescriptorCollection $descriptors): void
     {
-        if ($this->options->flatten === true) {
-            /** @var DescriptorInterface[] $flattened */
-            $flattened = $descriptors->map($this->flattenMessage())->toArray();
-            $descriptors = new DescriptorCollection($flattened);
-        }
-
         if ($this->options->validateMessages === true && count($this->errors) > 0) {
             $this->logger->error('Validation errors encountered; extraction failed');
 
             return;
         }
 
+        if ($this->options->flatten === true) {
+            /** @var DescriptorInterface[] $flattened */
+            $flattened = $descriptors->map($this->flattenMessage())->toArray();
+            $descriptors = new DescriptorCollection(array_filter($flattened));
+        }
+
         $file = $this->options->outFile ?? 'php://output';
 
         $writerOptions = new WriterOptions();
@@ -282,11 +283,15 @@ public function __invoke(
 
     private function flattenMessage(): Closure
     {
-        return function (Descriptor $descriptor): Descriptor {
+        return function (Descriptor $descriptor): ?Descriptor {
             $message = $descriptor->getDefaultMessage();
             $messageFormatParser = new MessageFormatParser((string) $message);
             $result = $messageFormatParser->parse();
 
+            if ($result->err !== null) {
+                return null;
+            }
+
             /** @var MessageFormatParser\Type\ElementCollection $messageAst */
             $messageAst = $result->val;
 

src/Icu/MessageFormat/Parser.php

@@ -373,21 +373,21 @@ private function parseLiteral(int $nestingLevel, string $parentArgType): Result
 
         while (true) {
             $quoted = $this->tryParseQuote($parentArgType);
-            if ($quoted) {
+            if ($quoted !== null) {
                 $value .= $quoted;
 
                 continue;
             }
 
             $unquoted = $this->tryParseUnquoted($nestingLevel, $parentArgType);
-            if ($unquoted) {
+            if ($unquoted !== null) {
                 $value .= $unquoted;
 
                 continue;
             }
 
             $leftAngle = $this->tryParseLeftAngleBracket();
-            if ($leftAngle) {
+            if ($leftAngle !== null) {
                 $value .= $leftAngle;
 
                 continue;

tests/Extractor/MessageExtractorTest.php

@@ -795,7 +795,10 @@ public function testProcessFlatten(): void
         );
 
         ob_start();
-        $extractor->process([__DIR__ . '/Parser/Descriptor/fixtures/*.ph*']);
+        $extractor->process([
+            __DIR__ . '/Parser/Descriptor/fixtures/*.ph*',
+            __DIR__ . '/../fixtures/invalid-message.php',
+        ]);
         $output = ob_get_contents();
         ob_end_clean();
 

tests/Icu/MessageFormat/ManipulatorTest.php

@@ -64,6 +64,9 @@ public function messageProvider(): array
                             other{many cats}}
                     EOD,
             ],
+            'should not mangle numbers in messages' => [
+                'message' => 'All classes are pre-recorded and average 30-40 minutes in total length.',
+            ],
         ];
     }
 }

tests/Icu/MessageFormat/__snapshots__/ManipulatorTest__testHoistSelectors with data set should not mangle numbers in messages__1.txt

@@ -0,0 +1 @@
+All classes are pre-recorded and average 30-40 minutes in total length.