Add StringHelper::parsePath() (#81)

Author: vjik

CHANGELOG.md

@@ -1,38 +1,36 @@
 # Yii Strings Change Log
 
-
 ## 2.0.1 under development
 
-- New #75: Add method `Inflector::toSnakeCase()` that convert word to "snake_case" (soodssr)
+- New #75: Add method `Inflector::toSnakeCase()` that convert word to "snake_case" (@soodssr)
+- New #81: Add `StringHelper::parsePath()` method (@arogachev, @vjik)
 
 ## 2.0.0 February 10, 2021
 
-- Chg #67: Remove `\Yiisoft\Strings\WildcardPattern::withoutEscape()` (samdark)
-- Chg #67: Remove `\Yiisoft\Strings\WildcardPattern::withExactLeadingPeriod()` (samdark)
-- Enh #67: Add `**`, match anything including `/`, to `\Yiisoft\Strings\WildcardPattern`, remove `withExactSlashes()` and `withEnding()` (samdark)
-- Enh #67: Allow specifying delimiters for `*` (samdark)
-- Enh #67: Add `\Yiisoft\Strings\WildcardPattern::isDynamic()` (samdark)
-- Enh #67: Add `\Yiisoft\Strings\WildcardPattern::quote()` (samdark)
+- Chg #67: Remove `\Yiisoft\Strings\WildcardPattern::withoutEscape()` (@samdark)
+- Chg #67: Remove `\Yiisoft\Strings\WildcardPattern::withExactLeadingPeriod()` (@samdark)
+- Enh #67: Add `**`, match anything including `/`, to `\Yiisoft\Strings\WildcardPattern`, remove `withExactSlashes()` and `withEnding()` (@samdark)
+- Enh #67: Allow specifying delimiters for `*` (@samdark)
+- Enh #67: Add `\Yiisoft\Strings\WildcardPattern::isDynamic()` (@samdark)
+- Enh #67: Add `\Yiisoft\Strings\WildcardPattern::quote()` (@samdark)
 
 ## 1.2.0 January 22, 2021
 
-- Enh #62: Add method `StringHelper::split()` that split a string to array with non-empty lines (vjik)
-- Enh #63: Add method `NumericHelper::isInteger()` that checks whether the given string is an integer number (vjik)
-- Enh #64: Add support of a boolean values to `NumericHelper::normalize()` (vjik)
+- Enh #62: Add method `StringHelper::split()` that split a string to array with non-empty lines (@vjik)
+- Enh #63: Add method `NumericHelper::isInteger()` that checks whether the given string is an integer number (@vjik)
+- Enh #64: Add support of a boolean values to `NumericHelper::normalize()` (@vjik)
 
 ## 1.1.0 November 13, 2020
 
-- Enh #52: Allow turning off options in `WildcardPattern` (vjik)
-- Enh #51: Add an option `withEnding()` to `WildcardPattern` for match ending of testing string (vjik)
-- Bug #44: `NumericHelper::toOrdinal()` throws an error for numbers with fractional part (vjik)
+- Enh #52: Allow turning off options in `WildcardPattern` (@vjik)
+- Enh #51: Add an option `withEnding()` to `WildcardPattern` for match ending of testing string (@vjik)
+- Bug #44: `NumericHelper::toOrdinal()` throws an error for numbers with fractional part (@vjik)
 
 ## 1.0.1 October 12, 2020
 
-- Enh #40: Use `str_starts_with()` and `str_ends_with()` if available (viktorprogger)
-- Bug #43: `NumericHelper::normalize()` throws an error for `float` or `int` values in PHP 8 (vjik)
+- Enh #40: Use `str_starts_with()` and `str_ends_with()` if available (@viktorprogger)
+- Bug #43: `NumericHelper::normalize()` throws an error for `float` or `int` values in PHP 8 (@vjik)
 
 ## 1.0.0 August 31, 2020
 
 - Initial release.
-
-

README.md

@@ -87,6 +87,7 @@ Overall the helper has the following method groups.
 
 ### Other
 
+- parsePath
 - split
 
 ## NumericHelper usage

src/StringHelper.php

@@ -4,6 +4,8 @@
 
 namespace Yiisoft\Strings;
 
+use InvalidArgumentException;
+
 use function array_slice;
 use function count;
 use function function_exists;
@@ -496,4 +498,79 @@ 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);
  }
