bug #1476 [ysm] handle linebreak followed by an immediate root-level comment

jrushlow · web-flow · commit 07614b59348f · 2024-03-28T13:00:20.000-04:00
diff --git a/src/Util/YamlSourceManipulator.php b/src/Util/YamlSourceManipulator.php
@@ -915,6 +915,12 @@ private function advanceCurrentPosition(int $newPosition): void
             return;
         }
 
+        if (str_starts_with($advancedContent, "\n#") || str_starts_with($advancedContent, "\r\n#")) {
+            $this->log('A linebreak followed by a root-level comment, no indent changes');
+
+            return;
+        }
+
         if (str_contains($advancedContent, "\n")) {
             $lines = explode("\n", $advancedContent);
             if (!empty($lines)) {
diff --git a/tests/Util/YamlSourceManipulatorTest.php b/tests/Util/YamlSourceManipulatorTest.php
@@ -48,7 +48,7 @@ public function testSetData(string $startingSource, array $newData, string $expe
         $this->assertSame($expectedSource, $actualContents);
     }
 
-    private function getYamlDataTests()
+    private function getYamlDataTests(): \Generator
     {
         $finder = new Finder();
         $finder->in(__DIR__.'/yaml_fixtures')
@@ -82,14 +82,14 @@ private function getYamlDataTests()
          */
     }
 
-    public function getYamlDataTestsUnixSlashes()
+    public function getYamlDataTestsUnixSlashes(): \Generator
     {
         foreach ($this->getYamlDataTests() as $key => $data) {
             yield 'unix_'.$key => $data;
         }
     }
 
-    public function getYamlDataTestsWindowsSlashes()
+    public function getYamlDataTestsWindowsSlashes(): \Generator
     {
         foreach ($this->getYamlDataTests() as $key => $data) {
             $data['source'] = str_replace("\n", "\r\n", $data['source']);
diff --git a/tests/Util/yaml_fixtures/new_line_with_root_level_comment.test b/tests/Util/yaml_fixtures/new_line_with_root_level_comment.test
@@ -0,0 +1,13 @@
+security:
+  firewalls:
+#  main:
+===
+$data['security'] = [
+    'firewalls' => 'a firewall',
+    'providers' => 'a provider'
+];
+===
+security:
+  firewalls: 'a firewall'
+  providers: 'a provider'
+#  main:

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public function testSetData(string $startingSource, array $newData, string $expe`
`48`	`48`	`$this->assertSame($expectedSource, $actualContents);`
`49`	`49`	`}`
`50`	`50`
`51`		`- private function getYamlDataTests()`
	`51`	`+ private function getYamlDataTests(): \Generator`
`52`	`52`	`{`
`53`	`53`	`$finder = new Finder();`
`54`	`54`	`$finder->in(__DIR__.'/yaml_fixtures')`
`@@ -82,14 +82,14 @@ private function getYamlDataTests()`
`82`	`82`	`*/`
`83`	`83`	`}`
`84`	`84`
`85`		`- public function getYamlDataTestsUnixSlashes()`
	`85`	`+ public function getYamlDataTestsUnixSlashes(): \Generator`
`86`	`86`	`{`
`87`	`87`	`foreach ($this->getYamlDataTests() as $key => $data) {`
`88`	`88`	`yield 'unix_'.$key => $data;`
`89`	`89`	`}`
`90`	`90`	`}`
`91`	`91`
`92`		`- public function getYamlDataTestsWindowsSlashes()`
	`92`	`+ public function getYamlDataTestsWindowsSlashes(): \Generator`
`93`	`93`	`{`
`94`	`94`	`foreach ($this->getYamlDataTests() as $key => $data) {`
`95`	`95`	`$data['source'] = str_replace("\n", "\r\n", $data['source']);`