Lint SPDX conventions

The `reuse lint` command only checks for REUSE compliance, which
will accept all sorts of SPDX headers.

In this project, however, we have also other conventions. For
example, we require all PHP and docs files from the project
to have a specific license (not just any license) and also a
specific File Copyright Text (not just any copyright).

This commit introduces a command to solve this problem, validating
the headers more thoroughly.

The introduced command also does some dogfooding, using validators
from the library itself to perform some of its tasks, namely: Call,
Each, Contains, Templated and Named, showcasing potential different
use cases for the project.

Author: alganet

.github/workflows/reuse.yml

@@ -21,8 +21,20 @@ jobs:
         with:
           python-version: '3.x'
 
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.5
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --prefer-dist
+
       - name: Install REUSE tool
         run: pip install reuse
 
       - name: Run REUSE check
-        run: reuse lint
+        run: reuse lint
+
+      - name: Run SPDX conventions check
+        run: bin/console spdx:lint

bin/console

@@ -13,6 +13,7 @@ require __DIR__ . '/../vendor/autoload.php';
 use Respect\Dev\Commands\CreateMixinCommand;
 use Respect\Dev\Commands\DocsLintCommand;
 use Respect\Dev\Commands\SmokeTestsCheckCompleteCommand;
+use Respect\Dev\Commands\SpdxLintCommand;
 use Respect\Dev\Commands\UpdateDomainSuffixesCommand;
 use Respect\Dev\Commands\UpdateDomainToplevelCommand;
 use Respect\Dev\Commands\UpdatePostalCodesCommand;
@@ -43,6 +44,7 @@ return (static function () {
     $application->addCommand(new UpdateDomainToplevelCommand());
     $application->addCommand(new UpdatePostalCodesCommand());
     $application->addCommand(new SmokeTestsCheckCompleteCommand());
+    $application->addCommand(new SpdxLintCommand());
 
     return $application->run();
 })();

composer.json

@@ -83,7 +83,9 @@
         "phpstan": "vendor/bin/phpstan analyze",
         "phpunit": "vendor/bin/phpunit --testsuite=unit",
         "smoke-complete": "bin/console smoke-tests:check-complete",
+        "spdx-lint": "bin/console spdx:lint",
         "qa": [
+            "@spdx-lint",
             "@phpcs",
             "@phpstan",
             "@phpunit",

src-dev/Commands/SpdxLintCommand.php

@@ -0,0 +1,99 @@
+<?php
+
+/*
+ * SPDX-License-Identifier: MIT
+ * SPDX-FileCopyrightText: (c) Respect Project Contributors
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Dev\Commands;
+
+use Respect\Validation\Exceptions\ValidationException;
+use Respect\Validation\ValidatorBuilder;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Finder\SplFileInfo;
+
+use function array_filter;
+use function array_keys;
+use function array_map;
+use function dirname;
+use function explode;
+use function file_get_contents;
+use function preg_match;
+use function sprintf;
+use function trim;
+
+#[AsCommand(
+    name: 'spdx:lint',
+    description: 'Apply SPDX linters to source and documentation files',
+)]
+final class SpdxLintCommand extends Command
+{
+    public const array HEADERS = [
+        'License-Identifier: MIT',
+        'FileCopyrightText: (c) Respect Project Contributors',
+    ];
+    public const array EXTENSIONS = [
+        'php' => '/\/\*+(.*?)\*\//s',
+        'md' => '/<!--+(.*?)-->/s',
+    ];
+    public const array SEARCH_DIRS = [
+        '/src',
+        '/src-dev',
+        '/tests',
+        '/bin',
+        '/docs',
+    ];
+
+    public static function extractFileHeader(SplFileInfo $file): string
+    {
+        preg_match(
+            self::EXTENSIONS[$file->getExtension()],
+            file_get_contents($file->getRealPath()),
+            $matches,
+        );
+
+        return $matches[1] ?? '';
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $pass = true;
+        $root = dirname(__DIR__, 2);
+        $finder = (new Finder())->in(array_map(static fn($dir) => $root . $dir, self::SEARCH_DIRS))->files();
+        $validator = ValidatorBuilder::call(
+            static fn($input) => array_filter(explode("\n", trim($input))),
+            ValidatorBuilder::templated(
+                'Each header line of {{subject}}',
+                ValidatorBuilder::each(ValidatorBuilder::stringType()->contains('SPDX')),
+            ),
+        );
+
+        foreach (array_keys(self::EXTENSIONS) as $extension) {
+            $finder = $finder->name('*.' . $extension);
+        }
+
+        foreach (self::HEADERS as $headerLine) {
+            $validator = $validator->contains(sprintf('SPDX-%s', $headerLine));
+        }
+
+        foreach ($finder as $file) {
+            try {
+                ValidatorBuilder::named(
+                    sprintf('File "%s" SPDX header', $file->getRelativePathname()),
+                    $validator,
+                )->assert(static::extractFileHeader($file));
+            } catch (ValidationException $e) {
+                $output->writeln($e->getFullMessage());
+                $pass = false;
+            }
+        }
+
+        return $pass ? Command::SUCCESS : Command::FAILURE;
+    }
+}