Improve rendering logic

Author: SerafimArts

composer.json

@@ -9,13 +9,11 @@
     "type": "project",
     "repositories": [
         {"type": "path", "url": "libs/content-renderer"},
-        {"type": "path", "url": "libs/markdown-info"},
         {"type": "path", "url": "libs/github"}
     ],
     "require": {
         "php": "^8.1",
         "local/github": "^1.0",
-        "local/markdown-info": "^1.0",
         "local/content-renderer": "^1.0",
         "beberlei/doctrineextensions": "^1.3",
         "doctrine/inflector": "^2.0",

composer.lock

@@ -13,6 +13,7 @@
         "php": "^8.1",
         "ext-simplexml": "*",
         "league/commonmark": "^2.3",
+        "scrivo/highlight.php": "^9.18.1.9",
         "spatie/commonmark-highlighter": "^3.0"
     },
     "autoload": {
@@ -30,12 +31,13 @@
         "psr-4": {
             "App\\ContentRenderer\\Tests\\": "tests"
         }
-    },"extra": {
-    "branch-alias": {
-        "dev-master": "1.x-dev",
-        "dev-main": "1.x-dev"
-    }
-},
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.x-dev",
+            "dev-main": "1.x-dev"
+        }
+    },
     "config": {
         "sort-packages": true
     },

libs/content-renderer/composer.json

@@ -13,8 +13,8 @@
 interface ContentRendererInterface
 {
     /**
-     * @param string $original
+     * @param string $markdown
      * @return ResultInterface
      */
-    public function render(string $original): ResultInterface;
+    public function render(string $markdown): ResultInterface;
 }

libs/content-renderer/src/ContentRendererInterface.php

