[+]: add simple auto-fix v2

voku · voku · commit f35b22c4ba61 · 2020-11-18T01:11:28.000+01:00
diff --git a/README.md b/README.md
@@ -8,5 +8,5 @@ git clone https://github.com/php/doc-en.git
 git clone https://github.com/voku/php-doc-fixer.git
 cd php-doc-fixer/
 composer update --prefer-dist
-php bin/phpdocfixer run [--auto-fix="true"] ../doc-en/reference
+php bin/phpdocfixer run [--auto-fix="true"] [--remove-array-value-info="true"] ../doc-en/reference
 ```
diff --git a/src/voku/PhpDocFixer/CliCommand/PhpDocFixerCommand.php b/src/voku/PhpDocFixer/CliCommand/PhpDocFixerCommand.php
@@ -39,6 +39,13 @@ public function configure(): void
                 \Symfony\Component\Console\Input\InputOption::VALUE_OPTIONAL,
                 'Automatically fix the types in the given xml files. (false or true)',
                 'false'
+            )
+            ->addOption(
+                'remove-array-value-info',
+                null,
+                \Symfony\Component\Console\Input\InputOption::VALUE_OPTIONAL,
+                'Automatically convert e.g. int[] into array. (false or true)',
+                'false'
             );
     }
 
@@ -50,6 +57,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
         \assert(\is_string($realPath));
 
         $autoFix = $input->getOption('auto-fix') !== 'false';
+        $removeArrayValueInfo = $input->getOption('remove-array-value-info') !== 'false';
 
         if (!$realPath || !\file_exists($realPath)) {
             $output->writeln('-------------------------------');
@@ -63,7 +71,10 @@ public function execute(InputInterface $input, OutputInterface $output): int
         $xmlDocInfo = $xmlReader->parse();
 
         $phpStormStubsPath = __DIR__ . '/../../../../vendor/jetbrains/phpstorm-stubs/';
-        $phpTypesFromPhpStormStubs = new \voku\PhpDocFixer\PhpStormStubs\PhpStormStubsReader($phpStormStubsPath);
+        $phpTypesFromPhpStormStubs = new \voku\PhpDocFixer\PhpStormStubs\PhpStormStubsReader(
+            $phpStormStubsPath,
+            $removeArrayValueInfo
+        );
         $phpStormStubsInfo = $phpTypesFromPhpStormStubs->parse();
 
         $errors = [];
diff --git a/src/voku/PhpDocFixer/PhpStormStubs/PhpStormStubsReader.php b/src/voku/PhpDocFixer/PhpStormStubs/PhpStormStubsReader.php
@@ -8,9 +8,12 @@ final class PhpStormStubsReader
 {
     private string $path;
 
-    public function __construct(string $path)
+    private bool $removeArrayValueInfo;
+
+    public function __construct(string $path, bool $removeArrayValueInfo = false)
     {
         $this->path = $path;
+        $this->removeArrayValueInfo = $removeArrayValueInfo;
     }
 
     /**
@@ -26,8 +29,14 @@ public function parse(): array
         $functionInfo = $phpCode->getFunctionsInfo();
         foreach ($functionInfo as $functionName => $info) {
             $return[$functionName]['return'] = \ltrim($info['returnTypes']['typeFromPhpDocSimple'] ?? '', '\\');
+            if ($this->removeArrayValueInfo) {
+                $return[$functionName]['return'] = $this->removeArrayValueInfo($return[$functionName]['return']);
+            }
             foreach ($info['paramsTypes'] as $paramName => $paramTypes) {
                 $return[$functionName]['params'][$paramName] = \ltrim($paramTypes['typeFromPhpDocSimple'] ?? '', '\\');
+                if ($this->removeArrayValueInfo) {
+                    $return[$functionName]['params'][$paramName] = $this->removeArrayValueInfo($return[$functionName]['params'][$paramName]);
+                }
             }
         }
 
@@ -36,12 +45,28 @@ public function parse(): array
             $className = (string) $class->name;
             foreach ($methodInfo as $methodName => $info) {
                 $return[$className . '::' . $methodName]['return'] = \ltrim($info['returnTypes']['typeFromPhpDocSimple'] ?? '', '\\');
+                if ($this->removeArrayValueInfo) {
+                    $return[$className . '::' . $methodName]['return'] = $this->removeArrayValueInfo($return[$className . '::' . $methodName]['return']);
+                }
                 foreach ($info['paramsTypes'] as $paramName => $paramTypes) {
                     $return[$className . '::' . $methodName]['params'][$paramName] = \ltrim($paramTypes['typeFromPhpDocSimple'] ?? '', '\\');
+                    if ($this->removeArrayValueInfo) {
+                        $return[$className . '::' . $methodName]['params'][$paramName] = $this->removeArrayValueInfo($return[$className . '::' . $methodName]['params'][$paramName]);
+                    }
                 }
             }
         }
 
         return $return;
     }
+
+    /**
+     * @param string $phpdoc_type
+     *
+     * @return string
+     */
+    public function removeArrayValueInfo(string $phpdoc_type): string
+    {
+        return (string) \preg_replace('#([\w_]*\[\])#', 'array', $phpdoc_type);
+    }
 }
diff --git a/src/voku/PhpDocFixer/XmlDocs/XmlReader.php b/src/voku/PhpDocFixer/XmlDocs/XmlReader.php
@@ -28,7 +28,12 @@ public function parse(): array
         $xmlParser->autoRemoveXPathNamespaces();
 
         $finder = new \Symfony\Component\Finder\Finder();
-        $finder->files()->in($this->xml_path);
+
+        if (\file_exists($this->xml_path) && !\is_dir($this->xml_path)) {
+            $finder->files()->in(\dirname($this->xml_path))->name(\basename($this->xml_path));
+        } else {
+            $finder->files()->in($this->xml_path);
+        }
 
         $data = [[]];
         foreach ($finder as $file) {
@@ -40,12 +45,15 @@ public function parse(): array
             $absoluteFilePath = $file->getPath() . \DIRECTORY_SEPARATOR . $fileName;
             $content = $file->getContents();
 
+            $contentMethodKeyword = 'methodsynopsis';
             \preg_match('#<methodsynopsis>.*</methodsynopsis>#Uis', $content, $contentMethod);
             $contentMethod = $contentMethod[0] ?? null;
 
+            $contentMethodOopKeyword = 'methodsynopsis';
             \preg_match('#<methodsynopsis role="oop">.*</methodsynopsis>#Uis', $content, $contentMethodOop);
             $contentMethodOop = $contentMethodOop[0] ?? null;
 
+            $contentConstructorKeyword = 'constructorsynopsis';
             \preg_match('#<constructorsynopsis>.*</constructorsynopsis>#Uis', $content, $contentConstructor);
             $contentConstructor = $contentConstructor[0] ?? null;
 
@@ -55,17 +63,17 @@ public function parse(): array
 
             if ($contentMethod) {
                 $methodsynopsis = $xmlParser->loadXml($contentMethod);
-                $data[] = $this->findTypes($methodsynopsis, $absoluteFilePath);
+                $data[] = $this->findTypes($methodsynopsis, $absoluteFilePath, $contentMethodKeyword);
             }
 
             if ($contentMethodOop) {
                 $methodsynopsisOop = $xmlParser->loadXml($contentMethodOop);
-                $data[] = $this->findTypes($methodsynopsisOop, $absoluteFilePath);
+                $data[] = $this->findTypes($methodsynopsisOop, $absoluteFilePath, $contentMethodOopKeyword);
             }
 
             if ($contentConstructor) {
                 $constructorsynopsis = $xmlParser->loadXml($contentConstructor);
-                $data[] = $this->findTypes($constructorsynopsis, $absoluteFilePath);
+                $data[] = $this->findTypes($constructorsynopsis, $absoluteFilePath, $contentConstructorKeyword);
             }
         }
 
@@ -75,6 +83,7 @@ public function parse(): array
     /**
      * @param \voku\helper\XmlDomParser $xmlParser
      * @param string                    $absoluteFilePath
+     * @param string                    $xmlWrapperElement
      *
      * @return array
      *
@@ -86,22 +95,23 @@ public function parse(): array
      */
     private function findTypes(
         \voku\helper\XmlDomParser $xmlParser,
-        string $absoluteFilePath
+        string $absoluteFilePath,
+        string $xmlWrapperElement
     ): array {
         // init
         $data = [];
 
-        $name = $xmlParser->findOne('//methodname')->text();
+        $name = $xmlParser->findOne('methodname')->text();
         $data[$name]['absoluteFilePath'] = $absoluteFilePath;
 
         $returnTypesArray = [];
-        $returnTypesTmp = $xmlParser->findMultiOrFalse('type.union type');
+        $returnTypesTmp = $xmlParser->findMultiOrFalse($xmlWrapperElement . ' > type.union > type');
         if ($returnTypesTmp !== false) {
             foreach ($returnTypesTmp as $returnTypeTmp) {
                 $returnTypeText = $returnTypeTmp->text();
                 $returnTypesArray[$returnTypeText] = \ltrim($returnTypeText, '\\');
             }
-        } elseif (($returnTypeTmp = $xmlParser->findOneOrFalse('type')) !== false) {
+        } elseif (($returnTypeTmp = $xmlParser->findOneOrFalse($xmlWrapperElement . ' > type')) !== false) {
             $returnTypeText = $returnTypeTmp->text();
             $returnTypesArray[$returnTypeText] = \ltrim($returnTypeText, '\\');
         }
@@ -113,7 +123,7 @@ private function findTypes(
                 $paramName = $param->findOne('parameter')->text();
                 $paramTypesArray = [];
 
-                $paramTypesTmp = $param->findMultiOrFalse('type.union type');
+                $paramTypesTmp = $param->findMultiOrFalse('type.union > type');
                 if ($paramTypesTmp !== false) {
                     foreach ($paramTypesTmp as $paramTypeTmp) {
                         $paramTypeText = $paramTypeTmp->text();
diff --git a/tests/CheckerTest.php b/tests/CheckerTest.php
@@ -15,6 +15,37 @@ public static function testPhpStormStubsReader(): void
         $phpTypesFromPhpStormStubs = new \voku\PhpDocFixer\PhpStormStubs\PhpStormStubsReader($phpStormStubsPath);
         $phpStormStubsInfo = $phpTypesFromPhpStormStubs->parse();
 
-        static::assertSame('int|false', $phpStormStubsInfo['mb_strpos']['return']);
+        $expected = [
+            'return' => 'int|false',
+            'params' => [
+                'haystack' => 'string',
+                'needle'   => 'string',
+                'offset'   => 'int',
+                'encoding' => 'string',
+            ],
+        ];
+
+        static::assertSame($expected, $phpStormStubsInfo['mb_strpos']);
+    }
+
+    public static function testPhpDocXmlReader(): void
+    {
+        $xmlPath = __DIR__ . '/fixtures/bcpow.xml';
+        $phpDocXmlReader = new \voku\PhpDocFixer\XmlDocs\XmlReader($xmlPath);
+        $phpDocXmlReaderInfo = $phpDocXmlReader->parse();
+
+        $expected = [
+            'bcpow' => [
+                'absoluteFilePath' => '/home/lmoelleken/testing/git/php-doc-fixer/tests/fixtures/bcpow.xml',
+                'return'           => 'string',
+                'params'           => [
+                    'num'      => 'string',
+                    'exponent' => 'string',
+                    'scale'    => 'int|null',
+                ],
+            ],
+        ];
+
+        static::assertSame($expected, $phpDocXmlReaderInfo);
     }
 }
diff --git a/tests/fixtures/bcpow.xml b/tests/fixtures/bcpow.xml
@@ -0,0 +1,147 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.bcpow" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>bcpow</refname>
+  <refpurpose>Raise an arbitrary precision number to another</refpurpose>
+ </refnamediv>
+ 
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>bcpow</methodname>
+   <methodparam><type>string</type><parameter>num</parameter></methodparam>
+   <methodparam><type>string</type><parameter>exponent</parameter></methodparam>
+   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>scale</parameter><initializer>&null;</initializer></methodparam>
+  </methodsynopsis>
+  <para>
+   Raise <parameter>num</parameter> to the power 
+   <parameter>exponent</parameter>. 
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>num</parameter></term>
+     <listitem>
+      <para>
+       The base, as a string.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>exponent</parameter></term>
+     <listitem>
+      <para>
+       The exponent, as a string. If the exponent is non-integral, it is truncated.
+       The valid range of the exponent is platform specific, but is at least
+       <literal>-2147483648</literal> to <literal>2147483647</literal>.
+      </para>
+     </listitem>
+    </varlistentry>
+    &bc.scale.description;
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the result as a string.
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="changelog"><!-- {{{ -->
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>7.3.0</entry>
+      <entry>
+       <function>bcpow</function> now returns numbers with the requested scale.
+       Formerly, the returned numbers may have omitted trailing decimal zeroes.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1><!-- }}} -->
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><function>bcpow</function> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+
+echo bcpow('4.2', '3', 2); // 74.08
+
+?>
+]]>
+   </programlisting>
+  </example>
+ </refsect1>
+
+ <refsect1 role="notes">
+  &reftitle.notes;
+  <note>
+   <para>
+    Before PHP 7.3.0 <function>bcpow</function> may return a result with fewer digits after the
+    decimal point than the <parameter>scale</parameter> parameter would
+    indicate. This only occurs when the result doesn't require all of the
+    precision allowed by the <parameter>scale</parameter>. For example:
+    <example>
+     <title><function>bcpow</function> scale example</title>
+     <programlisting role="php">
+<![CDATA[
+<?php
+echo bcpow('5', '2', 2);     // prints "25", not "25.00"
+?>
+]]>
+     </programlisting>
+    </example>
+   </para>
+  </note>
+ </refsect1>
+ 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>bcpowmod</function></member>
+    <member><function>bcsqrt</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+</refentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,12 @@ final class PhpStormStubsReader`
`8`	`8`	`{`
`9`	`9`	`private string $path;`
`10`	`10`
`11`		`- public function __construct(string $path)`
	`11`	`+ private bool $removeArrayValueInfo;`
	`12`	`+`
	`13`	`+ public function __construct(string $path, bool $removeArrayValueInfo = false)`
