Merge pull request #54 from voku/copilot/integrate-infection-into-ci-pipeline

Raise Infection from no-op to enforced signal and cover newly exposed mutation gaps

Author: voku

.github/workflows/ci.yml

@@ -51,11 +51,13 @@ jobs:
             composer: basic
             phpunit: '^9.6'
             phpunit_config: phpunit.xml.dist
+            run_infection: true
           - php: '8.4'
             composer: basic
             phpunit: '^9.6'
             phpunit_config: phpunit.xml.dist
-    timeout-minutes: 10
+    # Infection mutates and re-runs the suite, so that leg needs a longer timeout.
+    timeout-minutes: ${{ matrix.run_infection && 30 || 10 }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -84,6 +86,10 @@ jobs:
       - name: Install dependencies
         run: |
           composer require --dev --no-update "phpunit/phpunit:${{ matrix.phpunit }}"
+          if [[ "${{ matrix.run_infection }}" == "true" ]]; then
+            composer config --no-plugins allow-plugins.infection/extension-installer false
+            composer require --dev --no-update "infection/infection:^0.32.7"
+          fi
           if [[ "${{ matrix.composer }}" == "lowest" ]]; then
             composer update --prefer-dist --no-interaction --prefer-lowest --prefer-stable
           fi;
@@ -105,6 +111,16 @@ jobs:
         run: |
           php vendor/bin/phpstan analyse
 
+      - name: Run infection with phpstan integration
+        if: ${{ matrix.run_infection == true }}
+        run: |
+          XDEBUG_MODE=coverage php vendor/bin/infection \
+            --configuration=infection.json.dist \
+            --threads=max \
+            --ignore-msi-with-no-mutations \
+            --only-covering-test-cases \
+            --logger-github
+
       - name: Upload coverage results to Coveralls
         if: ${{ matrix.php == '8.3' }}
         continue-on-error: true

infection.json.dist

@@ -0,0 +1,18 @@
+{
+    "$schema": "https://infection.github.io/schema.json",
+    "source": {
+        "directories": [
+            "src"
+        ],
+        "excludes": [
+            "src/JsonSerializableReturnTypeTraitPhp81.php"
+        ]
+    },
+    "phpUnit": {
+        "configDir": "."
+    },
+    "staticAnalysisTool": "phpstan",
+    "staticAnalysisToolOptions": "--memory-limit=512M",
+    "minMsi": 87,
+    "minCoveredMsi": 87
+}

src/CollectionStringy.php

@@ -35,6 +35,7 @@ public static function create(
         string $iteratorClass = \Arrayy\ArrayyIterator::class,
         bool $checkPropertiesInConstructor = true
     ) {
+        /** @phpstan-ignore return.type (generic static<TCreate> is not preserved through new static) */
         return new static(
             $data,
             $iteratorClass,

tests/CollectionStringyTest.php

@@ -41,6 +41,14 @@ public function testFail()
         S::collection(['fòôbàř', 'lall', 1]);
     }
 
+    public function testCreateValidatesElementTypesByDefault()
+    {
+        $this->expectException(TypeError::class);
+        $this->expectExceptionMessage('Invalid type: expected to be of type {Stringy\Stringy}, instead got value `1` with type {integer}.');
+
+        \Stringy\CollectionStringy::create([1]);
+    }
+
     public function testCollectionFunctionWithSingleString()
     {
         // A single (non-array) string must be wrapped and produce a one-element collection.

tests/StaticStringyTest.php

@@ -16,6 +16,7 @@ final class StaticStringyTest extends \PHPUnit\Framework\TestCase
     public function testBadMethodCall()
     {
         $this->expectException(\BadMethodCallException::class);
+        $this->expectExceptionMessage('invalidMethod is not a valid method');
 
         /** @noinspection PhpUndefinedMethodInspection */
         /** @noinspection PhpUnusedLocalVariableInspection */
@@ -56,6 +57,13 @@ public function testFullArgsInvocation()
     public function testArgumentNumbers()
     {
         $staticStringyClass = new ReflectionClass(S::class);
+        $methodArgsProperty = $staticStringyClass->getProperty('methodArgs');
+        $methodArgsProperty->setAccessible(true);
+        // Reset the cache so this test always exercises __callStatic()'s argument counting.
+        $methodArgsProperty->setValue(null, null);
+
+        S::slice('fòôbàř', 0, 3, 'UTF-8');
+
         $stringyClass = new ReflectionClass(Stringy::class);
 
         // getStaticPropertyValue can't access protected properties

tests/StringyTest.php

@@ -2055,6 +2055,17 @@ public function testAppendStringy()
         static::assertSame('abczzz123öäüdef', $result->toString());
     }
 
+    public function testAppendStringyConcatenatesEveryArgument()
+    {
+        $result = S::create('abc')->appendStringy(
+            S::create('123'),
+            S::create('öäü'),
+            S::create('def')
+        );
+
+        static::assertSame('abc123öäüdef', $result->toString());
+    }
+
     /**
      * @dataProvider atProvider()
      *
@@ -3897,6 +3908,18 @@ public function testWords()
         }
     }
 
+    public function testWordsKeepsEmptyValuesByDefault()
+    {
+        $words = S::create('foo oo oöäü#s')->words();
+        $result = [];
+
+        foreach ($words as $word) {
+            $result[] = $word->toString();
+        }
+
+        static::assertSame(['', 'foo', ' ', 'oo', ' ', 'oöäü', '#', 's', ''], $result);
+    }
+
     /**
      * @dataProvider splitProvider()
      *
@@ -5493,6 +5516,20 @@ public function testItPreservesEncodingChunk()
         }
     }
 
+    public function testChunkUsesSingleCharacterLengthByDefault()
+    {
+        $chunks = S::create('foo')->chunk();
+
+        static::assertSame(['f', 'o', 'o'], \array_map('strval', $chunks));
+    }
+
+    public function testChunkCollectionUsesSingleCharacterLengthByDefault()
+    {
+        $chunks = S::create('foo')->chunkCollection();
+
+        static::assertSame(['f', 'o', 'o'], \array_map('strval', $chunks->toArray()));
+    }
+
     public function testItCanBeExploded()
     {
         $string = new \Stringy\Stringy('john pinkerton');