+
+ /**
+ * @param string $path The path of where do you want to write a value to `$array`. The path can be described by
+ * a string when each key should be separated by delimiter. If a path item contains delimiter, it can be escaped
+ * with "\" (backslash) or a custom delimiter can be used.
+ * @param string $delimiter A separator, used to parse string key for embedded object property retrieving. Defaults
+ * to "." (dot).
+ * @param string $escapeCharacter An escape character, used to escape delimiter. Defaults to "\" (backslash).
+ * @param bool $preserveDelimiterEscaping Whether to preserve delimiter escaping in the items of final array (in
+ * case of using string as an input). When `false`, "\" (backslashes) are removed. For a "." as delimiter, "."
+ * becomes "\.". Defaults to `false`.
+ *
+ * @return string[]
+ */
+ public static function parsePath(
+ string $path,
+ string $delimiter = '.',
+ string $escapeCharacter = '\\',
+ bool $preserveDelimiterEscaping = false
+ ): array {
+ if (strlen($delimiter) !== 1) {
+ throw new InvalidArgumentException('Only 1 character is allowed for delimiter.');
+ }
+
+ if (strlen($escapeCharacter) !== 1) {
+ throw new InvalidArgumentException('Only 1 escape character is allowed.');
+ }
+
+ if ($delimiter === $escapeCharacter) {
+ throw new InvalidArgumentException('Delimiter and escape character must be different.');
+ }
+
+ if ($path === '') {
+ return [];
+ }
+
+ $matches = preg_split(
+ sprintf(
+ '/(?<!%1$s)((?>%1$s%1$s)*)%2$s/',
+ preg_quote($escapeCharacter, '/'),
+ preg_quote($delimiter, '/')
+ ),
+ $path,
+ -1,
+ PREG_SPLIT_OFFSET_CAPTURE
+ );
+ $result = [];
+ $countResults = count($matches);
+ for ($i = 1; $i < $countResults; $i++) {
+ $l = $matches[$i][1] - $matches[$i - 1][1] - strlen($matches[$i - 1][0]) - 1;
+ $result[] = $matches[$i - 1][0] . ($l > 0 ? str_repeat($escapeCharacter, $l) : '');
+ }
+ $result[] = $matches[$countResults - 1][0];
+
+ if ($preserveDelimiterEscaping === true) {
+ return $result;
+ }
+
+ return array_map(
+ static function (string $key) use ($delimiter, $escapeCharacter): string {
+ return str_replace(
+ [
+ $escapeCharacter . $escapeCharacter,
+ $escapeCharacter . $delimiter,
+ ],
+ [
+ $escapeCharacter,
+ $delimiter,
+ ],
+ $key
+ );
+ },
+ $result
+ );
+ }
 }

tests/InflectorTest.php

@@ -7,6 +7,8 @@
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Strings\Inflector;
 