`12`	`14`	`{`
`13`	`15`	`$this->path = $path;`
	`16`	`+ $this->removeArrayValueInfo = $removeArrayValueInfo;`
`14`	`17`	`}`
`15`	`18`
`16`	`19`	`/**`
`@@ -26,8 +29,14 @@ public function parse(): array`
`26`	`29`	`$functionInfo = $phpCode->getFunctionsInfo();`
`27`	`30`	`foreach ($functionInfo as $functionName => $info) {`
`28`	`31`	`$return[$functionName]['return'] = \ltrim($info['returnTypes']['typeFromPhpDocSimple'] ?? '', '\\');`
	`32`	`+ if ($this->removeArrayValueInfo) {`
	`33`	`+ $return[$functionName]['return'] = $this->removeArrayValueInfo($return[$functionName]['return']);`
	`34`	`+ }`
`29`	`35`	`foreach ($info['paramsTypes'] as $paramName => $paramTypes) {`
`30`	`36`	`$return[$functionName]['params'][$paramName] = \ltrim($paramTypes['typeFromPhpDocSimple'] ?? '', '\\');`
	`37`	`+ if ($this->removeArrayValueInfo) {`
	`38`	`+ $return[$functionName]['params'][$paramName] = $this->removeArrayValueInfo($return[$functionName]['params'][$paramName]);`
	`39`	`+ }`
