[12.x] Make Str::is() match multiline strings (#51196)

* make Str::is() support multiline strings * more tests with patterns containing new lines * cs * cs
laravel · Apr 25, 2024 · baed746 · baed746
1 parent 63797d3
commit baed746
Show file tree

Hide file tree

Showing 5 changed files with 105 additions and 4 deletions.
diff --git a/src/Illuminate/Process/PendingProcess.php b/src/Illuminate/Process/PendingProcess.php
@@ -350,7 +350,7 @@ public function withFakeHandlers(array $fakeHandlers)
     protected function fakeFor(string $command)
     {
         return collect($this->fakeHandlers)
-                ->first(fn ($handler, $pattern) => $pattern === '*' || Str::is($pattern, $command));
+                ->first(fn ($handler, $pattern) => Str::is($pattern, $command));
     }
 
     /**

diff --git a/src/Illuminate/Support/Str.php b/src/Illuminate/Support/Str.php
@@ -432,7 +432,7 @@ public static function is($pattern, $value)
             // If the given value is an exact match we can of course return true right
             // from the beginning. Otherwise, we will translate asterisks and do an
             // actual pattern match against the two strings to see if they match.
-            if ($pattern === $value) {
+            if ($pattern === '*' || $pattern === $value) {
                 return true;
             }
 
@@ -443,7 +443,7 @@ public static function is($pattern, $value)
             // pattern such as "library/*", making any string check convenient.
             $pattern = str_replace('\*', '.*', $pattern);
 
-            if (preg_match('#^'.$pattern.'\z#u', $value) === 1) {
+            if (preg_match('#^'.$pattern.'\z#su', $value) === 1) {
                 return true;
             }
         }

diff --git a/tests/Process/ProcessTest.php b/tests/Process/ProcessTest.php
@@ -156,7 +156,7 @@ public function testBasicProcessFakeWithMultiLineCommand()
         $factory->preventStrayProcesses();
 
         $factory->fake([
-            '*' => 'The output',
+            '*' => $expectedOutput = 'The output',
         ]);
 
         $result = $factory->run(<<<'COMMAND'
@@ -167,6 +167,29 @@ public function testBasicProcessFakeWithMultiLineCommand()
         COMMAND);
 
         $this->assertSame(0, $result->exitCode());
+        $this->assertSame("$expectedOutput\n", $result->output());
+    }
+
+    public function testProcessFakeWithMultiLineCommand()
+    {
+        $factory = new Factory;
+
+        $factory->preventStrayProcesses();
+
+        $factory->fake([
+            '*--branch main*' => 'not this one',
+            '*--branch develop*' => $expectedOutput = 'yes thank you',
+        ]);
+
+        $result = $factory->run(<<<'COMMAND'
+        git clone --depth 1 \
+              --single-branch \
+              --branch develop \
+              git://some-url .
+        COMMAND);
+
+        $this->assertSame(0, $result->exitCode());
+        $this->assertSame("$expectedOutput\n", $result->output());
     }
 
     public function testProcessFakeExitCodes()

diff --git a/tests/Support/SupportStrTest.php b/tests/Support/SupportStrTest.php
@@ -487,6 +487,52 @@ public function testIs()
         $this->assertTrue(Str::is([null], null));
     }
 
+    public function testIsWithMultilineStrings()
+    {
+        $this->assertFalse(Str::is('/', "/\n"));
+        $this->assertTrue(Str::is('/*', "/\n"));
+        $this->assertTrue(Str::is('*/*', "/\n"));
+        $this->assertTrue(Str::is('*/*', "\n/\n"));
+
+        $this->assertTrue(Str::is('*', "\n"));
+        $this->assertTrue(Str::is('*', "\n\n"));
+        $this->assertFalse(Str::is('', "\n"));
+        $this->assertFalse(Str::is('', "\n\n"));
+
+        $multilineValue = <<<'VALUE'
+        <?php
+
+        namespace Illuminate\Tests\Support;
+
+        use Exception;
+        VALUE;
+
+        $this->assertTrue(Str::is($multilineValue, $multilineValue));
+        $this->assertTrue(Str::is('*', $multilineValue));
+        $this->assertTrue(Str::is("*namespace Illuminate\Tests\*", $multilineValue));
+        $this->assertFalse(Str::is("namespace Illuminate\Tests\*", $multilineValue));
+        $this->assertFalse(Str::is("*namespace Illuminate\Tests", $multilineValue));
+        $this->assertTrue(Str::is('<?php*', $multilineValue));
+        $this->assertTrue(Str::is("<?php*namespace Illuminate\Tests\*", $multilineValue));
+        $this->assertFalse(Str::is('use Exception;', $multilineValue));
+        $this->assertFalse(Str::is('use Exception;*', $multilineValue));
+        $this->assertTrue(Str::is('*use Exception;', $multilineValue));
+
+        $this->assertTrue(Str::is("<?php\n\nnamespace Illuminate\Tests\*", $multilineValue));
+
+        $this->assertTrue(Str::is(<<<'PATTERN'
+        <?php
+        *
+        namespace Illuminate\Tests\*
+        PATTERN, $multilineValue));
+
+        $this->assertTrue(Str::is(<<<'PATTERN'
+        <?php
+
+        namespace Illuminate\Tests\*
+        PATTERN, $multilineValue));
+    }
+
     public function testIsUrl()
     {
         $this->assertTrue(Str::isUrl('https://laravel.com'));

diff --git a/tests/Support/SupportStringableTest.php b/tests/Support/SupportStringableTest.php
@@ -800,6 +800,38 @@ public function testIs()
         $this->assertFalse($this->stringable('test')->is([]));
     }
 
+    public function testIsWithMultilineStrings()
+    {
+        $this->assertFalse($this->stringable("/\n")->is('/'));
+        $this->assertTrue($this->stringable("/\n")->is('/*'));
+        $this->assertTrue($this->stringable("/\n")->is('*/*'));
+        $this->assertTrue($this->stringable("\n/\n")->is('*/*'));
+
+        $this->assertTrue($this->stringable("\n")->is('*'));
+        $this->assertTrue($this->stringable("\n\n")->is('*'));
+        $this->assertFalse($this->stringable("\n")->is(''));
+        $this->assertFalse($this->stringable("\n\n")->is(''));
+
+        $multilineValue = <<<'VALUE'
+        <?php
+
+        namespace Illuminate\Tests\Support;
+
+        use Exception;
+        VALUE;
+
+        $this->assertTrue($this->stringable($multilineValue)->is($multilineValue));
+        $this->assertTrue($this->stringable($multilineValue)->is('*'));
+        $this->assertTrue($this->stringable($multilineValue)->is("*namespace Illuminate\Tests\*"));
+        $this->assertFalse($this->stringable($multilineValue)->is("namespace Illuminate\Tests\*"));
+        $this->assertFalse($this->stringable($multilineValue)->is("*namespace Illuminate\Tests"));
+        $this->assertTrue($this->stringable($multilineValue)->is('<?php*'));
+        $this->assertTrue($this->stringable($multilineValue)->is("<?php*namespace Illuminate\Tests\*"));
+        $this->assertFalse($this->stringable($multilineValue)->is('use Exception;'));
+        $this->assertFalse($this->stringable($multilineValue)->is('use Exception;*'));
+        $this->assertTrue($this->stringable($multilineValue)->is('*use Exception;'));
+    }
+
     public function testKebab()
     {
         $this->assertSame('laravel-php-framework', (string) $this->stringable('LaravelPhpFramework')->kebab());