[github] Refine CODEOWNERS inference rules (#67)

Author: coisa

resources/CODEOWNERS

@@ -0,0 +1,11 @@
+# Generated by fast-forward/dev-tools.
+# Review the generated owners before committing this file.
+#
+# When no GitHub owners can be inferred automatically, replace the placeholder
+# example below with the usernames, teams, or emails that should review
+# changes in the consumer repository.
+#
+# Example:
+# * @your-github-user @your-org/platform-team
+{{ suggestions }}
+{{ rule }}

resources/CODEOWNERS.dist

@@ -61,14 +61,19 @@ public function __construct(
      */
     public function inferOwners(): array
     {
+        $owners = [];
+        $groupOwner = $this->inferGroupOwner();
+
+        if (null !== $groupOwner) {
+            $owners[] = $groupOwner;
+        }
+
         $authors = $this->composer->getAuthors();
 
         if (! is_iterable($authors)) {
-            return [];
+            return $owners;
         }
 
-        $owners = [];
-
         foreach ($authors as $author) {
             if (! $author instanceof AuthorInterface) {
                 continue;
@@ -86,29 +91,6 @@ public function inferOwners(): array
         return array_values(array_unique($owners));
     }
 
-    /**
-     * Returns best-effort commented suggestions when direct ownership cannot be inferred.
-     *
-     * @return list<string>
-     */
-    public function inferSuggestedOwners(): array
-    {
-        $source = $this->composer->getSupport()
-            ->getSource();
-
-        if ('' === $source) {
-            return [];
-        }
-
-        $owner = $this->extractGitHubRepositoryOwner($source);
-
-        if (null === $owner) {
-            return [];
-        }
-
-        return ['@' . $owner];
-    }
-
     /**
      * Normalizes user-provided owner tokens.
      *
@@ -147,23 +129,40 @@ static function (string $owner): string {
     public function generate(?array $owners = null): string
     {
         $owners ??= $this->inferOwners();
-        $suggestions = [];
-
-        if ([] === $owners) {
-            $suggestions = $this->inferSuggestedOwners();
-        }
-
-        $template = $this->filesystem->readFile($this->fileLocator->locate('resources/CODEOWNERS.dist'));
-        $suggestionBlock = [] === $suggestions
+        $template = $this->filesystem->readFile($this->fileLocator->locate('resources/CODEOWNERS'));
+        $suggestionBlock = [] === $owners
             ? '# No GitHub owners could be inferred from composer.json metadata.'
-            : \sprintf('# Suggested owner from composer support metadata: %s', implode(' ', $suggestions));
+            : '';
         $rule = [] === $owners
             ? '# * @your-github-user'
             : \sprintf('* %s', implode(' ', $owners));
 
         return str_replace(['{{ suggestions }}', '{{ rule }}'], [$suggestionBlock, $rule], $template);
     }
 
+    /**
+     * Returns the repository or organization owner inferred from support metadata.
+     *
+     * @return string|null the inferred group owner with `@`, or null when unavailable
+     */
+    public function inferGroupOwner(): ?string
+    {
+        $source = $this->composer->getSupport()
+            ->getSource();
+
+        if ('' === $source) {
+            return null;
+        }
+
+        $owner = $this->extractGitHubRepositoryOwner($source);
+
+        if (null === $owner) {
+            return null;
+        }
+
+        return '@' . $owner;
+    }
+
     /**
      * Extracts a GitHub user handle from a homepage URL.
      *

src/CodeOwners/CodeOwnersGenerator.php

@@ -67,9 +67,9 @@ protected function setUp(): void
         $this->filesystem = $this->prophesize(FilesystemInterface::class);
         $this->fileLocator = $this->prophesize(FileLocatorInterface::class);
 
-        $this->fileLocator->locate('resources/CODEOWNERS.dist')
-            ->willReturn('/package/resources/CODEOWNERS.dist');
-        $this->filesystem->readFile('/package/resources/CODEOWNERS.dist')
+        $this->fileLocator->locate('resources/CODEOWNERS')
+            ->willReturn('/package/resources/CODEOWNERS');
+        $this->filesystem->readFile('/package/resources/CODEOWNERS')
             ->willReturn(<<<'TEXT'
                 # Header
                 {{ suggestions }}
@@ -87,8 +87,10 @@ protected function setUp(): void
      * @return void
      */
     #[Test]
-    public function inferOwnersWillCollectGitHubHandlesFromAuthorHomepages(): void
+    public function inferOwnersWillCollectGroupAndAuthorOwners(): void
     {
+        $this->composerJson->getSupport()
+            ->willReturn(new Support(source: 'https://github.com/php-fast-forward/dev-tools'));
         $this->composerJson->getAuthors()
             ->willReturn([
                 new Author(homepage: 'https://github.com/php-fast-forward'),
@@ -103,12 +105,12 @@ public function inferOwnersWillCollectGitHubHandlesFromAuthorHomepages(): void
      * @return void
      */
     #[Test]
-    public function inferSuggestedOwnersWillReturnRepositoryOwnerFromSupportSource(): void
+    public function inferGroupOwnerWillReturnRepositoryOwnerFromSupportSource(): void
     {
         $this->composerJson->getSupport()
             ->willReturn(new Support(source: 'https://github.com/php-fast-forward/dev-tools'));
 
-        self::assertSame(['@php-fast-forward'], $this->generator->inferSuggestedOwners());
+        self::assertSame('@php-fast-forward', $this->generator->inferGroupOwner());
     }
 
     /**
@@ -117,28 +119,42 @@ public function inferSuggestedOwnersWillReturnRepositoryOwnerFromSupportSource()
     #[Test]
     public function generateWillRenderExplicitOwners(): void
     {
+        self::assertSame(
+            "# Header\n\n* @php-fast-forward @mentordosnerds",
+            $this->generator->generate(['@php-fast-forward', '@mentordosnerds']),
+        );
+    }
+
+    /**
+     * @return void
+     */
+    #[Test]
+    public function generateWillRenderCommentedFallbackWhenOwnersCannotBeInferred(): void
+    {
+        $this->composerJson->getAuthors()
+            ->willReturn([]);
         $this->composerJson->getSupport()
             ->willReturn(new Support());
 
         self::assertSame(
-            "# Header\n# No GitHub owners could be inferred from composer.json metadata.\n* @php-fast-forward @mentordosnerds",
-            $this->generator->generate(['@php-fast-forward', '@mentordosnerds']),
+            "# Header\n# No GitHub owners could be inferred from composer.json metadata.\n# * @your-github-user",
+            $this->generator->generate(),
         );
     }
 
     /**
      * @return void
      */
     #[Test]
-    public function generateWillRenderCommentedFallbackWhenOwnersCannotBeInferred(): void
+    public function generateWillRenderGroupOwnerWhenAuthorCannotBeInferred(): void
     {
         $this->composerJson->getAuthors()
             ->willReturn([]);
         $this->composerJson->getSupport()
             ->willReturn(new Support(source: 'https://github.com/php-fast-forward/dev-tools'));
 
         self::assertSame(
-            "# Header\n# Suggested owner from composer support metadata: @php-fast-forward\n# * @your-github-user",
+            "# Header\n\n* @php-fast-forward",
             $this->generator->generate(),
         );
     }