#977 Sync word-count

bin/auto-sync.txt

@@ -81,5 +81,6 @@ sublist
 two-bucket
 two-fer
 wordy
+word-count
 yacht
 zebra-puzzle

exercises/practice/word-count/.meta/config.json

@@ -6,7 +6,8 @@
     "arueckauer",
     "kunicmarko20",
     "kytrinyx",
-    "petemcfarlane"
+    "petemcfarlane",
+    "hazeolation"
   ],
   "files": {
     "solution": [

exercises/practice/word-count/.meta/example.php

@@ -1,27 +1,5 @@
 <?php
 
-/*
- * By adding type hints and enabling strict type checking, code can become
- * easier to read, self-documenting and reduce the number of potential bugs.
- * By default, type declarations are non-strict, which means they will attempt
- * to change the original type to match the type specified by the
- * type-declaration.
- *
- * In other words, if you pass a string to a function requiring a float,
- * it will attempt to convert the string value to a float.
- *
- * To enable strict mode, a single declare directive must be placed at the top
- * of the file.
- * This means that the strictness of typing is configured on a per-file basis.
- * This directive not only affects the type declarations of parameters, but also
- * a function's return type.
- *
- * For more info review the Concept on strict type checking in the PHP track
- * <link>.
- *
- * To disable strict typing, comment out the directive below.
- */
-
 declare(strict_types=1);
 
 function wordCount($phrase)

exercises/practice/word-count/.meta/tests.toml

@@ -28,6 +28,11 @@ description = "normalize case"
 
 [4185a902-bdb0-4074-864c-f416e42a0f19]
 description = "with apostrophes"
+include = false
+
+[4ff6c7d7-fcfc-43ef-b8e7-34ff1837a2d3]
+description = "with apostrophes"
+reimplements = "4185a902-bdb0-4074-864c-f416e42a0f19"
 
 [be72af2b-8afe-4337-b151-b297202e4a7b]
 description = "with quotations"
@@ -40,3 +45,6 @@ description = "multiple spaces not detected as a word"
 
 [50176e8a-fe8e-4f4c-b6b6-aa9cf8f20360]
 description = "alternating word separators not detected as a word"
+
+[6d00f1db-901c-4bec-9829-d20eb3044557]
+description = "quotation for word with apostrophe"

exercises/practice/word-count/WordCountTest.php

@@ -1,27 +1,5 @@
 <?php
 
-/*
- * By adding type hints and enabling strict type checking, code can become
- * easier to read, self-documenting and reduce the number of potential bugs.
- * By default, type declarations are non-strict, which means they will attempt
- * to change the original type to match the type specified by the
- * type-declaration.
- *
- * In other words, if you pass a string to a function requiring a float,
- * it will attempt to convert the string value to a float.
- *
- * To enable strict mode, a single declare directive must be placed at the top
- * of the file.
- * This means that the strictness of typing is configured on a per-file basis.
- * This directive not only affects the type declarations of parameters, but also
- * a function's return type.
- *
- * For more info review the Concept on strict type checking in the PHP track
- * <link>.
- *
- * To disable strict typing, comment out the directive below.
- */
-
 declare(strict_types=1);
 
 use PHPUnit\Framework\TestCase;
@@ -33,59 +11,228 @@ public static function setUpBeforeClass(): void
         require_once 'WordCount.php';
     }
 
+    /**
+     * UUID 61559d5f-2cad-48fb-af53-d3973a9ee9ef
+     */
+    #[TestDox('count one word')]
     public function testCountOneWord(): void
     {
-        $this->assertEquals(['word' => 1], wordCount('word'));
+        $this->assertEquals(
+            ['word' => 1],
+            wordCount('word'),
+        );
     }
 
+    /**
+     * UUID 5abd53a3-1aed-43a4-a15a-29f88c09cbbd
+     */
+    #[TestDox('count one of each word')]
     public function testCountOneOfEachWord(): void
     {
-        $this->assertEquals(['one' => 1, 'of' => 1, 'each' => 1], wordCount('one of each'));
+        $this->assertEquals(
+            [
+                'one' => 1,
+                'of' => 1,
+                'each' => 1,
+            ],
+            wordCount('one of each'),
+        );
     }
 
+    /**
+     * UUID 2a3091e5-952e-4099-9fac-8f85d9655c0e
+     */
+    #[TestDox('multiple occurrences of a word')]
     public function testMultipleOccurrencesOfAWord(): void
     {
         $this->assertEquals(
-            ['one' => 1, 'fish' => 4, 'two' => 1, 'red' => 1, 'blue' => 1],
-            wordCount('one fish two fish red fish blue fish')
+            [
+                'one' => 1,
+                'fish' => 4,
+                'two' => 1,
+                'red' => 1,
+                'blue' => 1,
+            ],
+            wordCount('one fish two fish red fish blue fish'),
+        );
+    }
+
+    /**
+     * UUID e81877ae-d4da-4af4-931c-d923cd621ca6
+     */
+    #[TestDox('handles cramped lists')]
+    public function testHandlesCrampedLists(): void
+    {
+        $this->assertEquals(
+            [
+                'one' => 1,
+                'two' => 1,
+                'three' => 1,
+            ],
+            wordCount('one,two,three'),
         );
     }
 
+    /**
+     * UUID 7349f682-9707-47c0-a9af-be56e1e7ff30
+     */
+    #[TestDox('handles expanded lists')]
+    public function testHandlesExpandedLists(): void
+    {
+        $this->assertEquals(
+            [
+                'one' => 1,
+                'two' => 1,
+                'three' => 1,
+            ],
+            wordCount("one,\ntwo,\nthree"),
+        );
+    }
+
+    /**
+     * UUID a514a0f2-8589-4279-8892-887f76a14c82
+     */
+    #[TestDox('ignore punctuation')]
     public function testIgnorePunctuation(): void
     {
         $this->assertEquals(
-            ['car' => 1, 'carpet' => 1, 'as' => 1, 'java' => 1, 'javascript' => 1],
-            wordCount('car : carpet as java : javascript!!&@$%^&')
+            [
+                'car' => 1,
+                'carpet' => 1,
+                'as' => 1,
+                'java' => 1,
+                'javascript' => 1,
+            ],
+            wordCount('car : carpet as java : javascript!!&@$%^&'),
         );
     }
 
+    /**
+     * UUID d2e5cee6-d2ec-497b-bdc9-3ebe092ce55e
+     */
+    #[TestDox('include numbers')]
     public function testIncludeNumbers(): void
     {
-        $this->assertEquals(['1' => 1, '2' => 1, 'testing' => 2], wordCount('testing, 1, 2 testing'));
+        $this->assertEquals(
+            [
+                '1' => 1,
+                '2' => 1,
+                'testing' => 2,
+            ],
+            wordCount('testing, 1, 2 testing'),
+        );
     }
 
+    /**
+     * UUID dac6bc6a-21ae-4954-945d-d7f716392dbf
+     */
+    #[TestDox('normalize case')]
     public function testNormalizeCase(): void
     {
-        $this->assertEquals(['go' => 3, 'stop' => 2], wordCount('go Go GO Stop stop'));
+        $this->assertEquals(
+            ['go' => 3, 'stop' => 2],
+            wordCount('go Go GO Stop stop'),
+        );
     }
 
-    public function testCountsMultiline(): void
+    /**
+     * UUID 4ff6c7d7-fcfc-43ef-b8e7-34ff1837a2d3
+     */
+    #[TestDox('with apostrophes')]
+    public function testWithApostrophes(): void
     {
-        $this->assertEquals(['hello' => 1, 'world' => 1], wordCount("hello\nworld"));
+        $this->assertEquals(
+            [
+                'first' => 1,
+                "don't" => 2,
+                'laugh' => 1,
+                'then' => 1,
+                'cry' => 1,
+                "you're" => 1,
+                'getting' => 1,
+                'it' => 1,
+            ],
+            wordCount("'First: don't laugh. Then: don't cry. You're getting it.'"),
+        );
+    }
+
+    /**
+     * UUID be72af2b-8afe-4337-b151-b297202e4a7b
+     */
+    #[TestDox('with quotations')]
+    public function testWithQuotations(): void
+    {
+        $this->assertEquals(
+            [
+                'joe' => 1,
+                "can't" => 1,
+                'tell' => 1,
+                'between' => 1,
+                'large' => 2,
+                'and' => 1,
+            ],
+            wordCount("Joe can't tell between 'large' and large."),
+        );
+    }
+
+    /**
+     * UUID 8d6815fe-8a51-4a65-96f9-2fb3f6dc6ed6
+     */
+    #[TestDox('substrings from the beginning')]
+    public function testSubstringsFromTheBeginning(): void
+    {
+        $this->assertEquals(
+            [
+                'joe' => 1,
+                "can't" => 1,
+                'tell' => 1,
+                'between' => 1,
+                'app' => 1,
+                'apple' => 1,
+                'and' => 1,
+                'a' => 1,
+            ],
+            wordCount("Joe can't tell between app, apple and a."),
+        );
     }
 
-    public function testCountsTabs(): void
+    /**
+     * UUID c5f4ef26-f3f7-4725-b314-855c04fb4c13
+     */
+    #[TestDox('multiple spaces not detected as a word')]
+    public function testMultipleSpacesNotDetectedAsAWord(): void
     {
-        $this->assertEquals(['hello' => 1, 'world' => 1], wordCount("hello\tworld"));
+        $this->assertEquals(
+            ['multiple' => 1, 'whitespaces' => 1],
+            wordCount(' multiple   whitespaces'),
+        );
     }
 
-    public function testCountsMultipleSpacesAsOne(): void
+    /**
+     * UUID 50176e8a-fe8e-4f4c-b6b6-aa9cf8f20360
+     */
+    #[TestDox('alternating word separators are not detected as a word')]
+    public function testAlternatingWordSeparatorsNotDetectedAsAWord(): void
     {
-        $this->assertEquals(['hello' => 1, 'world' => 1], wordCount('hello  world'));
+        $this->assertEquals(
+            [
+                'one' => 1,
+                'two' => 1,
+                'three' => 1,
+            ],
+            wordCount(",\n,one,\n ,two \n 'three'"),
+        );
     }
 
-    public function testDoesNotCountLeadingOrTrailingWhitespace(): void
+    /**
+     * UUID 6d00f1db-901c-4bec-9829-d20eb3044557
+     */
+    #[TestDox('quotation for word with apostrophe')]
+    public function testQuotationForWordWithApostrophe(): void
     {
-        $this->assertEquals(['introductory' => 1, 'course' => 1], wordCount("\t\tIntroductory Course      "));
+        $this->assertEquals(
+            ['can' => 1, "can't" => 2],
+            wordCount("can, can't, 'can't'"),
+        );
     }
 }