wip

Author: Illia Sakovich

README.md

@@ -1,11 +1,11 @@
-# Laravel Dynamic Renderer
+# Laravel Dynamic Rendering
 
 ## Installation
 
 You can install this package via composer using this command:
 
 ```bash
-composer require coderello/laravel-dynamic-renderer
+composer require coderello/laravel-dynamic-rendering
 ```
 
 The package will automatically register itself.

composer.json

@@ -1,6 +1,6 @@
 {
-    "name": "coderello/laravel-dynamic-renderer",
-    "description": "Dynamic renderer for your Laravel application.",
+    "name": "coderello/laravel-dynamic-rendering",
+    "description": "Dynamic rendering for your Laravel application.",
     "type": "library",
     "license": "MIT",
     "require": {
@@ -14,12 +14,12 @@
     },
     "autoload": {
         "psr-4": {
-            "Coderello\\DynamicRenderer\\": "src/"
+            "Coderello\\DynamicRendering\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Coderello\\DynamicRenderer\\Tests\\": "tests/"
+            "Coderello\\DynamicRendering\\Tests\\": "tests/"
         }
     },
     "scripts": {
@@ -28,7 +28,7 @@
     "extra": {
         "laravel": {
             "providers": [
-                "Coderello\\DynamicRenderer\\Providers\\DynamicRendererServiceProvider"
+                "Coderello\\DynamicRendering\\Providers\\DynamicRenderingServiceProvider"
             ]
         }
     }

config/dynamic-renderer.php

@@ -0,0 +1,44 @@
+<?php
+
+return [
+
+    /*
+     * Enable or disable the dynamic rendering.
+     */
+    'enabled' => env('DYNAMIC_RENDERING_ENABLED', true),
+
+    /*
+     * The driver which is used to render the pages dynamically.
+     *
+     * Available drivers: "prerender", "rendertron".
+     */
+    'default' => env('DYNAMIC_RENDERER', 'prerender'),
+
+    /*
+     * The list of rendering criteria which should be met to render
+     * the page dynamically.
+     */
+    'rendering_criteria' => [
+        \Coderello\DynamicRendering\RenderingCriteria\IsEnabled::class,
+        // \Coderello\DynamicRendering\RenderingCriteria\IsProduction::class,
+        \Coderello\DynamicRendering\RenderingCriteria\IsNotRenderer::class,
+        \Coderello\DynamicRendering\RenderingCriteria\IsCrawler::class,
+        \Coderello\DynamicRendering\RenderingCriteria\IsNotStaticFilePath::class,
+    ],
+
+    /**
+     * The list of renderers and their configurations.
+     */
+    'renderers' => [
+
+        'prerender' => [
+            'url' => env('PRERENDER_URL', 'http://localhost:3000'),
+        ],
+
+        'rendertron' => [
+            'url' => env('RENDERTRON_URL', 'http://localhost:3000'),
+        ],
+
+    ],
+
+];

config/dynamic-rendering.php

@@ -10,13 +10,13 @@ featherIcon: download
 You can install this package via composer using this command:
 
 ```bash
-composer require coderello/laravel-dynamic-renderer
+composer require coderello/laravel-dynamic-rendering
 ```
 
-To publish the config file to `config/dynamic-renderer.php` run:
+To publish the config file to `config/dynamic-rendering.php` run:
 
 ```bash
-php artisan vendor:publish --tag="dynamic-renderer-config"
+php artisan vendor:publish --tag="dynamic-rendering-config"
 ```
 
 ## Choosing the renderer

docs/installation.md

@@ -5,7 +5,7 @@ weight: 200
 featherIcon: info
 ---
 
-**Laravel Dynamic Renderer** totally solves the SEO issue for SPA (single page applications).
+**Laravel Dynamic Rendering** totally solves the SEO issue for SPA (single page applications).
 
 Under the hood, if the request was made by the search bot, the requested page of your SPA is being converted into the plain HTML using the renderer and returned to the robot.
 

docs/introduction.md

@@ -24,6 +24,6 @@ The default port is `3000`. Change the server port with `export PORT=3005` if ne
 All you have to do on the application side is to put these variables into the `.env` file.
 
 ```
-DYNAMIC_RENDERER_DRIVER=prerender
+DYNAMIC_RENDERER=prerender
 PRERENDER_URL=http://localhost:3000
 ```

docs/prerender.md

@@ -24,6 +24,6 @@ The default port is `3000`.
 All you have to do on the application side is to put these variables into the `.env` file.
 
 ```
-DYNAMIC_RENDERER_DRIVER=rendertron
+DYNAMIC_RENDERER=rendertron
 RENDERTRON_URL=http://localhost:3000
 ```

docs/rendertron.md

@@ -10,7 +10,7 @@
          processIsolation="false"
          stopOnFailure="false">
     <testsuites>
-        <testsuite name="Dynamic Renderer Test Suite">
+        <testsuite name="Dynamic Rendering Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>

phpunit.xml.dist

@@ -1,17 +1,17 @@
 <?php
 
-namespace Coderello\DynamicRenderer\Facades;
+namespace Coderello\DynamicRendering\Facades;
 
-use Coderello\DynamicRenderer\Managers\DynamicRendererManager;
-use Coderello\DynamicRenderer\Support\RenderingResult;
+use Coderello\DynamicRendering\Managers\DynamicRenderingManager;
+use Coderello\DynamicRendering\Support\RenderingResult;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Facade;
 
 /**
  * @method static RenderingResult render(string $url)
  * @method static bool isRendering(Request $request)
  *
- * @see DynamicRendererManager
+ * @see DynamicRenderingManager
  */
 class DynamicRenderer extends Facade
 {

src/Facades/DynamicRenderer.php

@@ -1,25 +1,20 @@
 <?php
 
-namespace Coderello\DynamicRenderer\Managers;
+namespace Coderello\DynamicRendering\Managers;
 
-use Coderello\DynamicRenderer\Renderers\PrerenderRenderer;
-use Coderello\DynamicRenderer\Renderers\Renderer;
-use Coderello\DynamicRenderer\Renderers\RendertronRenderer;
-use Coderello\DynamicRenderer\Support\RenderingResult;
+use Coderello\DynamicRendering\Renderers\PrerenderDynamicRenderer;
+use Coderello\DynamicRendering\Renderers\DynamicRenderer;
+use Coderello\DynamicRendering\Renderers\RendertronDynamicRenderer;
+use Coderello\DynamicRendering\Support\RenderingResult;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Manager;
 
-class DynamicRendererManager extends Manager implements Renderer
+class DynamicRendererManager extends Manager implements DynamicRenderer
 {
-    /**
-     * Get the default driver name.
-     *
-     * @return string
-     */
     public function getDefaultDriver(): string
     {
-        return $this->getConfigValue('dynamic-renderer.driver');
+        return $this->getConfigValue('dynamic-rendering.default');
     }
 
     private function getConfigValue(string $key, $default = null)
@@ -28,41 +23,37 @@ private function getConfigValue(string $key, $default = null)
         return Config::get($key, $default);
     }
 
-    public function createPrerenderDriver(): PrerenderRenderer
+    private function getRendererConfig(string $renderer): array
     {
-        return new PrerenderRenderer(
-            $this->getConfigValue('dynamic-renderer.prerender', [])
-        );
+        return $this->getConfigValue('dynamic-rendering.renderers.'.$renderer, []);
     }
 
-    public function createRendertronDriver(): RendertronRenderer
+    public function createPrerenderDriver(): PrerenderDynamicRenderer
     {
-        return new RendertronRenderer(
-            $this->getConfigValue('dynamic-renderer.rendertron', [])
+        return new PrerenderDynamicRenderer(
+            $this->getRendererConfig('prerender')
         );
     }
 
-    public function render(string $url): RenderingResult
+    public function createRendertronDriver(): RendertronDynamicRenderer
     {
-        /** @var Renderer $driver */
-        $driver = $this->driver();
-
-        return $driver->render($url);
+        return new RendertronDynamicRenderer(
+            $this->getRendererConfig('rendertron')
+        );
     }
 
-    public function getUserAgentPatterns(): array
+    public function render(string $url): RenderingResult
     {
-        /** @var Renderer $driver */
-        $driver = $this->driver();
-
-        return $driver->getUserAgentPatterns();
+        return $this->driver()->render($url);
     }
 
     public function isRendering(Request $request): bool
     {
-        /** @var Renderer $driver */
-        $driver = $this->driver();
+        return $this->driver()->isRendering($request);
+    }
 
-        return $driver->isRendering($request);
+    public function driver($driver = null): DynamicRenderer
+    {
+        return parent::driver($driver);
     }
 }

src/Managers/DynamicRendererManager.php

@@ -1,16 +1,16 @@
 <?php
 
-namespace Coderello\DynamicRenderer\Middleware;
+namespace Coderello\DynamicRendering\Middleware;
 
 use Closure;
-use Coderello\DynamicRenderer\Facades\DynamicRenderer;
-use Coderello\DynamicRenderer\Renderers\Renderer;
-use Coderello\DynamicRenderer\Support\RenderingCriteriaChecker;
+use Coderello\DynamicRendering\Facades\DynamicRenderer;
+use Coderello\DynamicRendering\Renderers\DynamicRenderer;
+use Coderello\DynamicRendering\Support\RenderingCriteriaChecker;
 use Illuminate\Contracts\Container\Container;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 
-class DynamicRendererMiddleware
+class DynamicRenderingMiddleware
 {
     public function handle(Request $request, Closure $next)
     {

src/Middleware/DynamicRendererMiddleware.php src/Middleware/DynamicRenderingMiddleware.php

@@ -1,14 +1,14 @@
 <?php
 
-namespace Coderello\DynamicRenderer\Providers;
+namespace Coderello\DynamicRendering\Providers;
 
-use Coderello\DynamicRenderer\Managers\DynamicRendererManager;
-use Coderello\DynamicRenderer\Middleware\DynamicRendererMiddleware;
-use Coderello\DynamicRenderer\Renderers\Renderer;
+use Coderello\DynamicRendering\Managers\DynamicRendererManager;
+use Coderello\DynamicRendering\Middleware\DynamicRenderingMiddleware;
+use Coderello\DynamicRendering\Renderers\DynamicRenderer;
 use Illuminate\Contracts\Http\Kernel;
 use Illuminate\Support\ServiceProvider;
 
-class DynamicRendererServiceProvider extends ServiceProvider
+class DynamicRenderingServiceProvider extends ServiceProvider
 {
     /**
      * Bootstrap shared data service.
@@ -37,15 +37,15 @@ public function register()
     protected function registerPublishing()
     {
         $this->publishes([
-            __DIR__ . '/../../config/dynamic-renderer.php' => config_path('dynamic-renderer.php'),
-        ], 'dynamic-renderer-config');
+            __DIR__ . '/../../config/dynamic-rendering.php' => config_path('dynamic-rendering.php'),
+        ], 'dynamic-rendering-config');
     }
 
     protected function registerConfig()
     {
         $this->mergeConfigFrom(
-            __DIR__ . '/../../config/dynamic-renderer.php',
-            'dynamic-renderer'
+            __DIR__ . '/../../config/dynamic-rendering.php',
+            'dynamic-rendering'
         );
     }
 
@@ -61,6 +61,6 @@ protected function registerMiddleware()
         /** @var Kernel $kernel */
         $kernel = $this->app[Kernel::class];
 
-        $kernel->pushMiddleware(DynamicRendererMiddleware::class);
+        $kernel->pushMiddleware(DynamicRenderingMiddleware::class);
     }
 }

src/Providers/DynamicRendererServiceProvider.php src/Providers/DynamicRenderingServiceProvider.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace Coderello\DynamicRenderer\Renderers;
+namespace Coderello\DynamicRendering\Renderers;
 
-use Coderello\DynamicRenderer\Support\RenderingResult;
+use Coderello\DynamicRendering\Support\RenderingResult;
 use Illuminate\Http\Request;
 
-interface Renderer
+interface DynamicRenderer
 {
     public function render(string $url): RenderingResult;
 

src/Renderers/Renderer.php src/Renderers/DynamicRenderer.php

@@ -1,14 +1,14 @@
 <?php
 
-namespace Coderello\DynamicRenderer\Renderers;
+namespace Coderello\DynamicRendering\Renderers;
 
-use Coderello\DynamicRenderer\Support\RenderingResult;
+use Coderello\DynamicRendering\Support\RenderingResult;
 use GuzzleHttp\Client;
 use GuzzleHttp\RequestOptions;
 use Illuminate\Http\Request;
 use Illuminate\Support\Str;
 
-class PrerenderRenderer implements Renderer
+class PrerenderDynamicRenderer implements DynamicRenderer
 {
     /**
      * @var string|null
@@ -35,6 +35,6 @@ public function render(string $url): RenderingResult
 
     public function isRendering(Request $request): bool
     {
-        return Str::is('*Prerender*', $request->userAgent());
+        return Str::contains($request->userAgent(), 'Prerender');
     }
 }