Fixes generated or modified header

Author: raphaelstolt

CHANGELOG.md

@@ -8,6 +8,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 ## [Unreleased]
 
 
+## [v5.2.1] - 2025-10-17
+
+### Fixed
+- The correct file `HEADERS` (generated|modified) are written.
+
 ## [v5.2.0] - 2025-09-26
 
 ### Added
@@ -430,7 +435,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 - Initial release.
 
-[Unreleased]: https://github.com/raphaelstolt/lean-package-validator/compare/v5.2.0...HEAD
+[Unreleased]: https://github.com/raphaelstolt/lean-package-validator/compare/v5.2.1...HEAD
+[v5.2.1]: https://github.com/raphaelstolt/lean-package-validator/compare/v5.2.0...v5.2.1
 [v5.2.0]: https://github.com/raphaelstolt/lean-package-validator/compare/v5.1.0...v5.2.0
 [v5.1.0]: https://github.com/raphaelstolt/lean-package-validator/compare/v5.0.0...v5.1.0
 [v5.0.0]: https://github.com/raphaelstolt/lean-package-validator/compare/v4.7.1...v5.0.0

src/GitattributesFileRepository.php

@@ -95,27 +95,15 @@ public function applyOverwriteHeaderPolicy(string $contentToWrite): string
         $gitattributesPath = $this->analyser->getGitattributesFilePath();
 
         if (!\is_file($gitattributesPath)) {
-            return $contentToWrite;
+            return self::GENERATED_HEADER . PHP_EOL . PHP_EOL . $contentToWrite;
         }
 
