Merge pull request #8922 from fluffycondor/sprintf-non-empty-string

Make `sprintf` return `non-empty-string` when possible
vimeo · Dec 18, 2022 · 7d95f15 · 7d95f15
2 parents a76a1d1 + 9a22d68
commit 7d95f15
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 3 deletions.
diff --git a/stubs/CoreGenericFunctions.phpstub b/stubs/CoreGenericFunctions.phpstub
@@ -1117,6 +1117,9 @@ function preg_quote(string $str, ?string $delimiter = null) : string {}
  * @psalm-pure
  *
  * @param string|int|float $values
+ * @return ($format is non-empty-string
+ *      ? ($values is non-empty-string|int|float ? non-empty-string : string)
+ *      : string)
  *
  * @psalm-flow ($format, $values) -> return
  */

diff --git a/tests/Config/ConfigTest.php b/tests/Config/ConfigTest.php
@@ -1461,7 +1461,6 @@ public function pluginRegistersScannerAndAnalyzer(int $flags, ?int $expectedExce
         FileTypeSelfRegisteringPlugin::$names = $names;
         FileTypeSelfRegisteringPlugin::$flags = $flags;
 
-        /** @var non-empty-string $xml */
         $xml = sprintf(
             '<?xml version="1.0"?>
             <psalm><plugins><pluginClass class="%s"/></plugins></psalm>',

diff --git a/tests/Config/PluginTest.php b/tests/Config/PluginTest.php
@@ -801,7 +801,6 @@ public function testAfterAnalysisHooks(): void
 
     public function testPluginFilenameCanBeAbsolute(): void
     {
-        /** @var non-empty-string $xml */
         $xml = sprintf(
             '<?xml version="1.0"?>
             <psalm
@@ -828,7 +827,6 @@ public function testPluginInvalidAbsoluteFilenameThrowsException(): void
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('does-not-exist/plugins/StringChecker.php');
 
-        /** @var non-empty-string $xml */
         $xml = sprintf(
             '<?xml version="1.0"?>
             <psalm

diff --git a/tests/CoreStubsTest.php b/tests/CoreStubsTest.php
@@ -101,5 +101,27 @@ public function providerValidCodeParse(): iterable
             'ignored_issues' => ['RedundantCondition'],
             'php_version' => '8.0',
         ];
+        yield 'sprintf yields a non-empty-string for non-empty-string value' => [
+            'code' => '<?php
+
+            /**
+             * @param non-empty-string $foo
+             * @return non-empty-string
+             */
+            function foo(string $foo): string
+            {
+                return sprintf("%s", $foo);
+            }
+            ',
+        ];
+        yield 'sprintf yields a string for possible empty string param' => [
+            'code' => '<?php
+
+            $a = sprintf("%s", "");
+            ',
+            'assertions' => [
+                '$a===' => 'string',
+            ],
+        ];
     }
 }