[8.x] Add a wordCount() string helper (#36990)

* Add a wordCount() string helper

* Update Str.php

* Update Stringable.php

Co-authored-by: Taylor Otwell <taylor@laravel.com>

src/Illuminate/Support/Str.php

@@ -766,6 +766,17 @@ public static function ucfirst($string)
         return static::upper(static::substr($string, 0, 1)).static::substr($string, 1);
     }
 
+    /**
+     * Get the number of words a string contains.
+     *
+     * @param  string  $string
+     * @return int
+     */
+    public static function wordCount($string)
+    {
+        return str_word_count($string);
+    }
+
     /**
      * Generate a UUID (version 4).
      *

src/Illuminate/Support/Stringable.php

@@ -756,6 +756,16 @@ public function words($words = 100, $end = '...')
         return new static(Str::words($this->value, $words, $end));
     }
 
+    /**
+     * Get the number of words a string contains.
+     *
+     * @return int
+     */
+    public function wordCount()
+    {
+        return str_word_count($this->value);
+    }
+
     /**
      * Dump the string.
      *

tests/Support/SupportStrTest.php

@@ -494,6 +494,12 @@ public function testPadRight()
         $this->assertSame('Alien     ', Str::padRight('Alien', 10));
     }
 
+    public function testWordCount()
+    {
+        $this->assertEquals(2, Str::wordCount('Hello, world!'));
+        $this->assertEquals(10, Str::wordCount('Hi, this is my first contribution to the Laravel framework.'));
+    }
+
     public function validUuidList()
     {
         return [

tests/Support/SupportStringableTest.php

@@ -608,4 +608,10 @@ public function testRepeat()
         $this->assertSame('aaaaa', (string) $this->stringable('a')->repeat(5));
         $this->assertSame('', (string) $this->stringable('')->repeat(5));
     }
+
+    public function testWordCount()
+    {
+        $this->assertEquals(2, $this->stringable('Hello, world!')->wordCount());
+        $this->assertEquals(10, $this->stringable('Hi, this is my first contribution to the Laravel framework.')->wordCount());
+    }
 }