Split code into parser and renderer.

Author: bonzai

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release Notes
 
+## v2.0.0 (2018-06-17)
+
+- Split code into parser and renderer.
+
 ## v1.3.0 (2018-06-15)
 
 - Added support for multiple parsers with the same character.

README.md

@@ -15,6 +15,16 @@ A Laravel package for converting URLs in a given string of text into clickable l
 composer require osiemsiedem/laravel-autolink
 ```
 
+## Usage
+
+```php
+use OsiemSiedem\Autolink\Facades\Autolink;
+
+echo Autolink::convert('Check this out - www.example.com. This will be ignored - <a href="http://example.com">My awesome website</a>.');
+
+// Check this out - <a href="http://www.example.com">example.com</a>. This will be ignored - <a href="http://example.com">My awesome website</a>.
+```
+
 ## Testing
 
 ```

composer.json

@@ -11,7 +11,8 @@
     "require": {
         "php": "^7.1.3",
         "illuminate/support": "5.5.*|5.6.*",
-        "symfony/polyfill-mbstring": "^1.0"
+        "symfony/polyfill-mbstring": "^1.0",
+        "spatie/laravel-html": "^2.19"
     },
     "require-dev": {
         "phpunit/phpunit": "^6.0|^7.0",

config/autolink.php

@@ -5,11 +5,11 @@
 return [
     /*
     |--------------------------------------------------------------------------
-    | Ignored Elements
+    | Ignored Tags
     |--------------------------------------------------------------------------
     |
     */
-    'ignored' => [
+    'ignored_tags' => [
         'a',
         'code',
         'kbd',

src/Autolink.php

@@ -5,146 +5,67 @@
 namespace OsiemSiedem\Autolink;
 
 use Illuminate\Support\HtmlString;
-use OsiemSiedem\Autolink\Contracts\Filter;
-use OsiemSiedem\Autolink\Contracts\Parser;
 
 class Autolink
 {
     /**
-     * @var array
+     * @var \OsiemSiedem\Autolink\Parser
      */
-    protected $filters = [];
+    protected $parser;
 
     /**
-     * @var array
+     * @var \OsiemSiedem\Autolink\HtmlRenderer
      */
-    protected $parsers = [];
+    protected $renderer;
 
     /**
-     * @var array
-     */
-    protected $ignored = ['a', 'pre', 'code', 'kbd', 'script'];
-
-    /**
-     * Add a new extension.
+     * Create a new instance.
      *
-     * @param  \OsiemSiedem\Autolink\Contracts\Filter  $filter
-     * @return $this
+     * @param  \OsiemSiedem\Autolink\Parser  $parser
+     * @param  \OsiemSiedem\Autolink\HtmlRenderer  $renderer
+     * @return void
      */
-    public function addFilter(Filter $filter): self
+    public function __construct(Parser $parser, HtmlRenderer $renderer)
     {
-        $this->filters[] = $filter;
-
-        return $this;
+        $this->parser = $parser;
+        $this->renderer = $renderer;
     }
 
     /**
-     * Add a new parser.
+     * Convert the URLs into clickable links.
      *
-     * @param  \OsiemSiedem\Autolink\Contracts\Parser  $parser
-     * @return $this
+     * @param  string  $text
+     * @param  callable|null  $callback
+     * @return \Illuminate\Support\HtmlString
      */
-    public function addParser(Parser $parser): self
+    public function convert(string $text, callable $callback = null): HtmlString
     {
-        foreach ($parser->getCharacters() as $character) {
-            $this->parsers[$character][] = $parser;
-        }
+        $elements = $this->parse($text);
 
-        return $this;
+        return $this->render($text, $elements, $callback);
     }
 
     /**
-     * Set the ignored tags.
+     * Parse the text.
      *
-     * @param  array  $ignored
-     * @return $this
+     * @param  string  $text
+     * @return array
      */
-    public function ignore(array $ignored): self
+    public function parse(string $text): array
     {
-        $this->ignored = $ignored;
-
-        return $this;
+        return $this->parser->parse($text);
     }
 
     /**
-     * Convert the URLs into clickable links.
+     * Render the elements.
      *
      * @param  string  $text
+     * @param  array  $elements
      * @param  callable|null  $callback
      * @return \Illuminate\Support\HtmlString
      */
-    public function convert(string $text, callable $callback = null): HtmlString
+    public function render(string $text, array $elements, callable $callback = null): HtmlString
     {
-        $cursor = new Cursor($text);
-
-        $links = [];
-
-        foreach ($cursor as $character) {
-            if ($character === '<') {
-                foreach ($this->ignored as $ignored) {
-                    if ($cursor->match("#^<{$ignored}[\s>]#i")) {
-                        $cursor->next(strlen($ignored) + 1);
-
-                        while ($cursor->valid()) {
-                            while ($cursor->valid() && $cursor->getCharacter() !== '<') {
-                                $cursor->next();
-                            }
-
-                            if ($cursor->getPosition() === $cursor->getLength()) {
-                                break 2;
-                            }
-
-                            if ($cursor->match("#^</{$ignored}[\s>]#i")) {
-                                break 2;
-                            }
-
-                            $cursor->next();
-                        }
-
-                        break;
-                    }
-                }
-
-                while ($cursor->valid() && $cursor->getCharacter() !== '>') {
-                    $cursor->next();
-                }
-
-                continue;
-            }
-
-            $parsers = array_get($this->parsers, $character);
-
-            if (is_null($parsers)) {
-                continue;
-            }
-
-            foreach ($parsers as $parser) {
-                if ($link = $parser->parse($cursor)) {
-                    $links[] = $link;
-
-                    break;
-                }
-            }
-        }
-
-        for ($i = count($links) - 1; $i >= 0; $i--) {
-            $start = $links[$i]->getStart();
-
-            $end = $links[$i]->getEnd();
-
-            foreach ($this->filters as $filter) {
-                $links[$i] = $filter->filter($links[$i]);
-            }
-
-            if ( ! is_null($callback)) {
-                $links[$i] = $callback($links[$i]);
-            }
-
-            $text = mb_substr($text, 0, $start)
-                .$links[$i]->toHtml()
-                .mb_substr($text, $end, mb_strlen($text) - $end);
-        }
-
-        return new HtmlString($text);
+        return $this->renderer->render($text, $elements, $callback);
     }
 }

src/AutolinkServiceProvider.php

@@ -38,22 +38,32 @@ public function boot()
      */
     public function register()
     {
-        $this->app->singleton('osiemsiedem.autolink', function ($app) {
+        $this->app->singleton('osiemsiedem.autolink.parser', function ($app) {
             $config = $app['config']->get('autolink');
 
-            $autolink = new Autolink;
+            $parser = new Parser;
 
-            $autolink->ignore($config['ignored']);
+            $parser->setIgnoredTags($config['ignored_tags']);
 
-            foreach ($config['filters'] as $filter) {
-                $autolink->addFilter(new $filter);
+            foreach ($config['parsers'] as $elementParser) {
+                $parser->addElementParser(new $elementParser);
             }
 
-            foreach ($config['parsers'] as $parser) {
-                $autolink->addParser(new $parser);
+            return $parser;
+        });
+
+        $this->app->singleton('osiemsiedem.autolink.renderer', function ($app) {
+            $renderer = new HtmlRenderer;
+
+            foreach ($app['config']->get('autolink.filters') as $filter) {
+                $renderer->addFilter(new $filter);
             }
 
-            return $autolink;
+            return $renderer;
+        });
+
+        $this->app->singleton('osiemsiedem.autolink', function ($app) {
+            return new Autolink($app['osiemsiedem.autolink.parser'], $app['osiemsiedem.autolink.renderer']);
         });
     }
 
@@ -64,6 +74,10 @@ public function register()
      */
     public function provides()
     {
-        return ['osiemsiedem.autolink'];
+        return [
+            'osiemsiedem.autolink.parser',
+            'osiemsiedem.autolink.renderer',
+            'osiemsiedem.autolink',
+        ];
     }
 }

src/Contracts/Element.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OsiemSiedem\Autolink\Contracts;
+
+interface Element
+{
+    //
+}

src/Contracts/Filter.php

@@ -4,15 +4,13 @@
 
 namespace OsiemSiedem\Autolink\Contracts;
 
-use OsiemSiedem\Autolink\Link;
-
 interface Filter
 {
     /**
-     * Filter the link.
+     * Filter the element.
      *
-     * @param  \OsiemSiedem\Autolink\Link  $link
-     * @return \OsiemSiedem\Autolink\Link
+     * @param  \OsiemSiedem\Autolink\Contracts\Element  $element
+     * @return \OsiemSiedem\Autolink\Contracts\Element
      */
-    public function filter(Link $link): Link;
+    public function filter(Element $element): Element;
 }

src/Contracts/Parser.php

@@ -4,7 +4,6 @@
 
 namespace OsiemSiedem\Autolink\Contracts;
 
-use OsiemSiedem\Autolink\Link;
 use OsiemSiedem\Autolink\Cursor;
 
 interface Parser
@@ -20,7 +19,7 @@ public function getCharacters(): array;
      * Parse the text.
      *
      * @param  \OsiemSiedem\Autolink\Cursor  $cursor
-     * @return \OsiemSiedem\Autolink\Link|null
+     * @return \OsiemSiedem\Autolink\Contracts\Element|null
      */
-    public function parse(Cursor $cursor): ?Link;
+    public function parse(Cursor $cursor): ?Element;
 }