Adds rector and run it

Author: tonysm

rector.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\ValueObject\PhpVersion;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withPreparedSets(
+        deadCode: true,
+        codeQuality: true,
+        typeDeclarations: true,
+        privatization: true,
+        earlyReturn: true,
+    )
+    ->withAttributesSets()
+    ->withPhpSets()
+    ->withPhpVersion(PhpVersion::PHP_82);

src/Actions/FragmentByCanonicalizingAttachmentGalleries.php

@@ -15,20 +15,18 @@ class FragmentByCanonicalizingAttachmentGalleries
 {
     public function __invoke($content, callable $next)
     {
-        return $next($this->fragmentByReplacingAttachmentGalleryNodes($content, function (DOMElement $node) {
-            return HtmlConversion::document(sprintf(
-                '<%s>%s</%s>',
-                AttachmentGallery::TAG_NAME,
-                $this->getInnerHtmlOfNode($node),
-                AttachmentGallery::TAG_NAME,
-            ));
-        }));
+        return $next($this->fragmentByReplacingAttachmentGalleryNodes($content, fn(DOMElement $node): \DOMDocument => HtmlConversion::document(sprintf(
+            '<%s>%s</%s>',
+            AttachmentGallery::TAG_NAME,
+            $this->getInnerHtmlOfNode($node),
+            AttachmentGallery::TAG_NAME,
+        ))));
     }
 
-    public function fragmentByReplacingAttachmentGalleryNodes($content, callable $callback): Fragment
+    public function fragmentByReplacingAttachmentGalleryNodes(string|\Tonysm\RichTextLaravel\Fragment|\DOMDocument $content, callable $callback): Fragment
     {
-        return Fragment::wrap($content)->update(function (DOMDocument $source) use ($callback) {
-            $this->findAttachmentGalleryNodes($source)->each(function (DOMElement $node) use ($source, $callback) {
+        return Fragment::wrap($content)->update(function (DOMDocument $source) use ($callback): \DOMDocument {
+            $this->findAttachmentGalleryNodes($source)->each(function (DOMElement $node) use ($source, $callback): void {
                 // The fragment is wrapped with a rich-text-root tag, so we need
                 // to dig a bit deeper to get to the attachment gallery.
 
@@ -43,11 +41,11 @@ public function fragmentByReplacingAttachmentGalleryNodes($content, callable $ca
         });
     }
 
-    public function findAttachmentGalleryNodes($content): Collection
+    public function findAttachmentGalleryNodes(string|\Tonysm\RichTextLaravel\Fragment|\DOMDocument $content): Collection
     {
         return Fragment::wrap($content)
             ->findAll(AttachmentGallery::selector())
-            ->filter(function (DOMElement $node) {
+            ->filter(function (DOMElement $node): bool {
                 // We are only interested in DIVs that only contain rich-text-attachment
                 // tags. But they may contain empty texts as well, we can ignore them
                 // when converting the gallery attachments node objects later on.
@@ -83,6 +81,6 @@ private function galleryAttachmentNode(DOMNode $node): bool
     private function emptyTextNode(DOMNode $node): bool
     {
         return $node instanceof DOMText
-            && empty(trim($node->textContent));
+            && in_array(trim($node->textContent), ['', '0'], true);
     }
 }

src/AttachableFactory.php

@@ -12,23 +12,23 @@ class AttachableFactory
 {
     public static function fromNode(DOMElement $node): Attachables\AttachableContract
     {
-        if ($attachable = RichTextLaravel::attachableFromCustomResolver($node)) {
+        if (($attachable = RichTextLaravel::attachableFromCustomResolver($node)) instanceof \Tonysm\RichTextLaravel\Attachables\AttachableContract) {
             return $attachable;
         }
 
         if ($node->hasAttribute('sgid') && $attachable = static::attachableFromSgid($node->getAttribute('sgid'))) {
             return $attachable;
         }
 
-        if ($attachable = ContentAttachment::fromNode($node)) {
+        if (($attachable = ContentAttachment::fromNode($node)) instanceof \Tonysm\RichTextLaravel\Attachables\ContentAttachment) {
             return $attachable;
         }
 
-        if ($attachable = RemoteImage::fromNode($node)) {
+        if (($attachable = RemoteImage::fromNode($node)) instanceof \Tonysm\RichTextLaravel\Attachables\RemoteImage) {
             return $attachable;
         }
 
-        if ($attachable = RemoteFile::fromNode($node)) {
+        if (($attachable = RemoteFile::fromNode($node)) instanceof \Tonysm\RichTextLaravel\Attachables\RemoteFile) {
             return $attachable;
         }
 

src/Attachables/Attachable.php

@@ -20,12 +20,12 @@ public function richTextFilename(): ?string
         return null;
     }
 
-    public function richTextFilesize()
+    public function richTextFilesize(): null
     {
         return null;
     }
 
-    public function richTextMetadata(?string $key = null)
+    public function richTextMetadata(?string $key = null): null
     {
         return null;
     }

src/Attachables/ContentAttachment.php

@@ -20,7 +20,7 @@ public static function fromNode(DOMElement $node): ?static
         $contentType = $node->getAttribute('content-type');
         $content = trim($node->getAttribute('content'));
 
-        if (str_contains($contentType, 'html') && ! empty($content)) {
+        if (str_contains($contentType, 'html') && ($content !== '' && $content !== '0')) {
             return new static($contentType, $content);
         }
     }

src/Attachables/RemoteFile.php

@@ -97,7 +97,7 @@ public function richTextRender(array $options = []): string
 
     public function richTextAsPlainText($caption = null): string
     {
-        return __(sprintf('[%s]', $caption ?: $this->filename ?: 'File'));
+        return __(sprintf('[%s]', ($caption ?: $this->filename) ?: 'File'));
     }
 
     public function extension(): string

src/Attachment.php

@@ -9,7 +9,7 @@
 use Tonysm\RichTextLaravel\Attachables\AttachableContract;
 use Tonysm\RichTextLaravel\Attachments\TrixConvertion;
 
-class Attachment
+class Attachment implements \Stringable
 {
     use ForwardsCalls;
     use TrixConvertion;
@@ -34,7 +34,7 @@ public static function useTagName(string $tagName): void
 
     public static function fromAttachable(AttachableContract $attachable, array $attributes = []): ?static
     {
-        if ($node = static::nodeFromAttributes($attachable->toRichTextAttributes($attributes))) {
+        if (($node = static::nodeFromAttributes($attachable->toRichTextAttributes($attributes))) instanceof \DOMElement) {
             return new static($node, $attachable);
         }
 
@@ -49,18 +49,19 @@ public static function fromNode(DOMElement $node, ?AttachableContract $attachabl
     /**
      * @return null|static
      */
-    public static function fromAttributes(array $attributes = [], ?AttachableContract $attachable = null)
+    public static function fromAttributes(array $attributes = [], ?AttachableContract $attachable = null): ?self
     {
-        if ($node = static::nodeFromAttributes($attributes)) {
+        if (($node = static::nodeFromAttributes($attributes)) instanceof \DOMElement) {
             return static::fromNode($node, $attachable);
         }
+        return null;
     }
 
     public static function nodeFromAttributes(array $attributes = []): ?DOMElement
     {
         $attributes = static::processAttributes($attributes);
 
-        if (empty($attributes)) {
+        if ($attributes === []) {
             return null;
         }
 
@@ -141,7 +142,7 @@ public function is(Attachment $attachment): bool
         return $this->attachable->equalsToAttachable($attachment->attachable);
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return $this->toHtml();
     }

src/Attachments/Minification.php

@@ -10,8 +10,6 @@ trait Minification
 {
     public static function fragmentByMinifyingAttachments($content)
     {
-        return Fragment::wrap($content)->replace(Attachment::$TAG_NAME, function (DOMElement $node) {
-            return $node->cloneNode(deep: false);
-        });
+        return Fragment::wrap($content)->replace(Attachment::$TAG_NAME, fn(DOMElement $node): \DOMElement => $node->cloneNode(deep: false));
     }
 }

src/Attachments/TrixConvertion.php

@@ -10,24 +10,20 @@ trait TrixConvertion
 {
     public static function fragmentByConvertingTrixAttachments($content)
     {
-        return Fragment::wrap($content)->replace(TrixAttachment::$SELECTOR, function (DOMElement $node) {
-            return static::fromTrixAttachment(new TrixAttachment($node));
-        });
+        return Fragment::wrap($content)->replace(TrixAttachment::$SELECTOR, fn(DOMElement $node) => static::fromTrixAttachment(new TrixAttachment($node)));
     }
 
     public static function fragmentByConvertingTrixContent($content)
     {
-        return Fragment::wrap($content)->replace(TrixAttachment::$SELECTOR, function (DOMElement $node) {
-            return static::fromTrixAttachment(new TrixAttachment($node));
-        });
+        return Fragment::wrap($content)->replace(TrixAttachment::$SELECTOR, fn(DOMElement $node) => static::fromTrixAttachment(new TrixAttachment($node)));
     }
 
     public static function fromTrixAttachment(TrixAttachment $attachment)
     {
         return static::fromAttributes($attachment->attributes());
     }
 
-    public function toTrixAttachment($content = null)
+    public function toTrixAttachment($content = null): \Tonysm\RichTextLaravel\TrixAttachment
     {
         /** @psalm-suppress UndefinedThisPropertyFetch */
         if (! $content && method_exists($this->attachable, 'toTrixContent')) {

src/Commands/InstallCommand.php

@@ -21,7 +21,7 @@ class InstallCommand extends Command
 
     public $description = 'Installs the package.';
 
-    public function handle()
+    public function handle(): int
     {
         if (! $this->option('no-model')) {
             $this->publishMigration();
@@ -39,7 +39,7 @@ public function handle()
         return self::SUCCESS;
     }
 
-    private function publishMigration()
+    private function publishMigration(): void
     {
         FacadesProcess::forever()->run([
             $this->phpBinary(),
@@ -50,7 +50,7 @@ private function publishMigration()
         ], fn ($_type, $output) => $this->output->write($output));
     }
 
-    private function updateJsDependencies()
+    private function updateJsDependencies(): void
     {
         if ($this->usingImportmaps()) {
             $this->installJsDependenciesWithImportmaps();
@@ -59,7 +59,7 @@ private function updateJsDependencies()
         }
     }
 
-    private function runDatabaseMigrations()
+    private function runDatabaseMigrations(): void
     {
         if (! $this->confirm('A new migration was published to your app. Do you want to run it now?', true)) {
             return;
@@ -99,9 +99,7 @@ private function jsDependencies(): array
 
     private function updateJsDependenciesWithNpm(): void
     {
-        $this->updateNodePackages(function ($packages) {
-            return $this->jsDependencies() + $packages;
-        });
+        static::updateNodePackages(fn($packages): array => $this->jsDependencies() + $packages);
 
         if (file_exists(base_path('pnpm-lock.yaml'))) {
             $this->runCommands(['pnpm install', 'pnpm run build']);
@@ -112,7 +110,7 @@ private function updateJsDependenciesWithNpm(): void
         }
     }
 
-    private function runCommands($commands)
+    private function runCommands(array $commands): void
     {
         $process = Process::fromShellCommandline(implode(' && ', $commands), null, null, null, null);
 
@@ -124,7 +122,7 @@ private function runCommands($commands)
             }
         }
 
-        $process->run(function ($type, $line) {
+        $process->run(function ($type, string $line): void {
             $this->output->write('    '.$line);
         });
     }
@@ -154,7 +152,7 @@ private function ensureTrixLibIsImported(): void
         $entrypoint = Arr::first([
             resource_path('js/libs/index.js'),
             resource_path('js/app.js'),
-        ], fn ($file) => file_exists($file));
+        ], fn ($file): bool => file_exists($file));
 
         if (! $entrypoint) {
             return;
@@ -188,7 +186,7 @@ private function updateAppLayoutFiles(): void
             return;
         }
 
-        $layouts->each(function ($file) {
+        $layouts->each(function ($file): void {
             $contents = File::get($file);
 
             if (str_contains($contents, '<x-rich-text::styles')) {
@@ -235,7 +233,7 @@ protected static function updateNodePackages(callable $callback, $dev = true)
         );
     }
 
-    private function phpBinary()
+    private function phpBinary(): string
     {
         return (new PhpExecutableFinder)->find(false) ?: 'php';
     }