Extractor: keeps the first comment in the method [Closes #119]

nette · Nov 2, 2022 · 6436c65 · 6436c65
1 parent f5299fb
commit 6436c65
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 2 deletions.
diff --git a/src/PhpGenerator/Extractor.php b/src/PhpGenerator/Extractor.php
@@ -108,7 +108,7 @@ private function getReformattedContents(array $nodes, int $level): string
 	 */
 	private function prepareReplacements(array $nodes): array
 	{
-		$start = $nodes[0]->getStartFilePos();
+		$start = $this->getNodeStartPos($nodes[0]);
 		$replacements = [];
 		(new NodeFinder)->find($nodes, function (Node $node) use (&$replacements, $start) {
 			if ($node instanceof Node\Name\FullyQualified) {
@@ -430,7 +430,15 @@ private function toPhp(mixed $value): string
 
 	private function getNodeContents(Node ...$nodes): string
 	{
-		$start = $nodes[0]->getStartFilePos();
+		$start = $this->getNodeStartPos($nodes[0]);
 		return substr($this->code, $start, end($nodes)->getEndFilePos() - $start + 1);
 	}
+
+
+	private function getNodeStartPos(Node $node): int
+	{
+		return ($comments = $node->getComments())
+			? $comments[0]->getStartFilePos()
+			: $node->getStartFilePos();
+	}
 }
diff --git a/tests/PhpGenerator/expected/ClassType.from.bodies.expect b/tests/PhpGenerator/expected/ClassType.from.bodies.expect
@@ -27,6 +27,7 @@ abstract class Class7
 
 	public function long()
 	{
+		// comment
 		if ($member instanceof Method) {
 			$s = [1, 2, 3];
 		}
@@ -39,6 +40,7 @@ abstract class Class7
 
 	public function resolving($a = Abc\a\FOO, self $b = null, $c = self::FOO)
 	{
+		// constants
 		echo FOO;
 		echo \FOO;
 		echo a\FOO;

diff --git a/tests/PhpGenerator/expected/Extractor.bodies.expect b/tests/PhpGenerator/expected/Extractor.bodies.expect
@@ -37,6 +37,7 @@ abstract class Class7
 
 	function long()
 	{
+		// comment
 		if ($member instanceof Method) {
 			$s = [1, 2, 3];
 		}
@@ -49,6 +50,7 @@ abstract class Class7
 
 	function resolving($a = a\FOO, self $b = null, $c = self::FOO)
 	{
+		// constants
 		echo FOO;
 		echo \FOO;
 		echo a\FOO;

diff --git a/tests/PhpGenerator/expected/Extractor.bodies.resolving.expect b/tests/PhpGenerator/expected/Extractor.bodies.resolving.expect
@@ -32,6 +32,7 @@ abstract class Class7
 
 	function long()
 	{
+		// comment
 		if ($member instanceof \Abc\Method) {
 			$s = [1, 2, 3];
 		}
@@ -44,6 +45,7 @@ abstract class Class7
 
 	function resolving($a = \Abc\a\FOO, self $b = null, $c = self::FOO)
 	{
+		// constants
 		echo FOO;
 		echo \FOO;
 		echo \Abc\a\FOO;

diff --git a/tests/PhpGenerator/expected/Extractor.bodies.unresolving.expect b/tests/PhpGenerator/expected/Extractor.bodies.unresolving.expect
@@ -32,6 +32,7 @@ abstract class Class7
 
 	function long()
 	{
+		// comment
 		if ($member instanceof \Abc\Method) {
 			$s = [1, 2, 3];
 		}
@@ -44,6 +45,7 @@ abstract class Class7
 
 	function resolving($a = \Abc\a\FOO, self $b = null, $c = self::FOO)
 	{
+		// constants
 		echo FOO;
 		echo \FOO;
 		echo \Abc\a\FOO;

diff --git a/tests/PhpGenerator/expected/Extractor.expect b/tests/PhpGenerator/expected/Extractor.expect
@@ -9,6 +9,27 @@ class Class1
 			}
 		};
 	}
+
+
+	function comment1()
+	{
+		/** comment */
+		$a = 10;
+	}
+
+
+	function comment2()
+	{
+		// comment
+		"bar";
+	}
+
+
+	function comment3()
+	{
+		// comment
+		Foo\Bar::XX;
+	}
 }
 
 /**

diff --git a/tests/PhpGenerator/fixtures/extractor.php b/tests/PhpGenerator/fixtures/extractor.php
@@ -8,6 +8,24 @@ function bar() {
 			}
 		};
 	}
+
+	function comment1()
+	{
+		/** comment */
+		$a = 10;
+	}
+
+	function comment2()
+	{
+		// comment
+		'bar';
+	}
+
+	function comment3()
+	{
+		// comment
+		Foo\Bar::XX;
+	}
 }
 
 function () {};