Refactor

composer-require-checker.json

@@ -1,5 +1,6 @@
 {
   "symbol-whitelist": [
+    "XMLWriter",
     "Composer\\ClassMapGenerator\\ClassMapGenerator",
     "Composer\\InstalledVersions",
     "Faker\\Factory",

composer.json

@@ -62,7 +62,7 @@
     "illuminate/translation": "^11.0.8",
     "illuminate/validation": "^11.0.8",
     "larastan/larastan": "^2.8.1",
-    "league/commonmark": "^2.5.1",
+    "league/commonmark": "^2.6.0",
     "league/config": "^1.1.1",
     "mockery/mockery": "^1.6.5",
     "nette/neon": "^3.4",
@@ -92,6 +92,7 @@
     "webonyx/graphql-php": "^15.4.0"
   },
   "require-dev": {
+    "ext-xmlwriter": "*",
     "ext-pdo_sqlite": "*",
     "bamarni/composer-bin-plugin": "^1.8",
     "composer/class-map-generator": "^1.0",
@@ -135,6 +136,7 @@
       "packages/graphql-printer/docs/",
       "packages/graphql/docs/",
       "packages/migrator/docs/",
+      "packages/migrator/src/Migrations/MigratorTest/raw/",
       "packages/serializer/docs/",
       "packages/spa/docs/",
       "packages/testing/docs/"

packages/documentator/composer.json

@@ -27,7 +27,7 @@
     "illuminate/console": "^11.0.8",
     "illuminate/process": "^11.0.8",
     "illuminate/support": "^11.0.8",
-    "league/commonmark": "^2.5.1",
+    "league/commonmark": "^2.6.0",
     "league/config": "^1.1.1",
     "nikic/php-parser": "^5.0",
     "phpstan/phpdoc-parser": "^1.25",
@@ -43,6 +43,7 @@
     "lastdragon-ru/lara-asp-serializer": "self.version"
   },
   "require-dev": {
+    "ext-xmlwriter": "*",
     "lastdragon-ru/lara-asp-testing": "self.version",
     "mockery/mockery": "^1.6.5",
     "orchestra/testbench": "^9.0.0",

packages/documentator/src/Commands/Commands.php

@@ -6,7 +6,7 @@
 use Illuminate\Support\Str;
 use LastDragon_ru\LaraASP\Core\Path\DirectoryPath;
 use LastDragon_ru\LaraASP\Core\Utils\Cast;
-use LastDragon_ru\LaraASP\Documentator\Markdown\Document;
+use LastDragon_ru\LaraASP\Documentator\Markdown\Contracts\Markdown;
 use LastDragon_ru\LaraASP\Documentator\Markdown\Mutations\Document\Move;
 use LastDragon_ru\LaraASP\Documentator\Package;
 use LastDragon_ru\LaraASP\Documentator\PackageViewer;
@@ -36,7 +36,12 @@ class Commands extends Command {
         {--defaults : Include application default arguments/options like `--help`, etc.}
     SIGNATURE;
 
-    public function __invoke(PackageViewer $viewer, Filesystem $filesystem, ArtisanSerializer $serializer): void {
+    public function __invoke(
+        PackageViewer $viewer,
+        Filesystem $filesystem,
+        Markdown $markdown,
+        ArtisanSerializer $serializer,
+    ): void {
         // Options
         $application = Cast::to(Application::class, $this->getApplication());
         $namespace   = $application->findNamespace(Cast::toString($this->argument('namespace')));
@@ -68,6 +73,7 @@ static function () use ($filesystem, $target): void {
             $this->components->task(
                 "Command: {$command->getName()}",
                 static function () use (
+                    $markdown,
                     $filesystem,
                     $serializer,
                     $viewer,
@@ -94,7 +100,7 @@ static function () use (
                         'serializer' => $serializer,
                         'command'    => $command,
                     ]);
-                    $content = (string) (new Document($content, $source))->mutate(
+                    $content = (string) $markdown->parse($content, $source)->mutate(
                         new Move($path),
                     );
 

packages/documentator/src/Commands/Preprocess.php

@@ -333,7 +333,13 @@ private function getDocBlock(
     ): string {
         // Load
         $this->phpDocumentFactory ??= $this->laravel->make(PhpDocumentFactory::class);
-        $help                       = ($this->phpDocumentFactory)($object);
+        $phpdoc                     = new PhpDoc((string) $object->getDocComment());
+        $path                       = match (true) {
+            $object instanceof ReflectionProperty => $object->getDeclaringClass()->getFileName(),
+            default                               => $object->getFileName(),
+        };
+        $path = $path !== false ? new FilePath($path) : null;
+        $help = ($this->phpDocumentFactory)($phpdoc, $path);
 
         // Move to cwd
         $cwd  = new DirectoryPath((string) getcwd());

packages/documentator/src/Markdown/Location/Coordinate.php → packages/documentator/src/Editor/Coordinate.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Markdown\Location;
+namespace LastDragon_ru\LaraASP\Documentator\Editor;
 
 readonly class Coordinate {
     public function __construct(

packages/documentator/src/Markdown/Editor.php → packages/documentator/src/Editor/Editor.php

@@ -1,9 +1,7 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Markdown;
+namespace LastDragon_ru\LaraASP\Documentator\Editor;
 
-use LastDragon_ru\LaraASP\Documentator\Markdown\Location\Coordinate;
-use LastDragon_ru\LaraASP\Documentator\Markdown\Location\Location;
 use LastDragon_ru\LaraASP\Documentator\Utils\Text;
 use Override;
 use Stringable;
@@ -16,53 +14,47 @@
 use function array_values;
 use function count;
 use function implode;
+use function is_string;
 use function mb_substr;
 use function rtrim;
 use function usort;
 
 use const PHP_INT_MAX;
 
 /**
- * @internal
+ * @readonly Waiting for no PHP 8.2 (https://github.com/LastDragon-ru/lara-asp/issues/190)
  */
 class Editor implements Stringable {
-    public function __construct(
-        /**
-         * @var list<string>
-         */
-        private array $lines,
-        private int $offset = 0,
+    /**
+     * @var list<string>
+     */
+    protected readonly array $lines;
+
+    /**
+     * @param list<string>|string $content
+     */
+    final public function __construct(
+        array|string $content,
+        protected readonly int $startLine = 0,
+        protected readonly string $endOfLine = "\n",
     ) {
-        // empty
+        $this->lines = is_string($content) ? Text::getLines($content) : $content;
     }
 
     #[Override]
     public function __toString(): string {
-        return implode("\n", $this->lines);
+        return implode($this->endOfLine, $this->lines);
     }
 
     /**
-     * @return list<string>
+     * @param iterable<array-key, Coordinate> $location
      */
-    public function getLines(): array {
-        return $this->lines;
-    }
-
-    public function getOffset(): int {
-        return $this->offset;
-    }
-
-    public function getText(Location|Coordinate $location): ?string {
-        // Coordinate?
-        if ($location instanceof Coordinate) {
-            $location = [$location];
-        }
-
+    public function getText(iterable $location): ?string {
         // Select
         $selected = null;
 
         foreach ($location as $coordinate) {
-            $number = $coordinate->line - $this->offset;
+            $number = $coordinate->line - $this->startLine;
 
             if (isset($this->lines[$number])) {
                 $selected[] = mb_substr($this->lines[$number], $coordinate->offset, $coordinate->length);
@@ -77,11 +69,11 @@ public function getText(Location|Coordinate $location): ?string {
         }
 
         // Return
-        return implode("\n", $selected);
+        return implode($this->endOfLine, $selected);
     }
 
     /**
-     * @param iterable<array-key, array{Location, ?string}> $changes
+     * @param iterable<array-key, array{iterable<array-key, Coordinate>, ?string}> $changes
      *
      * @return new<static>
      */
@@ -100,7 +92,7 @@ public function mutate(iterable $changes): static {
             }
 
             // Change
-            $number  = $coordinate->line - $this->offset;
+            $number  = $coordinate->line - $this->startLine;
             $line    = $lines[$number] ?? '';
             $count   = count($text);
             $prefix  = mb_substr($line, 0, $coordinate->offset);
@@ -131,14 +123,11 @@ public function mutate(iterable $changes): static {
         }
 
         // Return
-        $editor        = clone $this;
-        $editor->lines = array_values($lines);
-
-        return $editor;
+        return new static(array_values($lines), $this->startLine, $this->endOfLine);
     }
 
     /**
-     * @param iterable<array-key, array{Location, ?string}> $changes
+     * @param iterable<array-key, array{iterable<array-key, Coordinate>, ?string}> $changes
      *
      * @return list<array{list<Coordinate>, ?string}>
      */

packages/documentator/src/Markdown/EditorTest.php → packages/documentator/src/Editor/EditorTest.php

@@ -1,10 +1,9 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Markdown;
+namespace LastDragon_ru\LaraASP\Documentator\Editor;
 
-use LastDragon_ru\LaraASP\Documentator\Markdown\Location\Append;
-use LastDragon_ru\LaraASP\Documentator\Markdown\Location\Coordinate;
-use LastDragon_ru\LaraASP\Documentator\Markdown\Location\Location;
+use LastDragon_ru\LaraASP\Documentator\Editor\Locations\Append;
+use LastDragon_ru\LaraASP\Documentator\Editor\Locations\Location;
 use LastDragon_ru\LaraASP\Documentator\Testing\Package\TestCase;
 use Override;
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -20,7 +19,7 @@
 #[CoversClass(Editor::class)]
 final class EditorTest extends TestCase {
     public function testMutate(): void {
-        $lines    = [
+        $lines   = [
             0  => 'a b c d',
             1  => 'e f g h',
             2  => 'i j k l',
@@ -38,8 +37,7 @@ public function testMutate(): void {
             14 => '>',
             15 => '>',
         ];
-        $editor   = new Editor($lines, 1);
-        $changes  = [
+        $changes = [
             [new Location(1, 1, 2, 3), "123\n345\n567"],
             [new Location(2, 4, 4, 4), '123'],
             [new Location(6, 8, 4, 4), "123\n345"],
@@ -49,6 +47,15 @@ public function testMutate(): void {
             [new Location(PHP_INT_MAX, PHP_INT_MAX), "added line a\n"],
             [new Location(PHP_INT_MAX, PHP_INT_MAX), "added line b\n"],
         ];
+        $editor  = new class($lines, 1) extends Editor {
+            /**
+             * @return list<string>
+             */
+            public function getLines(): array {
+                return $this->lines;
+            }
+        };
+
         $actual   = $editor->mutate($changes);
         $expected = [
             'a 123',
@@ -200,7 +207,7 @@ public function testGetText(): void {
             <<<'TEXT'
             f g
             TEXT,
-            $editor->getText(new Coordinate(2, 2, 3)),
+            $editor->getText([new Coordinate(2, 2, 3)]),
         );
     }
 }

packages/documentator/src/Markdown/Location/Append.php → packages/documentator/src/Editor/Locations/Append.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Markdown\Location;
+namespace LastDragon_ru\LaraASP\Documentator\Editor\Locations;
 
 use const PHP_INT_MAX;
 

packages/documentator/src/Markdown/Location/Location.php → packages/documentator/src/Editor/Locations/Location.php

@@ -1,8 +1,9 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Markdown\Location;
+namespace LastDragon_ru\LaraASP\Documentator\Editor\Locations;
 
 use IteratorAggregate;
+use LastDragon_ru\LaraASP\Documentator\Editor\Coordinate;
 use Override;
 use Traversable;
 

packages/documentator/src/Markdown/Location/LocationTest.php → packages/documentator/src/Editor/Locations/LocationTest.php

@@ -1,7 +1,8 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Markdown\Location;
+namespace LastDragon_ru\LaraASP\Documentator\Editor\Locations;
 
+use LastDragon_ru\LaraASP\Documentator\Editor\Coordinate;
 use LastDragon_ru\LaraASP\Documentator\Testing\Package\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 

packages/documentator/src/Markdown/Contracts/Markdown.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Documentator\Markdown\Contracts;
+
+use LastDragon_ru\LaraASP\Core\Path\FilePath;
+use LastDragon_ru\LaraASP\Documentator\Markdown\Document;
+
+interface Markdown {
+    public function parse(string $content, ?FilePath $path = null): Document;
+}

packages/documentator/src/Markdown/Contracts/Mutation.php

@@ -2,8 +2,8 @@
 
 namespace LastDragon_ru\LaraASP\Documentator\Markdown\Contracts;
 
+use LastDragon_ru\LaraASP\Documentator\Editor\Locations\Location;
 use LastDragon_ru\LaraASP\Documentator\Markdown\Document;
-use LastDragon_ru\LaraASP\Documentator\Markdown\Location\Location;
 
 interface Mutation {
     /**

packages/documentator/src/Markdown/Data/Data.php

@@ -17,7 +17,7 @@ final public function __construct(
         /**
          * @var T
          */
-        protected mixed $value,
+        public mixed $value,
     ) {
         // empty
     }

packages/documentator/src/Markdown/Data/Location.php

@@ -2,7 +2,7 @@
 
 namespace LastDragon_ru\LaraASP\Documentator\Markdown\Data;
 
-use LastDragon_ru\LaraASP\Documentator\Markdown\Location\Location as LocationContract;
+use LastDragon_ru\LaraASP\Documentator\Editor\Locations\Location as LocationContract;
 use LastDragon_ru\LaraASP\Documentator\Markdown\Utils;
 use League\CommonMark\Node\Block\AbstractBlock;
 use League\CommonMark\Node\Block\Document;