[String] Introduce underscore() method

simPod · simPod · commit c1876cd91d25 · 2019-12-03T14:02:50.000+01:00
diff --git a/src/Symfony/Component/String/AbstractString.php b/src/Symfony/Component/String/AbstractString.php
@@ -636,6 +636,8 @@ public function truncate(int $length, string $ellipsis = ''): self
         return $ellipsisLength ? $str->trimEnd()->append($ellipsis) : $str;
     }
 
+    abstract public function underscore(): self;
+
     /**
      * @return static
      */
diff --git a/src/Symfony/Component/String/AbstractUnicodeString.php b/src/Symfony/Component/String/AbstractUnicodeString.php
@@ -396,6 +396,14 @@ public function trimStart(string $chars = " \t\n\r\0\x0B\x0C\u{A0}\u{FEFF}"): pa
         return $str;
     }
 
+    public function underscore(): parent
+    {
+        $str = $this->camel()->snake();
+        $str->string = mb_strtolower(preg_replace('~(?<=[a-z])([0-9])~u', '_$1', $str->string), 'UTF-8');
+
+        return $str;
+    }
+
     public function upper(): parent
     {
         $str = clone $this;
diff --git a/src/Symfony/Component/String/ByteString.php b/src/Symfony/Component/String/ByteString.php
@@ -439,6 +439,14 @@ public function trimStart(string $chars = " \t\n\r\0\x0B\x0C"): parent
         return $str;
     }
 
+    public function underscore(): parent
+    {
+        $str = $this->camel()->snake();
+        $str->string = mb_strtolower(preg_replace('~(?<=[a-z])([0-9])~u', '_$1', $str->string), 'UTF-8');
+
+        return $str;
+    }
+
     public function upper(): parent
     {
         $str = clone $this;
diff --git a/src/Symfony/Component/String/Tests/AbstractAsciiTestCase.php b/src/Symfony/Component/String/Tests/AbstractAsciiTestCase.php
@@ -930,6 +930,32 @@ public static function provideSnake()
         ];
     }
 
+    /**
+     * @dataProvider provideUnderscore
+     */
+    public function testUnderscore(string $expectedString, string $origin): void
+    {
+        $instance = static::createFromString($origin)->underscore();
+
+        $this->assertEquals(static::createFromString($expectedString), $instance);
+    }
+
+    public static function provideUnderscore(): array
+    {
+        return [
+            ['', ''],
+            ['symfony_is_great', 'symfonyIsGreat'],
+            ['symfony_44_is_great', 'symfony44IsGreat'],
+            ['symfony_is_great_5', 'symfonyIsGreat5'],
+            ['symfony_5_is_great', 'symfony5IsGreat'],
+            ['symfony_5is_great', 'symfony5isGreat'],
+            ['symfony_is_great', 'Symfony is great'],
+            ['symfony_is_a_great_framework', 'symfonyIsAGreatFramework'],
+            ['symfony_is_great', 'symfonyIsGREAT'],
+            ['symfony_is_really_great', 'symfonyIsREALLYGreat'],
+        ];
+    }
+
     /**
      * @dataProvider provideStartsWith
      */

Original file line number	Diff line number	Diff line change
`@@ -636,6 +636,8 @@ public function truncate(int $length, string $ellipsis = ''): self`
`636`	`636`	`return $ellipsisLength ? $str->trimEnd()->append($ellipsis) : $str;`
`637`	`637`	`}`
`638`	`638`
	`639`	`+ abstract public function underscore(): self;`
	`640`	`+`
`639`	`641`	`/**`
`640`	`642`	`* @return static`
`641`	`643`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -396,6 +396,14 @@ public function trimStart(string $chars = " \t\n\r\0\x0B\x0C\u{A0}\u{FEFF}"): pa`
`396`	`396`	`return $str;`
`397`	`397`	`}`
`398`	`398`
	`399`	`+ public function underscore(): parent`
	`400`	`+ {`
	`401`	`+ $str = $this->camel()->snake();`
	`402`	`+ $str->string = mb_strtolower(preg_replace('~(?<=[a-z])([0-9])~u', '_$1', $str->string), 'UTF-8');`
	`403`	`+`
	`404`	`+ return $str;`
	`405`	`+ }`
	`406`	`+`
`399`	`407`	`public function upper(): parent`
`400`	`408`	`{`
`401`	`409`	`$str = clone $this;`
Original file line number	Diff line number	Diff line change
`@@ -439,6 +439,14 @@ public function trimStart(string $chars = " \t\n\r\0\x0B\x0C"): parent`
`439`	`439`	`return $str;`
`440`	`440`	`}`
`441`	`441`
	`442`	`+ public function underscore(): parent`
	`443`	`+ {`
	`444`	`+ $str = $this->camel()->snake();`
	`445`	`+ $str->string = mb_strtolower(preg_replace('~(?<=[a-z])([0-9])~u', '_$1', $str->string), 'UTF-8');`
	`446`	`+`
	`447`	`+ return $str;`
	`448`	`+ }`
	`449`	`+`
`442`	`450`	`public function upper(): parent`
`443`	`451`	`{`
`444`	`452`	`$str = clone $this;`