xtrm-tools 2.0.0

package/project-skills/tdd-guard/reporters/phpunit/composer.json

@@ -0,0 +1,55 @@
+{
+    "name": "tdd-guard/phpunit",
+    "description": "PHPUnit reporter for TDD Guard",
+    "version": "0.1.3",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Wolfgang Klinger",
+            "email": "hello@wolfgang-klinger.dev"
+        }
+    ],
+    "keywords": [
+        "tdd",
+        "test-driven-development",
+        "testing",
+        "phpunit",
+        "claude"
+    ],
+    "homepage": "https://github.com/nizos/tdd-guard",
+    "support": {
+        "issues": "https://github.com/nizos/tdd-guard/issues",
+        "source": "https://github.com/nizos/tdd-guard/tree/main/reporters/phpunit"
+    },
+    "require": {
+        "php": ">=8.1",
+        "phpunit/phpunit": "^9.0 || ^10.0 || ^11.0 || ^12.0"
+    },
+    "require-dev": {
+        "symfony/filesystem": "^5.4 || ^6.0 || ^7.0",
+        "friendsofphp/php-cs-fixer": "^3.40",
+        "vimeo/psalm": "^5.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "TddGuard\\PHPUnit\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "TddGuard\\PHPUnit\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "test:coverage": "vendor/bin/phpunit --coverage-text",
+        "format": "vendor/bin/php-cs-fixer fix",
+        "format:check": "vendor/bin/php-cs-fixer fix --dry-run --diff",
+        "lint": "vendor/bin/psalm",
+        "lint:check": "vendor/bin/psalm --no-progress"
+    },
+    "config": {
+        "sort-packages": true
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/phpunit.xml.dist

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         failOnRisky="true"
+         failOnWarning="true">
+    <testsuites>
+        <testsuite name="TDD Guard PHPUnit Reporter">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    
+    <source>
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+</phpunit>

package/project-skills/tdd-guard/reporters/phpunit/psalm.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="3"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
+>
+    <projectFiles>
+        <directory name="src" />
+        <directory name="tests" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <!-- Suppress for test files only -->
+        <PropertyNotSetInConstructor>
+            <errorLevel type="suppress">
+                <directory name="tests" />
+            </errorLevel>
+        </PropertyNotSetInConstructor>
+        <MissingConstructor>
+            <errorLevel type="suppress">
+                <directory name="tests" />
+            </errorLevel>
+        </MissingConstructor>
+        <UnusedClass>
+            <errorLevel type="suppress">
+                <directory name="tests" />
+            </errorLevel>
+        </UnusedClass>
+        
+        <!-- PHPUnit 9.x compatibility - TestListener interface was removed in PHPUnit 10 -->
+        <UndefinedClass>
+            <errorLevel type="suppress">
+                <referencedClass name="PHPUnit\Framework\TestListener" />
+            </errorLevel>
+        </UndefinedClass>
+    </issueHandlers>
+</psalm>

package/project-skills/tdd-guard/reporters/phpunit/src/Event/ErroredTestSubscriber.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit\Event;
+
+use PHPUnit\Event\Test\Errored;
+use PHPUnit\Event\Test\ErroredSubscriber;
+use TddGuard\PHPUnit\TestResultCollector;
+
+final class ErroredTestSubscriber implements ErroredSubscriber
+{
+    private TestResultCollector $collector;
+
+    public function __construct(TestResultCollector $collector)
+    {
+        $this->collector = $collector;
+    }
+
+    public function notify(Errored $event): void
+    {
+        $this->collector->addTestResult(
+            $event->test(),
+            'errored',
+            $event->throwable()->message()
+        );
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/src/Event/FailedTestSubscriber.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit\Event;
+
+use PHPUnit\Event\Test\Failed;
+use PHPUnit\Event\Test\FailedSubscriber;
+use TddGuard\PHPUnit\TestResultCollector;
+
+final class FailedTestSubscriber implements FailedSubscriber
+{
+    private TestResultCollector $collector;
+
+    public function __construct(TestResultCollector $collector)
+    {
+        $this->collector = $collector;
+    }
+
+    public function notify(Failed $event): void
+    {
+        $this->collector->addTestResult(
+            $event->test(),
+            'failed',
+            $event->throwable()->message()
+        );
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/src/Event/IncompleteTestSubscriber.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit\Event;
+
+use PHPUnit\Event\Test\MarkedIncomplete;
+use PHPUnit\Event\Test\MarkedIncompleteSubscriber;
+use TddGuard\PHPUnit\TestResultCollector;
+
+final class IncompleteTestSubscriber implements MarkedIncompleteSubscriber
+{
+    private TestResultCollector $collector;
+
+    public function __construct(TestResultCollector $collector)
+    {
+        $this->collector = $collector;
+    }
+
+    public function notify(MarkedIncomplete $event): void
+    {
+        $this->collector->addTestResult(
+            $event->test(),
+            'skipped',
+            'Incomplete: ' . $event->throwable()->message()
+        );
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/src/Event/PassedTestSubscriber.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit\Event;
+
+use PHPUnit\Event\Test\Passed;
+use PHPUnit\Event\Test\PassedSubscriber;
+use TddGuard\PHPUnit\TestResultCollector;
+
+final class PassedTestSubscriber implements PassedSubscriber
+{
+    private TestResultCollector $collector;
+
+    public function __construct(TestResultCollector $collector)
+    {
+        $this->collector = $collector;
+    }
+
+    public function notify(Passed $event): void
+    {
+        $this->collector->addTestResult(
+            $event->test(),
+            'passed'
+        );
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/src/Event/SkippedTestSubscriber.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit\Event;
+
+use PHPUnit\Event\Test\Skipped;
+use PHPUnit\Event\Test\SkippedSubscriber;
+use TddGuard\PHPUnit\TestResultCollector;
+
+final class SkippedTestSubscriber implements SkippedSubscriber
+{
+    private TestResultCollector $collector;
+
+    public function __construct(TestResultCollector $collector)
+    {
+        $this->collector = $collector;
+    }
+
+    public function notify(Skipped $event): void
+    {
+        $this->collector->addTestResult(
+            $event->test(),
+            'skipped',
+            $event->message()
+        );
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/src/Event/TestRunnerFinishedSubscriber.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit\Event;
+
+use PHPUnit\Event\TestRunner\Finished;
+use PHPUnit\Event\TestRunner\FinishedSubscriber;
+use TddGuard\PHPUnit\TestResultCollector;
+
+final class TestRunnerFinishedSubscriber implements FinishedSubscriber
+{
+    private TestResultCollector $collector;
+
+    public function __construct(TestResultCollector $collector)
+    {
+        $this->collector = $collector;
+    }
+
+    public function notify(Finished $event): void
+    {
+        $this->collector->saveResults();
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/src/PathValidator.php

@@ -0,0 +1,88 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit;
+
+final class PathValidator
+{
+    public static function resolveProjectRoot(string $configuredRoot): string
+    {
+        if ($configuredRoot !== '') {
+            $validated = self::validateProjectRoot($configuredRoot);
+            if ($validated === null) {
+                throw new \InvalidArgumentException('Configured project root is invalid');
+            }
+
+            return $validated;
+        }
+
+        $envRoot = getenv('TDD_GUARD_PROJECT_ROOT');
+        if ($envRoot !== false && $envRoot !== '') {
+            $validated = self::validateProjectRoot($envRoot);
+            if ($validated === null) {
+                throw new \InvalidArgumentException('TDD_GUARD_PROJECT_ROOT is invalid');
+            }
+
+            return $validated;
+        }
+
+        return getcwd();
+    }
+
+    private static function validateProjectRoot(string $path): ?string
+    {
+        if ($path === '') {
+            return null;
+        }
+
+        if (!self::isAbsolutePath($path)) {
+            return null;
+        }
+
+        if (strpos($path, '..') !== false) {
+            return null;
+        }
+
+        if (!is_dir($path)) {
+            return null;
+        }
+
+        $normalizedPath = realpath($path);
+        if ($normalizedPath === false) {
+            return null;
+        }
+
+        $cwd = realpath(getcwd());
+        if ($cwd === false) {
+            return null;
+        }
+
+        if (!self::isAncestorOrSame($normalizedPath, $cwd)) {
+            return null;
+        }
+
+        return $normalizedPath;
+    }
+
+    private static function isAncestorOrSame(string $potentialAncestor, string $path): bool
+    {
+        $potentialAncestor = rtrim($potentialAncestor, DIRECTORY_SEPARATOR);
+        $path = rtrim($path, DIRECTORY_SEPARATOR);
+
+        if ($potentialAncestor === $path) {
+            return true;
+        }
+
+        return strpos($path, $potentialAncestor . DIRECTORY_SEPARATOR) === 0;
+    }
+
+    private static function isAbsolutePath(string $path): bool
+    {
+        if (PHP_OS_FAMILY === 'Windows') {
+            return preg_match('/^[a-zA-Z]:[\\\\\\/]/', $path) === 1;
+        }
+
+        return strpos($path, '/') === 0;
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/src/Storage.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit;
+
+final class Storage
+{
+    private string $projectRoot;
+
+    public function __construct(string $projectRoot = '')
+    {
+        $this->projectRoot = PathValidator::resolveProjectRoot($projectRoot);
+    }
+
+    public function saveTest(string $content): void
+    {
+        $dataDir = $this->projectRoot . '/.claude/tdd-guard/data';
+
+        if (!is_dir($dataDir)) {
+            mkdir($dataDir, 0755, true);
+        }
+
+        file_put_contents($dataDir . '/test.json', $content);
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/src/TddGuardExtension.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit;
+
+use PHPUnit\Runner\Extension\Extension;
+use PHPUnit\Runner\Extension\Facade;
+use PHPUnit\Runner\Extension\ParameterCollection;
+use PHPUnit\TextUI\Configuration\Configuration;
+
+/**
+ * @psalm-api
+ */
+final class TddGuardExtension implements Extension
+{
+    public function bootstrap(Configuration $configuration, Facade $facade, ParameterCollection $parameters): void
+    {
+        $projectRoot = $this->getProjectRoot($parameters);
+
+        $subscriber = new TddGuardSubscriber($projectRoot);
+        foreach ($subscriber->getSubscribers() as $eventSubscriber) {
+            $facade->registerSubscriber($eventSubscriber);
+        }
+    }
+
+    private function getProjectRoot(ParameterCollection $parameters): string
+    {
+        $configuredRoot = $parameters->has('projectRoot') ? $parameters->get('projectRoot') : '';
+
+        return PathValidator::resolveProjectRoot($configuredRoot);
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/src/TddGuardListener.php

@@ -0,0 +1,158 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit;
+
+use PHPUnit\Framework\AssertionFailedError;
+use PHPUnit\Framework\Test;
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\TestListener;
+use PHPUnit\Framework\TestListenerDefaultImplementation;
+use PHPUnit\Framework\TestSuite;
+use PHPUnit\Framework\Warning;
+use Throwable;
+
+/**
+ * @psalm-api
+ */
+final class TddGuardListener implements TestListener
+{
+    use TestListenerDefaultImplementation;
+
+    private array $testResults = [];
+    private string $projectRoot;
+
+    public function __construct(string $projectRoot = '')
+    {
+        $this->projectRoot = PathValidator::resolveProjectRoot($projectRoot);
+    }
+
+    public function startTest(Test $test): void
+    {
+    }
+
+    public function endTest(Test $test, float $time): void
+    {
+        if (!$test instanceof TestCase) {
+            return;
+        }
+
+        $fullName = $test->toString();
+
+        foreach ($this->testResults as $result) {
+            if ($result['test']['fullName'] === $fullName) {
+                return;
+            }
+        }
+
+        $this->addTestResult($test, 'passed');
+    }
+
+    public function addError(Test $test, Throwable $t, float $time): void
+    {
+        $this->addTestResult($test, 'failed', $t->getMessage());
+    }
+
+    public function addFailure(Test $test, AssertionFailedError $e, float $time): void
+    {
+        $this->addTestResult($test, 'failed', $e->getMessage());
+    }
+
+    public function addWarning(Test $test, Warning $e, float $time): void
+    {
+        $this->addTestResult($test, 'failed', 'Warning: ' . $e->getMessage());
+    }
+
+    public function addIncompleteTest(Test $test, Throwable $t, float $time): void
+    {
+        $this->addTestResult($test, 'skipped', 'Incomplete: ' . $t->getMessage());
+    }
+
+    public function addRiskyTest(Test $test, Throwable $t, float $time): void
+    {
+        $this->addTestResult($test, 'failed', 'Risky: ' . $t->getMessage());
+    }
+
+    public function addSkippedTest(Test $test, Throwable $t, float $time): void
+    {
+        $this->addTestResult($test, 'skipped', $t->getMessage());
+    }
+
+    private function addTestResult(Test $test, string $state, ?string $message = null): void
+    {
+        if (!$test instanceof TestCase) {
+            return;
+        }
+
+        $testName = $test->getName();
+        $className = get_class($test);
+        $fullName = $test->toString();
+
+        $result = [
+            'name' => $testName,
+            'fullName' => $fullName,
+            'state' => $state,
+        ];
+
+        if ($message !== null && $state === 'failed') {
+            $result['errors'] = [
+                ['message' => $message],
+            ];
+        }
+
+        try {
+            $reflection = new \ReflectionClass($className);
+            $moduleId = $this->getRelativePath($reflection->getFileName());
+        } catch (\ReflectionException $e) {
+            $moduleId = str_replace('\\', '/', $className) . '.php';
+        }
+
+        $this->testResults[] = [
+            'test' => $result,
+            'module' => $moduleId,
+        ];
+    }
+
+    private function getRelativePath(string $absolutePath): string
+    {
+        if (str_starts_with($absolutePath, $this->projectRoot)) {
+            $relativePath = substr($absolutePath, strlen($this->projectRoot) + 1);
+
+            return str_replace(DIRECTORY_SEPARATOR, '/', $relativePath);
+        }
+
+        return basename($absolutePath);
+    }
+
+    public function endTestSuite(TestSuite $suite): void
+    {
+        if (empty($this->testResults)) {
+            return;
+        }
+
+        $this->saveResults();
+    }
+
+    private function saveResults(): void
+    {
+        $modules = [];
+        foreach ($this->testResults as $item) {
+            $moduleId = $item['module'];
+            if (!isset($modules[$moduleId])) {
+                $modules[$moduleId] = [
+                    'moduleId' => $moduleId,
+                    'tests' => [],
+                ];
+            }
+            $modules[$moduleId]['tests'][] = $item['test'];
+        }
+
+        $output = [
+            'testModules' => array_values($modules),
+        ];
+
+        $reporter = new Storage($this->projectRoot);
+        $reporter->saveTest(json_encode($output, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
+    }
+}

package/project-skills/tdd-guard/reporters/phpunit/src/TddGuardSubscriber.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TddGuard\PHPUnit;
+
+use TddGuard\PHPUnit\Event\ErroredTestSubscriber;
+use TddGuard\PHPUnit\Event\FailedTestSubscriber;
+use TddGuard\PHPUnit\Event\IncompleteTestSubscriber;
+use TddGuard\PHPUnit\Event\PassedTestSubscriber;
+use TddGuard\PHPUnit\Event\SkippedTestSubscriber;
+use TddGuard\PHPUnit\Event\TestRunnerFinishedSubscriber;
+
+final class TddGuardSubscriber
+{
+    private TestResultCollector $collector;
+
+    public function __construct(string $projectRoot)
+    {
+        $storage = new Storage($projectRoot);
+        $this->collector = new TestResultCollector($storage, $projectRoot);
+    }
+
+    public function getSubscribers(): array
+    {
+        return [
+            new PassedTestSubscriber($this->collector),
+            new FailedTestSubscriber($this->collector),
+            new ErroredTestSubscriber($this->collector),
+            new SkippedTestSubscriber($this->collector),
+            new IncompleteTestSubscriber($this->collector),
+            new TestRunnerFinishedSubscriber($this->collector),
+        ];
+    }
+}