Change default value of $strict parameter in Inflector::toSnakeCase() to false

CHANGELOG.md

@@ -1,8 +1,8 @@
 # Yii Strings Change Log
 
-## 2.4.1 under development
+## 3.0.0 under development
 
-- no changes in this release.
+- Chg #112: Change default value of `$strict` parameter in `Inflector::toSnakeCase()` to `false` (@vjik)
 
 ## 2.4.0 December 22, 2023
 

UPGRADE.md

@@ -8,7 +8,18 @@ In a big application however there may be more things to consider, which are exp
 > Note: The following upgrading instructions are cumulative. That is, if you want to upgrade from a version A to version
 > C and there is a version B between A and C, you need to follow the instructions for both A and B.
 
-## Upgrade from 1.2.0
+## Upgrade from 2.x to 3.x
+
+Default value of `$strict` parameter in `Inflector::toSnakeCase()` changed to `false`. To keep previous behaviour add 
+`strict: true` to call methods `Inflector::toSnakeCase()` without `strict` argument. For example:
+
+```php
+Inflector::toSnakeCase($name);
+// change to
+Inflector::toSnakeCase($name, true);
+```
+
+## Upgrade from 1.x to 2.x
 
 `\Yiisoft\Strings\WildCardPattern` was changed.
 

src/Inflector.php

@@ -520,8 +520,8 @@
 
         $result = preg_replace($regex, addslashes($separator) . '\1', $input);
 
         if ($separator !== '_') {
             $result = str_replace('_', $separator, $result);
         }
 
         return mb_strtolower(trim($result, $separator));
@@ -581,7 +581,7 @@
     {
         $input = $this->toPascalCase($input);
 
         return mb_strtolower(mb_substr($input, 0, 1)) . mb_substr($input, 1);
     }
 
     /**
@@ -592,11 +592,11 @@
      * so "who's online" will be converted to "who_s_online".
      *
      * @param string $input The word to convert.
-     * @param bool $strict Whether to insert a separator between two consecutive uppercase chars, defaults to true.
+     * @param bool $strict Whether to insert a separator between two consecutive uppercase chars, defaults to false.
      *
      * @return string The "snake_cased" string.
      */
-    public function toSnakeCase(string $input, bool $strict = true): string
+    public function toSnakeCase(string $input, bool $strict = false): string
     {
         return $this->pascalCaseToId(preg_replace('/[^\pL\pN]+/u', '_', $input), '_', $strict);
     }
@@ -643,12 +643,12 @@
      */
     public function toSlug(string $input, string $replacement = '-', bool $lowercase = true): string
     {
         $quotedReplacement = preg_quote($replacement, '/');
         // replace all non words character
         $input = preg_replace('/[^a-zA-Z0-9]+/u', $replacement, $this->toTransliterated($input));
         // remove first and last replacements
         $input = preg_replace(
             "/^(?:$quotedReplacement)+|(?:$quotedReplacement)+$/u" . ($lowercase ? 'i' : ''),
             '',
             $input,
         );

tests/InflectorTest.php

@@ -166,13 +166,13 @@ public function dataToSnakeCase(): array
     {
         return [
             [['input' => 'userName'], 'user_name'],
-            [['input' => 'travelSGuide'], 'travel_s_guide'],
+            [['input' => 'travelSGuide', 'strict' => true], 'travel_s_guide'],
             [['input' => 'ひらがなHepimiz'], 'ひらがな_hepimiz'],
             [['input' => 'Let\'s say "Hello, World!" yii 3 😂'], 'let_s_say_hello_world_yii_3'],
-            [['input' => 'HTML'], 'h_t_m_l'],
-            [['input' => 'createMyDTO'], 'create_my_d_t_o'],
-            [['input' => 'HTML', 'strict' => false], 'html'],
-            [['input' => 'createMyDTO', 'strict' => false], 'create_my_dto'],
+            [['input' => 'HTML', 'strict' => true], 'h_t_m_l'],
+            [['input' => 'createMyDTO', 'strict' => true], 'create_my_d_t_o'],
+            [['input' => 'HTML'], 'html'],
+            [['input' => 'createMyDTO'], 'create_my_dto'],
         ];
     }