Add support for inline post processing (#20)

Add support for inline post processing

Author: PhiloNL

src/Blade/CodeComponent.php

@@ -5,9 +5,11 @@
 
 namespace Torchlight\Blade;
 
+use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 use Illuminate\View\Component;
 use Torchlight\Block;
+use Torchlight\PostProcessors\SimpleSwapProcessor;
 use Torchlight\Torchlight;
 
 class CodeComponent extends Component
@@ -30,13 +32,23 @@ class CodeComponent extends Component
      * @param  null  $contents
      * @param  null  $torchlightId
      */
-    public function __construct($language, $theme = null, $contents = null, $torchlightId = null)
+    public function __construct($language, $theme = null, $contents = null, $swap = null, $postProcessors = [], $torchlightId = null)
     {
         $this->language = $language;
         $this->theme = $theme;
         $this->contents = $contents;
 
         $this->block = Block::make($torchlightId)->language($this->language)->theme($this->theme);
+
+        $postProcessors = Arr::wrap($postProcessors);
+
+        if ($swap) {
+            $postProcessors[] = SimpleSwapProcessor::make($swap);
+        }
+
+        foreach ($postProcessors as $processor) {
+            $this->block->addPostProcessor($processor);
+        }
     }
 
     public function withAttributes(array $attributes)

src/Block.php

@@ -35,6 +35,13 @@ class Block
      */
     public $code;
 
+    /**
+     * The post processors.
+     *
+     * @var array
+     */
+    public $postProcessors = [];
+
     /**
      * The highlighted code, wrapped in pre+code tags.
      *
@@ -171,6 +178,19 @@ public function code($code)
         return $this;
     }
 
+    /**
+     * @param $processor
+     * @return $this
+     */
+    public function addPostProcessor($processor)
+    {
+        if ($processor) {
+            $this->postProcessors[] = Torchlight::validatedPostProcessor($processor);
+        }
+
+        return $this;
+    }
+
     /**
      * @param $wrapped
      * @return $this

src/Manager.php

@@ -109,20 +109,13 @@ public function overrideEnvironment($environment = null)
 
     /**
      * @param  array|string  $classes
-     *
-     * @throws ConfigurationException
      */
     public function addPostProcessors($classes)
     {
         $classes = Arr::wrap($classes);
 
         foreach ($classes as $class) {
-            if (!in_array(PostProcessor::class, class_implements($class))) {
-                $class = is_string($class) ? $class : get_class($class);
-                throw new ConfigurationException("Post-processor '$class' does not implement " . PostProcessor::class);
-            }
-
-            $this->postProcessors[] = $class;
+            $this->postProcessors[] = $this->validatedPostProcessor($class);
         }
     }
 
@@ -131,24 +124,27 @@ public function addPostProcessors($classes)
      */
     public function postProcessBlocks($blocks)
     {
+        // Global post-processors
         foreach ($this->postProcessors as $processor) {
-            $processor = app($processor);
-
-            // By default we do _not_ run post-processors when Laravel is compiling
-            // views, because it could lead to data leaks if a post-processor swaps
-            // user data in. If the developer understands this, they can turn
-            // `processEvenWhenCompiling` on and we'll happily run them.
-            $processWhenCompiling = property_exists($processor, 'processEvenWhenCompiling')
-                && $processor->processEvenWhenCompiling;
-
-            if ($this->currentlyCompilingViews && !$processWhenCompiling) {
+            if ($this->shouldSkipProcessor($processor)) {
                 continue;
             }
 
             foreach ($blocks as $block) {
                 $processor->process($block);
             }
         }
+
+        // Block specific post-processors
+        foreach ($blocks as $block) {
+            foreach ($block->postProcessors as $processor) {
+                if ($this->shouldSkipProcessor($processor)) {
+                    continue;
+                }
+
+                $processor->process($block);
+            }
+        }
     }
 
     public function processFileContents($file)
@@ -245,4 +241,36 @@ public function findTorchlightIds($content)
 
         return array_values(array_unique(Arr::get($matches, 1, [])));
     }
+
+    /**
+     * @param $processor
+     * @return PostProcessor
+     *
+     * @throws ConfigurationException
+     */
+    public function validatedPostProcessor($processor)
+    {
+        if (is_string($processor)) {
+            $processor = app($processor);
+        }
+
+        if (!in_array(PostProcessor::class, class_implements($processor))) {
+            $class = get_class($processor);
+            throw new ConfigurationException("Post-processor '$class' does not implement " . PostProcessor::class);
+        }
+
+        return $processor;
+    }
+
+    protected function shouldSkipProcessor($processor)
+    {
+        // By default we do _not_ run post-processors when Laravel is compiling
+        // views, because it could lead to data leaks if a post-processor swaps
+        // user data in. If the developer understands this, they can turn
+        // `processEvenWhenCompiling` on and we'll happily run them.
+        $processWhenCompiling = property_exists($processor, 'processEvenWhenCompiling')
+            && $processor->processEvenWhenCompiling;
+
+        return $this->currentlyCompilingViews && !$processWhenCompiling;
+    }
 }