+use function extension_loaded;
+
 final class InflectorTest extends TestCase
 {
  private function getTestDataForToPlural(): array
@@ -209,7 +211,7 @@ public function toSlugCommonsDataProvider(): array
  public function testToSlugCommons(string $input, string $expected, string $replacement = '-'): void
  {
  $inflector = new Inflector();
- if (\extension_loaded('intl')) {
+ if (extension_loaded('intl')) {
  $this->assertEquals($expected, $inflector->toSlug($input, $replacement));
  }
  $this->assertEquals($expected, $inflector
@@ -219,7 +221,7 @@ public function testToSlugCommons(string $input, string $expected, string $repla
 
  public function testToSlugWithIntl(): void
  {
- if (!\extension_loaded('intl')) {
+ if (!extension_loaded('intl')) {
  $this->markTestSkipped('intl extension is required.');
  }
 
@@ -256,23 +258,28 @@ public function testToSlugWithIntl(): void
 
  public function testToTransliteratedStrict(): void
  {
- if (!\extension_loaded('intl')) {
+ if (!extension_loaded('intl')) {
  $this->markTestSkipped('intl extension is required.');
  }
 
  // Some test strings are from https://github.com/bergie/midgardmvc_helper_urlize. Thank you, Henri Bergius!
  $data = [
  // Korean
  '해동검도' => 'haedong-geomdo',
+
  // Hiragana
  'ひらがな' => 'hiragana',
+
  // Georgian
  'საქართველო' => 'sakartvelo',
+
  // Arabic
  'العربي' => 'ạlʿrby',
  'عرب' => 'ʿrb',
+
  // Hebrew
  'עִבְרִית' => 'ʻibĕriyţ',
+
  // Turkish
  'Sanırım hepimiz aynı şeyi düşünüyoruz.' => 'Sanırım hepimiz aynı şeyi düşünüyoruz.',
 
@@ -288,6 +295,7 @@ public function testToTransliteratedStrict(): void
 
  // Spanish
  '¿Español?' => '¿Español?',
+
  // Chinese
  '美国' => 'měi guó',
  ];
@@ -301,23 +309,28 @@ public function testToTransliteratedStrict(): void
 
  public function testToTransliteratedMedium(): void
  {
- if (!\extension_loaded('intl')) {
+ if (!extension_loaded('intl')) {
  $this->markTestSkipped('intl extension is required.');
  }
 
  // Some test strings are from https://github.com/bergie/midgardmvc_helper_urlize. Thank you, Henri Bergius!
  $data = [
  // Korean
  '해동검도' => ['haedong-geomdo'],
+
  // Hiragana
  'ひらがな' => ['hiragana'],
+
  // Georgian
  'საქართველო' => ['sakartvelo'],
+
  // Arabic
  'العربي' => ['alʿrby'],
  'عرب' => ['ʿrb'],
+
  // Hebrew
  'עִבְרִית' => ['\'iberiyt', 'ʻiberiyt'],
+
  // Turkish
  'Sanırım hepimiz aynı şeyi düşünüyoruz.' => ['Sanirim hepimiz ayni seyi dusunuyoruz.'],
 
@@ -332,7 +345,8 @@ public function testToTransliteratedMedium(): void
  'Српска: ђ, њ, џ!' => ['Srpska: d, n, d!'],
 
  // Spanish
- '¿Español?' => ['¿Espanol?'],
+ '¿Español?' => ['¿Espanol?', '?Espanol?'],
+
  // Chinese
  '美国' => ['mei guo'],
  ];
@@ -346,23 +360,28 @@ public function testToTransliteratedMedium(): void
 
  public function testToTransliteratedLoose(): void
  {
- if (!\extension_loaded('intl')) {
+ if (!extension_loaded('intl')) {
  $this->markTestSkipped('intl extension is required.');
  }
 
  // Some test strings are from https://github.com/bergie/midgardmvc_helper_urlize. Thank you, Henri Bergius!
  $data = [
  // Korean
  '해동검도' => ['haedong-geomdo'],
+
  // Hiragana
  'ひらがな' => ['hiragana'],
+
  // Georgian
  'საქართველო' => ['sakartvelo'],
+
  // Arabic
  'العربي' => ['alrby'],
  'عرب' => ['rb'],
+
  // Hebrew
  'עִבְרִית' => ['\'iberiyt', 'iberiyt'],
+
  // Turkish
  'Sanırım hepimiz aynı şeyi düşünüyoruz.' => ['Sanirim hepimiz ayni seyi dusunuyoruz.'],
 
@@ -377,7 +396,8 @@ public function testToTransliteratedLoose(): void
  'Српска: ђ, њ, џ!' => ['Srpska: d, n, d!'],
 
  // Spanish
- '¿Español?' => ['Espanol?'],
+ '¿Español?' => ['Espanol?', '?Espanol?'],
+
  // Chinese
  '美国' => ['mei guo'],
  ];
@@ -391,7 +411,7 @@ public function testToTransliteratedLoose(): void
 
  public function testToTransliteratedWithTransliterator(): void
  {
- if (!\extension_loaded('intl')) {
+ if (!extension_loaded('intl')) {
  $this->markTestSkipped('intl extension is required.');
  }
 
@@ -401,7 +421,7 @@ public function testToTransliteratedWithTransliterator(): void
 
  public function testToTransliteratedWithTransliterationMap(): void
  {
- if (!\extension_loaded('intl')) {
+ if (!extension_loaded('intl')) {
  $this->markTestSkipped('intl extension is required.');
  }