-        $presentContent = (string) @\file_get_contents($gitattributesPath);
-        if ($presentContent === '') {
-            return $contentToWrite;
+        if (\str_contains($contentToWrite, self::GENERATED_HEADER)) {
+            return str_replace(self::GENERATED_HEADER, self::MODIFIED_HEADER, $contentToWrite);
         }
 
-        if (\str_contains($presentContent, self::GENERATED_HEADER)) {
-            $generatedPrefix = self::GENERATED_HEADER . PHP_EOL;
-            $modifiedPrefix  = self::MODIFIED_HEADER . PHP_EOL;
-
-            // If the new content starts with the "generated by" header, replace it.
-            if (\str_starts_with($contentToWrite, $generatedPrefix)) {
-                return $modifiedPrefix . \substr($contentToWrite, \strlen($generatedPrefix));
-            }
-
-            // If no header is present at the top, prepend the "partly modified" header.
-            if (!\str_starts_with($contentToWrite, $modifiedPrefix)) {
-                return self::MODIFIED_HEADER . PHP_EOL . PHP_EOL . $contentToWrite;
-            }
+        if (!str_contains($contentToWrite, self::MODIFIED_HEADER) && !str_contains($contentToWrite, self::GENERATED_HEADER)) {
+            return self::MODIFIED_HEADER . PHP_EOL . PHP_EOL . $contentToWrite;
         }
 
         return $contentToWrite;

tests/Commands/ValidateCommandTest.php

@@ -19,6 +19,7 @@
 use Stolt\LeanPackage\Commands\ValidateCommand;
 use Stolt\LeanPackage\Exceptions\InvalidGlobPattern;
 use Stolt\LeanPackage\Exceptions\NoLicenseFilePresent;
+use Stolt\LeanPackage\GitattributesFileRepository;
 use Stolt\LeanPackage\Helpers\Str as OsHelper;
 use Stolt\LeanPackage\Presets\Finder;
 use Stolt\LeanPackage\Presets\PhpPreset;
@@ -1617,6 +1618,19 @@ public function incompleteGitattributesFileIsOverwritten(string $option): void
             ['specs']
         );
 
+        $header = GitattributesFileRepository::GENERATED_HEADER . PHP_EOL . PHP_EOL;
+
+        if ($option === '--overwrite') {
+            $header = GitattributesFileRepository::MODIFIED_HEADER . PHP_EOL;
+        }
+
+        if ($option === '--create') {
+            $header = GitattributesFileRepository::GENERATED_HEADER . PHP_EOL . PHP_EOL;
+        }
+
+        echo 'OPTION: ' . $option . PHP_EOL;
+        echo 'HEADER: ' . $header . PHP_EOL;
+
         $command = $this->application->find('validate');
         $commandTester = new CommandTester($command);
         $commandTester->execute([
@@ -1633,6 +1647,7 @@ public function incompleteGitattributesFileIsOverwritten(string $option): void
 The present .gitattributes file is considered invalid.
 
 Overwrote it with the shown content:
+$header
 * text=auto eol=lf
 
 .gitattributes export-ignore

tests/GitattributesFileRepositoryTest.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Stolt\LeanPackage\Tests;
+
+use PHPUnit\Framework\Attributes\Test;
+use Stolt\LeanPackage\Analyser;
+use Stolt\LeanPackage\GitattributesFileRepository;
+use Stolt\LeanPackage\Presets\Finder;
+use Stolt\LeanPackage\Presets\PhpPreset;
+
+final class GitattributesFileRepositoryTest extends TestCase
+{
+    public function setUp(): void
+    {
+        $this->setUpTemporaryDirectory();
+    }
+
+    /**
+     * Tear down the test environment.
+     *
+     * @return void
+     */
+    protected function tearDown(): void
+    {
+        if (\is_dir($this->temporaryDirectory)) {
+            $this->removeDirectory($this->temporaryDirectory);
+        }
+    }
+
+    #[Test]
+    public function addsExpectedFileHeaders(): void
+    {
+        $analyser = (new Analyser(new Finder(new PhpPreset())))->setDirectory($this->temporaryDirectory);
+
+        $repository = new GitattributesFileRepository($analyser);
+
+        $fakeGitattributesContent = <<<CONTENT
+* text=auto eol=lf
+
+.gitattributes export-ignore
+phpspec.yml.dist export-ignore
+specs/ export-ignore
+version-increase-command export-ignore
+CONTENT;
+        $contentWithFileHeader = $repository->applyOverwriteHeaderPolicy($fakeGitattributesContent);
+
+        $this->assertStringContainsString(GitattributesFileRepository::GENERATED_HEADER, $contentWithFileHeader);
+
+        $generatedHeader = GitattributesFileRepository::GENERATED_HEADER . PHP_EOL . PHP_EOL;
+        $fakeGitattributesContent = <<<CONTENT
+$generatedHeader
+* text=auto eol=lf
+
+.gitattributes export-ignore
+phpspec.yml.dist export-ignore
+specs/ export-ignore
+version-increase-command export-ignore
+CONTENT;
+
+        \touch($this->temporaryDirectory . DIRECTORY_SEPARATOR . '.gitattributes');
+
+        $contentWithFileHeader = $repository->applyOverwriteHeaderPolicy($fakeGitattributesContent);
+
+        $this->assertStringContainsString(GitattributesFileRepository::MODIFIED_HEADER, $contentWithFileHeader);
+
+        $modifiedHeader = GitattributesFileRepository::MODIFIED_HEADER . PHP_EOL . PHP_EOL;
+        $fakeGitattributesContent = <<<CONTENT
+$modifiedHeader
+* text=auto eol=lf
+
+.gitattributes export-ignore
+phpspec.yml.dist export-ignore
+specs/ export-ignore
+version-increase-command export-ignore
+CONTENT;
+        $contentWithFileHeader = $repository->applyOverwriteHeaderPolicy($fakeGitattributesContent);
+
+        $this->assertStringContainsString(GitattributesFileRepository::MODIFIED_HEADER, $contentWithFileHeader);
+
+        $fakeGitattributesContent = <<<CONTENT
+* text=auto eol=lf
+
+.gitattributes export-ignore
+phpspec.yml.dist export-ignore
+specs/ export-ignore
+version-increase-command export-ignore
+CONTENT;
+
+        $contentWithFileHeader = $repository->applyOverwriteHeaderPolicy($fakeGitattributesContent);
+
+        $this->assertStringContainsString(GitattributesFileRepository::MODIFIED_HEADER, $contentWithFileHeader);
+    }
+}