src/PostProcessors/SimpleSwapProcessor.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * @author Aaron Francis <[email protected]|https://twitter.com/aarondfrancis>
+ */
+
+namespace Torchlight\PostProcessors;
+
+use Torchlight\Block;
+use Torchlight\Contracts\PostProcessor;
+
+class SimpleSwapProcessor implements PostProcessor
+{
+    public $swap = [];
+
+    public static function make($swap)
+    {
+        return new static($swap);
+    }
+
+    public function __construct($swap)
+    {
+        $this->swap = $swap;
+    }
+
+    public function process(Block $block)
+    {
+        $block->highlighted = str_replace(array_keys($this->swap), array_values($this->swap), $block->highlighted);
+    }
+}

tests/MiddlewareAndComponentTest.php

@@ -139,6 +139,40 @@ public function inline_keeps_its_spaces()
         );
     }
 
+    /** @test */
+    public function inline_swaps_run()
+    {
+        $this->fakeSuccessfulResponse('component', [
+            'classes' => 'torchlight',
+            'styles' => 'background-color: #292D3E;',
+            'highlighted' => 'echo "hello world"',
+        ]);
+
+        $response = $this->getView('an-inline-component-with-swaps.blade.php');
+
+        $this->assertEquals(
+            'this is <code class="torchlight" style="background-color: #292D3E;">echo "goodbye world"</code> inline',
+            $response->content()
+        );
+    }
+
+    /** @test */
+    public function inline_processors_run()
+    {
+        $this->fakeSuccessfulResponse('component', [
+            'classes' => 'torchlight',
+            'styles' => 'background-color: #292D3E;',
+            'highlighted' => 'echo "hello world"',
+        ]);
+
+        $response = $this->getView('an-inline-component-with-post-processors.blade.php');
+
+        $this->assertEquals(
+            'this is <code class="torchlight" style="background-color: #292D3E;">echo "goodbye world"</code> inline',
+            $response->content()
+        );
+    }
+
     /** @test */
     public function language_can_be_set_via_component()
     {

tests/PostProcessorTest.php

@@ -8,6 +8,7 @@
 use Torchlight\Block;
 use Torchlight\Contracts\PostProcessor;
 use Torchlight\Exceptions\ConfigurationException;
+use Torchlight\PostProcessors\SimpleSwapProcessor;
 use Torchlight\Torchlight;
 
 class PostProcessorTest extends BaseTest
@@ -106,6 +107,19 @@ public function they_run_in_order()
         $this->assertEquals($blocks[0]->highlighted, '<div class=\'highlighted\'>echo "goodbye cruel world";</div>');
     }
 
+    /** @test */
+    public function it_runs_inline_post_processors()
+    {
+        $this->fakeSuccessfulResponse('id');
+
+        $blocks = Torchlight::highlight(
+            Block::make('id')->language('php')->code('echo "hello world";')
+                ->addPostProcessor(SimpleSwapProcessor::make(['hello world' => 'goodbye world']))
+        );
+
+        $this->assertEquals($blocks[0]->highlighted, '<div class=\'highlighted\'>echo "goodbye world";</div>');
+    }
+
     /** @test */
     public function must_implement_interface()
     {

tests/Support/an-inline-component-with-post-processors.blade.php

@@ -0,0 +1,2 @@
+@php($p = \Torchlight\PostProcessors\SimpleSwapProcessor::make(['hello' => 'goodbye']))
+this is <x-torchlight-code torchlight-id='component' language='php' :post-processors='$p'>echo "hello world"</x-torchlight-code> inline

tests/Support/an-inline-component-with-swaps.blade.php

@@ -0,0 +1 @@
+this is <x-torchlight-code torchlight-id='component' language='php' :swap='["hello" => "goodbye"]'>echo "hello world"</x-torchlight-code> inline