From f6f7ff4a6e4659cef5130afc95a5ee95039ecdeb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20Kowalik?= <maf.michal@gmail.com>
Date: Wed, 13 Mar 2019 00:58:49 +0100
Subject: [PATCH] #654 drop ereg functions in favoure of preg functions

---
 src/Mutator/Extensions/MBString.php       |  56 +++++-
 tests/Mutator/Extensions/MBStringTest.php | 224 +++++++++++++++-------
 2 files changed, 200 insertions(+), 80 deletions(-)

diff --git a/src/Mutator/Extensions/MBString.php b/src/Mutator/Extensions/MBString.php
index 0fe91e649..9018e1598 100644
--- a/src/Mutator/Extensions/MBString.php
+++ b/src/Mutator/Extensions/MBString.php
@@ -84,12 +84,12 @@ private function setupConverters(array $functionsMap): void
     {
         $converters = [
             'mb_chr' => $this->mapNameSkipArg('chr', 1),
-            'mb_ereg_match' => $this->mapNameSkipArg('preg_match', 2),
-            'mb_ereg_replace_callback' => $this->mapNameSkipArg('preg_replace_callback', 3),
-            'mb_ereg_replace' => $this->mapNameSkipArg('ereg_replace', 3),
-            'mb_ereg' => $this->mapName('ereg'),
-            'mb_eregi_replace' => $this->mapNameSkipArg('eregi_replace', 3),
-            'mb_eregi' => $this->mapName('eregi'),
+            'mb_ereg_match' => $this->mapEreg($this->mapNameSkipArg('preg_match', 2), '^', '', [$this, 'warpEqOne']),
+            'mb_ereg_replace_callback' => $this->mapEreg($this->mapNameSkipArg('preg_replace_callback', 3)),
+            'mb_ereg_replace' => $this->mapEreg($this->mapNameSkipArg('preg_replace', 3)),
+            'mb_ereg' => $this->mapEreg($this->mapName('preg_match'), '', '', [$this, 'warpTernary']),
+            'mb_eregi_replace' => $this->mapEreg($this->mapNameSkipArg('preg_replace', 3), '', 'i'),
+            'mb_eregi' => $this->mapEreg($this->mapName('preg_match'), '', 'i', [$this, 'warpTernary']),
             'mb_ord' => $this->mapNameSkipArg('ord', 1),
             'mb_parse_str' => $this->mapName('parse_str'),
             'mb_send_mail' => $this->mapName('mail'),
@@ -132,6 +132,50 @@ private function mapNameSkipArg(string $functionName, int $skipArgs): callable
         };
     }
 
