Add StringHelper::split()

Co-authored-by: Alexander Makarov <sam@rmcreative.ru>

Author: vjik

CHANGELOG.md

@@ -3,7 +3,7 @@
 
 ## 1.1.1 under development
 
-- no changes in this release.
+- Enh #62: Add method `StringHelper::split` that split a string to array with non-empty lines (vjik)
 
 ## 1.1.0 November 13, 2020
 

README.md

@@ -81,6 +81,10 @@ Overall the helper has the following method groups.
 - base64UrlEncode
 - base64UrlDecode
 
+### Other
+
+- split
+
 ## NumericHelper usage
 
 Numeric helper methods are static so usage is like the following:

composer.json

@@ -21,10 +21,10 @@
  "ext-mbstring": "*"
  },
  "require-dev": {
- "phpunit/phpunit": "^9.4",
- "roave/infection-static-analysis-plugin": "^1.5",
+ "phpunit/phpunit": "^9.5",
+ "roave/infection-static-analysis-plugin": "^1.6",
  "spatie/phpunit-watcher": "^1.23",
- "vimeo/psalm": "^4.2"
+ "vimeo/psalm": "^4.3"
  },
  "autoload": {
  "psr-4": {

src/StringHelper.php

@@ -473,4 +473,20 @@ public static function base64UrlDecode(string $input): string
  {
  return base64_decode(strtr($input, '-_', '+/'));
  }
+
+ /**
+ * Split a string to array with non-empty lines.
+ * Whitespace from the beginning and end of a each line will be stripped.
+ *
+ * @param string $string The input string.
+ * @param string $separator The boundary string. It is a part of regular expression
+ * so should be taken into account or properly escaped with {@see preg_quote()}.
+ *
+ * @return array
+ */
+ public static function split(string $string, string $separator = '\R'): array
+ {
+ $string = preg_replace('(^\s*|\s*$)', '', $string);
+ return preg_split('~\s*' . $separator . '\s*~', $string, -1, PREG_SPLIT_NO_EMPTY);
+ }
 }

tests/StringHelperTest.php

@@ -367,4 +367,58 @@ public function testReplaceSubstring(string $expected, array $arguments): void
  {
  $this->assertSame($expected, StringHelper::replaceSubstring(...$arguments));
  }
+
+ public function dataSplit(): array
+ {
+ return [
+ ['', []],
+ [' ', []],
+ [" \n\n \n ", []],
+ [' A B', ['A B']],
+ ['A B ', ['A B']],
+ ['A B', ['A B']],
+ ['Home', ['Home']],
+ [' Hello World! ', ['Hello World!']],
+ [
+ "A \r B \r\r \r C",
+ ['A', 'B', 'C'],
+ ],
+ [
+ "A \n B \n\n \n C",
+ ['A', 'B', 'C'],
+ ],
+ [
+ "A \r\n B \r\n\r\n \r\n C",
+ ['A', 'B', 'C'],
+ ],
+ [
+ "A \v B \v \v C",
+ ['A', 'B', 'C'],
+ ],
+ [
+ "A \n Hello World! \n \n C",
+ ['A', 'Hello World!', 'C'],
+ ],
+ [
+ "\0\nA\nB",
+ ["\0", 'A', 'B'],
+ ],
+ ];
+ }
+
+ /**
+ * @dataProvider dataSplit
+ *
+ * @param string $string
+ * @param array $expected
+ */
+ public function testSplit(string $string, array $expected): void
+ {
+ $this->assertSame($expected, StringHelper::split($string));
+ }
+
+ public function testSplitWithSeparator(): void
+ {
+ $this->assertSame(['A', 'B', 'C'], StringHelper::split(' A 2 B3C', '\d'));
+ }
 }