Refactor Shortcode parsing

Author: OleVik

CHANGELOG.md

@@ -1,3 +1,13 @@
+# v1.7.1-beta.8
+## XX-05-2019
+
+1. [](#improved)
+   - Initialize API earlier
+   - Refactor Parser->interpretShortcodes()
+   - Parse Shortcodes with Thunderer/Shortcode
+2. [](#new)
+   - Option for Shortcode Parser
+
 # v1.7.1-beta.7
 ## 19-05-2019
 

blueprints.yaml

@@ -14,7 +14,6 @@ docs: https://github.com/OleVik/grav-plugin-presentation/blob/master/README.md
 license: MIT
 dependencies:
   - { name: grav, version: ">=1.6" }
-  - { name: shortcode-core, version: ">=4.1" }
 
 form:
   validation: strict
@@ -280,6 +279,14 @@ form:
               description: PLUGIN_PRESENTATION.ADMIN.ADVANCED.SHORTCODE_CLASSES.DESCRIPTION
               validate:
                 type: string
+            shortcode_parser:
+              type: select
+              label: PLUGIN_PRESENTATION.ADMIN.ADVANCED.SHORTCODE_PARSER.LABEL
+              description: PLUGIN_PRESENTATION.ADMIN.ADVANCED.SHORTCODE_PARSER.LABEL
+              options:
+                  RegularParser: PLUGIN_PRESENTATION.ADMIN.ADVANCED.SHORTCODE_PARSER.OPTIONS.REGULAR
+                  RegexParser: PLUGIN_PRESENTATION.ADMIN.ADVANCED.SHORTCODE_PARSER.OPTIONS.REGEX
+                  WordpressParser: PLUGIN_PRESENTATION.ADMIN.ADVANCED.SHORTCODE_PARSER.OPTIONS.WORDPRESS
             transition:
               type: toggle
               label: PLUGIN_PRESENTATION.ADMIN.ADVANCED.TRANSITION.LABEL

classes/Parser.php

@@ -17,6 +17,12 @@
 use Grav\Common\Uri;
 use Grav\Common\Utils;
 use Grav\Plugin\PresentationPlugin\Utilities;
+use Thunder\Shortcode\Parser\RegularParser;
+use Thunder\Shortcode\Parser\RegexParser;
+use Thunder\Shortcode\Parser\WordpressParser;
+use Thunder\Shortcode\Processor\Processor;
+use Thunder\Shortcode\Shortcode\ShortcodeInterface;
+use Thunder\Shortcode\HandlerContainer\HandlerContainer;
 
 /**
  * Parser API
@@ -35,7 +41,6 @@ class Parser implements ParserInterface
      * Regular expressions
      */
     const REGEX_FRAGMENT_SHORTCODE = '~\[fragment=*([a-zA-Z-]*)\](.*)\[\/fragment\]~im';
-    const REGEX_SHORTCODES = '~((?:\[\s*(?<name>[a-zA-Z0-9-_]+)\s*(?:\=\s*(?<bbCode>\"(?:[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*)\"|((?:(?!=\s*|\]|\/\])[^\s])+)))?\s*(?<parameters>(?:\s*(?:\w+(?:\s*\=\s*\"(?:[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*)\"|\s*\=\s*((?:(?!=\s*|\]|\/\])[^\s])+)|(?=\s|\]|\/\s*\]|$))))*)\s*(?:\](?<content>.*?)\[\s*(?<markerContent>\/)\s*(\k<name>)\s*\]|\]|(?<marker>\/)\s*\])))~u';
     const REGEX_MEDIA_P = '/<p>\s*(<a .*>\s*<img.*\s*<\/a>|\s*<img.*|<img.*\s*|<video.*|<audio.*)\s*<\/p>/i';
 
     /**
@@ -48,6 +53,7 @@ public function __construct($config, $transport)
     {
         $this->config = $config;
         $this->transport = $transport;
+        $this->props = [];
     }
 
     /**
@@ -60,32 +66,28 @@ public function __construct($config, $transport)
      */
     public function interpretShortcodes(string $content, string $id)
     {
-        $return = array();
-        preg_match_all(
-            self::REGEX_SHORTCODES,
-            $content,
-            $matches,
-            PREG_SET_ORDER,
-            0
-        );
-        if (!empty($matches)) {
-            foreach ($matches as $match) {
-                $name = $match['name'];
-                $value = trim($match['bbCode'], '"');
-                $content = str_replace($match[0], '', $content);
+        $handlers = new HandlerContainer();
+        $handlers->setDefault(
+            function (ShortcodeInterface $sc) {
+                $return = array();
+                $name = $sc->getName();
+                $value = $sc->getParameter($name, $sc->getBbCode());
                 if (Utils::startsWith($name, 'class')) {
-                    $return['class'] = $value;
-                } elseif (Utils::startsWith($name, 'hide')) {
-                    $return['hide'] = true;
+                    $this->props['class'] = $value;
                 } elseif (Utils::startsWith($name, 'style')) {
                     $name = str_replace('style-', '', $name);
-                    $return['styles'][$name] = $value;
+                    $this->props['styles'][$name] = $value;
                 } elseif (Utils::startsWith($name, 'data')) {
-                    $return['styles'][$name] = $value;
+                    $this->props['styles'][$name] = $value;
+                } elseif (Utils::startsWith($name, 'hide')) {
+                    $this->props['hide'] = [true];
                 }
+                return;
             }
-        }
-        return ['content' => $content, 'props' => $return];
+        );
+        $parser = "Thunder\Shortcode\Parser\\" . $this->config['shortcode_parser'];
+        $processor = new Processor(new $parser(), $handlers);
+        return ['content' => $processor->process($content), 'props' => $this->props];
     }
 
     /**
@@ -111,10 +113,11 @@ public function processFragments(string $content)
      * @param array  $styles List of key-value pairs
      * @param string $route  Route to Page for relative assets
      * @param string $id     Slide id-attribute
+     * @param string $base   Base path to prepend to file
      *
      * @return string Processed styles, in inline string
      */
-    public function processStylesData(array $styles, string $route, string $id)
+    public function processStylesData(array $styles, string $route, string $id, string $base = "")
     {
         $inline = $data = '';
         foreach ($styles as $property => $value) {
@@ -128,7 +131,7 @@ public function processStylesData(array $styles, string $route, string $id)
                     $locations = Utilities::explodeFileLocations($locations, GRAV_ROOT, '/', '/');
                     $file = Utilities::fileFinder($value, $locations);
                     $file = str_ireplace(GRAV_ROOT, '', $file);
-                    $value = $this->config['base_url'] . $file;
+                    $value = $base . $file;
                 }
                 $inline .= $property . ': url(' . $value . ');';
             } elseif (Utils::startsWith($property, 'data')) {

composer.json

@@ -27,37 +27,14 @@
   },
   "require": {
     "php": ">=7.1.3",
-    "getgrav/grav": ">=1.6",
-    "getgrav/grav-plugin-shortcode-core": "4.1.*",
     "michelf/php-smartypants": "^1.8",
-    "composer/installers": "~1.0"
-  },
-  "suggest": {
-    "getgrav/grav-plugin-shortcode-core": "Enables Shortcodes"
+    "composer/installers": "~1.0",
+    "thunderer/shortcode": "^0.7.2"
   },
   "autoload": {
     "psr-4": {
       "Grav\\Plugin\\PresentationPlugin\\": "classes/",
       "Grav\\Plugin\\PresentationPlugin\\API\\": "classes/"
     }
-  },
-  "repositories": [
-    {
-      "type": "package",
-      "package": {
-        "name": "getgrav/grav-plugin-shortcode-core",
-        "version": "dev-master",
-        "type": "grav-plugin",
-        "require": {
-          "thunderer/shortcode": "~0.7",
-          "composer/installers": "~1.0"
-        },
-        "source": {
-          "url": "https://github.com/getgrav/grav-plugin-shortcode-core.git",
-          "type": "git",
-          "reference": "4.1.0"
-        }
-      }
-    }
-  ]
+  }
 }

composer.lock

@@ -188,6 +188,13 @@ en:
         SHORTCODE_CLASSES:
           LABEL: Shortcode Classes
           DESCRIPTION: Default Classes to use with Presentation-shortcodes, each separated by a space.
+        SHORTCODE_PARSER:
+          LABEL: Shortcode Parser
+          DESCRIPTION: "Processor to use for Shortcode parsing: RegularParser, RegexParser, or WordpressParser"
+          OPTIONS:
+            REGULAR: RegularParser
+            REGEX: RegexParser
+            WORDPRESS: WordpressParser
         TRANSITION:
           LABEL: OnLoad Transition
           DESCRIPTION: Fade in from white when page (DOM-structure) is ready.