`31`	`40`	`}`
`32`	`41`	`}`
`33`	`42`
`@@ -36,12 +45,28 @@ public function parse(): array`
`36`	`45`	`$className = (string) $class->name;`
`37`	`46`	`foreach ($methodInfo as $methodName => $info) {`
`38`	`47`	`$return[$className . '::' . $methodName]['return'] = \ltrim($info['returnTypes']['typeFromPhpDocSimple'] ?? '', '\\');`
	`48`	`+ if ($this->removeArrayValueInfo) {`
	`49`	`+ $return[$className . '::' . $methodName]['return'] = $this->removeArrayValueInfo($return[$className . '::' . $methodName]['return']);`
	`50`	`+ }`
`39`	`51`	`foreach ($info['paramsTypes'] as $paramName => $paramTypes) {`
`40`	`52`	`$return[$className . '::' . $methodName]['params'][$paramName] = \ltrim($paramTypes['typeFromPhpDocSimple'] ?? '', '\\');`
	`53`	`+ if ($this->removeArrayValueInfo) {`
	`54`	`+ $return[$className . '::' . $methodName]['params'][$paramName] = $this->removeArrayValueInfo($return[$className . '::' . $methodName]['params'][$paramName]);`
	`55`	`+ }`
`41`	`56`	`}`
`42`	`57`	`}`
`43`	`58`	`}`
`44`	`59`
`45`	`60`	`return $return;`
`46`	`61`	`}`
	`62`	`+`
	`63`	`+ /**`
	`64`	`+ * @param string $phpdoc_type`
	`65`	`+ *`
	`66`	`+ * @return string`
	`67`	`+ */`
	`68`	`+ public function removeArrayValueInfo(string $phpdoc_type): string`
	`69`	`+ {`
	`70`	`+ return (string) \preg_replace('#([\w_]*\[\])#', 'array', $phpdoc_type);`
	`71`	`+ }`
`47`	`72`	`}`