Add post-processors

Author: aarondfrancis

src/Contracts/PostProcessor.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
+ */
+
+namespace Torchlight\Contracts;
+
+use Torchlight\Block;
+
+interface PostProcessor
+{
+    public function process(Block $block);
+}

src/Manager.php

@@ -5,11 +5,14 @@
 
 namespace Torchlight;
 
+use Exception;
 use Illuminate\Contracts\Cache\Repository;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Macroable;
+use Torchlight\Contracts\PostProcessor;
+use Torchlight\Exceptions\ConfigurationException;
 
 class Manager
 {
@@ -35,6 +38,11 @@ class Manager
      */
     protected $environment;
 
+    /**
+     * @var array
+     */
+    protected $postProcessors = [];
+
     /**
      * @param Client $client
      * @return Manager
@@ -64,7 +72,15 @@ public function client()
      */
     public function highlight($blocks)
     {
-        return $this->client()->highlight($blocks);
+        $blocks = $this->client()->highlight($blocks);
+
+        foreach ($blocks as $block) {
+            foreach ($this->postProcessors as $processor) {
+                app($processor)->process($block);
+            }
+        }
+
+        return $blocks;
     }
 
     /**
@@ -83,6 +99,24 @@ public function overrideEnvironment($environment = null)
         $this->environment = $environment;
     }
 
+    /**
+     * @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;
+        }
+    }
+
     /**
      * Get an item out of the config using dot notation.
      *

tests/PostProcessorTest.php

@@ -0,0 +1,108 @@
+<?php
+/**
+ * @author Aaron Francis <aaron@hammerstone.dev|https://twitter.com/aarondfrancis>
+ */
+
+namespace Torchlight\Tests;
+
+use Torchlight\Block;
+use Torchlight\Contracts\PostProcessor;
+use Torchlight\Exceptions\ConfigurationException;
+use Torchlight\Exceptions\RequestException;
+use Torchlight\Torchlight;
+
+class PostProcessorTest extends BaseTest
+{
+    public function getEnvironmentSetUp($app)
+    {
+        config()->set('torchlight', [
+            'theme' => 'material',
+            'token' => 'token',
+        ]);
+    }
+
+    /** @test */
+    public function it_runs_post_processors()
+    {
+        $this->fakeSuccessfulResponse('id');
+
+        Torchlight::addPostProcessors([
+            GoodbyePostProcessor::class
+        ]);
+
+        $blocks = Torchlight::highlight(
+            Block::make('id')->language('php')->code('echo "hello world";')
+        );
+
+        $this->assertEquals($blocks[0]->highlighted, '<div class=\'highlighted\'>echo "goodbye world";</div>');
+    }
+
+    /** @test */
+    public function null_processor_works()
+    {
+        $this->fakeSuccessfulResponse('id');
+
+        Torchlight::addPostProcessors([
+            NullPostProcessor::class
+        ]);
+
+        $blocks = Torchlight::highlight(
+            Block::make('id')->language('php')->code('echo "hello world";')
+        );
+
+        $this->assertEquals($blocks[0]->highlighted, '<div class=\'highlighted\'>echo "hello world";</div>');
+    }
+
+    /** @test */
+    public function they_run_in_order()
+    {
+        $this->fakeSuccessfulResponse('id');
+
+        Torchlight::addPostProcessors([
+            GoodbyePostProcessor::class,
+            GoodbyeCruelPostProcessor::class
+        ]);
+
+        $blocks = Torchlight::highlight(
+            Block::make('id')->language('php')->code('echo "hello world";')
+        );
+
+        $this->assertEquals($blocks[0]->highlighted, '<div class=\'highlighted\'>echo "goodbye cruel world";</div>');
+    }
+
+    /** @test */
+    public function must_implement_interface()
+    {
+        $this->expectException(ConfigurationException::class);
+        $this->expectExceptionMessage('Post-processor \'Torchlight\Block\' does not implement Torchlight\Contracts\PostProcessor');
+
+        Torchlight::addPostProcessors([
+            Block::class
+        ]);
+    }
+
+}
+
+class NullPostProcessor implements PostProcessor
+{
+    public function process(Block $block)
+    {
+
+    }
+}
+
+class GoodbyePostProcessor implements PostProcessor
+{
+    public function process(Block $block)
+    {
+        $block->highlighted = str_replace('hello', 'goodbye', $block->highlighted);
+    }
+}
+
+class GoodbyeCruelPostProcessor implements PostProcessor
+{
+    public function process(Block $block)
+    {
+        $block->highlighted = str_replace('goodbye', 'goodbye cruel', $block->highlighted);
+    }
+}