Skip to content

Ensure guideline file content ends with a newline #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Ensure guideline file content ends with a newline #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3e8fb7
Ensure file content ends with a newline
balu-lt Aug 14, 2025
93e9d8e
Update GuidelineWriterTest
balu-lt Aug 14, 2025
6522e47
Test to avoid adding extra newline
balu-lt Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/Install/GuidelineWriter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ public function write(string $guidelines): int
$newContent = $frontMatter.$existingContent.$separatingNewlines.$replacement;
}

// Ensure file content ends with a newline
if (! str_ends_with($newContent, "\n")) {
$newContent .= "\n";
}

if (ftruncate($handle, 0) === false || fseek($handle, 0) === -1) {
throw new RuntimeException("Failed to reset file pointer: {$filePath}");
}
Expand Down
49 changes: 36 additions & 13 deletions tests/Unit/Install/GuidelineWriterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
$writer->write('test guidelines content');

$content = file_get_contents($tempFile);
expect($content)->toBe("<laravel-boost-guidelines>\ntest guidelines content\n</laravel-boost-guidelines>");
expect($content)->toBe("<laravel-boost-guidelines>\ntest guidelines content\n</laravel-boost-guidelines>\n");

unlink($tempFile);
});
Expand All @@ -77,7 +77,7 @@
$writer->write('new guidelines');

$content = file_get_contents($tempFile);
expect($content)->toBe("# Existing content\n\nSome text here.\n\n===\n\n<laravel-boost-guidelines>\nnew guidelines\n</laravel-boost-guidelines>");
expect($content)->toBe("# Existing content\n\nSome text here.\n\n===\n\n<laravel-boost-guidelines>\nnew guidelines\n</laravel-boost-guidelines>\n");

unlink($tempFile);
});
Expand All @@ -95,7 +95,30 @@
$writer->write('updated guidelines');

$content = file_get_contents($tempFile);
expect($content)->toBe("# Header\n\n<laravel-boost-guidelines>\nupdated guidelines\n</laravel-boost-guidelines>\n\n# Footer");
expect($content)->toBe("# Header\n\n<laravel-boost-guidelines>\nupdated guidelines\n</laravel-boost-guidelines>\n\n# Footer\n");

unlink($tempFile);
});

test('it avoids adding extra newline if one already exists', function () {
$tempFile = tempnam(sys_get_temp_dir(), 'boost_test_');
$initialContent = "# Header\n\n<laravel-boost-guidelines>\nold guidelines\n</laravel-boost-guidelines>\n\n# Footer\n";
file_put_contents($tempFile, $initialContent);

$agent = Mockery::mock(Agent::class);
$agent->shouldReceive('guidelinesPath')->andReturn($tempFile);
$agent->shouldReceive('frontmatter')->andReturn(false);

$writer = new GuidelineWriter($agent);
$writer->write('updated guidelines');

$content = file_get_contents($tempFile);
expect($content)->toBe("# Header\n\n<laravel-boost-guidelines>\nupdated guidelines\n</laravel-boost-guidelines>\n\n# Footer\n");

// Assert no double newline at the end
expect(substr($content, -2))->not->toBe("\n\n");
// Assert still ends with exactly one newline
expect(substr($content, -1))->toBe("\n");

unlink($tempFile);
});
Expand All @@ -114,7 +137,7 @@

$content = file_get_contents($tempFile);
// Should replace in-place, preserving structure
expect($content)->toBe("Start\n<laravel-boost-guidelines>\nsingle line\n</laravel-boost-guidelines>\nEnd");
expect($content)->toBe("Start\n<laravel-boost-guidelines>\nsingle line\n</laravel-boost-guidelines>\nEnd\n");

unlink($tempFile);
});
Expand All @@ -133,7 +156,7 @@

$content = file_get_contents($tempFile);
// Should replace first occurrence, second block remains untouched due to non-greedy matching
expect($content)->toBe("Start\n<laravel-boost-guidelines>\nreplacement\n</laravel-boost-guidelines>\nMiddle\n<laravel-boost-guidelines>\nsecond\n</laravel-boost-guidelines>\nEnd");
expect($content)->toBe("Start\n<laravel-boost-guidelines>\nreplacement\n</laravel-boost-guidelines>\nMiddle\n<laravel-boost-guidelines>\nsecond\n</laravel-boost-guidelines>\nEnd\n");

unlink($tempFile);
});
Expand Down Expand Up @@ -165,7 +188,7 @@
$writer->write('my guidelines');