@@ -28,40 +28,24 @@ class ContentRendererServiceProvider extends ServiceProvider
     public function register(): void
     {
         // Boot Default
-        $this->registerDefaultRenderer();
-
-        // Boot Factory
-        $this->app->singleton(Factory::class, function (Application $app) {
-            $factory = new Factory($app->make(ContentRendererInterface::class));
-
-            $factory->extend(Type::MENU, static function () use ($app) {
-                return new MenuRenderer($app->make(DispatcherInterface::class));
-            });
-
-            $factory->extend(Type::MENU_TRANSLATION, static function () use ($app) {
-                return new MenuTranslationRenderer($app->make(DispatcherInterface::class));
-            });
-
-            $factory->extend(Type::DOCUMENTATION, static function () use ($app) {
-                return new DocumentationRenderer($app->make(DispatcherInterface::class));
-            });
-
-            $factory->extend(Type::DOCUMENTATION_TRANSLATION, static function () use ($app) {
-                return new DocumentationTranslationRenderer($app->make(DispatcherInterface::class));
-            });
-
-            return $factory;
+        $this->app->singleton(DefaultRenderer::class);
+        $this->app->singleton(MenuRenderer::class);
+        $this->app->singleton(MenuTranslationRenderer::class);
+        $this->app->singleton(DocumentationRenderer::class);
+        $this->app->singleton(DocumentationTranslationRenderer::class);
+
+        $this->app->singleton(Factory::class, function (Application $app): Factory {
+            $default = $app->make(ContentRendererInterface::class);
+
+            return new Factory($default, value(static function () use ($app): iterable {
+                yield Type::MENU => $app->make(MenuRenderer::class);
+                yield Type::MENU_TRANSLATION => $app->make(MenuTranslationRenderer::class);
+                yield Type::DOCUMENTATION => $app->make(DocumentationRenderer::class);
+                yield Type::DOCUMENTATION_TRANSLATION => $app->make(DocumentationTranslationRenderer::class);
+            }));
         });
 
-        $this->app->alias(Factory::class, FactoryInterface::class);
-    }
-
-    /**
-     * @return void
-     */
-    private function registerDefaultRenderer(): void
-    {
-        $this->app->singleton(DefaultRenderer::class);
         $this->app->alias(DefaultRenderer::class, ContentRendererInterface::class);
+        $this->app->alias(Factory::class, FactoryInterface::class);
     }
 }

libs/content-renderer/src/ContentRendererServiceProvider.php

@@ -16,47 +16,22 @@
  */
 final class Factory implements FactoryInterface
 {
-    /**
-     * @var array<non-empty-string, RendererResolver>
-     */
-    private array $registered = [];
-
     /**
      * @var array<non-empty-string, ContentRendererInterface>
      */
-    private array $resolved = [];
+    private array $renderers = [];
 
     /**
      * @param ContentRendererInterface $default
+     * @param iterable<Type, ContentRendererInterface> $renderers
      */
     public function __construct(
         private readonly ContentRendererInterface $default,
+        iterable $renderers = [],
     ) {
-    }
-
-    /**
-     * @param Type $type
-     * @param RendererResolver $resolver
-     * @return $this
-     */
-    public function extend(Type $type, callable $resolver): self
-    {
-        $this->registered[$type->name] = $resolver;
-
-        return $this;
-    }
-
-    /**
-     * @param Type|null $type
-     * @return ContentRendererInterface
-     */
-    private function resolve(?Type $type): ContentRendererInterface
-    {
-        if (isset($this->registered[$type->name])) {
-            return $this->registered[$type->name]();
+        foreach ($renderers as $type => $renderer) {
+            $this->renderers[$type->name] = $renderer;
         }
-
-        return $this->default;
     }
 
     /**
@@ -68,6 +43,6 @@ public function create(Type $type = null): ContentRendererInterface
             return $this->default;
         }
 
-        return $this->resolved[$type->name] ??= $this->resolve($type);
+        return $this->renderers[$type->name] ??= $this->default;
     }
 }

libs/content-renderer/src/Event/Rendered.php

@@ -11,8 +11,6 @@
 
 namespace App\ContentRenderer;
 
-use App\ContentRenderer\ContentRendererInterface;
-
 interface FactoryInterface
 {
     /**

libs/content-renderer/src/Event/Rendering.php

@@ -11,6 +11,6 @@
 
 namespace App\ContentRenderer\Renderer;
 
-class DefaultRenderer extends Renderer
+final class DefaultRenderer extends Renderer
 {
 }

libs/content-renderer/src/Factory.php

@@ -16,24 +16,17 @@
 use App\ContentRenderer\Extension\QuotesFormatter;
 use App\ContentRenderer\Extension\RemoveEmptyParagraphs;
 use App\ContentRenderer\Extension\RemoveStyleTags;
-use Illuminate\Contracts\Events\Dispatcher;
-use League\CommonMark\Util\HtmlFilter;
 use League\CommonMark\Extension\CommonMark\Node\Block\FencedCode;
 use League\CommonMark\Extension\CommonMark\Node\Block\IndentedCode;
+use League\CommonMark\Util\HtmlFilter;
 use Spatie\CommonMarkHighlighter\FencedCodeRenderer;
 use Spatie\CommonMarkHighlighter\IndentedCodeRenderer;
 
 class DocumentationRenderer extends Renderer
 {
-    /**
-     * @param Dispatcher $dispatcher
-     */
-    public function __construct(
-        Dispatcher $dispatcher,
-    ) {
-        parent::__construct($dispatcher, [
-            'html_input' => HtmlFilter::ALLOW,
-        ]);
+    public function __construct()
+    {
+        parent::__construct(['html_input' => HtmlFilter::ALLOW]);
 
         $this->env->addExtension(new ImportHeaderClasses());
         $this->env->addExtension(new QuotesFormatter());

libs/content-renderer/src/FactoryInterface.php

@@ -12,17 +12,12 @@
 namespace App\ContentRenderer\Renderer;
 
 use App\ContentRenderer\Extension\RemoveCommitRelation;
-use Illuminate\Contracts\Events\Dispatcher;
 
-class DocumentationTranslationRenderer extends DocumentationRenderer
+final class DocumentationTranslationRenderer extends DocumentationRenderer
 {
-    /**
-     * @param Dispatcher $dispatcher
-     */
-    public function __construct(
-        Dispatcher $dispatcher,
-    ) {
-        parent::__construct($dispatcher);
+    public function __construct()
+    {
+        parent::__construct();
 
         $this->env->addExtension(new RemoveCommitRelation());
     }

libs/content-renderer/src/Renderer/DefaultRenderer.php

@@ -17,14 +17,10 @@
 
 class MenuRenderer extends Renderer
 {
-    /**
-     * @param Dispatcher $dispatcher
-     */
-    public function __construct(
-        Dispatcher $dispatcher,
-    ) {
-        parent::__construct($dispatcher);
-
+    public function __construct() 
+    {
+        parent::__construct();
+        
         $this->env->addExtension(new MenuTitlesNormalizer());
         $this->env->addExtension(new ExternalLinks(['/api'], 'https://laravel.com', 'external-link'));
     }