[generator] don't duplicate special-cases list, fixes #523

thecodingmachine · Feb 8, 2025 · b4640be · b4640be
1 parent 6d35e7f
commit b4640be
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 31 deletions.
diff --git a/generator/config/specialCasesFunctions.php b/generator/config/specialCasesFunctions.php
diff --git a/generator/src/Generator/FileCreator.php b/generator/src/Generator/FileCreator.php
@@ -4,6 +4,7 @@
 
 namespace Safe\Generator;
 
+use Safe\XmlDocParser\Scanner;
 use Safe\XmlDocParser\Method;
 
 use function array_merge;
@@ -94,7 +95,7 @@ private function getFunctionsNameList(array $functions): array
         $functionNames = array_map(function (Method $function) {
             return $function->getFunctionName();
         }, $functions);
-        $specialCases = require FileCreator::getSafeRootDir() . '/generator/config/specialCasesFunctions.php';
+        $specialCases = Scanner::getSpecialCases();
         $functionNames = array_merge($functionNames, $specialCases);
         natcasesort($functionNames);
         return $functionNames;

diff --git a/generator/src/XmlDocParser/DocPage.php b/generator/src/XmlDocParser/DocPage.php
@@ -25,7 +25,7 @@ public static function findReferenceDir(): string
         return DocPage::findDocDir() . '/doc-en/en/reference';
     }
 
-    // Ignore function if it was removed before PHP 7.1
+    // Ignore function if it was removed before PHP 8.1
     private function getIsDeprecated(string $file): bool
     {
         if (preg_match('/&warn\.deprecated\.function-(\d+-\d+-\d+)\.removed-(\d+-\d+-\d+)/', $file, $matches)) {
@@ -48,25 +48,21 @@ private function getIsDeprecated(string $file): bool
     }
 
     public function getErrorType(): ErrorType
-    {
-        $returnValuesSection = $this->getReturnValues();
-        $detectErrorType = require FileCreator::getSafeRootDir() . '/generator/config/detectErrorType.php';
-        return $detectErrorType($returnValuesSection);
-    }
-
-    private function getReturnValues(): string
     {
         $file = file_get_contents($this->path);
         if ($file === false) {
             throw new \RuntimeException('An error occurred while reading '.$this->path);
         }
         if ($this->getIsDeprecated($file)) {
-            return "";
+            return ErrorType::UNKNOWN;
         }
+
         // Only evaluate the text inside the `<refsect1 role="returnvalues">...</refsect1>` section of the doc page.
         // This minimizes 'false positives', where text such as "returns false when ..." could be matched outside
         // the function's dedicated Return Values section.
-        return $this->extractSection('returnvalues', $file);
+        $returnDocs = $this->extractSection('returnvalues', $file);
+        $detectErrorType = require FileCreator::getSafeRootDir() . '/generator/config/detectErrorType.php';
+        return $detectErrorType($returnDocs);
     }
 
     /**

diff --git a/generator/src/XmlDocParser/Scanner.php b/generator/src/XmlDocParser/Scanner.php
@@ -59,7 +59,7 @@ private function getIgnoredFunctions(): array
     {
         if ($this->ignoredFunctions === null) {
             $ignoredFunctions = require FileCreator::getSafeRootDir() . '/generator/config/ignoredFunctions.php';
-            $specialCaseFunctions = require FileCreator::getSafeRootDir() . '/generator/config/specialCasesFunctions.php';
+            $specialCaseFunctions = $this->getSpecialCases();
 
             $this->ignoredFunctions = array_merge($ignoredFunctions, $specialCaseFunctions);
         }
@@ -78,6 +78,23 @@ private function getIgnoredModules(): array
         return $this->ignoredModules;
     }
 
+    /**
+     * Get a list of functions defined in special_cases.php so that we
+     * can ignore them in the main list.
+     *
+     * @return string[]
+     */
+    public static function getSpecialCases(): array
+    {
+        $data = file_get_contents(FileCreator::getSafeRootDir() . '/lib/special_cases.php');
+        if ($data === false) {
+            throw new \RuntimeException('Unable to read special cases');
+        }
+        $matches = [];
+        preg_match_all('/function\s+([\w_]+)\(/', $data, $matches);
+        return $matches[1];
+    }
+
     /**
      * @param SplFileInfo[] $paths
      */