+    private function mapEreg(callable $baseConverter, string $prefix = '', string $suffix = '', callable $warp = null): callable
+    {
+        return function (Node\Expr\FuncCall $node) use ($baseConverter, $prefix, $suffix, $warp): Generator {
+            foreach ($baseConverter($node) as $newNode) {
+                /* @var Node\Expr\FuncCall $newNode */
+                $newNode->args[0] = new Node\Arg(
+                    new Node\Expr\BinaryOp\Concat(
+                        new Node\Expr\BinaryOp\Concat(
+                            new Node\Scalar\String_("/$prefix"),
+                            new Node\Expr\FuncCall(
+                                new Node\Name('\str_replace'),
+                                [
+                                    new Node\Arg(new Node\Scalar\String_('/')),
+                                    new Node\Arg(new Node\Scalar\String_('\/')),
+                                    new Node\Arg($newNode->args[0]->value),
+                                ]
+                            )
+                        ),
+                        new Node\Scalar\String_("/$suffix")
+                    )
+                );
+
+                yield $warp ? $warp($newNode) : $newNode;
+            }
+        };
+    }
+
+    private function warpEqOne(Node\Expr\FuncCall $node): Node
+    {
+        return new Node\Expr\BinaryOp\Identical(
+            $node,
+            new Node\Scalar\LNumber(1)
+        );
+    }
+
+    private function warpTernary(Node\Expr\FuncCall $node): Node
+    {
+        return new Node\Expr\Ternary(
+            $node,
+            new Node\Scalar\LNumber(1),
+            new Node\Expr\ConstFetch(new Node\Name('false'))
+        );
+    }
+
     private function mapConvertCase(): callable
     {
         return function(Node\Expr\FuncCall $node): Generator {
diff --git a/tests/Mutator/Extensions/MBStringTest.php b/tests/Mutator/Extensions/MBStringTest.php
index f8180700f..451190711 100644
--- a/tests/Mutator/Extensions/MBStringTest.php
+++ b/tests/Mutator/Extensions/MBStringTest.php
@@ -35,6 +35,7 @@
 
 namespace Infection\Tests\Mutator\Extensions;
 
+use Generator;
 use Infection\Tests\Mutator\AbstractMutatorTestCase;
 
 /**
@@ -50,7 +51,7 @@ public function test_mutator(string $input, string $expected = null, array $sett
         $this->doTest($input, $expected, $settings);
     }
 
-    public function provideMutationCases(): \Generator
+    public function provideMutationCases(): Generator
     {
         yield 'It converts mb_strlen with leading slash' => [
             "<?php \mb_strlen('test');",
@@ -78,8 +79,59 @@ public function provideMutationCases(): \Generator
             ['settings' => ['mb_strlen' => false]],
         ];
 
-        // mb_chr-> chr
+        yield from $this->provideMutationCasesForChr();
 
+        yield from $this->provideMutationCasesForEregMatch();
+
+        yield from $this->provideMutationCasesForEregReplaceCallback();
+
+        yield from $this->provideMutationCasesForEregReplace();
+
+        yield from $this->provideMutationCasesForEreg();
+
+        yield from $this->provideMutationCasesForEregiReplace();
+
+        yield from $this->provideMutationCasesForEregi();
+
+        yield from $this->provideMutationCasesForOrd();
+
+        yield from $this->provideMutationCasesForParseStr();
+
+        yield from $this->provideMutationCasesForSendMail();
+
+        yield from $this->provideMutationCasesForSplit();
+
+        yield from $this->provideMutationCasesForStrCut();
+
+        yield from $this->provideMutationCasesForStrPos();
+
+        yield from $this->provideMutationCasesForStrIPos();
+
+        yield from $this->provideMutationCasesForStrIStr();
+
+        yield from $this->provideMutationCasesForStrRiPos();
+
+        yield from $this->provideMutationCasesForStrRPos();
+
+        yield from $this->provideMutationCasesForStrStr();
+
+        yield from $this->provideMutationCasesForStrToLower();
+
+        yield from $this->provideMutationCasesForStrToUpper();
+
+        yield from $this->provideMutationCasesForSubStrCount();
+
+        yield from $this->provideMutationCasesForSubStr();
+
+        yield from $this->provideMutationCasesForStrRChr();
+
+        yield from $this->provideMutationCasesForStrRiChr();
+
+        yield from $this->provideMutationCasesForConvertCase();
+    }
+
+    private function provideMutationCasesForChr(): Generator
+    {
         yield 'It converts mb_chr to chr' => [
             '<?php mb_chr(74);',
             "<?php\n\nchr(74);",
@@ -89,81 +141,88 @@ public function provideMutationCases(): \Generator
             "<?php mb_chr(74, 'utf-8');",
             "<?php\n\nchr(74);",
         ];
+    }
 
-        // mb_ereg_match -> preg_match
-
+    private function provideMutationCasesForEregMatch(): Generator
+    {
         yield 'It converts mb_ereg_match to preg_match' => [
-            "<?php mb_ereg_match('#t#', 'test');",
-            "<?php\n\npreg_match('#t#', 'test');",
+            "<?php mb_ereg_match(M_2_PI, 'test');",
+            "<?php\n\npreg_match('/^' . \str_replace('/', '\\\\/', M_2_PI) . '/', 'test') === 1;",
         ];
 
         yield 'It converts mb_ereg_match with encoding argument to preg_match' => [
-            "<?php mb_ereg_match('#t#', 'trim', 'mb');",
-            "<?php\n\npreg_match('#t#', 'trim');",
+            "<?php mb_ereg_match(M_2_PI, 'trim', 'mb');",
+            "<?php\n\npreg_match('/^' . \str_replace('/', '\\\\/', M_2_PI) . '/', 'trim') === 1;",
         ];
+    }
 
-        // mb_ereg_replace_callback -> preg_replace_callback
-
+    private function provideMutationCasesForEregReplaceCallback(): Generator
+    {
         yield 'It converts mb_ereg_replace_callback to preg_replace_callback' => [
-            "<?php mb_ereg_replace_callback('#t#', 'trim', 'test');",
-            "<?php\n\npreg_replace_callback('#t#', 'trim', 'test');",
+            "<?php mb_ereg_replace_callback('[A-Z/#]', 'trim', 'test');",
+            "<?php\n\npreg_replace_callback('/' . \str_replace('/', '\\\\/', '[A-Z/#]') . '/', 'trim', 'test');",
         ];
 
         yield 'It converts mb_ereg_replace_callback with options to preg_replace_callback' => [
-            "<?php mb_ereg_replace_callback('#t#', 'trim', 'test', 'msr');",
-            "<?php\n\npreg_replace_callback('#t#', 'trim', 'test');",
+            "<?php mb_ereg_replace_callback('[A-Z/#]', 'trim', 'test', 'msr');",
+            "<?php\n\npreg_replace_callback('/' . \str_replace('/', '\\\\/', '[A-Z/#]') . '/', 'trim', 'test');",
         ];
+    }
 
-        // mb_ereg_replace -> ereg_replace
-
+    private function provideMutationCasesForEregReplace(): Generator
+    {
         yield 'It converts mb_ereg_replace to ereg_replace' => [
-            "<?php mb_ereg_replace('#t#', 'T', 'test');",
-            "<?php\n\nereg_replace('#t#', 'T', 'test');",
+            "<?php mb_ereg_replace(\$pattern, 'T', 'test');",
+            "<?php\n\npreg_replace('/' . \str_replace('/', '\\\\/', \$pattern) . '/', 'T', 'test');",
         ];
 
         yield 'It converts mb_ereg_replace with options to ereg_replace' => [
-            "<?php mb_ereg_replace('#t#', 'T', 'test', 'mb');",
-            "<?php\n\nereg_replace('#t#', 'T', 'test');",
+            "<?php mb_ereg_replace(\$pattern, 'T', 'test', 'mb');",
+            "<?php\n\npreg_replace('/' . \str_replace('/', '\\\\/', \$pattern) . '/', 'T', 'test');",
         ];
+    }
 
-        // mb_ereg -> ereg
-
+    private function provideMutationCasesForEreg(): Generator
+    {
         yield 'It converts mb_ereg to ereg' => [
-            "<?php mb_ereg('#t#', 'test');",
-            "<?php\n\nereg('#t#', 'test');",
+            "<?php mb_ereg(getPattern(\$x, 1), 'test');",
+            "<?php\n\npreg_match('/' . \str_replace('/', '\\\\/', getPattern(\$x, 1)) . '/', 'test') ? 1 : false;",
         ];
 
         yield 'It converts mb_ereg with regs argument to ereg' => [
-            "<?php mb_ereg('#t#', 'test', \$regs);",
-            "<?php\n\nereg('#t#', 'test', \$regs);",
+            "<?php mb_ereg(getPattern(\$x, 1), 'test', \$regs);",
+            "<?php\n\npreg_match('/' . \str_replace('/', '\\\\/', getPattern(\$x, 1)) . '/', 'test', \$regs) ? 1 : false;",
         ];
+    }
 
-        // mb_eregi_replace -> eregi_replace
-
+    private function provideMutationCasesForEregiReplace(): Generator
+    {
         yield 'It converts mb_eregi_replace to eregi_replace' => [
-            "<?php mb_eregi_replace('#t#', 'T', 'test');",
-            "<?php\n\neregi_replace('#t#', 'T', 'test');",
+            "<?php mb_eregi_replace(\$a . \$b, 'T', 'test');",
+            "<?php\n\npreg_replace('/' . \str_replace('/', '\\\\/', \$a . \$b) . '/i', 'T', 'test');",
         ];
 
         yield 'It converts mb_eregi_replace with options to eregi_replace' => [
-            "<?php mb_eregi_replace('#t#', 'T', 'test', 'msr');",
-            "<?php\n\neregi_replace('#t#', 'T', 'test');",
+            "<?php mb_eregi_replace(\$a . \$b, 'T', 'test', 'msr');",
+            "<?php\n\npreg_replace('/' . \str_replace('/', '\\\\/', \$a . \$b) . '/i', 'T', 'test');",
         ];
+    }
 
-        // mb_eregi -> eregi
-
+    private function provideMutationCasesForEregi(): Generator
+    {
         yield 'It converts mb_eregi to eregi' => [
-            "<?php mb_eregi('#t#', 'test');",
-            "<?php\n\neregi('#t#', 'test');",
+            "<?php mb_eregi(\DateTime::getLastErrors(), 'test');",
+            "<?php\n\npreg_match('/' . \str_replace('/', '\\\\/', \DateTime::getLastErrors()) . '/i', 'test') ? 1 : false;",
         ];
 
         yield 'It converts mb_eregi with regs parameter to eregi' => [
-            "<?php mb_eregi('#t#', 'test', \$regs);",
-            "<?php\n\neregi('#t#', 'test', \$regs);",
+            "<?php mb_eregi(\DateTime::getLastErrors(), 'test', \$regs);",
+            "<?php\n\npreg_match('/' . \str_replace('/', '\\\\/', \DateTime::getLastErrors()) . '/i', 'test', \$regs) ? 1 : false;",
         ];
+    }
 
-        // mb_ord -> ord
-
+    private function provideMutationCasesForOrd(): Generator
+    {
         yield 'It converts mb_ord to ord' => [
             "<?php mb_ord('T');",
             "<?php\n\nord('T');",
@@ -173,9 +232,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_ord('T', 'utf-8');",
             "<?php\n\nord('T');",
         ];
+    }
 
-        // mb_parse_str -> parse_str
-
+    private function provideMutationCasesForParseStr(): Generator
+    {
         yield 'It converts mb_parse_str to parse_str' => [
             "<?php mb_parse_str('T');",
             "<?php\n\nparse_str('T');",
@@ -185,9 +245,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_parse_str('T', \$params);",
             "<?php\n\nparse_str('T', \$params);",
         ];
+    }
 
-        // mb_send_mail -> mail
-
+    private function provideMutationCasesForSendMail(): Generator
+    {
         yield 'It converts mb_send_mail to mail' => [
             "<?php mb_send_mail('to', 'subject', 'msg');",
             "<?php\n\nmail('to', 'subject', 'msg');",
@@ -197,9 +258,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_send_mail('to', 'subject', 'msg', [], []);",
             "<?php\n\nmail('to', 'subject', 'msg', [], []);",
         ];
+    }
 
-        // mb_split -> split
-
+    private function provideMutationCasesForSplit(): Generator
+    {
         yield 'It converts mb_split to split' => [
             "<?php mb_split('to', 'subject');",
             "<?php\n\nsplit('to', 'subject');",
@@ -209,9 +271,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_split('to', 'subject', 2);",
             "<?php\n\nsplit('to', 'subject', 2);",
         ];
+    }
 
-        // mb_strcut -> substr
-
+    private function provideMutationCasesForStrCut(): Generator
+    {
         yield 'It converts mb_strcut to substr' => [
             "<?php mb_strcut('subject', 1);",
             "<?php\n\nsubstr('subject', 1);",
@@ -226,9 +289,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_strcut('subject', 1, 20, 'utf-8');",
             "<?php\n\nsubstr('subject', 1, 20);",
         ];
+    }
 
-        // mb_strpos -> strpos
-
+    private function provideMutationCasesForStrPos(): Generator
+    {
         yield 'It converts mb_strpos to strpos' => [
             "<?php mb_strpos('subject', 'b');",
             "<?php\n\nstrpos('subject', 'b');",
@@ -243,9 +307,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_strpos('subject', 'b', 3, 'utf-8');",
             "<?php\n\nstrpos('subject', 'b', 3);",
         ];
+    }
 
-        // mb_stripos -> stripos
-
+    private function provideMutationCasesForStrIPos(): Generator
+    {
         yield 'It converts mb_stripos to stripos' => [
             "<?php mb_stripos('subject', 'b');",
             "<?php\n\nstripos('subject', 'b');",
@@ -260,9 +325,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_stripos('subject', 'b', 3, 'utf-8');",
             "<?php\n\nstripos('subject', 'b', 3);",
         ];
+    }
 
-        // mb_stristr -> stristr
-
+    private function provideMutationCasesForStrIStr(): Generator
+    {
         yield 'It converts mb_stristr to stristr' => [
             "<?php mb_stristr('subject', 'b');",
             "<?php\n\nstristr('subject', 'b');",
@@ -277,9 +343,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_stristr('subject', 'b', false, 'utf-8');",
             "<?php\n\nstristr('subject', 'b', false);",
         ];
+    }
 
-        // mb_strripos -> strripos
-
+    private function provideMutationCasesForStrRiPos(): Generator
+    {
         yield 'It converts mb_strripos to strripos' => [
             "<?php mb_strripos('subject', 'b');",
             "<?php\n\nstrripos('subject', 'b');",
@@ -294,9 +361,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_strripos('subject', 'b', 2, 'utf-8');",
             "<?php\n\nstrripos('subject', 'b', 2);",
         ];
+    }
 
-        // mb_strrpos -> strrpos
-
+    private function provideMutationCasesForStrRPos(): Generator
+    {
         yield 'It converts mb_strrpos to strrpos' => [
             "<?php mb_strrpos('subject', 'b');",
             "<?php\n\nstrrpos('subject', 'b');",
@@ -311,9 +379,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_strrpos('subject', 'b', 2, 'utf-8');",
             "<?php\n\nstrrpos('subject', 'b', 2);",
         ];
+    }
 
-        // mb_strstr -> strstr
-
+    private function provideMutationCasesForStrStr(): Generator
+    {
         yield 'It converts mb_strstr to strstr' => [
             "<?php mb_strstr('subject', 'b');",
             "<?php\n\nstrstr('subject', 'b');",
@@ -328,9 +397,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_strstr('subject', 'b', false, 'utf-8');",
             "<?php\n\nstrstr('subject', 'b', false);",
         ];
+    }
 
-        // mb_strtolower -> strtolower
-
+    private function provideMutationCasesForStrToLower(): Generator
+    {
         yield 'It converts mb_strtolower to strtolower' => [
             "<?php mb_strtolower('test');",
             "<?php\n\nstrtolower('test');",
@@ -340,9 +410,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_strtolower('test', 'utf-8');",
             "<?php\n\nstrtolower('test');",
         ];
+    }
 
-        // mb_strtoupper -> strtoupper
-
+    private function provideMutationCasesForStrToUpper(): Generator
+    {
         yield 'It converts mb_strtoupper to strtoupper' => [
             "<?php mb_strtoupper('test');",
             "<?php\n\nstrtoupper('test');",
@@ -352,9 +423,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_strtoupper('test', 'utf-8');",
             "<?php\n\nstrtoupper('test');",
         ];
+    }
 
-        // mb_substr_count -> substr_count
-
+    private function provideMutationCasesForSubStrCount(): Generator
+    {
         yield 'It converts mb_substr_count to substr_count' => [
             "<?php mb_substr_count('test', 't');",
             "<?php\n\nsubstr_count('test', 't');",
@@ -364,9 +436,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_substr_count('test', 't', 'utf-8');",
             "<?php\n\nsubstr_count('test', 't');",
         ];
+    }
 
-        // mb_substr -> substr
-
+    private function provideMutationCasesForSubStr(): Generator
+    {
         yield 'It converts mb_substr to substr' => [
             "<?php mb_substr('test', 2);",
             "<?php\n\nsubstr('test', 2);",
@@ -381,9 +454,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_substr('test', 2, 10, 'utf-8');",
             "<?php\n\nsubstr('test', 2, 10);",
         ];
+    }
 
-        // mb_strrchr -> strrchr
-
+    private function provideMutationCasesForStrRChr(): Generator
+    {
         yield 'It converts mb_strrchr to strrchr' => [
             "<?php mb_strrchr('subject', 'b');",
             "<?php\n\nstrrchr('subject', 'b');",
@@ -398,9 +472,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_strrchr('subject', 'b', false, 'utf-8');",
             "<?php\n\nstrrchr('subject', 'b');",
         ];
+    }
 
-        // mb_strrichr -> strrchr
-
+    private function provideMutationCasesForStrRiChr(): Generator
+    {
         yield 'It converts mb_strrichr to strrchr' => [
             "<?php mb_strrichr('subject', 'b');",
             "<?php\n\nstrrchr('subject', 'b');",
@@ -415,9 +490,10 @@ public function provideMutationCases(): \Generator
             "<?php mb_strrichr('subject', 'b', false, 'utf-8');",
             "<?php\n\nstrrchr('subject', 'b');",
         ];
+    }
 
-        // mb_convert_case
-
+    private function provideMutationCasesForConvertCase(): Generator
+    {
         yield 'It converts mb_convert_case with MB_CASE_UPPER mode to strtoupper' => [
             "<?php mb_convert_case('test', MB_CASE_UPPER);",
             "<?php\n\nstrtoupper('test');",