$content = file_get_contents($tempFile);
expect($content)->toBe("# Title\n\nParagraph 1\n\nParagraph 2\n\n===\n\n<laravel-boost-guidelines>\nmy guidelines\n</laravel-boost-guidelines>");
expect($content)->toBe("# Title\n\nParagraph 1\n\nParagraph 2\n\n===\n\n<laravel-boost-guidelines>\nmy guidelines\n</laravel-boost-guidelines>\n");

unlink($tempFile);
});
Expand All @@ -182,7 +205,7 @@
$writer->write('first guidelines');

$content = file_get_contents($tempFile);
expect($content)->toBe("<laravel-boost-guidelines>\nfirst guidelines\n</laravel-boost-guidelines>");
expect($content)->toBe("<laravel-boost-guidelines>\nfirst guidelines\n</laravel-boost-guidelines>\n");

unlink($tempFile);
});
Expand All @@ -199,7 +222,7 @@
$writer->write('clean guidelines');

$content = file_get_contents($tempFile);
expect($content)->toBe("<laravel-boost-guidelines>\nclean guidelines\n</laravel-boost-guidelines>");
expect($content)->toBe("<laravel-boost-guidelines>\nclean guidelines\n</laravel-boost-guidelines>\n");

unlink($tempFile);
});
Expand All @@ -218,7 +241,7 @@

expect($result)->toBe(GuidelineWriter::REPLACED);
$content = file_get_contents($tempFile);
expect($content)->toBe("# Title\n\n<other-rules>\nShould not be touched\n</other-rules>\n\n<laravel-boost-guidelines>\nnew guidelines\n</laravel-boost-guidelines>\n\n<custom-config>\nAlso untouched\n</custom-config>");
expect($content)->toBe("# Title\n\n<other-rules>\nShould not be touched\n</other-rules>\n\n<laravel-boost-guidelines>\nnew guidelines\n</laravel-boost-guidelines>\n\n<custom-config>\nAlso untouched\n</custom-config>\n");

unlink($tempFile);
});
Expand Down Expand Up @@ -248,7 +271,7 @@
expect($content)->toContain('More content here.');

// Verify exact structure
expect($content)->toBe("# My Project\n\n<laravel-boost-guidelines>\nupdated guidelines from boost\n</laravel-boost-guidelines>\n\n# User Added Section\nThis content was added by the user after the guidelines.\n\n## Another user section\nMore content here.");
expect($content)->toBe("# My Project\n\n<laravel-boost-guidelines>\nupdated guidelines from boost\n</laravel-boost-guidelines>\n\n# User Added Section\nThis content was added by the user after the guidelines.\n\n## Another user section\nMore content here.\n");

unlink($tempFile);
});
Expand Down Expand Up @@ -296,7 +319,7 @@
$writer->write('new guidelines');

$content = file_get_contents($tempFile);
expect($content)->toBe("---\nalwaysApply: true\n---\n# Existing content\n\nSome text here.\n\n===\n\n<laravel-boost-guidelines>\nnew guidelines\n</laravel-boost-guidelines>");
expect($content)->toBe("---\nalwaysApply: true\n---\n# Existing content\n\nSome text here.\n\n===\n\n<laravel-boost-guidelines>\nnew guidelines\n</laravel-boost-guidelines>\n");

unlink($tempFile);
});
Expand All @@ -313,7 +336,7 @@
$writer->write('new guidelines');

$content = file_get_contents($tempFile);
expect($content)->toBe("---\ncustomOption: true\n---\n# Existing content\n\nSome text here.\n\n===\n\n<laravel-boost-guidelines>\nnew guidelines\n</laravel-boost-guidelines>");
expect($content)->toBe("---\ncustomOption: true\n---\n# Existing content\n\nSome text here.\n\n===\n\n<laravel-boost-guidelines>\nnew guidelines\n</laravel-boost-guidelines>\n");

unlink($tempFile);
});
Expand All @@ -331,7 +354,7 @@

expect($result)->toBe(GuidelineWriter::NEW);
$content = file_get_contents($tempFile);
expect($content)->toBe("# Existing content\n\nSome text here.\n\n===\n\n<laravel-boost-guidelines>\nnew guidelines\n</laravel-boost-guidelines>");
expect($content)->toBe("# Existing content\n\nSome text here.\n\n===\n\n<laravel-boost-guidelines>\nnew guidelines\n</laravel-boost-guidelines>\n");

unlink($tempFile);
});